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.

0xArchive lets you start with a key and a real market-data request before you design a larger pipeline.
1

Create an account

Open the dashboard and create an API key.
2

Run the quickstart request

Use Quickstart to call a Hyperliquid BTC order-book route.
3

Check the route family

Use Venue Coverage before moving beyond the first request.
4

Watch limits

Use Rate Limits before a script widens to more symbols or history.

Quickstart

Make the first authenticated request.

REST API

Browse route families and examples.

​
What To Test First

Use a free key to confirm the integration path, not to design an unlimited production job. Start with one current order-book request, confirm the response envelope, and preserve meta.request_id. Then choose whether the real task needs history, streaming, SDKs, CLI, MCP Server, Skill, or OpenAPI code generation.

​
Free-Key Test Packet

Keep the first test small and explicit.
FieldStarter value
Route familyHyperliquid core
Request/v1/hyperliquid/orderbook/BTC
AuthX-API-Key from OXARCHIVE_API_KEY
Response fieldssuccess, data.symbol, data.bids, data.asks, meta.request_id
Next checkVenue Coverage, then Rate Limits and Data Quality
After the starter request works, repeat the same packet for the actual family you need: Spot pair, HIP-3 symbol, HIP-4 outcome side, or Lighter market.

​
Upgrade Signals

You are ready to evaluate a paid plan when the route family is correct and the workflow needs more volume, concurrency, history depth, replay, L3/L4, or production reliability. Use Rate Limits and the pricing page before widening a script across symbols or long windows.

​
Do Not Use The Starter Path For

Do not use a starter key as the design point for long-running production systems, broad historical backfills, high-concurrency crawlers, replay-heavy workflows, L3/L4 reconstruction, or customer-facing exports. Those jobs should start with route coverage, rate and credit limits, data-quality gates, and commercial fit.

​
Supported Jobs

0xArchive is strongest for supported venue market data: Hyperliquid core, Hyperliquid Spot, HIP-3, HIP-4, and Lighter. It is not a replacement for generic RPC infrastructure, onchain wallet indexing, broad CEX catalogs, or execution APIs.

​
Practical Boundary

The free path is for proving fit. Use it to decide whether 0xArchive supports the venue family, symbol format, and data family you need. Once the workflow depends on repeated calls, long history, multiple symbols, replay, L3/L4, or a production SLA, move the conversation to plan limits and commercial fit instead of trying to stretch a starter key into production infrastructure.
Last modified on May 18, 2026