> ## Documentation Index
> Fetch the complete documentation index at: https://docs.0xarchive.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Request parameters

> How 0xArchive REST requests are shaped: path symbols per venue, time windows, intervals, depth, limits, and the filters each route accepts.

Build a REST request from a path that names the venue family and symbol, plus query parameters that set the time window, the shape of the result, and any filters. Each data-type page under Datasets lists its routes' exact parameters; the rules below are shared by all of them.

## Path: venue family and symbol

The symbol sits in the path, and its shape depends on the venue family:

| Family | Namespace and 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` |
| Lighter on Robinhood Chain | `/v1/rh-lighter/*`. `BTC` for perps, `AAPL-USDG` for USDG-quoted spot; list with `/v1/rh-lighter/instruments` |

Keep the symbol shape intact. A HIP-3 prefix or a HIP-4 `#` is part of the identifier, not decoration.

## Query: time windows

Most routes accept a `start` and `end` window. Snapshot-at-time routes use `timestamp` instead, and the levels routes also accept `at`. Every one of these parameters takes either form:

* **Unix milliseconds**, for example `1767225600000`.
* **RFC 3339**, for example `2026-01-01T00:00:00Z` or `2026-01-01T02:00:00+02:00`. URL-encode `+` as `%2B`.

`start` defaults to 24 hours before `end` on most history routes, and `end` defaults to now. A time that does not parse returns `400` with `error_code` `invalid_time_range` when you send the version header, or `invalid_query_params` without it. A range that starts before a data type's first served row is served from that row; see [API conventions](/conventions#coverage-signals).

Use `start` and `end` on `/history` and `/diffs` routes. Use `timestamp` only on snapshot routes such as `/orderbook/{symbol}` or `/orderbook/{symbol}/l2`.

## Query: shape, size, and filters

| Parameter | Where it applies and what it does |
| - | - |
| `interval` | Candles, CVD, funding, open interest, prices, liquidation volume, breadth, and order flow. Aggregation bucket, e.g. `1h`. Every one of these routes accepts `1m`; the full list differs by route |
| `depth` | Order-book snapshot and history routes. Levels per side. Native Hyperliquid/HIP-3 L2 routes cap at 20 levels (venue source limit); full-depth Hyperliquid/HIP-3 `/l2` snapshots and history, and HIP-3, HIP-4, and Spot native history, keep the best `depth` levels |
| `limit` | Most list routes. Max rows; the default varies by route, and the ceiling is `page_limit` in [capabilities](/capabilities) |
| `cursor` | Paginated routes. Continuation token from `meta.next_cursor`, present while `meta.has_more` is `true` (see [Pagination](/rest-api/pagination)) |
| `side` | Every trades route, including `/recent`. `buy` or `sell`; filters before paging |
| `status` | Order history on core, HIP-3, and HIP-4 routes. Filter by order status |
| `order_type` | Order history on core, HIP-3, and HIP-4 routes. Filter by order type |
| `triggered` | TP/SL, and order history on core, HIP-3, and HIP-4. Filter by whether a trigger fired |
| `user` | Order history and TP/SL. Filter by wallet address. `user_address` is ignored; use `user` |

A value outside a documented parameter's accepted set returns `400` and names the parameter. The generated contract for every route is in [OpenAPI](/openapi).

## 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 and `limit` to the question, then paginate rather than asking for everything at once.

## Next step

Walk a long window page by page with [Pagination](/rest-api/pagination).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.