Skip to main content
GET
https://api.0xarchive.io
/
v1
/
hyperliquid
/
hip4
/
orderbook
/
{symbol}
Get HIP-4 order book
curl --request GET \
  --url https://api.0xarchive.io/v1/hyperliquid/hip4/orderbook/{symbol} \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "data": {
    "symbol": "BTC",
    "coin": "BTC",
    "timestamp": "2025-01-21T10:30:45.123Z",
    "bids": [
      {
        "px": "42150.00",
        "sz": "1.5",
        "n": 15
      }
    ],
    "asks": [
      {
        "px": "42150.00",
        "sz": "1.5",
        "n": 15
      }
    ],
    "mid_price": "42150.50",
    "spread": "1.00",
    "spread_bps": "2.37"
  },
  "meta": {
    "count": 123,
    "next_cursor": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

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.

Authorizations

X-API-Key
string
header
required

API key for authentication. Get yours at https://www.0xarchive.io/dashboard/

Path Parameters

symbol
string
required

HIP-4 coin id (e.g., 0 for outcome 0 Yes side, 1 for No side). The #-prefixed form (#0, #1) is also accepted.

Example:

"0"

Query Parameters

timestamp
integer<int64>

Unix timestamp in milliseconds. If not provided, returns latest snapshot.

depth
integer

Number of price levels per side. Tier limits: Free=20, Build=200, Pro=Full Depth, Enterprise=Full Depth

Example:

20

Response

Order book snapshot

success
boolean
Example:

true

data
object

L2 order book snapshot

meta
object

Response metadata

Last modified on May 20, 2026