{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "ApiResponseHip4OpenInterestArray",
"description": "API response wrapping an array of HIP-4 per-side open-interest records",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"description": "HIP-4 per-side open-interest record. Mirrors the HIP-3 OI shape and adds `outcome_id` and `side`. `oracle_price` is omitted for HIP-4 (outcomes have no oracle feed). Note: `mark_price` is an implied probability in [0,1], not a USD price; same field name as perps because Hyperliquid upstream uses `markPx` for both.",
"type": "object",
"required": [
"coin",
"open_interest",
"outcome_id",
"side",
"symbol",
"timestamp"
],
"properties": {
"coin": {
"description": "`#`-prefixed per-side coin identifier",
"type": "string",
"example": "#0"
},
"mark_price": {
"description": "Implied probability in [0,1], NOT a USD price. Same field name as perps because Hyperliquid upstream uses `markPx` for both.",
"type": "string",
"nullable": true,
"example": "0.6502"
},
"mid_price": {
"description": "Mid price (probability in [0,1])",
"type": "string",
"nullable": true,
"example": "0.65038"
},
"open_interest": {
"description": "Open interest in contracts (notional currency: USDH)",
"type": "string",
"example": "568048"
},
"outcome_id": {
"description": "Numeric outcome identifier",
"type": "integer",
"format": "int64",
"example": 0
},
"side": {
"description": "Side index: 0 = Yes, 1 = No",
"type": "integer",
"enum": [
0,
1
],
"example": 0
},
"symbol": {
"description": "Same value as `coin`. Provided for consistency with other venues.",
"type": "string",
"example": "#0"
},
"timestamp": {
"description": "Snapshot timestamp (UTC)",
"type": "string",
"format": "date-time",
"example": "2026-05-02T20:27:21Z"
}
}
}
},
"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
}
}
}