Skip to main content

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.

The data section maps public product surfaces to the route, chart, export, schema, and rights pages behind them. 0xArchive data is organized by venue family, data family, freshness state, delivery surface, and use rights. The live product surface for visual browsing and file exports is 0xArchive Data. The docs surface explains how that data maps to API routes, export schemas, response schemas, examples, and downstream boundaries.

Data Families

Data familyCommon routesUse it for
Instruments and pairs/instruments, /spot/pairs, HIP-4 outcomesMarket discovery and symbol validation
Order books/orderbook/{symbol}, history, L3, L4Snapshots, depth, reconstruction, liquidity views
Trades/trades/{symbol} and recent trade routesFill history, tape review, backtests, chart inputs
Candles/candles/{symbol}OHLC-style historical analysis
Funding and OI/funding/{symbol}, /openinterest/{symbol}Perp funding, exposure, and derivatives research
Liquidations and ordersLiquidation, order history, flow, TPSL routesRisk, flow, and order-level analysis where available
TWAP and Spot-specific data/v1/hyperliquid/spot/twap/{symbol}Hyperliquid Spot execution-history analysis
Data quality/v1/data-quality/*Coverage, freshness, incidents, latency, and SLA checks
File exportsData Catalog schemasParquet/ZSTD historical datasets, warehouse loads, and offline research

Venue Scope

0xArchive exposes two top-level venue APIs: Hyperliquid and Lighter.xyz. Hyperliquid core, Hyperliquid Spot, HIP-3, and HIP-4 are separate Hyperliquid-scoped market families. Lighter routes live under /v1/lighter/*. Do not flatten those families in a data model. Store venue family, symbol, route, time window, and request ID with the records. A BTC perp record, a HYPE-USDC Spot pair, a km:US500 HIP-3 symbol, a HIP-4 outcome side, and a Lighter symbol should stay distinguishable in storage, examples, and generated code.

Data Routing Packet

Use this packet when the request starts from broad data intent instead of a concrete endpoint.
DecisionPublic path
Visual market inspectionStart with Markets and the live Data explorer.
Programmatic market-data callsChoose REST API, WebSocket, SDKs, CLI, MCP Server, or Skill based on the execution environment.
Route and schema reviewUse OpenAPI, Schemas, Responses, and Example Responses.
Historical filesUse Data Catalog, Export Schemas, and Export Checkout.
Downstream publishing or resaleReview Data Rights before exposing raw records outside the organization.
Reliability-sensitive outputAttach Data Quality, coverage, freshness, incident, and request-ID context to the job.

Data Workflow

1

Choose venue family

Use Venue Coverage before choosing a REST path or WebSocket channel.
2

Confirm data availability

Check instruments, pairs, outcomes, coverage, or freshness before running wide historical jobs.
3

Inspect schema and response shape

Use Schemas, Responses, and Export Schemas before parsing fields into typed code or warehouse tables.
4

Run a bounded example

Use Examples with one symbol and one small window before widening.
5

Check rights before redistribution

Use Data Rights before public exports, resale, customer-facing delivery, or partner feeds.

Product Surface Versus API Surface

The live Data explorer is for visual browsing and market inspection. The REST API, WebSocket API, SDKs, CLI, MCP Server, Skill, and OpenAPI are for programmatic use. They should agree on venue family, freshness, and field meaning, but they serve different jobs. If a user asks for a chart page, start with Markets. If they ask for code, start with REST API, WebSocket, OpenAPI, or Examples. If they ask for raw file delivery, start with Data Catalog, Export Schemas, Export Checkout, and Data Rights.

Next Step

Open Data Catalog for export product routes, Schemas for JSON field and envelope rules, Export Schemas for Parquet datasets, Responses for payload parsing, and Examples for copyable request patterns.
Last modified on May 20, 2026