HIP-3 Order Book History Schema

Source OpenAPI: 0xArchive API 1.6.1; 147 paths; 128 component schemas. 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.

Route Metadata

Field	Value
Method	`GET`
Path	`/v1/hyperliquid/hip3/orderbook/{symbol}/history`
operationId	`getHip3OrderbookHistory`
Tag	HIP-3 Builder Perps - Order Book
Family	HIP-3
Deprecated or legacy	no

Request Parameters

Path Parameters

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

Query Parameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3OrderbookHistory query parameters",
  "type": "object",
  "properties": {
    "start": {
      "description": "Start timestamp in Unix milliseconds. Defaults to 24h ago.",
      "type": "integer",
      "format": "int64",
      "x-parameter-location": "query"
    },
    "end": {
      "description": "End timestamp in Unix milliseconds. Defaults to now.",
      "type": "integer",
      "format": "int64",
      "x-parameter-location": "query"
    },
    "cursor": {
      "description": "Cursor for pagination",
      "type": "integer",
      "format": "int64",
      "x-parameter-location": "query"
    },
    "limit": {
      "description": "Maximum number of results (default: 100, max: 1000)",
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "x-parameter-location": "query"
    },
    "depth": {
      "description": "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.",
      "type": "integer",
      "maximum": 20,
      "x-parameter-location": "query"
    }
  }
}

Response Contracts

Status 200

List of order book snapshots

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3OrderbookHistory response 200",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "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"
          }
        }
      }
    },
    "meta": {
      "description": "Response metadata",
      "type": "object",
      "properties": {
        "count": {
          "description": "Number of records returned",
          "type": "integer"
        },
        "coverage_from": {
          "description": "Earliest coverage for the requested symbol and data type. Present only when the requested window ends before coverage begins.",
          "type": "string",
          "format": "date-time"
        },
        "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
        },
        "notice": {
          "description": "Human-readable advisory about the response. Currently used when the requested window ends before coverage begins for the symbol; may carry other advisories in future.",
          "type": "string"
        },
        "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": "getHip3OrderbookHistory response 400",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}

OpenAPI example

{
  "code": 400,
  "error": "Failed to deserialize query string: limit: invalid digit found in string",
  "error_code": "invalid_query_params",
  "request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05"
}

Status 401

Authentication required

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3OrderbookHistory response 401",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}

OpenAPI example

{
  "code": 401,
  "error": "Missing or invalid API key. Provide X-API-Key header."
}

Status 429

Rate limit exceeded

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3OrderbookHistory response 429",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}

OpenAPI example

{
  "code": 429,
  "error": "Rate limit exceeded"
}

API reference

SDKs & tooling

AI & agents

HIP-3 Order Book History Schema

Route Metadata

Request Parameters

Path Parameters

Query Parameters

Response Contracts

Status 200

application/json

Status 400

application/json

OpenAPI example

Status 401

application/json

OpenAPI example

Status 429

application/json

OpenAPI example

​Route Metadata

​Request Parameters

​Path Parameters

​Query Parameters

​Response Contracts

​Status 200

​application/json

​Status 400

​application/json

OpenAPI example

​Status 401

​application/json

OpenAPI example

​Status 429

​application/json

OpenAPI example

Route Metadata

Request Parameters

Path Parameters

Query Parameters

Response Contracts

Status 200

application/json

Status 400

application/json

Status 401

application/json

Status 429

application/json