StreamL4Book - Stream Full L4 Order Book
Subscribe to a typed Hyperliquid L4 opening snapshot followed by native per-block order-book diffs over V3 gRPC.
StreamL4Book exposes the full per-order book for one coin. The first frame is a typed snapshot; later frames carry the node-native JSON diff object in data.
Request and opening behavior
coin is required and validated case-sensitively. Omitted mirror defaults to true, enabling HIP-4 binary-sibling projection. Mirrored orders set synthetic: true and have bit 52 set in oid.
The snapshot contains typed L4Order rows. Each later diff contains JSON-encoded {order_statuses, book_diffs} plus its block time and sequential block number.
Large opening snapshot
The opening snapshot can exceed the client inbound message limit. The Go example sets a 64 MiB receive allowance as a practical starting point; tune it for the selected coin and workload while keeping memory use bounded.
Delivery and recovery
This is an incremental stream. Frame loss, a stream state reset, or an outcome market changing shape closes it with ABORTED. Reconnect and rebuild from the next opening snapshot. For typed order-level diffs without native JSON, use StreamL4OrderUpdates. Shared live-stream and error semantics are on the gRPC overview.
Related references: StreamL4OrderUpdates and the Order Book WebSocket L4 book.
StreamL2BookDiff - Stream Ordered L2 Diffs
Reconstruct up to 20 Hyperliquid L2 books from typed opening snapshots and sequenced level diffs over V3 gRPC.
StreamL4OrderUpdates - Stream Typed Order Diffs
Maintain typed Hyperliquid resting-order state from an opening snapshot and sequenced L4 diffs over V3 gRPC.