HIP-3 Builder Perps - Orders

Get HIP-3 order flow

Get order flow aggregation for a HIP-3 symbol, in buckets of granularity (1m by default). Shows order placement and cancellation rates over time.

Buckets: each bucket is labelled by its open time in UTC, and buckets open on multiples of the bucket width since the Unix epoch. A bucket with no order events is omitted. A bucket counts only the events inside [start, end), so when start or end falls inside a bucket, that first or last bucket is partial; start and end on bucket opens give whole buckets.

get/v1/hyperliquid/hip3/orders/{symbol}/flow

Request

  • Base URL: https://api.0xarchive.io
  • URL: https://api.0xarchive.io/v1/hyperliquid/hip3/orders/{symbol}/flow
  • Auth: API key in header X-API-Key

Path parameters

symbolstring required
Example:hyna:BTC

HIP-3 symbol (case-sensitive, e.g., hyna:BTC, km:US500)

Query parameters

startinteger
Example:1767225600000

Start timestamp in Unix milliseconds, inclusive (default: 24 hours before now)

endinteger
Example:1767225600000

End timestamp in Unix milliseconds, exclusive (default: now)

cursorstring

Cursor for pagination (use the value from previous response's next_cursor)

limitinteger

Maximum number of buckets, oldest first (default: 1000, max: 10000)

granularity'1m' | '5m' | '15m' | '1h'

Bucket width (default: 1m). interval is accepted as an alias and takes precedence when both are sent. Any other value returns 400.

Response

Order flow aggregation data

successboolean
dataobject[]

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.