Skip to main content
GET
Get Hyperliquid trade intent
Operation schema · Trade intent buckets and coverage

Authorizations

X-API-Key
string
header
required

API key for authentication. Get yours at https://0xarchive.io/dashboard

Headers

0xArchive-Version
enum<string>

Selects the 2026-10 response contract. Send 2026-10-01; any dated version on or after it selects the same shapes. Without the header every response keeps its existing shape. With it:

  • The data quality routes, /v1/status/coverage and /v1/symbols answer the standard {success, data, meta} envelope.
  • Record times that are integer milliseconds by default become RFC 3339 UTC strings with millisecond precision, and the integer moves to a *_ms field: L4 resting-order timestamp (timestamp_ms), CVD buckets, HIP-3 oracle reads, Lighter and Lighter on Robinhood Chain liquidations and liquidation volume. Levels and trigger-levels snapshot_ts become RFC 3339 with snapshot_ts_ms.
  • Error bodies carry the contract error_code names: invalid_parameter instead of invalid_query_params and invalid_path_params, historical_depth_exceeded instead of history_window_exceeded, and historical_range_exceeded instead of request_range_exceeded; a malformed cursor that fails to parse answers 400 invalid_cursor instead of invalid_query_params. With 0xArchive-Version: 2026-10-01, malformed cursors on trades, liquidations, L2 and L4 diffs, order history, TP/SL and order-flow routes answer 400 invalid_cursor. Without the header, the first six route families treat a malformed cursor as no cursor and return the first page; order flow answers 400 invalid_query_params. Malformed trade time inputs answer 400 invalid_time_range with the header and 400 invalid_query_params without it.

The response echoes the selected version in its own 0xArchive-Version header.

Available options:
2026-10-01
Example:

"2026-10-01"

Path Parameters

symbol
string
required

Hyperliquid core perp symbol (e.g., BTC, ETH).

Example:

"BTC"

Query Parameters

start

Start of the window, inclusive. Defaults to 24 hours before end, so set it explicitly when paging: the default moves with the clock. Accepts Unix milliseconds or an RFC 3339 UTC string such as 2026-01-01T00:00:00Z. An instant: Unix milliseconds, or an RFC 3339 string such as 2026-01-01T00:00:00Z (encode a + offset as %2B). An unparsable value answers 400 invalid_time_range.

Example:

1767225600000

end

End of the window, inclusive. Defaults to now. Accepts Unix milliseconds or an RFC 3339 UTC string such as 2026-01-01T00:00:00Z. An instant: Unix milliseconds, or an RFC 3339 string such as 2026-01-01T00:00:00Z (encode a + offset as %2B). An unparsable value answers 400 invalid_time_range.

Example:

1767225600000

interval
enum<string>
default:1h

Bucket width (default: 1h), on UTC epoch boundaries. Each family has its own coverage: see the description.

Available options:
1s,
5s,
15s,
1m,
5m,
15m,
1h,
4h,
1d
cursor
string

Opaque pagination cursor: pass meta.next_cursor from the previous page unchanged, with the same filters. Omit it for the first page. It is the next page's first bucket open.

limit
integer
default:500

Buckets per page (default: 500, max: 2,000). A larger value is read as 2,000.

Required range: x <= 2000

Response

Trade intent buckets

API response containing trade intent buckets. meta carries symbol, venue, built_through, and preliminary_row_count when preliminary buckets are present.

success
boolean
Example:

true

data
object[]
meta
object

Response metadata. Every 2xx JSON response carries meta.request_id; list payloads add count; cursor-paged routes add has_more and, when another page follows, next_cursor; per-symbol routes add symbol and venue. Fields that do not apply to a route are omitted.

Last modified on November 4, 2026