The REST route atlas helps you pick the venue family and data family before opening endpoint-level parameters and schemas. The REST API uses a stable base URL, API-key auth, and reference pages generated from the OpenAPI contract.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.
Order Books
L2, L3, L4, snapshots, history, and depth-specific route selection.
Trades And Liquidations
Trade lists, liquidation events, flow windows, and venue-specific caveats.
Funding, OI, And Candles
Perp context, open-interest series, candle windows, and model inputs.
Orders And L4 Lifecycle
Order events, TP/SL, flow, L4 diffs, L4 history, and reconstruction.
Hyperliquid
Core perp routes for order books, trades, candles, funding, OI, liquidations, orders, and L4.
Hyperliquid Spot
Spot pairs, order books, trades, L4 reconstruction, order history, TWAP, and freshness.
HIP-3
Builder-perp routes under
/v1/hyperliquid/hip3.HIP-4
Outcome-market routes under
/v1/hyperliquid/hip4.Lighter.xyz
Lighter-specific L2/L3, trades, funding, OI, and reconstruction-oriented routes.
Data Quality
Coverage, freshness, incidents, latency, status, and SLA routes.
Playground
Send a request from the docs, then copy the equivalent curl command.
Base Request
Response Envelope
Generated Reference
Use the API Reference tab for endpoint pages with operation names, parameters, response schemas, auth, and examples.REST Request Packet
Before writing code or handing a route to an agent, capture the request packet that determines the correct family.| Field | Example |
|---|---|
| Venue family | Hyperliquid core, Spot, HIP-3, HIP-4, Lighter, or data quality |
| Symbol format | BTC, HYPE-USDC, km:US500, HIP-4 outcome ID, or Lighter symbol |
| Data family | Order books, trades, candles, funding, OI, liquidations, L3, L4, freshness, or coverage |
| Route path | Generated REST path from OpenAPI, including namespace and path parameters |
| Request bound | One symbol, one page, one short UTC window, or one status check before widening |
| Response context | Envelope, cursor, error code, decimal handling, and meta.request_id |
| Quality decision | Coverage, freshness, incidents, latency, or SLA context when downstream work depends on the result |
Route Selection Rules
Choose the route family before choosing the endpoint. Standard Hyperliquid perp symbols such asBTC and ETH use /v1/hyperliquid/*. Spot pair symbols such as HYPE-USDC use /v1/hyperliquid/spot/*. HIP-3 builder markets such as km:US500 use /v1/hyperliquid/hip3/*. HIP-4 outcome markets use /v1/hyperliquid/hip4/* and require probability-price handling. Lighter markets use /v1/lighter/*.
Endpoint reference pages define parameters and schemas. Curated pages explain which namespace to use, what the symbol format means, which data-quality check belongs near the request, and when WebSocket replay or SDK reconstruction is a better primitive than a REST list.