HIP-3 Builder Perps - Full-Depth L2 Order Book

Get HIP-3 full-depth L2 order book

Get a full-depth aggregated L2 order book snapshot derived from L4 data for HIP-3. Use this route when you need full-depth aggregated L2 from March 11, 2026 01:03 UTC onward. The native /orderbook route remains capped at 20 venue-native levels.

get/v1/hyperliquid/hip3/orderbook/{symbol}/l2

Request

  • Base URL: https://api.0xarchive.io
  • URL: https://api.0xarchive.io/v1/hyperliquid/hip3/orderbook/{symbol}/l2
  • Auth: API key in header X-API-Key

Path parameters

symbolstring required
Example:km:US500

HIP-3 symbol (case-sensitive, e.g., hyna:BTC, km:US500)

Query parameters

timestampinteger
Example:1767225600000

Unix timestamp in milliseconds. If not provided, returns the latest full-depth L2 snapshot.

depthinteger
Example:200

Requested aggregated L2 levels per side. This dedicated route returns all available aggregated levels for the selected symbol and checkpoint.

Response

Full-depth L2 order book snapshot

successboolean

Example response

{
  "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",
    "bid_levels": 9842,
    "ask_levels": 10318,
    "total_bid_size": 10234.56,
    "total_ask_size": 9876.54
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.