Get order book (Deprecated) JSON Schema

Source OpenAPI: 0xArchive API 1.6.1; 147 paths; 128 component schemas. Deprecated: Use /v1/hyperliquid/orderbook/{symbol} for the native 20-level Hyperliquid snapshot or /v1/hyperliquid/orderbook/{symbol}/l2 for full-depth aggregated L2. Use /v1/lighter/orderbook/{symbol} for Lighter. Get the latest deprecated compatibility order book snapshot for a coin, or at a specific timestamp. This Hyperliquid compatibility route is capped at the native 20 price levels per side.

Route Metadata

Field	Value
Method	`GET`
Path	`/v1/orderbook/{symbol}`
operationId	`getOrderbook`
Tag	Legacy
Family	Legacy
Deprecated or legacy	yes

Request Parameters

Path Parameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getOrderbook path parameters",
  "type": "object",
  "required": [
    "symbol"
  ],
  "properties": {
    "symbol": {
      "description": "Trading pair symbol (e.g., BTC, ETH, SOL)",
      "type": "string",
      "example": "BTC",
      "x-parameter-location": "path"
    }
  }
}

Query Parameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getOrderbook query parameters",
  "type": "object",
  "properties": {
    "timestamp": {
      "description": "Unix timestamp in milliseconds. If not provided, returns latest snapshot.",
      "type": "integer",
      "format": "int64",
      "example": 1704067200000,
      "x-parameter-location": "query"
    },
    "depth": {
      "description": "Requested price levels per side for this deprecated Hyperliquid compatibility route. Native Hyperliquid L2 data is capped at 20 levels per side; values above 20 do not return full depth here. Use /v1/hyperliquid/orderbook/{symbol}/l2 for full-depth aggregated L2.",
      "type": "integer",
      "maximum": 20,
      "example": 20,
      "x-parameter-location": "query"
    }
  }
}

Response Contracts

Status 200

Order book snapshot

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getOrderbook response 200",
  "type": "object",
  "properties": {
    "data": {
      "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": "getOrderbook 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": "getOrderbook 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 404

Resource not found

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getOrderbook 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"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}

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": "getOrderbook 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

Get order book (Deprecated) JSON 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 404

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 404

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

application/json

Status 429

application/json