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.

Core concepts are the decision layer before route references: venue family, data family, time window, depth, credits, rate limits, gaps, and reconstruction behavior. Core concepts are not a second API surface. They are the rules that keep 0xArchive requests from drifting into the wrong venue, symbol namespace, access tier, or downstream use case.

Concept Map

ConceptDecision it controlsStart with
Venue familyWhether a request belongs to Hyperliquid core, Hyperliquid Spot, HIP-3, HIP-4, or LighterVenue Coverage
Venue taxonomyHow top-level venues and Hyperliquid-scoped families should be namedVenue Taxonomy
Market supportWhether the exact symbol and data family are availableMarkets and Data Quality
Order-book depthWhether the job needs L2, L3, L4, diffs, order events, or historyOrder Book Depth
Historical dataWhether the job needs snapshots, history, replay, exports, or backtesting metadataHistorical Market Data
Replay and reconstructionWhether sequence, local state, or gap handling mattersReplay And Reconstruction
AuthenticationHow REST, WebSocket, SDK, CLI, MCP, and Skill clients pass credentialsAuthentication
Response envelopeWhat to log from success and error responsesErrors
Rate limitsHow fast and how broadly a client can call the APIRate Limits
CreditsHow usage volume and export credits affect workflow designCredits
Data gapsHow to treat missing, stale, or incomplete market windowsData Gaps
Data rightsWhat a downstream product can do with API outputData Rights

The Routing Rule

Choose venue family before endpoint. Hyperliquid and Lighter are the two top-level venue APIs. Hyperliquid core perps, Hyperliquid Spot, HIP-3, and HIP-4 are separate Hyperliquid-scoped market families. Do not route a Spot pair through a core perp route, do not strip a HIP-3 builder prefix, and do not treat HIP-4 probability-like prices as ordinary dollar prices. After the venue family is known, choose the data family: order book, trades, candles, funding, open interest, liquidations, orders, L3, L4, replay, or data quality. Then check whether the exact symbol, time window, and access tier fit the job.

Implementation Sequence

1

Pick the venue family

Use the symbol format and user intent to choose Hyperliquid core, Hyperliquid Spot, HIP-3, HIP-4, or Lighter.
2

Confirm support

Use instrument, coverage, or freshness routes before widening to long windows or many symbols.
3

Choose the interface

Use REST for request/response jobs, WebSocket for streaming or replay, SDKs for application code, CLI for shell jobs, MCP Server for MCP-capable hosts, and Skill for reusable agent workflows.
4

Save trace fields

Store route, parameters, time window, data-quality result, and meta.request_id with every output that another system will trust.

Concept Decision Packet

Before moving from concepts into code, write down the decision packet that controls the request.
FieldWhy it matters
Venue familyPrevents core, Spot, HIP-3, HIP-4, and Lighter from sharing a loose symbol label
Data familyChooses order books, trades, candles, funding, OI, liquidations, L3, L4, replay, or quality checks
Time windowKeeps historical pulls, replays, and exports bounded
Depth and stateDecides whether L2, L3, L4, diffs, local state, or reconstruction is required
Capacity ruleNames rate, concurrency, credits, replay speed, and route gates before broad work starts
Trace fieldsPreserves route, params, quality decision, cursor, and request ID with downstream output

When This Page Is Enough

This page is enough when the question is “where do I start?” or “which concept decides the route?” It is not enough when you are writing code. For code, move from this page into REST API, OpenAPI, WebSocket, or the generated endpoint reference.

Data Availability

Decide whether a venue, symbol, data family, and time window are available.

Venue Taxonomy

Classify top-level venues and Hyperliquid-scoped market families before routing.

Order Book Depth

Separate L2, L3, L4, diffs, order events, history, and reconstruction.

Historical Market Data

Plan windows, routes, quality gates, replay, and export choices.

Replay And Reconstruction

Decide when sequence, local state, and gap handling require stricter workflows.

Rate Limits

Design around request rate, concurrency, credits, and route gates.

Free Tier

Use a starter key to confirm route fit without implying production capacity.

Data Gaps

Treat stale or incomplete windows as explicit data-quality decisions.
Last modified on May 18, 2026