Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.0xarchive.io/llms.txt

Use this file to discover all available pages before exploring further.

Source OpenAPI: 0xArchive API 1.5.0; 116 paths; 90 component schemas. Get historical order book snapshots within a time range with cursor pagination. Data available from February 2026. Free tier: km:US500 only. Build+: all symbols.

​
Route Metadata

FieldValue
MethodGET
Path/v1/hyperliquid/hip3/orderbook/{symbol}/history
operationIdgetHip3OrderbookHistory
TagHIP-3 Builder Perps - Order Book
FamilyHIP-3
Deprecated or legacyno

​
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": "Number of price levels per side. Tier limits: Free=20, Build=200, Pro=Full Depth, Enterprise=Full Depth",
      "type": "integer",
      "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"
        },
        "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": "getHip3OrderbookHistory 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": "getHip3OrderbookHistory 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 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"
    }
  }
}
OpenAPI example
{
  "code": 429,
  "error": "Rate limit exceeded"
}
Last modified on May 18, 2026