Skip to main content
Source OpenAPI: 0xArchive API 1.5.0; 122 paths; 97 component schemas. Get a full-depth aggregated L2 order book snapshot derived from L4 data for HIP-3. Use this route when you need Build 200-level or Pro/Enterprise full-depth L2 from March 10, 2026 onward. The native /orderbook route remains capped at 20 venue-native levels.

​
Route Metadata

FieldValue
MethodGET
Path/v1/hyperliquid/hip3/orderbook/{symbol}/l2
operationIdgetHip3FullDepthL2Orderbook
TagHIP-3 Builder Perps - Full-Depth L2 Order Book
FamilyHIP-3
Deprecated or legacyno

​
Request Parameters

​
Path Parameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3FullDepthL2Orderbook path parameters",
  "type": "object",
  "required": [
    "symbol"
  ],
  "properties": {
    "symbol": {
      "description": "HIP-3 symbol (case-sensitive, e.g., hyna:BTC, km:US500)",
      "type": "string",
      "example": "km:US500",
      "x-parameter-location": "path"
    }
  }
}

​
Query Parameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3FullDepthL2Orderbook query parameters",
  "type": "object",
  "properties": {
    "timestamp": {
      "description": "Unix timestamp in milliseconds. If not provided, returns the latest full-depth L2 snapshot.",
      "type": "integer",
      "format": "int64",
      "example": 1767225600000,
      "x-parameter-location": "query"
    },
    "depth": {
      "description": "Requested full-depth L2 price levels per side. Plan caps apply: Free 20 where available, Build 200, Pro/Enterprise full depth.",
      "type": "integer",
      "example": 200,
      "x-parameter-location": "query"
    }
  }
}

​
Response Contracts

​
Status 200

Full-depth L2 order book snapshot

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3FullDepthL2Orderbook response 200",
  "type": "object",
  "properties": {
    "data": {
      "allOf": [
        {
          "description": "L2 order book snapshot",
          "type": "object",
          "required": [
            "asks",
            "bids",
            "coin",
            "symbol",
            "timestamp"
          ],
          "properties": {
            "asks": {
              "description": "Ask price levels (best ask first)",
              "type": "array",
              "items": {
                "description": "Single price level in the order book",
                "type": "object",
                "required": [
                  "n",
                  "px",
                  "sz"
                ],
                "properties": {
                  "n": {
                    "description": "Number of orders at this level",
                    "type": "integer",
                    "example": 15
                  },
                  "px": {
                    "description": "Price",
                    "type": "string",
                    "example": "42150.00"
                  },
                  "sz": {
                    "description": "Total size at this price level",
                    "type": "string",
                    "example": "1.5"
                  }
                }
              }
            },
            "bids": {
              "description": "Bid price levels (best bid first)",
              "type": "array",
              "items": {
                "description": "Single price level in the order book",
                "type": "object",
                "required": [
                  "n",
                  "px",
                  "sz"
                ],
                "properties": {
                  "n": {
                    "description": "Number of orders at this level",
                    "type": "integer",
                    "example": 15
                  },
                  "px": {
                    "description": "Price",
                    "type": "string",
                    "example": "42150.00"
                  },
                  "sz": {
                    "description": "Total size at this price level",
                    "type": "string",
                    "example": "1.5"
                  }
                }
              }
            },
            "coin": {
              "description": "Trading pair symbol (deprecated, use symbol instead)",
              "type": "string",
              "deprecated": true,
              "example": "BTC"
            },
            "mid_price": {
              "description": "Mid price (best bid + best ask) / 2",
              "type": "string",
              "example": "42150.50"
            },
            "spread": {
              "description": "Spread in absolute terms (best ask - best bid)",
              "type": "string",
              "example": "1.00"
            },
            "spread_bps": {
              "description": "Spread in basis points",
              "type": "string",
              "example": "2.37"
            },
            "symbol": {
              "description": "Trading pair symbol",
              "type": "string",
              "example": "BTC"
            },
            "timestamp": {
              "description": "Snapshot timestamp (UTC)",
              "type": "string",
              "format": "date-time",
              "example": "2025-01-21T10:30:45.123Z"
            }
          }
        },
        {
          "description": "0xArchive full-depth aggregated L2 order book snapshot derived from L4 data",
          "type": "object",
          "properties": {
            "ask_levels": {
              "description": "Total ask price levels available before any depth truncation",
              "type": "integer",
              "example": 10318
            },
            "bid_levels": {
              "description": "Total bid price levels available before any depth truncation",
              "type": "integer",
              "example": 9842
            },
            "total_ask_size": {
              "description": "Aggregate ask size across the available full-depth L2 book",
              "type": "number",
              "example": 9876.54
            },
            "total_bid_size": {
              "description": "Aggregate bid size across the available full-depth L2 book",
              "type": "number",
              "example": 10234.56
            }
          }
        }
      ]
    },
    "meta": {
      "description": "Response metadata",
      "type": "object",
      "properties": {
        "count": {
          "description": "Number of records returned",
          "type": "integer"
        },
        "next_cursor": {
          "description": "Cursor for pagination (timestamp). Use this value as the `cursor` parameter to fetch the next page of results.",
          "type": "string",
          "nullable": true
        },
        "request_id": {
          "description": "Unique request ID for support",
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}

​
Status 400

Invalid request

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3FullDepthL2Orderbook response 400",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
OpenAPI example
{
  "code": 400,
  "error": "Invalid request parameters"
}

​
Status 401

Authentication required

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3FullDepthL2Orderbook response 401",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
OpenAPI example
{
  "code": 401,
  "error": "Missing or invalid API key. Provide X-API-Key header."
}

​
Status 404

Resource not found

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3FullDepthL2Orderbook response 404",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
OpenAPI example
{
  "code": 404,
  "error": "Resource not found"
}

​
Status 429

Rate limit exceeded

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3FullDepthL2Orderbook response 429",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
OpenAPI example
{
  "code": 429,
  "error": "Rate limit exceeded"
}
Last modified on June 11, 2026