Route Metadata
| Field | Value |
|---|---|
| Method | GET |
| Path | /v1/hyperliquid/hip3/liquidations/{symbol}/levels |
| operationId | getHip3LiquidationLevels |
| Tag | HIP-3 Builder Perps - Liquidations |
| Family | HIP-3 |
| Deprecated or legacy | no |
Request Parameters
Path Parameters
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHip3LiquidationLevels path parameters",
"type": "object",
"required": [
"symbol"
],
"properties": {
"symbol": {
"description": "Trading pair symbol.",
"type": "string",
"example": "km:US500",
"x-parameter-location": "path"
}
}
}
Query Parameters
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHip3LiquidationLevels query parameters",
"type": "object",
"properties": {
"range_pct": {
"description": "Percentage range around current mid/mark price. Values are 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. Values are clamped between 10 and 200. Default 50.",
"type": "integer",
"default": 50,
"minimum": 10,
"maximum": 200,
"x-parameter-location": "query"
},
"side": {
"description": "Optional side filter. Accepted values: bid, ask, buy, sell, B, A.",
"type": "string",
"enum": [
"bid",
"ask",
"buy",
"sell",
"B",
"A"
],
"x-parameter-location": "query"
}
}
}
Response Contracts
Status 200
HIP-3 liquidation level bucketsapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHip3LiquidationLevels response 200",
"description": "API response containing liquidation level buckets.",
"type": "object",
"properties": {
"data": {
"description": "Liquidation/trigger-order levels response body.",
"type": "object",
"required": [
"levels",
"mid_price"
],
"properties": {
"levels": {
"type": "array",
"items": {
"description": "Aggregated trigger-order level near the current mark/mid price.",
"type": "object",
"required": [
"ask_count",
"ask_size",
"bid_count",
"bid_size",
"price_bucket"
],
"properties": {
"ask_count": {
"description": "Number of ask-side trigger orders in the bucket.",
"type": "integer",
"format": "int64",
"example": 9
},
"ask_size": {
"description": "Ask-side trigger size in the bucket.",
"type": "number",
"example": 18.75
},
"bid_count": {
"description": "Number of bid-side trigger orders in the bucket.",
"type": "integer",
"format": "int64",
"example": 12
},
"bid_size": {
"description": "Bid-side trigger size in the bucket.",
"type": "number",
"example": 31.25
},
"price_bucket": {
"description": "Rounded trigger price bucket.",
"type": "number",
"example": 64200
}
}
}
},
"mid_price": {
"description": "Current mid/mark price used as the center of the requested range.",
"type": "number",
"example": 64215
}
}
},
"meta": {
"description": "Response metadata",
"type": "object",
"properties": {
"count": {
"description": "Number of records returned",
"type": "integer"
},
"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
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
}
}
},
"success": {
"type": "boolean",
"example": true
}
}
}
Status 400
Invalid requestapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHip3LiquidationLevels response 400",
"description": "Error response",
"type": "object",
"properties": {
"code": {
"description": "HTTP status code",
"type": "integer"
},
"error": {
"description": "Error message",
"type": "string"
}
}
}
OpenAPI example
{
"code": 400,
"error": "Invalid request parameters"
}
Status 401
Authentication requiredapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHip3LiquidationLevels response 401",
"description": "Error response",
"type": "object",
"properties": {
"code": {
"description": "HTTP status code",
"type": "integer"
},
"error": {
"description": "Error message",
"type": "string"
}
}
}
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": "getHip3LiquidationLevels response 429",
"description": "Error response",
"type": "object",
"properties": {
"code": {
"description": "HTTP status code",
"type": "integer"
},
"error": {
"description": "Error message",
"type": "string"
}
}
}
OpenAPI example
{
"code": 429,
"error": "Rate limit exceeded"
}