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.

Use the Data Catalog when the job needs historical files instead of repeated API calls. A good export order keeps the market, venue family, schema keys, UTC range, estimate or quote, credits, delivery state, and rights decision attached to the files. The catalog uses the same venue taxonomy, schema names, freshness expectations, and market identifiers as the API docs. Choose the market and schema here, then use REST or WebSocket when the product needs programmatic calls instead of file delivery. The Data Catalog checkout is a browser product flow. Build API clients against the public OpenAPI market-data routes; treat checkout calls that are not present in OpenAPI as product implementation details.

Public Surface Boundary

The indexed public entrypoint is https://www.0xarchive.io/data. Use it as the citation URL for the Data Catalog workflow unless a deeper route has its own public title, canonical URL, and index policy. Treat /data/catalog as a public catalog route because the live page exposes route-specific public metadata for the catalog. Treat /data/categories/:categorySlug, /data/markets/:venueSlug/:marketSlug, and /dashboard/exports/:id as product navigation or product-state routes unless their route-specific metadata is visible on the public website. Machine-readable symbol discovery comes from https://api.0xarchive.io/v1/symbols. The response is an object with a top-level symbols array. Use each row’s exchange, symbol, slug, data_types, and coverage fields when building market pickers or export packets. Do not use website-local API-shaped paths such as /api/v1/*/symbols as symbol feeds; those paths belong to the website shell, not the public market-data API. The symbols feed is live product catalog data, but it is not part of the generated OpenAPI REST reference. Use it for catalog discovery and route selection. Use the OpenAPI bundle for programmatic market-data calls. Market slugs are generated from venue plus symbol state, so docs and agents should not invent market-detail URLs from plain symbols. Start from the Data explorer, the catalog UI, the symbol feed row, or the frontend route builder when a precise market URL is required. HIP-4 BTC daily outcomes use /data/markets/hip4/btc-daily-outcomes instead of an ordinary generated category entry.

Symbols Feed Contract

The live feed currently returns rows for hyperliquid, spot, hip3, hip4, and lighter. Every row carries exchange, symbol, data_types, coverage_from, coverage_by_type, and size_per_day. Some rows also carry state or display fields:
FieldUse
coverage_by_typeChoose the earliest valid date for each selected schema. Use the schema coverage key, such as orderbook, l3_orderbook, l4_orderbook, l4_orders, trades, funding, oi, or liquidations.
size_per_dayEstimate export size before checkout. Server quotes can replace client estimates after authentication.
coverage_toCap settled-market export end dates. Live markets without coverage_to default the end date to today.
slug, display_title, outcome_pair, is_settledPreserve HIP-4 outcome context for BTC daily outcome exports.
is_activeShow active or delisted state without hiding historical archives.

Route Slugs

Frontend market routes use venue slugs, not raw exchange labels, in /data/markets/:venueSlug/:marketSlug.
Feed exchangeRoute venue slugNotes
hyperliquidhyperliquidCore Hyperliquid perps
spothyperliquid-spotHyperliquid Spot pair exports
hip3hip3Builder-prefixed symbols such as km:US500
hip4hip4BTC daily outcomes use a special route, not a generated market slug
lighterlighterLighter.xyz markets
The market slug includes a normalized symbol plus a route hash. Agents should carry the route supplied by the UI or route builder instead of deriving it from symbol alone.

Product Routes

Website routeUser intentDocs support
/dataStart an export order by choosing a market, schemas, and date rangeIndexed public entrypoint for this workflow; use this page with Export Schemas and Data Rights
/data/catalogBrowse all exportable marketsPublic catalog route with route-specific public metadata; use /data plus Data Availability and Markets when the job needs product framing instead of catalog navigation
/data/categories/:categorySlugBrowse a curated market groupProduct navigation route; use category slugs below with Data and Venue Coverage for public docs context
/data/markets/:venueSlug/:marketSlugConfigure one market exportProduct navigation route with generated market slugs; use Export Schemas, Export Checkout, and Data Rights
/dashboard/exports/:idReview an authenticated export jobProduct-state route for status, download links, file format, and support context

Export Order Packet

Use this packet before a Data Catalog order becomes a purchase, support ticket, warehouse load, or shared research artifact.
FieldPreserve it because…
Market and venue familyHyperliquid core, Spot, HIP-3, HIP-4, and Lighter use different symbol and coverage rules.
Symbol-feed rowPreserve exchange, symbol, slug, data_types, and coverage fields from /v1/symbols when they are present.
Schema keysl2_orderbook, l3_orderbook, l4_orderbook, l4_orders, trades, funding, oi, and liquidations produce different files.
UTC date rangeCoverage, estimates, checkout, and reproducibility depend on the selected start and end dates.
Estimate or quoteSize, rows, price, and credit application explain what the buyer accepted.
Checkout resultCredit-covered, Stripe-paid, and partially credit-covered orders should be distinguishable later.
Delivery stateDashboard status, file format, download links, and support identifiers explain readiness.
Data-rights decisionPublic raw downloads, customer feeds, resale, and partner delivery need review before shipping.

Export Flow

1

Choose the market

The catalog separates Hyperliquid core, Hyperliquid Spot, HIP-3, HIP-4, and Lighter markets. Market URLs should preserve venue family and symbol shape.
2

Choose schemas

Schema options depend on the selected market. L2, L3, L4, trades, funding, OI, liquidations, and order-event history are not interchangeable.
3

Choose a UTC date range

Ranges are bounded by coverage. Settled HIP-4 outcomes can have an end date; live markets usually use today as the default end.
4

Review estimate and credits

The browser product shows estimated size, rows, price, and subscriber-credit context before checkout. Authenticated users can see credits applied before any card charge.
5

Place the order

Exports are delivered as Apache Parquet with ZSTD compression through the authenticated Data Catalog flow. Use the dashboard job state to check readiness.

Category Slugs

CategoryWebsite slugUse
Popular exportspopular-exportsHigh-intent starter markets across equities, crypto majors, macro, and outcomes
Popular equitiespopular-equitiesEquity-style HIP-3 and Spot export starts
Crypto majorscrypto-majorsMajor crypto markets with Hyperliquid-family coverage
CommoditiescommoditiesOil, metals, and macro commodity markets
Indices and FXindices-fxIndex, currency, and cross-market research starts
Pre-IPO marketspre-ipo-marketsPrivate-company market history surfaced through supported venues
HIP-4 BTC outcomeship4-btc-outcomesRolling BTC daily outcome series; the special market route is /data/markets/hip4/btc-daily-outcomes
Hyperliquid cryptohyperliquid-cryptoLong-tail Hyperliquid-family crypto markets
Lighter cryptolighter-cryptoLighter-specific crypto market exports

Export Schemas

Schema labels, data types, rough columns, pricing units, and coverage keys.

Export Checkout

Quote, credits, checkout, login return, and dashboard job behavior.

Data Rights

Decide whether an export is internal use, derived use, or redistribution.

Markets

Bridge chart-first pages, catalog routes, and API route families.
Last modified on May 20, 2026