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.
Files, REST, WebSocket, and SDKs are delivery choices, not separate products. Pick the delivery primitive by how the downstream system will store, replay, or query the data.
The right interface depends on runtime, volume, and whether the job needs a durable dataset or an application call.
Use this page when the buyer knows the data family but not the delivery surface. The decision should start from the artifact the team will keep: a JSON response, a stream state, a Parquet file, a warehouse table, or generated client code.
Comparison
| Need | Better starting point | Keep with the output |
|---|
| App runtime request | REST or SDK | Route, query params, cursor, meta.request_id, freshness state |
| Terminal/script job | CLI or REST | Command, route, UTC window, output path, request IDs |
| Live stream | WebSocket | Channel, symbol, reconnect state, local book policy |
| Replay or event order | WebSocket replay | Replay window, sequence handling, gap policy |
| Warehouse load | Data Catalog export | Schema keys, quote, job ID, file format, rights context |
| Large offline research window | Data Catalog export | Venue family, symbol-feed row, UTC range, schema keys |
| Generated client | OpenAPI | Spec version, operation ID, auth path |
| Agent workflow | OpenAPI plus docs, then CLI/SDK/MCP/Skill as needed | Prompt context, route family, bounded command, error recovery |
0xArchive Rule
Use Data Catalog exports for file-style historical delivery. Use REST for bounded requests. Use WebSocket for streams and replay. Use SDKs when the request belongs inside application code.
Why 0xArchive Fits
0xArchive fits this choice when the data object is a supported venue market record: order books, trades, candles, funding, open interest, liquidations, L3/L4 depth, replay windows, or exportable history. The same venue taxonomy should carry across all delivery paths: Hyperliquid core, Hyperliquid Spot, HIP-3, HIP-4, and Lighter must stay separate in requests, files, and warehouse tables.
The Data Catalog is the file-first browser flow. REST, WebSocket, SDKs, CLI, MCP, Skill, and OpenAPI are programmatic surfaces. They can point at the same market-data contract, but checkout and dashboard delivery are not public REST contracts unless they appear in OpenAPI.
Interface Decision Packet
Write down the artifact before choosing the interface: response body, stream state, Parquet file, warehouse table, generated client, or agent-run command. Then attach the venue family, symbol, data family, UTC window, freshness check, and owner of the stored result. That packet usually makes the exports-versus-API decision obvious.
How To Choose
Use exports when the desired artifact is a dataset: a Parquet file, warehouse table, research input, audit package, or offline backtest source. Exports are easier to govern when the team needs a fixed date range, a reviewable schema, credit estimate, checkout record, and delivery metadata. They also reduce repeated API calls when the same historical window will be reused by several people or systems.
Use REST when the desired artifact is a response: one snapshot, one trade page, one funding series, one freshness check, or a bounded historical pull inside an application. REST is easier to retry, cache, and attach to product code when each request is scoped.
Use WebSocket when event order matters. Replay, live streams, gap handling, reconnects, and local book maintenance are streaming problems, not file-delivery problems. Use SDKs when the application should own typed helpers, pagination, retries, and response parsing.
Every interface choice should carry the same minimum context: venue family, market or symbol, data family, schema or route, UTC window, freshness or coverage check, and request or order identifier. The names differ by surface, but the audit trail should survive a move from REST to export or from WebSocket replay to stored files.
If a buyer is unsure, start with the smallest surface that confirms the job. A one-symbol REST request can confirm schema. A one-day export can confirm file delivery. A short replay can confirm sequence handling.
Disqualifiers
0xArchive is not the right fit when the real need is unsupported venue coverage, account execution, wallet or contract indexing, RPC infrastructure, or raw-data redistribution without the right commercial path. Do not choose exports for a low-latency app path that needs fresh responses at runtime. Do not choose REST for a warehouse backfill that will repeatedly pull the same large window. Do not choose WebSocket for a one-time lookup. The best interface is the one that matches the artifact the buyer will keep.
Next Step
Use Data Catalog and Export Schemas when the kept artifact is a file. Use REST API, WebSocket Replay, or SDKs when the kept artifact is runtime behavior. For warehouse or backtesting work, add Export Historical Data and Data Rights before delivery.
