Skip to main content
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 Endpoint Reference pages backed by the OpenAPI contract. Every authenticated market-data request starts with https://api.0xarchive.io, includes X-API-Key, and returns either a success/data/meta envelope or a JSON error with a request handle. GET /health is unauthenticated liveness and should not be used as an API-key check. The data map lives in Data, and coverage lives in Market data: one page per data type, each with a venue switch and REST, WebSocket, and export access. This tab is the REST mechanics that apply across all of them.

Parameters

Path symbols, time windows, intervals, depth, limits, and filters.

Pagination

Cursor pagination, meta.next_cursor, and resumable backfills.

Response envelope

The { success, data, meta } shape and the field dictionary.

Data conventions

Decimal strings vs numbers, UTC timestamps, and the coin alias.

Errors & retries

Status codes, Retry-After, and request IDs for safe retries.

Reliability

Retries, request-ID logging, concurrency, and data-quality gating.

Rate limits

Per-tier request limits and credits, and how to stay inside them.

OpenAPI

The generated contract: every operation, parameter, and schema.

Browse the data

What we cover by venue, with a page per data type.

Base Request

curl "https://api.0xarchive.io/v1/hyperliquid/orderbook/BTC" \
  -H "X-API-Key: $OXARCHIVE_API_KEY"

Response Envelope

Most market-data endpoints return a JSON envelope with success, data, and meta. meta can include count, next_cursor, and request_id when relevant. Some auth, system, wallet, and data-quality endpoints return resource-specific bodies; check the REST reference and response headers for the exact response body. Log meta.request_id when it is present, and store route-specific status fields plus x-request-id when a response does not use the standard envelope.

Endpoint Reference

Use the Reference tab for endpoint pages with operation names, parameters, response schemas, auth, and examples, or open the OpenAPI contract directly.

REST Request Checklist

Before writing code or handing a route to an agent, capture the request checklist that determines the correct family.
FieldExample
Venue familyHyperliquid core, Spot, HIP-3, HIP-4, Lighter, or data quality
Symbol formatBTC, HYPE-USDC, km:US500, HIP-4 outcome ID, or Lighter symbol
Data familyOrder books, trades, candles, funding, OI, liquidations, L3, L4, freshness, or coverage
Route pathGenerated REST path from OpenAPI, including namespace and path parameters
Request boundOne symbol, one page, one short UTC window, or one status check before widening
Response contextEnvelope, cursor, error code, decimal handling, and meta.request_id
Quality decisionCoverage, 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 as BTC 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.

Why 0xArchive Fits

0xArchive keeps route families, auth, examples, and response envelopes together so builders can move from first request to backtests, freshness checks, CLI jobs, MCP Server calls, or generated clients without relearning each venue surface.

Next Step

Open OpenAPI for the contract source, Venue coverage for route-family selection, or Choose an interface when the same request should run through CLI, MCP Server, Skill, SDKs, or a coding agent.
Last modified on June 29, 2026