WebSocket channels

​

Subscribe

ws.send(JSON.stringify({
  op: "subscribe",
  channel: "orderbook",
  symbol: "BTC"
}));

ws.send(JSON.stringify({
  op: "subscribe",
  channel: "hip3_l4_diffs",
  symbol: "xyz:XYZ100"
}));

ws.send(JSON.stringify({
  op: "subscribe",
  channel: "spot_orderbook",
  symbol: "HYPE-USDC"
}));

// A side stops trading when its outcome settles, so pick a live one when the example runs.
const res = await fetch("https://api.0xarchive.io/v1/hyperliquid/hip4/instruments", {
  headers: { "X-API-Key": process.env.OXARCHIVE_API_KEY }
});
const side = (await res.json()).data.find(
  (i) => !i.is_settled && Date.parse(i.recurring_expiry) > Date.now()
).coin;

ws.send(JSON.stringify({
  op: "subscribe",
  channel: "hip4_trades",
  symbol: side
}));

ws.send(JSON.stringify({
  op: "subscribe",
  channel: "lighter_orderbook",
  symbol: "BTC",
  interval_ms: 1000
}));

ws.send(JSON.stringify({
  op: "subscribe",
  channel: "rh_lighter_trades",
  symbol: "AAPL-USDG"
}));

ws.send(JSON.stringify({
  op: "unsubscribe",
  channel: "orderbook",
  symbol: "BTC"
}));

​

Replay

const end = Date.now() - 5 * 60_000; // five minutes ago
const start = end - 60_000;          // one minute earlier

ws.send(JSON.stringify({
  op: "replay",
  channel: "hip3_l4_diffs",
  symbol: "xyz:XYZ100",
  start,
  end
}));

const end = Date.now() - 5 * 60_000; // five minutes ago
const start = end - 2_000;           // two seconds earlier

ws.send(JSON.stringify({
  op: "replay",
  channel: "orderbook_full",
  symbol: "BTC",
  start,
  end
}));

​

Channel reference

• Live: you can subscribe to it.
• Real-time only: live, with no replay; history, where it exists, is on REST.
• Timed replay: historical_data messages paced by speed, up to your plan’s standard replay speed.
• Checkpoint replay: Checkpoint-anchored bulk replay: one l4_snapshot from the latest checkpoint at or before start, then ordered l4_batch messages; speed is ignored, the request is single-channel, and it is refused when no checkpoint exists for the symbol and window. WebSocket replay has the event flow.
• Replaces: each message is complete; replace what you hold with it.
• Adds: each message carries new events; append them.
• Changes: each message changes the snapshot you hold; apply the changes in the order received.

​

Hyperliquid core

• orderbook: Live and timed replay. Replaces: the top 20 price levels per side, as levels [bids, asks] live and as bids and asks in replay rows.
• orderbook_full: Live and checkpoint replay. Changes: full-depth L2. It opens with an l4_snapshot of every price level, then l4_batch level changes {side, px, sz, n, bn}: set the level at px to size sz and order count n, and remove it when sz is 0.
• l4_diffs: Live and checkpoint replay. Changes: Hyperliquid core L4. It opens with an l4_snapshot of every resting order, then l4_batch order diffs that change it. L4 order book has the rules for applying them.
• l4_orders: Live and checkpoint replay. Adds: l4_batch order lifecycle events. A live subscription starts with no snapshot; a replay opens with one.
• trades: Live and timed replay. Adds: fill legs. Trade-row user_address and builder_address fields can be null depending on the source; filter them client-side.
• liquidations: Live and timed replay. Adds: liquidation events.
• open_interest and funding: Live and timed replay. Replaces: live messages carry the market context {coin, ctx}, with open interest, funding, mark, oracle and mid prices, and 24-hour volume.
• candles: Replay only, timed; use REST for current candles. Each row is one candle, one hour wide unless the replay sets interval.
• ticker: Real-time only. Replaces: the same {coin, ctx} market context for one symbol.
• all_tickers: Real-time only. It takes no symbol. Replaces: mids, the mid price of every market.

​

Hyperliquid Spot

• spot_orderbook: Real-time only. Replaces: the top 20 price levels per side, as separate bids and asks arrays.
• spot_trades: Real-time only. Adds: fill legs.
• spot_l4_diffs and spot_l4_orders: Live and checkpoint replay. Changes and adds, as l4_diffs and l4_orders do: the Spot L4 channels carry order-level diffs and events, delivered as on Hyperliquid core, with the dashed pair symbol in each frame.
• spot_twap: accepted but sends no messages. Read TWAP from the Spot TWAP routes.

​

HIP-3

• hip3_orderbook: Live and timed replay. Replaces: the top 20 price levels per side, as on orderbook.
• hip3_orderbook_full: Live and checkpoint replay. Changes: full-depth L2 level changes, as on orderbook_full.
• hip3_l4_diffs and hip3_l4_orders: Live and checkpoint replay. Changes and adds: HIP-3 L4, delivered as l4_diffs and l4_orders are.
• hip3_trades and hip3_liquidations: Live and timed replay. Adds: fill legs and liquidation events.
• hip3_open_interest and hip3_funding: Live and timed replay. Replaces: the {coin, ctx} market context.
• hip3_candles: Replay only, timed; use REST for current candles.

​

HIP-4

• hip4_trades: Live and timed replay. Adds: fill legs.
• hip4_l4_diffs and hip4_l4_orders: Live and checkpoint replay. Changes and adds: HIP-4 L4, delivered as l4_diffs and l4_orders are.
• hip4_orderbook and hip4_open_interest: Replay only, timed, from stored history; use REST for the current book and outcome-side open interest.

​

Hyperliquid, all products

• mempool: Real-time only. It is never stored, so no route has its history. Adds: signed transactions as our Hyperliquid node receives them, before they are in a block, one item per action. It is served only on wss://stream.0xarchive.io/ws, and it is the one channel that comes with the Pro, Scale and Enterprise plans rather than every plan. Mempool channel has the messages, limits, and errors.

​

Lighter

• lighter_orderbook: Live and timed replay. Replaces: a full top-20 book per side, at most once per interval: one book a second by default, or the rate set by the optional interval_ms subscribe field (100 to 5000).
• lighter_trades: Live and timed replay. Adds: fill legs, two per trade with the same tid. Replay returns finalized trades only.
• lighter_open_interest and lighter_funding: Live and timed replay. Replaces: both carry the same market-context message.
• lighter_candles: Replay only, timed; use REST for current candles.
• lighter_l3_orderbook: Replay only, timed. Lighter L3: each row is an order-level snapshot; use REST for current L3 depth.

​

Lighter on Robinhood Chain

• rh_lighter_orderbook: Live and timed replay. Replaces, as on lighter_orderbook, with the same interval_ms range.
• rh_lighter_trades: Live and timed replay. Adds: fill legs, as on lighter_trades.
• rh_lighter_open_interest and rh_lighter_funding: Live and timed replay. Replaces: the market-context message, perps only.
• rh_lighter_candles: Replay only, timed; use REST for current candles.

​

Keep subscription state correct

• Venue family, channel, and symbol, such as Hyperliquid core orderbook BTC, HIP-3 hip3_l4_diffs xyz:XYZ100, or HIP-4 hip4_trades #0, in the family’s own symbol format.
• Book interval: the interval_ms you set on lighter_orderbook or rh_lighter_orderbook. A reconnect without it falls back to one book a second.
• Consumer: dashboard, alert, local book, replay, or export writer, which sets throughput and gap tolerance.
• Stop condition: unsubscribe, close, replay stop, or a retry budget, so no stream is abandoned.

​

Next step