> ## 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.

# Hyperliquid Order Book Schema

> Get Hyperliquid native L2 order book (20 levels) JSON Schema contract. Includes route metadata, schemas, examples, and implementation notes.

Source OpenAPI: 0xArchive API 1.5.0; 140 paths; 119 component schemas.

Get the latest venue-native Hyperliquid L2 order book snapshot, or a snapshot at a specific timestamp. This native route is capped at the 20 price levels per side provided by Hyperliquid source snapshots. Use `/v1/hyperliquid/orderbook/{symbol}/l2` for full-depth aggregated L2 derived from L4.

## Route Metadata

| Field                | Value                                |
| -------------------- | ------------------------------------ |
| Method               | `GET`                                |
| Path                 | `/v1/hyperliquid/orderbook/{symbol}` |
| operationId          | `getHyperliquidOrderbook`            |
| Tag                  | Hyperliquid - Order Book             |
| Family               | Hyperliquid Core                     |
| Deprecated or legacy | no                                   |

## Request Parameters

### Path Parameters

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidOrderbook 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

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidOrderbook 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 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,
      "example": 20,
      "x-parameter-location": "query"
    }
  }
}
```

## Response Contracts

### Status 200

Order book snapshot

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidOrderbook 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"
        },
        "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

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidOrderbook response 400",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 400,
  "error": "Invalid request parameters"
}
```

### Status 401

Authentication required

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidOrderbook response 401",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 401,
  "error": "Missing or invalid API key. Provide X-API-Key header."
}
```

### Status 404

Resource not found

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidOrderbook response 404",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 404,
  "error": "Resource not found"
}
```

### Status 429

Rate limit exceeded

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHyperliquidOrderbook response 429",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 429,
  "error": "Rate limit exceeded"
}
```