Choose venue and market type

Outcome

Leave one route choice for a single market, with its venue, market type, original symbol, API namespace, and first request recorded. Start with Venues and market types for the source hierarchy. This guide turns one selected market into a bounded API call.

Prerequisites

Have one symbol or market identity in its original form.
Decide whether the record is an order book, trades, candles, funding, open interest, liquidations, orders, or another documented data type.
Use /v1/symbols for public discovery before selecting a route when the venue or market type is not known.
Keep an API key available for the selected authenticated market-data call.

Inputs

Field	Example
Venue	Hyperliquid
Market type	Core perpetuals
Symbol	`BTC`
Data type	Native L2 order book
First request	`/v1/hyperliquid/orderbook/BTC?depth=1`
Window	Current snapshot, or explicit Unix-millisecond `start` and `end`
Saved identity	Venue, market type, symbol, route, query, and request ID

Steps

Discover the identity

curl -sS "https://api.0xarchive.io/v1/symbols"

Find the row whose exchange and symbol match the requested market. Preserve the row’s spelling, prefix, pair separator, and any market slug.

Select the API namespace

Use core for perp symbols such as BTC; Spot for pairs such as HYPE-USDC; HIP-3 for builder-prefixed symbols such as km:US500; HIP-4 for outcome-market identifiers; and Lighter for a Lighter market.

Make one bounded call

For the example inputs, call:

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

Replace the path only after checking the selected market-type page.

Keep the identity intact

Put the venue, market type, and namespace in the route, function or config name, stored record, logs, and agent prompt. Do not normalize a symbol into a different namespace.

Expected state

The route and symbol agree on one venue and market type. For the example, the response is a Hyperliquid core native L2 snapshot. A Spot, HIP-3, HIP-4, or Lighter selection must use its own namespace and its own response interpretation. Lighter L3 is individual-order depth, not an aggregated L2 shape. /v1/lighter/l3orderbook/{symbol} returns numeric order_index, owner_account_index, price, remaining_size, and original_size; the two index fields are Lighter indexes, not wallet addresses or raw order IDs.

Verification

Check the exact route in OpenAPI, then compare the selected market and data type with Venue coverage. For a historical window, inspect /v1/symbols coverage_by_type or the exact symbol-coverage route before relying on a date. Do not use /v1/status/coverage as a substitute for symbol-level schema dates.

Failure and recovery

No matching symbol row: stop and retain the requested spelling. Do not invent a replacement ticker.
404: check the API namespace and symbol format before retrying.
400: correct the parameter or symbol named by the response.
403: inspect the exact endpoint/account/key response. Do not turn the status into a general market-availability claim.
A market-specific field is surprising: stop at the Endpoint Reference and keep the original response shape.

Saved run metadata

{
  "discovery_route": "/v1/symbols",
  "venue": "hyperliquid",
  "market_type": "core_perpetuals",
  "symbol": "BTC",
  "data_type": "l2_orderbook",
  "route": "/v1/hyperliquid/orderbook/BTC",
  "query": { "depth": 1 },
  "request_ids": ["00000000-0000-0000-0000-000000000000"],
  "coverage_source": "record the selected symbol row or symbol-coverage response"
}

The zero UUID is a shape placeholder only. Replace it with the UUID returned by the route or client wrapper.

Next task

Open Venue coverage for symbol-level history and quality checks, then use the matching page under REST API for additional routes.

​Outcome

​Prerequisites

​Inputs

​Steps

​Expected state

​Verification

​Failure and recovery

​Saved run metadata

​Next task