Path: venue family and symbol
The symbol sits in the path, and its shape depends on the venue family:| Family | Path namespace | Symbol shape |
|---|---|---|
| Hyperliquid core | /v1/hyperliquid/* | Plain perp, e.g. BTC |
| Hyperliquid Spot | /v1/hyperliquid/spot/* | Pair, e.g. HYPE-USDC |
| HIP-3 | /v1/hyperliquid/hip3/* | Builder prefix, e.g. km:US500 (case-sensitive) |
| HIP-4 | /v1/hyperliquid/hip4/* | Outcome side id, URL-encoded, e.g. %230 |
| Lighter | /v1/lighter/* | Lighter symbol; list with /v1/lighter/instruments |
# is part of the identifier, not decoration.
Query: time windows
Most routes accept astart and end window. The format is not uniform, so check the route:
- Market-state routes (order books, trades, candles, funding, open interest, liquidations) take Unix milliseconds.
startdefaults to 24h ago,endto now. - Order routes (order history, order flow, take profits & stop losses) take ISO 8601 strings, e.g.
2026-01-01T00:00:00Z.
Query: shape and size
| Parameter | Where it applies | What it does |
|---|---|---|
interval | candles, funding, open interest | Aggregation bucket, e.g. 1h |
depth | order books | Levels per side; plan-gated (Free 20, Build 200, Pro/Enterprise full) |
limit | most list routes | Max rows; the default and ceiling vary by route |
cursor | paginated routes | Continuation token from meta.next_cursor (see Pagination) |
| filters | order routes | status, order_type, triggered, user_address where the route supports them |
Keep requests bounded
Start with one symbol, one route, and one short window before widening. A bounded request is cheaper, easier to retry, and easier to reason about than an open-ended pull. Size the window andlimit to the question, then paginate rather than asking for everything at once. For the exact parameter table per data type, open the matching page under Market data; for the generated contract, use OpenAPI.