{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "ApiResponsePositioningArray",
"description": "API response containing one positioning record per listed perp, sorted by symbol. `meta.as_of` is the 5-minute close the records describe.",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"description": "One listed perp over the trailing window.",
"type": "object",
"required": [
"buy_usd",
"liq_long_count",
"liq_long_usd",
"liq_short_count",
"liq_short_usd",
"mark_end",
"mark_start",
"oi_buckets",
"oi_end",
"oi_start",
"sell_usd",
"symbol",
"typical_flow",
"typical_oi",
"typical_price",
"typical_windows",
"window",
"window_end",
"window_end_ms",
"window_start",
"window_start_ms"
],
"properties": {
"buy_usd": {
"description": "Taker buy notional in the window, USD to the cent. 0 means none.",
"type": "number",
"format": "double",
"example": 426153898.11
},
"liq_long_count": {
"description": "Long liquidations in the window.",
"type": "integer",
"format": "int64",
"example": 35
},
"liq_long_usd": {
"description": "Notional of long positions liquidated in the window, USD to the cent.",
"type": "number",
"format": "double",
"example": 132411.14
},
"liq_short_count": {
"description": "Short liquidations in the window.",
"type": "integer",
"format": "int64",
"example": 1
},
"liq_short_usd": {
"description": "Notional of short positions liquidated in the window, USD to the cent.",
"type": "number",
"format": "double",
"example": 5186.43
},
"mark_end": {
"description": "Mark price at the window's last 5-minute reading. Null when that bucket has no reading.",
"type": "number",
"format": "double",
"nullable": true,
"example": 80010
},
"mark_start": {
"description": "Mark price at the 5-minute reading before the window. Null when that bucket has no reading.",
"type": "number",
"format": "double",
"nullable": true,
"example": 80139
},
"oi_buckets": {
"description": "Number of 5-minute open interest readings inside the window.",
"type": "integer",
"example": 48
},
"oi_end": {
"description": "Open interest in contracts at the window's last 5-minute reading. Null when that bucket has no reading.",
"type": "number",
"format": "double",
"nullable": true,
"example": 39592.93574
},
"oi_start": {
"description": "Open interest in contracts at the 5-minute reading before the window. Null when that bucket has no reading, never 0.",
"type": "number",
"format": "double",
"nullable": true,
"example": 41558.2733
},
"sell_usd": {
"description": "Taker sell notional in the window, USD to the cent. 0 means none.",
"type": "number",
"format": "double",
"example": 452128639.73
},
"symbol": {
"description": "The market's symbol.",
"type": "string",
"example": "BTC"
},
"typical_flow": {
"description": "Median absolute taker imbalance, (buy - sell) / (buy + sell), over the same windows. Null under 288 counted windows.",
"type": "number",
"format": "double",
"nullable": true,
"example": 0.10512875847481765
},
"typical_oi": {
"description": "Median absolute relative change of open interest over the same windows. Null under 288 counted windows.",
"type": "number",
"format": "double",
"nullable": true,
"example": 0.010328192376292733
},
"typical_price": {
"description": "Median absolute relative change of the mark over every window of this length in the last 2,000 five-minute buckets. Null under 288 counted windows.",
"type": "number",
"format": "double",
"nullable": true,
"example": 0.003597216644913026
},
"typical_windows": {
"description": "Windows counted for the `typical_*` figures.",
"type": "integer",
"example": 1952
},
"window": {
"description": "The requested window.",
"type": "string",
"enum": [
"1h",
"4h",
"24h"
],
"example": "4h"
},
"window_end": {
"description": "End of the window, exclusive: the 5-minute close the cross-section is as of. Equal to `meta.as_of`.",
"type": "string",
"format": "date-time",
"example": "2026-11-04T20:00:00.000Z"
},
"window_end_ms": {
"description": "`window_end` as Unix milliseconds.",
"type": "integer",
"format": "int64",
"example": 1793822400000
},
"window_start": {
"description": "Start of the window, inclusive.",
"type": "string",
"format": "date-time",
"example": "2026-11-04T16:00:00.000Z"
},
"window_start_ms": {
"description": "`window_start` as Unix milliseconds.",
"type": "integer",
"format": "int64",
"example": 1793808000000
}
}
}
},
"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
}
}
}