Stream catalogue

Every stream. Every method. Every field.

The complete inventory of what the feeds carry: proto methods, compatibility, field-by-field specs, filters, snapshot semantics, sample messages, and honest volume notes. If a field is not listed here, we do not stream it.

stream.hyperliquidrpc.com:443gRPC / TLS · x-api-key · reflection

hyperliquid.*QuickNode-compatible
hyperliquid_l1_gateway.v2Dwellir-compatible
hyperliquid_swaps.v1native schema
hyperliquid_btc_price.v1native schema

Trades / Swaps

Native schema

hyperliquid_swaps.v1.SwapStreaming/StreamSwaps

hyperliquid.Streaming/StreamData (stream_type: TRADES)

also via

The richest feed: full wallet attribution on every fill. The flat swap schema (Solana-swap-compatible) is the recommended surface; the same fills are also available QuickNode-compatibly via StreamData with stream_type TRADES. Around 6.5M fills a day across 462 markets.

Key fields

Field	Type	Description
coin	string	Market symbol (perp, spot @N, or HIP-3 dex:SYMBOL).
px	string	Fill price.Byte-exact decimal string, never a float.
sz	string	Fill size in base units.Byte-exact decimal string.
notional	string	Fill notional in USDC.Byte-exact decimal string.
side	string	Aggressor side: B (buy) or A (sell).
user	string	Trader's wallet address. Full attribution on every fill.
dir	string	Position context: Open Long, Close Short, etc.
start_position	string	Trader's position before the fill.Byte-exact decimal string.
closed_pnl	string	Realized PnL closed by this fill.Byte-exact decimal string.
fee	string	Fee paid (negative when rebated).Pair with is_rebate.
is_rebate	bool	True when the fee is a maker rebate.
crossed	bool	True if this side crossed the book (taker).
oid / cloid / tid	uint64 / string / uint64	Order id, client order id, and trade id.
twap_id	uint64?	Set when the fill belongs to a native TWAP execution.
liquidation	object?	Liquidation details (liquidated user, mark price) when applicable.

Server-side filters

coins[]: one or more markets
wallets[]: one or more trader addresses
market_type: ALL / SPOT / PERP
recent replay up to 6 hours

Semantics

Pure event stream: one message per executed fill, in block order. No snapshot phase; Ultra can replay from a recent block within the last 6 hours.

Sample message

{  "block_height": 612408133,  "block_time": "2026-06-09T08:14:02.418Z",  "coin": "BTC",  "px": "67012.0",  "sz": "0.14523",  "notional": "9732.15",  "side": "B",  "crossed": true,  "user": "0x7c4ee0c0c5d3ab91f7f0f3c2a3d6b18452e9a3f9",  "dir": "Close Short",  "start_position": "-0.42100",  "closed_pnl": "182.337041",  "fee": "2.433037",  "is_rebate": false,  "oid": 91834221107,  "cloid": "0x00000000000000000000000000a1b2c3",  "tid": 442191083327011,  "twap_id": null,  "liquidation": null}

Volume: ~6.5M fills/day across all markets (~75/s average; bursts are much higher). Filter server-side to pay only for what you subscribe to.

Read the Trades / Swaps guide

L2 Order Book

QuickNode-compatible

hyperliquid.OrderBookStreaming/StreamL2Book

Top-of-book and depth by price level for a single coin. Subscribe with {coin, n_levels}; the first message is a full snapshot, then one update per block. Levels carry price, aggregated size, and resting-order count.

Key fields

Field	Type	Description
coin	string	Market symbol.
levels	Level[][2]	Bids and asks arrays, best price first.
px	string	Price level.Byte-exact decimal string.
sz	string	Aggregated size resting at the level.Calculated aggregate serialized as a decimal string.
n	uint32	Number of resting orders at the level.
block_height	uint64	Block this state corresponds to.

Server-side filters

coin: required, one market per subscription
n_levels: 1 to 100

Semantics

Snapshot-then-updates: first message is a full book snapshot, then one full refresh per block. The book is guaranteed never crossed.

Sample message

