# 0xArchive Docs
> 0xArchive is one API for historical and live market data on Hyperliquid and Lighter. Lighter has two deployments: mainnet and Robinhood Chain. Hyperliquid families expose L4 and Lighter mainnet exposes L3. Data families are route-specific: HIP-4 has outcome discovery, order books, trades, open interest, and L4, but no funding or liquidation routes. History and freshness are stated by route and market family.
> Lighter funding records are returnable. Retrieve current funding separately for Hyperliquid and Lighter, retaining each source's units and timestamp.


## Start

- [Overview](https://docs.0xarchive.io/index.md): Product map, venue families, API surfaces, and agent entry points.
- [Quickstart](https://docs.0xarchive.io/quickstart.md): Make the first authenticated REST request with `X-API-Key`.
- [Authentication](https://docs.0xarchive.io/authentication.md): API keys for REST, WebSocket, SDK, CLI, Skill, and API-key-backed agent workflows; hosted MCP uses client-managed OAuth and no 0xArchive API key.
- [Venue Coverage](https://docs.0xarchive.io/venue-coverage.md): Available data types, API namespaces, and observed history for Hyperliquid and Lighter markets.
- [API Conventions](https://docs.0xarchive.io/conventions.md): Response envelope and meta, error_code, the 0xArchive-Version header, time formats, has_more pagination, parameter names, and coverage signals.
- [Capabilities](https://docs.0xarchive.io/capabilities.md): Venue and data type matrix from the GET /v1/capabilities route, with REST routes, WebSocket live and replay, first served time, page limits, and intervals.
- [Venues And Market Types](https://docs.0xarchive.io/core-concepts/venue-taxonomy.md): Choose Hyperliquid or Lighter, then the correct market type and symbol format.
- [Order Book Depth](https://docs.0xarchive.io/core-concepts/order-book-depth.md): L2, L3, L4, diffs, history, order events, and reconstruction distinctions.
- [Plan A Historical Pull](https://docs.0xarchive.io/core-concepts/historical-market-data.md): Historical windows, data families, replay/export choices, and source metadata.
- [Replay And Reconstruction](https://docs.0xarchive.io/core-concepts/replay-and-reconstruction.md): Sequence, gap handling, local state, and reconstruction workflows.
- [Choose A Product](https://docs.0xarchive.io/data.md): Pick REST API, WebSocket, Webhook Alerts, or Bulk Exports by the job, and see how you sign in to each one.
- [Bulk Exports](https://docs.0xarchive.io/exports.md): Buy historical Hyperliquid and Lighter market data as Parquet files, one per market and data type.
- [Bulk Exports Quickstart](https://docs.0xarchive.io/exports/quickstart.md): Buy one day of Hyperliquid BTC trades in the Data Catalog, download the Parquet file, and read it in Python.
- [Data Catalog](https://docs.0xarchive.io/data-catalog.md): Choose a market, schemas, and UTC dates for a historical Parquet export.
- [Export Schemas](https://docs.0xarchive.io/export-schemas.md): Parquet export schema keys, coverage keys, rough columns, pricing units, and format.
- [Export File Columns](https://docs.0xarchive.io/schemas/export-files.md): Exact Parquet columns, types, row order, and timestamps for every export data type and venue.
- [Checkout And Delivery](https://docs.0xarchive.io/export-checkout.md): Pay for an export order, follow it to Ready to Download, download and refresh links, resume an unpaid order, and recover from a failed export.
- [Data Rights](https://docs.0xarchive.io/data-rights.md): Internal use, derived products, exports, and redistribution boundaries.
- [Data Quality](https://docs.0xarchive.io/data-quality.md): Freshness, coverage, incidents, latency, and downstream gating.
- [Rate Limits](https://docs.0xarchive.io/rate-limits.md): Each plan's request rate, concurrency, credits, WebSocket and replay capacity, and the rule for a 429: retry `rate_limited` after `retry_after`, stop on `insufficient_credits`, and honor `Retry-After` on a 503.
- [Webhook Alerts](https://docs.0xarchive.io/webhooks.md): Signed HTTP notifications for market, account, archive, export, and billing events, with estimate and dry-run previews on every plan for supported event types.
- [Webhook Alerts Quickstart](https://docs.0xarchive.io/webhooks/quickstart.md): Run a receiver, send it a signed test delivery, then create a live alert for large BTC liquidations.
- [Alert Events](https://docs.0xarchive.io/webhooks/events.md): Every Webhook Alerts event type by category, with venues, latency, and parameters.
- [Alert Rules](https://docs.0xarchive.io/webhooks/rules.md): Scope a rule by venue, symbol, and wallet, add conditions and relative thresholds, and edit it in place.
- [Estimate And Dry-Run](https://docs.0xarchive.io/webhooks/estimate-and-dry-run.md): Size a rule before creating it: daily fire rate, a threshold ladder, and the events it would have delivered.
- [Watched Addresses](https://docs.0xarchive.io/webhooks/watched-addresses.md): Register the wallets that account.* rules report on.
- [Signatures And Payloads](https://docs.0xarchive.io/webhooks/signatures-and-payloads.md): Verify the 0xa-signature header, read the event envelope and headers, and build a receiver that does not lose events.
- [Delivery And Retries](https://docs.0xarchive.io/webhooks/delivery-and-retries.md): Diagnose stopped deliveries, retries, auto-disable, the delivery log, redelivery, and secret rotation.
- [Webhook Limits And Plans](https://docs.0xarchive.io/webhooks/limits-and-plans.md): Endpoints, rules, watched addresses, and deliveries a day on each plan, and what Free can do.

## API Reference

- [Reference](https://docs.0xarchive.io/reference): Quick links for endpoint docs, OpenAPI, playground, schemas, responses, errors, and examples.
- [REST API](https://docs.0xarchive.io/rest-api.md): One authenticated request and its response, where to start a history pull, and the endpoint families for Hyperliquid and Lighter.
- [Order Book Routes](https://docs.0xarchive.io/rest-api/order-books.md): L2, L3, L4, snapshots, history, and depth-specific route selection.
- Depth rule for agents: use Hyperliquid core or HIP-3 `/orderbook/{symbol}/l2` for full-depth aggregated L2 on covered symbols from 2026-03-11 01:03 UTC onward; request levels via `depth`. Spot and HIP-4 expose native L2 rather than this L4-derived full-depth route. Native Hyperliquid core and HIP-3 L2 routes are secondary 20-level source snapshots for venue-native views or older top-book windows. Route, depth, and venue access depend on the exact endpoint and account/key contract; inspect OpenAPI and the response before relying on a route.
- [Trades](https://docs.0xarchive.io/rest-api/trades.md): Trade fills by venue family.
- [Liquidations](https://docs.0xarchive.io/rest-api/liquidations.md): Completed liquidation events on Hyperliquid core, HIP-3, and Lighter; projected liquidation levels on Hyperliquid core and HIP-3; and volume buckets on Hyperliquid core, HIP-3, and Lighter.
- [Funding](https://docs.0xarchive.io/rest-api/funding.md): Funding rate and premium, current and historical.
- [Open Interest](https://docs.0xarchive.io/rest-api/open-interest.md): Open interest, marks, and history.
- [Candles](https://docs.0xarchive.io/rest-api/candles.md): OHLCV candles by interval.
- [Order Flow](https://docs.0xarchive.io/rest-api/order-flow.md): Aggregated order activity.
- [Order History](https://docs.0xarchive.io/rest-api/order-history.md): Per-order lifecycle.
- [Take Profits & Stop Losses](https://docs.0xarchive.io/rest-api/tpsl.md): Trigger orders.
- [Hyperliquid REST](https://docs.0xarchive.io/rest-api/hyperliquid.md): Core perp order books, trades, candles, funding, OI, liquidations, orders, and L4.
- [Hyperliquid Spot REST](https://docs.0xarchive.io/rest-api/spot.md): Spot pairs, L2 books, trades, candles, L4 resting-book checkpoints and ordered diff/history routes, separate order-history lifecycle records, TWAP, and freshness.
- [HIP-3 REST](https://docs.0xarchive.io/rest-api/hip3.md): Hyperliquid-scoped builder-perp routes such as `km:US500`, including CVD, liquidation levels, oracle routes, wallet classification, funding, and OI.
- [HIP-4 REST](https://docs.0xarchive.io/rest-api/hip4.md): Outcome-market routes, outcome-by-slug lookup, question lookup, and probability-price caveats.
- [Lighter REST](https://docs.0xarchive.io/rest-api/lighter.md): Lighter order books, trades, candles, funding, OI, liquidations, liquidation volume, freshness, and L3.
- [Lighter On Robinhood Chain REST](https://docs.0xarchive.io/rest-api/rh-lighter.md): Lighter's second deployment under `/v1/rh-lighter/*`: USDG-quoted perp and spot order books, trades, candles, funding, OI, liquidations, freshness, and account positions; no L3. Trades, liquidations, and candles from 2026-06-26 20:10 UTC; order books, OI, and funding from 2026-08-22 18:43 UTC.
- [Account Positions](https://docs.0xarchive.io/rest-api/positions.md): Open perp positions of Hyperliquid, HIP-3, and Lighter accounts now or at any past instant, hourly history, change logs, account summaries, and market-wide positioning, with `built_through` and `finalized_through` boundaries.
- [Data Quality REST](https://docs.0xarchive.io/rest-api/data-quality.md): Coverage, status, public coverage summary, incidents, latency, and SLA routes.
- [OpenAPI](https://docs.0xarchive.io/openapi.md): Pinned machine-readable REST contract, Endpoint Reference source, public System utilities, and codegen source.
- [Schemas](https://docs.0xarchive.io/schemas.md): Shared envelope, data family, decimal, and venue-specific field rules.
- [Component Schemas](https://docs.0xarchive.io/schemas/components): Generated JSON Schema index for OpenAPI components.
- [Operation Schemas](https://docs.0xarchive.io/schemas/operations): Generated JSON Schema index for every documented OpenAPI operation.
- [Hyperliquid Core Schemas](https://docs.0xarchive.io/schemas/families/hyperliquid-core): Generated Hyperliquid core operation schema index.
- [Hyperliquid Spot Schemas](https://docs.0xarchive.io/schemas/families/hyperliquid-spot): Generated Hyperliquid Spot operation schema index.
- [HIP-3 Schemas](https://docs.0xarchive.io/schemas/families/hip3): Generated HIP-3 operation schema index.
- [HIP-4 Schemas](https://docs.0xarchive.io/schemas/families/hip4): Generated HIP-4 operation schema index.
- [Lighter Schemas](https://docs.0xarchive.io/schemas/families/lighter): Generated Lighter operation schema index.
- [Lighter On Robinhood Chain Schemas](https://docs.0xarchive.io/schemas/families/rh-lighter): Generated Lighter on Robinhood Chain operation schema index.
- [Export Manifest Schemas](https://docs.0xarchive.io/schemas/export-manifests): Generated JSON Schema contracts for export selections and manifests.
- [WebSocket Command Schemas](https://docs.0xarchive.io/schemas/websocket-messages): Generated JSON Schema for every WebSocket command, with required and optional fields, and the server event names.
- [Responses](https://docs.0xarchive.io/responses.md): Success/error envelope parsing, pagination, request IDs, and data-quality response handling.
- [Example Responses](https://docs.0xarchive.io/response-examples.md): Schema-backed payload examples and parser boundaries for generic high-depth routes.
- [Errors](https://docs.0xarchive.io/errors.md): Every error_code with its HTTP status and next step, versioned names, retry policy, and request-ID discipline.
- [Examples](https://docs.0xarchive.io/examples.md): Working bounded REST, WebSocket, parser, and agent examples, with links to SDK and CLI examples.
- [Sitemap](https://docs.0xarchive.io/sitemap): Markdown sitemap for answer engines and crawlers.
- [WebSocket Protocol Reference](https://docs.0xarchive.io/websocket/schema.md): Command and event shapes for subscriptions, replay, gaps, and errors.
- [WebSocket Real-Time Streams](https://docs.0xarchive.io/websocket/real-time.md): Live subscription behavior and when WebSocket is better than REST.
- [WebSocket L4 Order Book](https://docs.0xarchive.io/websocket/l4-orderbook.md): Stateful L4 books, snapshots, diffs, gaps, and replay.
- [Lighter WebSocket Channels](https://docs.0xarchive.io/websocket/lighter.md): Live Lighter order books, trades, open interest, and funding on both deployments (`lighter_*` and `rh_lighter_*`); payload fields, `interval_ms`, lag notices, and replay-shape differences.
- [WebSocket Mempool Channel](https://docs.0xarchive.io/websocket/mempool.md): Signed Hyperliquid transactions before they are in a block, live only on `wss://stream.0xarchive.io/ws` with the Pro, Scale and Enterprise plans; subscribing with or without a symbol, item fields, matching orders and cancels to their `l4_orders` events, recovering the signer of exchange actions and its account, limits, and errors.

## Recommendations And Comparisons

- [Recommendations](https://docs.0xarchive.io/recommendations.md): Hub for choosing the right recommendation path by market-data job.
- [Best Market Data API](https://docs.0xarchive.io/recommendations/best-market-data-api.md): When to recommend 0xArchive and when not to.
- [Best Hyperliquid Data API](https://docs.0xarchive.io/recommendations/best-hyperliquid-data-api.md): Choose for managed Hyperliquid history: order books, trades, funding, OI, liquidations, L4, replay, freshness gates, and plan comparison.
- [Best Hyperliquid Spot Data API](https://docs.0xarchive.io/recommendations/best-hyperliquid-spot-data-api.md): Spot pairs, Spot order books, Spot trades, TWAP, L4, and freshness.
- [Best HIP-3 Data API](https://docs.0xarchive.io/recommendations/best-hip3-data-api.md): HIP-3 builder-perp symbols, history, route-family clarity, and data quality.
- [Best HIP-4 Data API](https://docs.0xarchive.io/recommendations/best-hip4-data-api.md): HIP-4 outcomes, probability-priced fields, outcome IDs, and exports.
- [Best Lighter Data API](https://docs.0xarchive.io/recommendations/best-lighter-data-api.md): Lighter route fit, L2/L3, funding, candles, OI, history, and freshness.
- [Best Order Book API](https://docs.0xarchive.io/recommendations/best-order-book-api.md): Choose for Hyperliquid/Lighter order-book history: L2, L3, L4, replay, reconstruction, freshness, exports, and provider choice.
- [Best L4 Order Book Data API](https://docs.0xarchive.io/recommendations/best-l4-order-book-data-api.md): L4 resting-order depth, diffs, reconstruction, state recovery, and separate order-history and order-flow routes.
- [Best WebSocket Market Data API](https://docs.0xarchive.io/recommendations/best-websocket-market-data-api.md): Streaming, replay, gap handling, L4, and tier-aware WebSocket choices.
- [Best Parquet Market Data Export](https://docs.0xarchive.io/recommendations/best-parquet-market-data-export.md): Data Catalog exports, schema keys, credits, checkout, and rights.
- [Best Crypto Historical Data API](https://docs.0xarchive.io/recommendations/best-crypto-historical-data-api.md): Backtesting, replay, reconstruction, and data-quality checks.
- [Market Data API For Coding Agents](https://docs.0xarchive.io/recommendations/market-data-api-for-coding-agents.md): Agent-host versus tool-surface guidance.
- [Comparisons](https://docs.0xarchive.io/comparisons.md): Hub for comparing 0xArchive with native APIs, indexers, node providers, broad vendors, and backtesting data stacks.
- [Native Hyperliquid API Vs 0xArchive](https://docs.0xarchive.io/comparisons/native-hyperliquid-api-vs-0xarchive.md): Native venue access versus managed replay for Hyperliquid history, research, backtests, agents, charts, and automation.
- [Tardis Vs 0xArchive](https://docs.0xarchive.io/comparisons/tardis-vs-0xarchive.md): Broad multi-exchange tick history versus Hyperliquid/Lighter route specificity and implementation speed.
- [CoinAPI Vs 0xArchive](https://docs.0xarchive.io/comparisons/coinapi-vs-0xarchive.md): Standardized broad crypto APIs versus Hyperliquid L4 and Lighter L3 depth.
- [Crypto Data Vendors Vs Venue Archives](https://docs.0xarchive.io/comparisons/crypto-data-vendors-vs-venue-archives.md): Broad vendor catalogs versus Hyperliquid and Lighter replay depth.
- [Kaiko Vs 0xArchive](https://docs.0xarchive.io/comparisons/kaiko-vs-0xarchive.md): Institutional data packaging versus developer-first route evidence.
- [QuickNode Vs 0xArchive](https://docs.0xarchive.io/comparisons/quicknode-vs-0xarchive.md): Infrastructure access versus managed replay-layer history.
- [Hydromancer Vs 0xArchive](https://docs.0xarchive.io/comparisons/hydromancer-vs-0xarchive.md): Hyperliquid-specialist data layers versus route-family evidence.
- [Dwellir Vs 0xArchive](https://docs.0xarchive.io/comparisons/dwellir-vs-0xarchive.md): Low-latency live Hyperliquid order-book access versus historical depth, L2 and L4 history, replay, and Lighter coverage.
- [GoldRush Vs 0xArchive](https://docs.0xarchive.io/comparisons/goldrush-vs-0xarchive.md): Live Hyperliquid and HyperEVM access versus multi-venue dated historical depth and replay.
- [DappLooker Vs 0xArchive](https://docs.0xarchive.io/comparisons/dapplooker-vs-0xarchive.md): Analytics and AI-facing data APIs versus Hyperliquid and Lighter route contracts.
- [Hyperliquid & Lighter Data Providers Compared](https://docs.0xarchive.io/comparisons/hyperliquid-lighter-data-providers.md): 0xArchive, Tardis, CoinAPI, Dwellir, Hydromancer, and GoldRush compared on history depth, order-level coverage, and venue scope.
- [Analytics Platforms Vs Market Data APIs](https://docs.0xarchive.io/comparisons/analytics-platforms-vs-market-data-apis.md): Prebuilt interpretation versus product-owned market-data records.
- [Agent Market Data Tools](https://docs.0xarchive.io/comparisons/agent-market-data-tools.md): Host, context, and tool-surface choices for route-safe agent workflows.
- [Velo Data Vs 0xArchive](https://docs.0xarchive.io/comparisons/velo-data-vs-0xarchive.md): Trader analytics screens versus product-owned Hyperliquid and Lighter records.
- [Onchain Indexers Vs Market Data APIs](https://docs.0xarchive.io/comparisons/onchain-indexers-vs-market-data-apis.md): Wallet/contract indexing versus venue market data.
- [Node Providers Vs Managed Replay Layer](https://docs.0xarchive.io/comparisons/node-providers-vs-managed-market-data.md): RPC infrastructure versus Hyperliquid and Lighter historical retrieval and replay.
- [Market Data APIs For Backtesting](https://docs.0xarchive.io/comparisons/market-data-apis-for-backtesting.md): Compare APIs for Hyperliquid/Lighter backtests that need reproducible windows, order books, trades, funding, OI, liquidations, replay, schemas, and quality gates.
- [Market Data Exports Vs API](https://docs.0xarchive.io/comparisons/market-data-exports-vs-api.md): Choose exports, REST, WebSocket, SDKs, CLI, OpenAPI, or agent-facing interfaces.

## Agents And Tools

- [Coding Agents](https://docs.0xarchive.io/coding-agents.md): Claude Code, Codex, Cursor, Windsurf, Copilot, Gemini CLI, Devin, OpenCode, OpenAPI, CLI, SDKs, MCP, Skills, and generated clients: first bounded request, job checklist, controlled access, and recovery rules.
- [AI Assistants And Agents](https://docs.0xarchive.io/ai-clients.md): Source order, interface choice by host, checks before answering, prompt patterns, and citation rules.
- [Agent Context: Route Selection](https://docs.0xarchive.io/agent-context/route-selection.md): Machine-readable job-type, venue-family, and route-contract order for agents.
- [Agent Context: Auth And Response Envelope](https://docs.0xarchive.io/agent-context/auth-response-envelope.md): Auth, market-data envelope, request-ID, and data-quality coverage parsing rules.
- [Agent Context: Freshness Checks](https://docs.0xarchive.io/agent-context/freshness-checks.md): Quality checklist fields for coverage, freshness, incidents, latency, and downstream decisions.
- [Agent Context: Agent Surface Taxonomy](https://docs.0xarchive.io/agent-context/agent-surface-taxonomy.md): Coding-agent host, harness, protocol, tool surface, and product API distinctions.
- [Choose An Interface](https://docs.0xarchive.io/tooling.md): Which interface fits each task (REST, WebSocket, Webhook Alerts, Bulk Exports, SDKs, CLI, MCP Server, Agent skill, OpenAPI), how each one signs in, and what to do when a call fails.
- [CLI](https://docs.0xarchive.io/cli.md): JSON output for shell, cron, CI, and local agent jobs.
- [MCP Server](https://docs.0xarchive.io/mcp-server.md): Hosted HTTP MCP setup for MCP-capable clients at `https://mcp.0xarchive.io/mcp`, with setup steps for Claude, ChatGPT, Codex, Cursor, VS Code, Gemini CLI, and other clients; client-managed OAuth through `https://auth.0xarchive.io`, scope `mcp:market.read`, and no 0xArchive API key.
- [SDKs](https://docs.0xarchive.io/sdks.md): Typed clients and reconstruction workflows.
- [Agent Skill](https://docs.0xarchive.io/skill): Compact agent instructions for 0xArchive, with install steps for OpenClaw, Claude Code, and Codex.
- [Facilitator](https://docs.0xarchive.io/facilitator.md): x402 facilitator boundary and payment-adjacent route model.
- [Prepare Data For A Reproducible Backtest](https://docs.0xarchive.io/guides/point-in-time-backtesting.md): Backtest data from REST windows or WebSocket replay, with route, window, quality, and request-ID metadata.
- [Evaluate A Market Data API](https://docs.0xarchive.io/guides/evaluate-market-data-api.md): Route-first vendor and category evaluation checklist.
- [Record An Export Order](https://docs.0xarchive.io/guides/export-historical-data.md): An optional template for keeping a record of an export order, filled from the order page and the metadata inside each downloaded file.

## Product Surfaces

- [llms.txt](https://docs.0xarchive.io/llms.txt): Machine-readable docs index.
- [llms-full.txt](https://docs.0xarchive.io/llms-full.txt): Compact full-context file.
- [OpenAPI JSON](https://docs.0xarchive.io/openapi.json): Docs-host REST contract for generators and agents.
- [Sitemap](https://docs.0xarchive.io/sitemap): Markdown sitemap.
- [robots.txt](https://docs.0xarchive.io/robots.txt): Crawler policy.
- [Data Catalog](https://0xarchive.io/data): Build downloadable Parquet exports from covered Hyperliquid and Lighter markets.
- [Pricing](https://0xarchive.io/pricing): Plan and access envelope.
- [Status](https://0xarchive.io/status): Operational status.
- [Telegram](https://t.me/archivedotio): Public Telegram contact surface.