{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "ApiResponseCoinSummary",
"description": "API response wrapping a market summary",
"type": "object",
"properties": {
"data": {
"description": "Shared market-summary shape. Route families omit unsupported optional fields; consult the operation description for family-specific applicability.",
"type": "object",
"required": [
"coin",
"symbol",
"timestamp"
],
"properties": {
"coin": {
"description": "Trading pair symbol (deprecated, use symbol instead)",
"type": "string",
"deprecated": true,
"example": "BTC"
},
"funding_rate": {
"description": "Current funding rate",
"type": "string",
"nullable": true,
"example": "0.00025"
},
"liquidation_volume_24h": {
"description": "Total 24h liquidation volume in USD",
"type": "number",
"nullable": true,
"example": 2500000
},
"long_liquidation_volume_24h": {
"description": "Long 24h liquidation volume in USD",
"type": "number",
"nullable": true,
"example": 1500000
},
"mark_price": {
"description": "Current mark price",
"type": "string",
"nullable": true,
"example": "95000.50"
},
"mid_price": {
"description": "Current mid price",
"type": "string",
"nullable": true,
"example": "95000.00"
},
"open_interest": {
"description": "Current open interest",
"type": "string",
"nullable": true,
"example": "500000.00"
},
"oracle_price": {
"description": "Current oracle price",
"type": "string",
"nullable": true,
"example": "94998.25"
},
"premium": {
"description": "Current premium",
"type": "string",
"nullable": true,
"example": "0.0005"
},
"short_liquidation_volume_24h": {
"description": "Short 24h liquidation volume in USD",
"type": "number",
"nullable": true,
"example": 1000000
},
"symbol": {
"description": "Trading pair symbol",
"type": "string",
"example": "BTC"
},
"timestamp": {
"description": "Summary timestamp (UTC)",
"type": "string",
"format": "date-time",
"example": "2026-02-23T12:00:00.000Z"
},
"volume_24h": {
"description": "24-hour notional volume",
"type": "string",
"nullable": true,
"example": "10000000.00"
}
}
},
"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
}
}
}