Get HIP-4 order flow
Get order flow aggregation for a HIP-4 outcome side, in buckets of interval (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.
Pagination: results are oldest first. When meta.has_more is true, pass the string meta.next_cursor unchanged as cursor with the same filters to get the next page. Stop when meta.has_more is false.
Request
- Base URL: https://api.0xarchive.io
- URL: https://api.0xarchive.io/v1/hyperliquid/hip4/orders/{symbol}/flow
- Auth: API key in header X-API-Key
Path parameters
HIP-4 coin id (e.g., 0 for outcome 0 Yes side, 1 for No side). The #-prefixed form (#0, #1) is also accepted.
Query parameters
Start timestamp, inclusive (default: 24 hours before now). Accepts Unix milliseconds or an RFC 3339 UTC string such as 2026-01-01T00:00:00Z.
End timestamp, exclusive (default: now). Accepts Unix milliseconds or an RFC 3339 UTC string such as 2026-01-01T00:00:00Z.
Pagination cursor: use the string meta.next_cursor returned when meta.has_more is true, passed back unchanged with the same filters. Do not parse or construct it. Stop when meta.has_more is false.
Maximum number of buckets, oldest first (default: 1000, max: 10000)
Bucket width: 1m (default), 5m, 15m or 1h. Case-sensitive. Any other value answers 400.
Deprecated alias of interval. interval wins when both are sent.
Response
Order flow aggregation data
Example response
{
"success": true
}Changes
No recorded changes to this operation across all 1 revision of this API.