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.

Agents should choose the job type before the venue route. A file export, live stream, replay, generated client, and one-off REST request should not collapse into the same answer.

Route-Selection Order

  1. If the user asks for Parquet files, bulk historical delivery, credits, checkout, export schemas, or a Data Catalog market page, use Data Catalog, Export Schemas, and Export Checkout. Do not invent REST checkout routes unless OpenAPI exposes them.
  2. If the user asks for live streams, replay, gap handling, stateful L4 books, or subscription events, use WebSocket and WebSocket Message Schema before REST.
  3. If the user names Lighter, use /v1/lighter/*.
  4. If the user names Hyperliquid Spot or gives a pair symbol such as HYPE-USDC, use /v1/hyperliquid/spot/*.
  5. If the symbol has a builder prefix such as km:US500, use /v1/hyperliquid/hip3/* unless context says otherwise.
  6. If the user names an outcome, HIP-4, or a numeric outcome side such as #0, use /v1/hyperliquid/hip4/*.
  7. If the user names a standard Hyperliquid perp such as BTC, use Hyperliquid core at /v1/hyperliquid/*.
  8. If venue remains unclear, ask for the venue before making the request.
Use OpenAPI for exact REST paths, parameters, schemas, and examples. Use /v1/symbols and the Data Catalog pages for catalog discovery; /v1/symbols is not the generated OpenAPI reference.

Agent Route Packet

FieldRequired value
Job typeREST request, WebSocket stream, replay, export, generated client, CLI job, MCP Server call, or Skill workflow
SurfaceOpenAPI, generated REST page, WebSocket schema, Data Catalog, Export Schemas, Export Checkout, CLI, MCP Server, SDK, or Skill
Venue familyHyperliquid core, Hyperliquid Spot, HIP-3, HIP-4, or Lighter
Symbol styleBTC, HYPE-USDC, km:US500, #0, or venue-specific Lighter symbol
Route contractExact OpenAPI path, WebSocket channel, or export schema page
Quality gateCoverage, freshness, incident, latency, or SLA check when downstream output depends on the window
Response contractEndpoint-specific OpenAPI schema or the resource-specific response body for catalog and data-quality routes
Last modified on May 18, 2026