snapshot_ts. Cursor pagination: pass start/end/limit and follow meta.next_cursor as the cursor parameter. summary=true omits only levels while retaining snapshot_ts, block_number, mid_price, total_long, total_short, and flagged_notional.
Route Metadata
| Field | Value |
|---|---|
| Method | GET |
| Path | /v1/hyperliquid/hip3/liquidations/{symbol}/levels/history |
| operationId | getHip3LiquidationLevelsHistory |
| Tag | HIP-3 - Liquidations |
| Family | HIP-3 |
| Deprecated or legacy | no |
Request Parameters
Path Parameters
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHip3LiquidationLevelsHistory path parameters",
"type": "object",
"required": [
"symbol"
],
"properties": {
"symbol": {
"description": "Trading pair symbol.",
"type": "string",
"example": "xyz:TSLA",
"x-parameter-location": "path"
}
}
}
Query Parameters
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHip3LiquidationLevelsHistory query parameters",
"type": "object",
"properties": {
"start": {
"description": "Range start, epoch milliseconds inclusive. Default: 24 hours before end.",
"type": "integer",
"format": "int64",
"x-parameter-location": "query"
},
"end": {
"description": "Range end, epoch milliseconds inclusive. Default: now.",
"type": "integer",
"format": "int64",
"x-parameter-location": "query"
},
"cursor": {
"description": "Cursor from meta.next_cursor of the previous page (a snapshot_ts in epoch milliseconds, exclusive). The page continues strictly after it.",
"type": "string",
"x-parameter-location": "query"
},
"limit": {
"description": "Snapshots per page. Default 24, maximum 100. When a page is full, meta.next_cursor carries the cursor for the next page.",
"type": "integer",
"default": 24,
"minimum": 1,
"maximum": 100,
"x-parameter-location": "query"
},
"summary": {
"description": "When true, omits only `levels` while retaining `snapshot_ts`, `block_number`, `mid_price`, `total_long`, `total_short`, and `flagged_notional`. Cheap way to discover which snapshots exist before fetching full histograms.",
"type": "boolean",
"default": false,
"x-parameter-location": "query"
},
"range_pct": {
"description": "Percentage range around the snapshot mid/mark price. Clamped between 1 and 50. Default 10.",
"type": "number",
"default": 10,
"minimum": 1,
"maximum": 50,
"x-parameter-location": "query"
},
"buckets": {
"description": "Number of price buckets. Clamped between 10 and 200. Default 50.",
"type": "integer",
"default": 50,
"minimum": 10,
"maximum": 200,
"x-parameter-location": "query"
},
"side": {
"description": "Optional side filter. bid/buy/B keeps the long (or bid) side, ask/sell/A keeps the short (or ask) side; the other side is zeroed.",
"type": "string",
"enum": [
"bid",
"ask",
"buy",
"sell",
"B",
"A"
],
"x-parameter-location": "query"
}
}
}
Response Contracts
Status 200
Get HIP-3 liquidation levels historyapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHip3LiquidationLevelsHistory response 200",
"description": "Paginated historical liquidation-levels snapshots, ascending by snapshot_ts. When a page is full, meta.next_cursor carries the cursor for the next page.",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"description": "One historical liquidation-levels snapshot. levels is omitted when summary=true.",
"type": "object",
"required": [
"block_number",
"flagged_notional",
"mid_price",
"snapshot_ts",
"total_long",
"total_short"
],
"properties": {
"block_number": {
"type": "integer",
"format": "int64"
},
"flagged_notional": {
"type": "number"
},
"levels": {
"type": "array",
"items": {
"description": "One price bucket of projected forced-liquidation exposure.",
"type": "object",
"required": [
"long_count",
"long_notional",
"price",
"short_count",
"short_notional"
],
"properties": {
"long_count": {
"description": "Number of long positions in this bucket.",
"type": "integer"
},
"long_notional": {
"description": "USD notional of long positions projected to liquidate in this bucket.",
"type": "number"
},
"price": {
"description": "Bucket center price.",
"type": "number"
},
"short_count": {
"description": "Number of short positions in this bucket.",
"type": "integer"
},
"short_notional": {
"description": "USD notional of short positions projected to liquidate in this bucket.",
"type": "number"
}
}
}
},
"mid_price": {
"type": "number"
},
"snapshot_ts": {
"type": "string"
},
"total_long": {
"type": "number"
},
"total_short": {
"type": "number"
}
}
}
},
"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. Currently used when the requested window ends before coverage begins for the symbol; 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
}
}
}
OpenAPI example: historical
{
"success": true,
"data": [
{
"snapshot_ts": "2026-08-05 14:03:07.000",
"block_number": 1099000000,
"mid_price": 325.07,
"total_long": 9851910.14,
"total_short": 12394193.54,
"flagged_notional": 15392787.78,
"levels": [
{
"price": 295.8137,
"long_notional": 124883.12,
"short_notional": 0,
"long_count": 33,
"short_count": 0
},
{
"price": 302.3151,
"long_notional": 106188.67,
"short_notional": 0,
"long_count": 51,
"short_count": 0
},
{
"price": 308.8165,
"long_notional": 76139.52,
"short_notional": 0,
"long_count": 14,
"short_count": 0
},
{
"price": 315.3179,
"long_notional": 48138.32,
"short_notional": 0,
"long_count": 47,
"short_count": 0
},
{
"price": 321.8193,
"long_notional": 1856.47,
"short_notional": 0,
"long_count": 5,
"short_count": 0
},
{
"price": 328.3207,
"long_notional": 0,
"short_notional": 870.54,
"long_count": 0,
"short_count": 2
},
{
"price": 334.8221,
"long_notional": 0,
"short_notional": 32169.58,
"long_count": 0,
"short_count": 11
},
{
"price": 341.3235,
"long_notional": 0,
"short_notional": 17878.85,
"long_count": 0,
"short_count": 1
},
{
"price": 347.8249,
"long_notional": 0,
"short_notional": 25706.21,
"long_count": 0,
"short_count": 9
},
{
"price": 354.3263,
"long_notional": 0,
"short_notional": 1654.61,
"long_count": 0,
"short_count": 10
}
]
}
],
"meta": {
"count": 1,
"next_cursor": null,
"request_id": "f6a7b8c9-d0e1-4234-9efa-23456789abcd"
}
}
Status 400
Invalid requestapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHip3LiquidationLevelsHistory response 400",
"description": "Error response",
"type": "object",
"properties": {
"code": {
"description": "HTTP status code",
"type": "integer"
},
"error": {
"description": "Error message",
"type": "string"
},
"error_code": {
"description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
"type": "string"
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
}
}
}
OpenAPI example
{
"code": 400,
"error": "Failed to deserialize query string: limit: invalid digit found in string",
"error_code": "invalid_query_params",
"request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05"
}
Status 401
Authentication requiredapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHip3LiquidationLevelsHistory response 401",
"description": "Error response",
"type": "object",
"properties": {
"code": {
"description": "HTTP status code",
"type": "integer"
},
"error": {
"description": "Error message",
"type": "string"
},
"error_code": {
"description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
"type": "string"
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
}
}
}
OpenAPI example
{
"code": 401,
"error": "Missing or invalid API key. Provide X-API-Key header."
}
Status 429
Rate limit exceededapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHip3LiquidationLevelsHistory response 429",
"description": "Error response",
"type": "object",
"properties": {
"code": {
"description": "HTTP status code",
"type": "integer"
},
"error": {
"description": "Error message",
"type": "string"
},
"error_code": {
"description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
"type": "string"
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
}
}
}
OpenAPI example
{
"code": 429,
"error": "Rate limit exceeded"
}