Skip to main content
Order flow is aggregated order activity over a window: the shape of placements and cancels rather than each individual order. It is available on Hyperliquid core, HIP-3, and HIP-4.

Get order flow

curl "https://api.0xarchive.io/v1/hyperliquid/orders/BTC/flow" \
  -H "X-API-Key: $OXARCHIVE_API_KEY"
/v1/hyperliquid/orders/{symbol}/flow. Plain perp symbols such as BTC.
The OpenAPI spec types this route as a raw object array, so capture a live fixture and pin the fields you depend on. The granularity parameter controls how flow is bucketed.

Request parameters

ParameterInTypeRequiredDescription
symbolpathstringYesTrading pair symbol, e.g. BTC
startquerystringNoStart time, ISO 8601 (e.g. 2026-01-01T00:00:00Z)
endquerystringNoEnd time, ISO 8601
granularityquerystringNoAggregation granularity
limitqueryintegerNoMax results. Default 1000, max 10000
cursorquerystringNoPagination cursor from meta.next_cursor

When to use it

Order flow answers “what was the shape of order activity here?” rather than “what filled?” Use Trades when you need the executions, Order history when you need each order’s lifecycle, and order flow when you want the aggregated placement and cancel pressure over a window. The granularity parameter trades resolution for size: finer buckets show more detail but return more rows. Keep the venue family, symbol, window, and granularity with every stored result so a later run reproduces the same view. Flow is most useful alongside the L4 book, since the same window of activity is what moved the resting orders.

Stream it live

Order flow is a REST-side aggregation, so there is no order-flow channel. For live order activity, stream the L4 order events (l4_orders, or the venue-prefixed variant) and aggregate placement and cancel pressure yourself.

Export in bulk

There is no standalone order-flow export schema. Export the raw order events with the l4_orders (Order Events) schema ($8/GB, $25 minimum) and aggregate to flow downstream. Schema columns and coverage keys are on Export Schemas.

Next

Use Order history for per-order detail, Order books for L4 depth, or Trades for the fill tape.
Last modified on June 8, 2026