{  "coin": "BTC",  "block_height": 612408133,  "time": "2026-06-09T08:14:02.418Z",  "is_snapshot": false,  "levels": [    [      { "px": "67011.0", "sz": "3.41280", "n": 14 },      { "px": "67010.0", "sz": "1.20019", "n": 6 }    ],    [      { "px": "67012.0", "sz": "2.88457", "n": 11 },      { "px": "67013.0", "sz": "5.10022", "n": 19 }    ]  ]}

Volume: One update per block per subscribed coin gives predictable, low-bandwidth depth. Use n_levels: 1 as a top-of-book ticker.

Read the L2 Order Book guide

L4 Order Book

QuickNode-compatible

hyperliquid.OrderBookStreaming/StreamL4Book

Every individual resting order, attributed to its wallet. Starts with a current complete book snapshot, then per-block diffs. This method is live-only; resubscribe for a fresh snapshot after a gap.

Key fields

Field	Type	Description
oid	uint64	Order id of the resting order.
user	string	Owner's wallet address.
coin	string	Market symbol.
side	string	B (bid) or A (ask).
px	string	Limit price.Byte-exact decimal string.
sz	string	Remaining size.Byte-exact decimal string.
diffs[].type	enum	NEW / UPDATE / REMOVE per-block change.

Server-side filters

coin: required, one market per subscription

Semantics

Snapshot + diffs: the first message is the complete order-by-order book; each block then delivers the set of order-level changes. Full snapshots can be large; set max receive size ≥256 MB.

Sample message

{  "coin": "BTC",  "block_height": 612408134,  "is_snapshot": false,  "diffs": [    {      "type": "NEW",      "order": {        "oid": 91834221299,        "user": "0x2f8a91be6cda04417e3c50f1a7b9d20c1e664b07",        "side": "A",        "px": "67018.0",        "sz": "0.75000"      }    },    { "type": "REMOVE", "oid": 91834219841 }  ]}

Volume: High volume on liquid markets. This is the full order flow behind 725M+ order updates/day, so budget bandwidth accordingly or filter to specific coins.

Read the L4 Order Book guide

Order lifecycle

QuickNode-compatible

hyperliquid.Streaming/StreamData (stream_type: ORDERS)

The full L1 order lifecycle for every wallet and market: placements, modifications, cancels, fills, trigger activations, and rejections, with the order's complete parameters on each event.

Key fields

Field	Type	Description
user	string	Wallet that owns the order.
coin	string	Market symbol.
side	string	B (buy) or A (sell).
limit_px	string	Limit price.Byte-exact decimal string.
sz	string	Order size.Byte-exact decimal string.
order_type	string	Limit, trigger (stop/TP), etc.
tif	string	Time-in-force: Gtc, Ioc, Alo.
trigger_px / trigger_condition	string?	Trigger parameters for stop and take-profit orders.
reduce_only	bool	True for reduce-only orders.
status	string	open / filled / canceled / triggered / rejected.
oid / cloid	uint64 / string	Order id and optional client order id.

Server-side filters

coins[]
wallets[]
recent replay up to 6 hours

Semantics

Pure event stream in block order: one message per order-status transition. No snapshot phase.

Sample message

{  "block_height": 612408135,  "block_time": "2026-06-09T08:14:03.121Z",  "user": "0x91b3c07a4de2f6cc185a0fd2b94e7a30c8d1572e",  "coin": "ETH",  "side": "B",  "limit_px": "3498.25",  "sz": "12.4400",  "order_type": "Limit",  "tif": "Gtc",  "trigger_px": null,  "trigger_condition": null,  "reduce_only": false,  "oid": 91834221384,  "cloid": null,  "status": "open"}

Volume: 725M+ order updates/day platform-wide (~8,400/s average). Server-side coin and wallet filters are strongly recommended.

Read the Order lifecycle guide

Raw book diffs

QuickNode-compatible

hyperliquid.Streaming/StreamData (stream_type: BOOK_UPDATES)

The lowest-level book surface: every captured change to every order book. Pair it with a compatible snapshot and apply deltas in order for queue-position and microstructure research within the data range you hold.

Key fields

