Quickstart

Get a key, call the BTC order book once, and read the response envelope. This is the Free Crypto Data API path: a free key and one real request.

Create a key

Open the dashboard and create an API key. The free tier needs no card.

Set it in your shell

export OXARCHIVE_API_KEY="0xa_your_api_key"

Call the BTC order book

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

The response

This native Hyperliquid L2 route returns an order-book object in the data field. Here is a representative response with one level per side:

{
  "success": true,
  "data": {
    "coin": "BTC",
    "symbol": "BTC",
    "timestamp": "2026-08-28T00:00:00.000Z",
    "bids": [
      { "px": "61077.0", "sz": "0.0003", "n": 1 }
    ],
    "asks": [
      { "px": "61078.0", "sz": "11.73086", "n": 1 }
    ],
    "mid_price": "61077.5",
    "spread": "1",
    "spread_bps": "0.16372641316360362"
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

px and sz are decimal strings. Parse them as decimals, not floats, when you need exact values.
n is the number of resting orders at that price level.
Keep meta.request_id or the x-request-id response header with the route and symbol.

import os
import requests

res = requests.get(
    "https://api.0xarchive.io/v1/hyperliquid/orderbook/BTC?depth=1",
    headers={"X-API-Key": os.environ["OXARCHIVE_API_KEY"]},
    timeout=20,
)
res.raise_for_status()
payload = res.json()
book = payload["data"]
print(book["symbol"], book["mid_price"], payload["meta"]["request_id"])

const res = await fetch("https://api.0xarchive.io/v1/hyperliquid/orderbook/BTC?depth=1", {
  headers: { "X-API-Key": process.env.OXARCHIVE_API_KEY }
});

if (!res.ok) throw new Error(`0xArchive request failed: ${res.status}`);
const payload = await res.json();
console.log(payload.data.symbol, payload.data.mid_price, payload.meta.request_id);

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

Confirm success

The first call is complete when it returns HTTP 200, success: true, an order-book object in data, and a UUID-shaped meta.request_id. Store the route, symbol, response timestamp, and request ID together before adding another route or symbol.

When a call fails

Most first-call failures are a missing or wrong key (401). Check your X-API-Key and follow REST authentication. Authentication failures can return a compact body with top-level code and error; other application errors commonly use the standard response envelope:

{
  "success": false,
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded"
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Code	Means	Do
`400`	Bad parameter, symbol, or time range	Fix the request before retrying
`401`	Missing or invalid API key	Check `X-API-Key` and key status
`403`	The supplied key or request is not accepted for this route	Check the exact endpoint, route family, symbol, and schema, then verify the account or key contract. Published route access is not a higher-tier feature; plans govern capacity and request windows, not route availability
`429`	Rate, concurrency, or credit limit reached	Honor `Retry-After`, otherwise back off

Full codes, retry rules, and request-ID handling are on Errors and request IDs. For credits, concurrency, and per-plan limits, see Rate limits. Keep the failed meta.request_id or x-request-id when you ask for support.

Browse REST routes

Parameters, schemas, examples, and credits, backed by OpenAPI.

Check venue coverage

Pick the right namespace and confirm the history window before wiring symbols.

Connect WebSocket

Check channel availability before choosing real-time data or replay.

Choose tooling

Move from curl to SDKs, CLI, MCP Server, Skill, or OpenAPI codegen.

Get started

Plans & limits

The response

Confirm success

When a call fails

Next

Browse REST routes

Check venue coverage

Connect WebSocket

Choose tooling

​The response

​Confirm success

​When a call fails

​Next

Browse REST routes

Check venue coverage

Connect WebSocket

Choose tooling

The response

Confirm success

When a call fails

Next