Guides - 0xArchive

Outcome

Choose one bounded market-data task and leave a request brief that names the venue family, exact route, inputs, completion condition, and next reference.

Prerequisites

Know the record you need: a snapshot, historical rows, an export, a freshness decision, or a replay.
Name one venue family and one symbol or market identity. Keep the original symbol spelling.
Load an API key from the runtime environment for an authenticated market-data route. The public /v1/symbols discovery route does not need a key.
Use REST authentication for HTTP request mechanics and the matching Endpoint Reference page for final parameters and response fields.

Inputs

Field	Example
Job	One-hour BTC trade pull
Venue family	Hyperliquid core
Symbol	`BTC`
Data family	Trades
Window	`start=1767225600000&end=1767229200000`
Surface	REST, WebSocket replay, Data Catalog, SDK, CLI, MCP Server, or Skill
Completion condition	Response or file is saved with route, window, quality state, and request IDs

Steps

Choose the task page

Use First authenticated request for a key and envelope check, Choose venue and market family for namespace selection, or Historical market data for a bounded pull.

Run one bounded call

If the route is not known yet, use this small core-market check:

curl -sS "https://api.0xarchive.io/v1/hyperliquid/orderbook/BTC?depth=1" \
  -H "X-API-Key: $OXARCHIVE_API_KEY"

For another family, replace the route only after checking its Endpoint Reference page.

Record the result

Save the exact method, path, query, venue family, symbol, response status, request IDs, and the quality or coverage decision that controls the next action.

Expected state

The brief is ready when a second engineer can identify the route family and repeat the same bounded call without guessing. A successful core order-book call has a success value, an order-book data object, and a route response identifier in meta.request_id.

Verification

Check the exact route and parameter types in OpenAPI. For historical or export work, check the selected symbol and data family with Data quality before widening the window. Keep the response body separate from the request brief so the recorded inputs cannot be mistaken for returned data.

Failure and recovery

401: stop and correct the X-API-Key source or header.
403: inspect the exact endpoint/account/key response. Do not infer a route or dataset gate from the status alone.
404: return to Venue coverage and check the namespace and symbol.
429: honor Retry-After when present, otherwise use capped exponential backoff with jitter and reduce concurrency.
A stale or incomplete quality result: narrow, delay, or mark the output instead of filling missing rows.

Saved run metadata

{
  "job": "btc_trade_pull_hour_001",
  "venue_family": "hyperliquid_core",
  "symbol": "BTC",
  "data_family": "trades",
  "surface": "REST",
  "route": "/v1/hyperliquid/trades/BTC",
  "query": {
    "start": 1767225600000,
    "end": 1767229200000,
    "limit": 1000
  },
  "request_ids": ["00000000-0000-0000-0000-000000000000"],
  "quality_state": "record the returned state",
  "output": "./artifacts/btc-trades-hour-001.json"
}

The zero UUID is a shape placeholder only. Replace it with the UUID returned by the response or client wrapper. Do not send it as a request value.

Next task

Historical market data for bounded REST rows.
Point-In-Time Backtesting for a reproducible research run.
Choose a tooling workflow when the runtime needs a different surface.
Reliability and data gaps when the quality decision is not clean.

​Outcome

​Prerequisites

​Inputs

​Steps

​Expected state

​Verification

​Failure and recovery

​Saved run metadata

​Next task