HIP-3 Builder Perps - Order Book

Get HIP-3 native L2 order book history (20 levels)

Get historical venue-native HIP-3 L2 order book snapshots within a time range. Historical windows use start and end Unix-millisecond query parameters. This native route is capped at 20 price levels per side; use /v1/hyperliquid/hip3/orderbook/{symbol}/l2/history for full-depth checkpoint history derived from L4.

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

Request

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

Path parameters

symbolstring required
Example:xyz:XYZ100

Trading pair symbol (e.g., km:US500, xyz:XYZ100). HIP-3 symbols are case-sensitive.

Query parameters

startinteger

Start timestamp in Unix milliseconds. Defaults to 24h ago.

endinteger

End timestamp in Unix milliseconds. Defaults to now.

cursorinteger

Cursor for pagination

limitinteger

Maximum number of results (default: 100, max: 1000)

depthinteger

Requested price levels per side for this native venue snapshot. Hyperliquid native L2 data is capped at 20 levels per side; values above 20 do not return full depth on this route. Use the /l2 routes for full-depth aggregated L2.

Response

List of order book snapshots

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"
    }
  ]
}

Changes

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