Credit Cost
3 per coin per minute (except BTC which is 60 per minute)
Processing
Realtime
- GoldRush-native.
l4Bookis not exposed onwss://api.hyperliquid.xyz/ws. Pointing a client at the public endpoint with this subscription type will fail. - Perps only. No spot assets.
coinis required. Unlikel2Bookandl2BookDiff, you cannot omitcointo stream every asset. Open one subscription per asset.- Snapshot, then diffs. The first message is always a
Snapshot; every message thereafter is anUpdates. Clients must seed local book state from the snapshot and apply diffs from there. On reconnect, drop local state and re-seed from the next snapshot. - Per-order detail. Each entry exposes
user,oid,cloid,tif, and trigger metadata - enabling queue-position reconstruction, per-trader flow attribution, and microstructure analytics that are not possible withl2Book. - See the L4 Order Book recipe for patterns to maintain book state, attribute flow by
user, or reconstruct aggregated price levels.
"coin":"BTC" is used, a credit rate of 60 credits per minute subscribed is applied.
Endpoint
Your GoldRush API key. Passed as a query parameter at connection time - no
Authorization header is used.Subscribe
Send this JSON message after the connection is established:Example
Unsubscribe
Send the samesubscription body with method: "unsubscribe":
Streamed messages
Every message haschannel: "l4Book". The data payload contains exactly one of two variants: a Snapshot (emitted once, immediately after subscribe) or an Updates (emitted on each subsequent HyperCore block where the book for coin changed).
Initial snapshot
The first message after subscribe carries the full resting book at the current block. Each entry inlevels[0] (bids) and levels[1] (asks) is an individual order - not an aggregated price level.
Incremental updates
Subsequent messages carry only what changed since the previous block.order_statuses describes order lifecycle events (open, etc.); book_diffs carries the corresponding price-level changes.
Response fields
Order object
The Order type appears insideSnapshot.levels[*][*] and Updates.order_statuses[*].order.
Wallet address that owns the order.
null when the order is nested inside an order_status (the parent already carries it).Related endpoints
l2Book
subscribe to real-time L2 order book snapshots for all Hyperliquid assets over WebSocket.
l2BookDiff
subscribe to real-time L2 order book (initial snapshot + diffs) for all Hyperliquid assets over WebSocket.
l2BookDiff2
subscribe to a diff-only L2 order book stream with per-coin sequence numbers and a server epoch for gap detection.
l4BookUpdates
subscribe to a strictly-ordered, diff-only order-level (L4) book stream with per-coin sequence numbers and a server epoch for gap detection.
/info and /ws APIs at hypercore.goldrushdata.com, with no rate limits and every fill, order, trade, funding and ledger event retained from the start of HyperCore coverage.
Last reviewed: 2026-11-02