{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "ApiResponseL4OrderBookArray",
"type": "object",
"required": [
"data",
"meta",
"success"
],
"properties": {
"data": {
"type": "array",
"items": {
"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 time: when the order joined the queue at its price. By default an integer, Unix milliseconds. `0` when unknown. With `0xArchive-Version: 2026-10-01` an RFC 3339 UTC string with millisecond precision (`null` when unknown), and the integer moves to `timestamp_ms`.",
"oneOf": [
{
"description": "Default: Unix milliseconds.",
"type": "integer",
"format": "int64",
"example": 1773273600123
},
{
"description": "Version 2026-10-01: RFC 3339 UTC.",
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2026-01-01T00:00:00.000Z"
}
]
},
"timestamp_ms": {
"description": "With `0xArchive-Version: 2026-10-01` only: `timestamp` as Unix milliseconds. `0` means unknown.",
"type": "integer",
"format": "int64",
"example": 1767225600000
},
"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 time: when the order joined the queue at its price. By default an integer, Unix milliseconds. `0` when unknown. With `0xArchive-Version: 2026-10-01` an RFC 3339 UTC string with millisecond precision (`null` when unknown), and the integer moves to `timestamp_ms`.",
"oneOf": [
{
"description": "Default: Unix milliseconds.",
"type": "integer",
"format": "int64",
"example": 1773273600123
},
{
"description": "Version 2026-10-01: RFC 3339 UTC.",
"type": "string",
"format": "date-time",
"nullable": true,
"example": "2026-01-01T00:00:00.000Z"
}
]
},
"timestamp_ms": {
"description": "With `0xArchive-Version: 2026-10-01` only: `timestamp` as Unix milliseconds. `0` means unknown.",
"type": "integer",
"format": "int64",
"example": 1767225600000
},
"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. Every 2xx JSON response carries `meta.request_id`; list payloads add `count`; cursor-paged routes add `has_more` and, when another page follows, `next_cursor`; per-symbol routes add `symbol` and `venue`. Fields that do not apply to a route are omitted.",
"type": "object",
"required": [
"request_id"
],
"properties": {
"as_of": {
"description": "Positioning: the 5-minute close the records describe, equal to each record's `window_end`.",
"type": "string",
"format": "date-time"
},
"built_through": {
"description": "Trade intent: how far the series is built. A second without a record had no trades up to this instant; after it nothing is known yet.",
"type": "string",
"format": "date-time"
},
"clamped_to": {
"description": "The boundary the request's `end` was clamped to, when clamping occurred.",
"type": "string",
"format": "date-time",
"nullable": true
},
"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"
},
"finalized_through": {
"description": "Two-tier datasets (Lighter trades): data at or before this instant is final; later data is preliminary.",
"type": "string",
"format": "date-time"
},
"has_more": {
"description": "Cursor-paged routes: whether another page follows. `next_cursor` is present exactly when this is `true`. A final page can be empty when the previous page was exactly full; `has_more` is `false` on it.",
"type": "boolean"
},
"next_cursor": {
"description": "Opaque cursor for the next page, present exactly when `has_more` is `true`. Pass it back unchanged as `cursor` with the same filters. Do not parse or construct it.",
"type": "string"
},
"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"
},
"preliminary_row_count": {
"description": "Number of preliminary rows in this response, on routes that intentionally serve preliminary data (Lighter `/recent`, trade intent).",
"type": "integer",
"nullable": true
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
},
"requested_end": {
"description": "The `end` the request asked for, echoed when it was clamped to `finalized_through`.",
"type": "string",
"format": "date-time",
"nullable": true
},
"symbol": {
"description": "Per-symbol routes: the canonical public symbol the response describes (for example `BTC`, `xyz:TSLA`, `HYPE-USDC`, `#0`).",
"type": "string",
"example": "BTC"
},
"venue": {
"description": "Per-symbol routes: the venue the response describes.",
"type": "string",
"enum": [
"hyperliquid",
"hip3",
"hip4",
"spot",
"lighter",
"rh-lighter"
],
"example": "hyperliquid"
}
}
},
"success": {
"type": "boolean",
"example": true
}
}
}