Field	Type	Description
update_type	enum	NEW / UPDATE / MODIFIED / REMOVE.
coin	string	Market symbol.
oid	uint64	Order id the delta applies to.
user	string	Owner's wallet address.
side	string	B (bid) or A (ask).
px	string	Price of the affected order.Byte-exact decimal string.
sz	string	Size after the change (0 on remove).Byte-exact decimal string.
block_height	uint64	Block the delta belongs to; apply in order.

Server-side filters

coins[]
recent replay up to 6 hours

Semantics

Pure delta stream in strict block order. For recovery, replay from a checkpoint only when you retained the compatible prior book state; otherwise resubscribe to StreamL4Book for current state.

Sample message

{  "block_height": 612408136,  "coin": "BTC",  "update_type": "MODIFIED",  "oid": 91834220771,  "user": "0x5d20af913cc01b76e4a8f20de33c197a40b8e641",  "side": "B",  "px": "67009.0",  "sz": "0.40000"}

Volume: The highest-volume stream: every book change on every market. Filter by coin unless you genuinely need the firehose.

Read the Raw book diffs guide

TWAP algos

QuickNode-compatible

hyperliquid.Streaming/StreamData (stream_type: TWAP)

Status events for Hyperliquid's native TWAP orders: who is running them, total and executed size, executed notional (giving average fill price), duration, and lifecycle status. Useful for large-order detection and flow analysis.

Key fields

Field	Type	Description
twap_id	uint64	TWAP identifier; joins to twap_id on fills.
coin	string	Market symbol.
user	string	Wallet running the TWAP.
side	string	B (buy) or A (sell).
sz	string	Total TWAP size.Byte-exact decimal string.
executed_sz	string	Size executed so far.Byte-exact decimal string.
executed_ntl	string	Notional executed so far; divide by executed_sz for average fill price.Byte-exact decimal string.
minutes	uint32	Configured duration.
status	string	activated / finished / canceled / terminated.

Server-side filters

coins[]
wallets[]
recent replay up to 6 hours

Semantics

Event stream: one message per TWAP status change or progress update, in block order.

Sample message

{  "block_height": 612408201,  "twap_id": 48112,  "coin": "HYPE",  "user": "0xa4f17bd09e26c3158c0b7341fa882ce05d97b264",  "side": "B",  "sz": "25000.00",  "executed_sz": "9412.36",  "executed_ntl": "116214.872340",  "minutes": 60,  "randomize": true,  "status": "activated"}

Volume: Low volume relative to fills, since only institutional TWAPs appear here. Cheap to subscribe to platform-wide.

Read the TWAP algos guide

Events

QuickNode-compatible

hyperliquid.Streaming/StreamData (stream_type: EVENTS)

The non-order event surface: per-user funding payments with the funding rate, liquidations with victim and mark price, deposits, withdrawals, and position updates. These captured events can also support custom liquidation or funding datasets.

Key fields

Field	Type	Description
type	string	funding / liquidation / deposit / withdraw / position update.
user	string	Affected wallet.
coin	string	Market symbol (funding, liquidation).
usdc	string	USDC amount of the event (signed for funding).Byte-exact decimal string.
funding_rate	string	Funding rate applied (funding events).Byte-exact decimal string.
szi	string	Signed position size the payment applied to.Byte-exact decimal string.
liquidation	object?	Liquidated size, price, and mark price (liquidation events).

Server-side filters

coins[]
wallets[]
recent replay up to 6 hours

Semantics

Pure event stream in block order. Funding arrives per user per funding interval; liquidations as they execute.

Sample message

{  "block_height": 612409002,  "block_time": "2026-06-09T09:00:00.084Z",  "type": "funding",  "user": "0xe83b6f02a1d94c7785cb01f3aa620d94b17c08d5",  "coin": "BTC",  "usdc": "-14.302187",  "szi": "2.54000",  "funding_rate": "0.0000125"}

Volume: Bursty: funding clusters at funding intervals across 63,000+ wallets; liquidations cluster with volatility.

Read the Events guide

Blocks

QuickNode-compatible

hyperliquid.BlockStreaming/StreamBlocks

hyperliquid.Streaming/StreamData (stream_type: BLOCKS)

also via

Every L1 block as produced: height, timestamp, and the raw block content. The base layer if you want to run your own decoding, indexing, or verification on top of our node fleet.

