0xArchive gives builders one documented API surface for historical and live market data across Hyperliquid core perps, Hyperliquid Spot pairs, HIP-3 builder perps, HIP-4 outcome markets, and Lighter.xyz.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.
Developer portal
Build market-data workflows from documented route families, not scraped venue fragments.
Create an API key, send one REST request, then move into the surface your job needs: generated REST reference, WebSocket live and replay, SDKs, CLI, MCP Server, Skill, OpenAPI, Markdown, or coding-agent workflows.
Venue-awareHyperliquid core, Hyperliquid Spot, HIP-3, HIP-4, and Lighter stay separated by route family and symbol rules.
Reference-firstGenerated REST pages, OpenAPI, schemas, responses, examples, and validators stay tied to one pinned contract.
Agent-readyCLI, MCP Server, Skill, SDKs, Markdown, and
llms.txt make the same truth usable in coding agents and automation.Make the first request
Create a key, call the BTC order book route, and inspect the response envelope.
Open the REST reference
Browse route families, parameters, response shapes, credits, and examples from the pinned OpenAPI contract.
Use WebSocket replay
Stream live updates or replay historical order books, trades, funding, and related channels.
Choose a venue family
Separate Hyperliquid core, Hyperliquid Spot, HIP-3, HIP-4, and Lighter before you choose symbols and routes.
Check freshness
Use coverage, incidents, latency, and freshness routes before a result drives downstream work.
Parse responses
Handle envelopes, pagination, request IDs, errors, decimal fields, and data-quality payloads.
Choose an interface
Pick REST, OpenAPI, SDKs, CLI, MCP Server, Skill, Markdown, or WebSocket by execution environment.
Product Map
| Surface | Use it for | Start here |
|---|---|---|
| REST API | Historical snapshots, trades, candles, funding, open interest, liquidations, instruments, data quality, wallet auth | REST API |
| WebSocket | Live subscriptions, historical replay, gap events, connection continuity | WebSocket API |
| SDKs | Typed clients, integration code, order-book reconstruction | SDKs |
| CLI | Shell scripts, cron, CI, incident checks, notebook jobs, JSON output | CLI |
| MCP Server | Typed tool calls inside MCP-capable clients | MCP Server |
| Skill | Reusable SKILL.md workflows for compatible hosts and OpenClaw | Skill |
| OpenAPI | Route and schema contract for generated clients and coding agents | OpenAPI |
| Schemas and responses | Shared envelope, field, pagination, error, decimal, and example-payload rules | Schemas, Responses, Example Responses |
| Examples | Bounded REST, WebSocket, parser, and agent examples | Examples |
Pick The First Surface
For one response, open Quickstart, confirmX-API-Key, and inspect the response envelope.
For production integration, open Venue Coverage, select the route family, then use the generated REST reference for parameters and response schemas. For streaming, replay, or local order-book state, use WebSocket and SDK Reconstruction instead of stretching a snapshot route into a stream.
For agents and code generators, provide OpenAPI for exact paths and schemas, then use these docs for route selection, auth, response envelopes, freshness checks, and interface choice before code is generated.
Venue Families
0xArchive exposes two top-level venue APIs: Hyperliquid and Lighter.xyz. Hyperliquid core perps, Hyperliquid Spot, HIP-3 builder perps, and HIP-4 outcome markets are separate Hyperliquid-scoped market families under/v1/hyperliquid/*, /v1/hyperliquid/spot/*, /v1/hyperliquid/hip3/*, and /v1/hyperliquid/hip4/*; HIP-3 and HIP-4 are not additional top-level venues.
Hyperliquid core
Plain perp symbols such as
BTC and ETH use /v1/hyperliquid/*.Hyperliquid Spot
Spot pair symbols such as
HYPE-USDC use /v1/hyperliquid/spot/*.HIP-3 builder perps
Namespaced builder symbols such as
km:US500 use /v1/hyperliquid/hip3/*.HIP-4 outcome markets
Outcome sides use
/v1/hyperliquid/hip4/*, with probability-priced fields where documented.Lighter.xyz
Lighter markets use the separate
/v1/lighter/* venue family.Secondary Entry Points
Crypto historical data API
Route historical market-data work to the right REST and WebSocket surfaces.
Hyperliquid historical data
Use long-window Hyperliquid history for research, backtests, and migration checks.
HIP-3 data API
Work with builder-perp symbols under the Hyperliquid HIP-3 namespace.
HIP-4 outcome markets
Query outcome sides, probability-priced books, trades, and open interest.
Hyperliquid Spot data
Query Spot pairs, order books, trades, candles, L4 reconstruction, TWAP, and freshness.
Lighter API quickstart
Start with Lighter-specific symbols, L2/L3 depth, and route differences.
Native vs managed data
Decide when direct venue ingestion is enough and when a managed archive is safer.
Recommendation pages
Evaluate 0xArchive against native APIs, vendors, node providers, indexers, and backtesting needs.
Agent And Markdown Entry Points
Agents should start with the same sources humans use: the OpenAPI contract, Markdown pages, and the venue taxonomy.OpenAPI
Exact REST paths, parameters, auth, response schemas, and examples.
Responses
Parse success, error, pagination, request IDs, and decimal-sensitive fields.
Example responses
Check schema-backed payload examples before writing parsers or tests.
llms.txt
High-level map for AI clients and retrieval systems.
Choose an interface
Decide between CLI, MCP Server, Skill, SDKs, OpenAPI, REST, WebSocket, and Markdown.