Get HIP-3 full-depth L2 order book history JSON Schema

Source OpenAPI: 0xArchive API 1.8.0; 227 paths; 217 component schemas. Get paginated full-depth L2 checkpoint snapshots derived from L4 data for HIP-3 from March 11, 2026 01:03 UTC onward. The route returns full checkpoint depth; it does not currently accept a per-request depth override.

Route Metadata

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

Human endpoint reference

Open GET /v1/hyperliquid/hip3/orderbook/{symbol}/l2/history for authentication, parameters, responses, and examples.

Request Parameters

Path Parameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3FullDepthL2History 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": "getHip3FullDepthL2History query parameters",
  "type": "object",
  "properties": {
    "start": {
      "description": "Start timestamp in Unix milliseconds. Defaults to 24h ago.",
      "type": "integer",
      "format": "int64",
      "example": 1767225600000,
      "x-parameter-location": "query"
    },
    "end": {
      "description": "End timestamp in Unix milliseconds. Defaults to now.",
      "type": "integer",
      "format": "int64",
      "example": 1767229200000,
      "x-parameter-location": "query"
    },
    "cursor": {
      "description": "Cursor for pagination (timestamp from previous response's `next_cursor`)",
      "type": "integer",
      "format": "int64",
      "x-parameter-location": "query"
    },
    "limit": {
      "description": "Maximum number of checkpoint snapshots (default: 100, max: 1000)",
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "x-parameter-location": "query"
    }
  }
}

Response Contracts

Status 200

Full-depth L2 checkpoint snapshots

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3FullDepthL2History response 200",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "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"
        },
        "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"
        },
        "has_more": {
          "description": "Present on cursor-paged routes: true when another page exists. `next_cursor` is present exactly when it is true.",
          "type": "boolean"
        },
        "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. Used when the requested window ends before coverage begins for the symbol, and on CVD responses that are one page of several; may carry other advisories in future.",
          "type": "string"
        },
        "request_id": {
          "description": "Unique request ID for support",
          "type": "string",
          "format": "uuid"
        },
        "symbol": {
          "description": "Present on per-symbol routes: the symbol the response covers.",
          "type": "string"
        },
        "venue": {
          "description": "Present on per-symbol routes: the venue the response covers, for example `hyperliquid` or `hip3`.",
          "type": "string"
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}

Status 400

Invalid request

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3FullDepthL2History 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"
    },
    "param": {
      "description": "The parameter at fault, when the error is about one parameter.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    },
    "success": {
      "description": "Always false on an error.",
      "type": "boolean",
      "example": false
    }
  }
}

OpenAPI example

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

Status 401

Authentication required

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3FullDepthL2History 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"
    },
    "param": {
      "description": "The parameter at fault, when the error is about one parameter.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    },
    "success": {
      "description": "Always false on an error.",
      "type": "boolean",
      "example": false
    }
  }
}

OpenAPI example

{
  "code": 401,
  "error": "Missing authentication credentials. Provide X-API-Key header or Bearer token.",
  "error_code": "unauthorized",
  "request_id": "71ed4b6f-63ef-4ae1-a123-07ffa47c1c14",
  "success": false
}

Status 404

Resource not found

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3FullDepthL2History response 404",
  "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"
    },
    "param": {
      "description": "The parameter at fault, when the error is about one parameter.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    },
    "success": {
      "description": "Always false on an error.",
      "type": "boolean",
      "example": false
    }
  }
}

OpenAPI example

{
  "code": 404,
  "error": "No L4 checkpoint available before requested timestamp",
  "error_code": "not_found",
  "request_id": "ad7df471-eb8a-477c-bd9f-c685a9825f5b",
  "success": false
}

Status 429

Rate limit exceeded

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3FullDepthL2History 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"
    },
    "param": {
      "description": "The parameter at fault, when the error is about one parameter.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    },
    "success": {
      "description": "Always false on an error.",
      "type": "boolean",
      "example": false
    }
  }
}

OpenAPI example

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

Endpoint reference

Requests and responses

Datasets

Venues

OpenAPI and schemas

Guides

Get HIP-3 full-depth L2 order book history JSON Schema

Route Metadata

Human endpoint reference

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 404

application/json

OpenAPI example

Status 429

application/json

OpenAPI example

​Route Metadata

​Human endpoint reference

​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 404

​application/json

OpenAPI example

​Status 429

​application/json

OpenAPI example

Route Metadata

Human endpoint reference

Request Parameters

Path Parameters

Query Parameters

Response Contracts

Status 200

application/json

Status 400

application/json

Status 401

application/json

Status 404

application/json

Status 429

application/json