Key fields

Field	Type	Description
height	uint64	Block height.
block_time	string	Block timestamp (ISO-8601).
raw	bytes	Raw block payload.

Server-side filters

QuickNode block methods are live-only
Dwellir StreamBlocks supports recent block_height on Ultra up to 6 hours

Semantics

QuickNode BlockStreaming/StreamBlocks and StreamData BLOCKS are live-only. For Ultra block replay within 6 hours, use the Dwellir-compatible StreamBlocks method with Position.block_height.

Sample message

{  "height": 612408133,  "block_time": "2026-06-09T08:14:02.418Z",  "num_txs": 1742,  "raw": "<bytes: 1.8 MB>"}

Volume: One message per L1 block. Individual blocks can be large; raise your client's max receive size.

Read the Blocks guide

Dedicated BTC price

Native schema

hyperliquid_btc_price.v1.BtcPriceStreaming/StreamBtcPrices

A single-purpose ticker for the most common ask: the current BTC price, from last trades on the BTC perp. Minimal payload, minimal bandwidth. The right surface for bots and dashboards that just need a number that moves.

Key fields

Field	Type	Description
px	string	BTC last-trade price.Byte-exact decimal string.
block_height	uint64	Block of the underlying trade.
time	string	Trade timestamp (ISO-8601).

Server-side filters

none (the stream is pre-filtered to BTC by design)

Semantics

Pure ticker: one message per BTC last-trade price change, no snapshot phase.

Sample message

{  "px": "67012.0",  "block_height": 612408133,  "time": "2026-06-09T08:14:02.418Z"}

Volume: Tiny: a few messages per second at most. Available on both self-serve plans.

Read the Dedicated BTC price guide

Dwellir-compatible gateway

Dwellir-compatible

hyperliquid_l1_gateway.v2.HyperliquidL1Gateway

For teams already integrated with Dwellir: the same hyperliquid_l1_gateway.v2 service and messages on our endpoint. Change the endpoint and key; keep your stubs. Recent block-height reads and replay are available on Ultra for up to 6 hours; timestamp inputs and book-snapshot requests return current state.

Key fields

Field	Type	Description
StreamBlocks	stream	L1 blocks, Dwellir wire format.
StreamFills	stream	Executed fills, Dwellir wire format.
StreamOrderbookSnapshots	stream	Current full snapshots every second; Position does not select history.
GetBlock	unary	Latest, or a recent block by block_height on Ultra.
GetFills	unary	Latest, or recent fills by block_height on Ultra.
GetOrderBookSnapshot	unary	Latest full book snapshot; timestamp lookup is not historical.

Server-side filters

Position.block_height for Ultra replay or recent lookup; unset for live/latest

Semantics

Dwellir-compatible service names, request messages, and response messages; generated stubs work unchanged. Historical timestamp addressing is not promised.

Sample message

{  "block_height": 612408133,  "coin": "BTC",  "px": "67012.0",  "sz": "0.14523",  "side": "B",  "user": "0x7c4ee0c0c5d3ab91f7f0f3c2a3d6b18452e9a3f9",  "time": "2026-06-09T08:14:02.418Z"}

Volume: Volume matches the underlying surfaces (blocks, fills, snapshots), so it is sized like the native equivalents.

Read the Dwellir-compatible gateway guide

Across every stream

Cross-cutting features

These apply to every surface above. They are properties of the platform, not of individual streams.

Server-side filtering

Filter by coin and wallet on the server. You only receive (and pay bandwidth for) what you subscribe to.

Replay from height

On Ultra, eligible StreamData event topics, StreamSwaps, and Dwellir block/fill streams can replay from a height within the last 6 hours, then continue live.

All markets

Perps, spot (@N), and HIP-3 / pre-market (dex:SYMBOL), including new listings.

Exact decimals

Raw prices, sizes, PnL, and fees retain exact decimal-string representations instead of binary floats.

Wire-compatible

QuickNode and Dwellir client stubs work unchanged; switch by changing one endpoint.

Found the fields you need?

Every stream on this page is on both plans. Subscribe in under a minute.

Get an API key Read the docs