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

# ApiResponseL4OrderBook Schema

> ApiResponseL4OrderBook JSON Schema for 0xArchive OpenAPI responses and field contracts. Includes route metadata, schemas, examples, and implementation notes.

Source OpenAPI: 0xArchive API 1.7.0; 218 paths; 210 component schemas.

Use the JSON Schema block below for field-level types, required fields, nested objects, and enum values.

## Required Fields

| Field | Type | Description |
| - | - | - |
| `data` | object | Current or reconstructed Hyperliquid-family L4 orderbook snapshot. |
| `meta` | object | Response metadata |
| `success` | boolean | Defined by the generated JSON Schema block. |

## JSON Schema

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ApiResponseL4OrderBook",
  "type": "object",
  "required": [
    "data",
    "meta",
    "success"
  ],
  "properties": {
    "data": {
      "description": "Current or reconstructed Hyperliquid-family L4 orderbook snapshot.",
      "type": "object",
      "required": [
        "ask_count",
        "asks",
        "bid_count",
        "bids",
        "checkpoint_timestamp",
        "coin",
        "diffs_applied",
        "last_block_number",
        "timestamp",
        "total_ask_size",
        "total_bid_size"
      ],
      "properties": {
        "ask_count": {
          "description": "Number of ask orders in the full stored/reconstructed checkpoint before optional depth truncates returned bids/asks.",
          "type": "integer",
          "example": 15
        },
        "asks": {
          "description": "Ask-side resting orders, best price first.",
          "type": "array",
          "items": {
            "description": "Individual resting order in a Hyperliquid-family L4 snapshot.",
            "type": "object",
            "required": [
              "oid",
              "price",
              "side",
              "size",
              "timestamp",
              "user_address"
            ],
            "properties": {
              "oid": {
                "description": "Hyperliquid order identifier.",
                "type": "integer",
                "format": "int64",
                "example": 18499128731
              },
              "price": {
                "description": "Venue-native resting order price.",
                "type": "number",
                "example": 105384.5
              },
              "side": {
                "description": "Book side: B for bid or A for ask.",
                "type": "string",
                "enum": [
                  "B",
                  "A"
                ],
                "example": "B"
              },
              "size": {
                "description": "Venue-native remaining order size.",
                "type": "number",
                "example": 0.824
              },
              "timestamp": {
                "description": "Queue-join timestamp in Unix epoch milliseconds; 0 when unknown.",
                "type": "integer",
                "format": "int64",
                "example": 1773273600123
              },
              "user_address": {
                "description": "Address attributed to the resting order.",
                "type": "string",
                "example": "0x0000000000000000000000000000000000000000"
              }
            }
          }
        },
        "bid_count": {
          "description": "Number of bid orders in the full stored/reconstructed checkpoint before optional depth truncates returned bids/asks.",
          "type": "integer",
          "example": 12
        },
        "bids": {
          "description": "Bid-side resting orders, best price first.",
          "type": "array",
          "items": {
            "description": "Individual resting order in a Hyperliquid-family L4 snapshot.",
            "type": "object",
            "required": [
              "oid",
              "price",
              "side",
              "size",
              "timestamp",
              "user_address"
            ],
            "properties": {
              "oid": {
                "description": "Hyperliquid order identifier.",
                "type": "integer",
                "format": "int64",
                "example": 18499128731
              },
              "price": {
                "description": "Venue-native resting order price.",
                "type": "number",
                "example": 105384.5
              },
              "side": {
                "description": "Book side: B for bid or A for ask.",
                "type": "string",
                "enum": [
                  "B",
                  "A"
                ],
                "example": "B"
              },
              "size": {
                "description": "Venue-native remaining order size.",
                "type": "number",
                "example": 0.824
              },
              "timestamp": {
                "description": "Queue-join timestamp in Unix epoch milliseconds; 0 when unknown.",
                "type": "integer",
                "format": "int64",
                "example": 1773273600123
              },
              "user_address": {
                "description": "Address attributed to the resting order.",
                "type": "string",
                "example": "0x0000000000000000000000000000000000000000"
              }
            }
          }
        },
        "checkpoint_timestamp": {
          "description": "Timestamp of the checkpoint used for this snapshot.",
          "type": "string",
          "format": "date-time",
          "example": "2026-03-12T00:00:00.000Z"
        },
        "coin": {
          "description": "Trading pair or market symbol.",
          "type": "string",
          "example": "BTC"
        },
        "diffs_applied": {
          "description": "Number of L4 diffs applied after the checkpoint.",
          "type": "integer",
          "example": 0
        },
        "is_crossed": {
          "description": "True only when a reconstructed historical book has best bid greater than or equal to best ask; omitted for clean snapshots.",
          "type": "boolean",
          "example": true
        },
        "last_block_number": {
          "description": "Last Hyperliquid block represented by this snapshot.",
          "type": "integer",
          "format": "int64",
          "example": 1023882395
        },
        "timestamp": {
          "description": "Snapshot timestamp in UTC.",
          "type": "string",
          "format": "date-time",
          "example": "2026-03-12T00:00:00.000Z"
        },
        "total_ask_size": {
          "description": "Aggregate venue-native ask size in the full stored/reconstructed checkpoint before optional depth truncates returned bids/asks.",
          "type": "number",
          "example": 98.76
        },
        "total_bid_size": {
          "description": "Aggregate venue-native bid size in the full stored/reconstructed checkpoint before optional depth truncates returned bids/asks.",
          "type": "number",
          "example": 102.34
        }
      }
    },
    "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. 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"
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}
```

## Referenced By

* [GET /v1/hyperliquid/hip3/orderbook/{symbol}/l4](/schemas/operations/get-hip3-l4-orderbook)
* [GET /v1/hyperliquid/hip4/orderbook/{symbol}/l4](/schemas/operations/get-hip4-l4-orderbook)
* [GET /v1/hyperliquid/orderbook/{symbol}/l4](/schemas/operations/get-hyperliquid-l4-orderbook)
* [GET /v1/hyperliquid/spot/orderbook/{symbol}/l4](/schemas/operations/get-hyperliquid-spot-l4-orderbook)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.