Streams

wss://data.hyperdash.com/v1/stream

import WebSocket from "ws";

const ws = new WebSocket("wss://data.hyperdash.com/v1/stream", {
  headers: { Authorization: `Bearer ${process.env.HYPERDASH_API_KEY}` },
});

ws.on("message", async (raw) => {
  const msg = JSON.parse(raw);
  switch (msg.op) {
    case "ready":        // authenticated: subscribe now, resuming from your saved cursor
      ws.send(JSON.stringify({ op: "subscribe", channel: "liquidations", coin: "ETH", cursor: saved.cursor }));
      break;
    case "data":
      await handle(msg.events);                 // process and checkpoint first...
      saved.cursor = msg.cursor;
      ws.send(JSON.stringify({ op: "ack", sub: msg.sub, batch: msg.batch }));  // ...then ack
      break;
    case "gap": backfillOverRest(msg.from, msg.to); break;
    case "ping": ws.send(JSON.stringify({ op: "pong" })); break;
    case "error": console.error(msg.code, msg.detail); break;
  }
});
ws.on("close", (code, reason) => reconnectWithJitter(code, reason.toString()));

​

Channels

​

Messages

​

Delivery and billing

• Events arrive in data batches of up to 100. The next batch waits until you acknowledge the previous one. If you don’t acknowledge a batch within 10 seconds, the subscription ends with ack_timeout; resubscribe from your last cursor.
• Every channel costs 1 credit per acknowledged event. Replays of events you already paid for are free. A key’s per-request maximum applies to each batch.
• Test keys receive a synthetic event every 2 seconds, free.

​

Resuming

​

Limits

• 20 subscriptions per connection, and one live subscription per key, channel, and target.
• Connections per workspace follow your plan: Starter 5, Growth 25, Scale 50.
• Wallets on the orders channel at once: Starter 10, Growth 50, Scale 200. A subscription can also be refused with orders stream capacity reached while server-wide capacity is full; retry later.
• Workspaces that leave 5 or more batches unacknowledged within 10 minutes (including batches dropped by unsubscribing or disconnecting) can’t open new subscriptions for a few minutes.
• Messages you send can be at most 64 KiB.

​

Close codes