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.

Historical file exports are for workflows where a bounded dataset is easier to govern, load, review, or procure than repeated API responses. The Data Catalog export flow is a product surface for file-style delivery. It is related to REST and WebSocket docs, but it is not the same contract as the public market-data API.

Export Workflow

1

Choose a market

Start from /data, /data/catalog, a category page, or a market page. Market slugs are generated, so preserve the venue family and market slug supplied by the UI instead of constructing one from a plain symbol.
2

Choose schemas

Select only the data families needed: L2, L3, L4, trades, funding, OI, liquidations, or order events.
3

Choose UTC dates

Keep the requested date range explicit. The browser presets are 30D, 90D, 1Y, All, and Custom; coverage and settled-market end dates can constrain the window.
4

Review the estimate

Check estimated size, rows, credits, pricing unit, minimums, and any subscriber-credit context.
5

Place the order

Use the authenticated Data Catalog checkout flow. Build API clients against documented OpenAPI routes; do not depend on browser checkout calls unless they are published as public API routes.
6

Store metadata with files

Keep venue family, market, schema key, UTC range, quote context, and data-rights decision with the output.

When To Export Instead Of Call The API

Use exports for warehouse loading, offline research, large historical windows, durable datasets, or workflows where Parquet files are easier to govern than many API calls. Use REST for app-integrated bounded requests. Use WebSocket replay when event order is part of the product requirement.

Validation Step

Before widening an order, run the smallest useful export: one market, one schema, and a short UTC window. Confirm the file schema, row timestamps, market identity, size estimate, and downstream loader behavior. Then scale the date range or schema set with the same metadata attached.

Shareable Selection Parameters

Catalog URLs can preserve a configured selection, but those parameters describe browser state, not a public REST contract.
ParameterMeaning
selectedLegacy selection key in exchange:symbol form when a market route is not already selected.
schemasComma-separated export schema keys, for example l2_orderbook, trades, and oi.
rangeOne of 30d, 90d, 1y, all, or custom.
start and endRequired only for range=custom; dates are clamped to coverage.
hip4_event, hip4_contracts, hip4_sideHIP-4 BTC daily outcome selection state.
When a market route such as /data/markets/hyperliquid/btc-uc0r/ is available, prefer that route over a selected query string. Keep the configured route, schema keys, and date range with the export packet so another user can reproduce the order without reconstructing the browser flow.

Export Order Packet

Keep a compact order record with every export request and delivered file.
FieldCapture
Market identityVenue family, market slug, symbol or pair, and any HIP-3 builder prefix or HIP-4 outcome context
Schema setSelected schema keys such as l2_orderbook, l3_orderbook, l4_orderbook, trades, funding, oi, or liquidations
Cart item identityOne cart item is keyed as exchange:symbol:data_type; data_type is the selected schema key, such as trades, l2_orderbook, or oi. Keep that identity with each selected market/schema pair.
Date rangeUTC start date, UTC end date, and any settled-market end constraint
EstimateSize, rows, credits, pricing unit, minimums, and quote context shown before checkout
DeliveryFile format, compression, job ID or dashboard reference, and link-expiration behavior
RightsInternal use, derived use, redistribution review, and retention requirements
Loader checkRow count, timestamp range, schema match, partitioning choice, and downstream destination
This packet lets another engineer understand the file without replaying the browser flow. It also keeps Data Catalog exports separate from JSON API responses when files move into a warehouse or model pipeline.

Data Catalog

Website route model and export product boundaries.

Export Schemas

Schema keys, coverage keys, rough columns, pricing units, and format.

Export Checkout

Credits, quote, checkout, authenticated return, and dashboard behavior.

Data Rights

Internal use, derived use, and raw redistribution boundaries.
Last modified on May 18, 2026