Route Metadata
| Field | Value |
|---|---|
| Method | GET |
| Path | /v1/lighter/liquidations/{symbol}/volume |
| operationId | getLighterLiquidationVolume |
| Tag | Lighter - Liquidations |
| Family | Lighter |
| Deprecated or legacy | no |
Request Parameters
Path Parameters
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getLighterLiquidationVolume path parameters",
"type": "object",
"required": [
"symbol"
],
"properties": {
"symbol": {
"description": "Lighter market symbol.",
"type": "string",
"example": "BTC",
"x-parameter-location": "path"
}
}
}
Query Parameters
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getLighterLiquidationVolume query parameters",
"type": "object",
"properties": {
"start": {
"description": "Start timestamp in Unix milliseconds. Defaults depend on the route family.",
"type": "integer",
"format": "int64",
"x-parameter-location": "query"
},
"end": {
"description": "End timestamp in Unix milliseconds. Defaults to now.",
"type": "integer",
"format": "int64",
"x-parameter-location": "query"
},
"cursor": {
"description": "Cursor for pagination. Use the value from the previous response metadata.",
"type": "string",
"x-parameter-location": "query"
},
"limit": {
"description": "Maximum number of results (default: 100, max: 1000)",
"type": "integer",
"default": 100,
"maximum": 1000,
"x-parameter-location": "query"
},
"interval": {
"description": "Aggregation interval. Defaults to 1h.",
"type": "string",
"enum": [
"5m",
"15m",
"30m",
"1h",
"4h",
"1d"
],
"default": "1h",
"x-parameter-location": "query"
}
}
}
Response Contracts
Status 200
Lighter liquidation volume bucketsapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getLighterLiquidationVolume response 200",
"description": "API response containing an array of aggregated liquidation volumes",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"description": "Aggregated liquidation volume for a time bucket",
"type": "object",
"required": [
"coin",
"count",
"long_count",
"long_usd",
"short_count",
"short_usd",
"symbol",
"timestamp",
"total_usd"
],
"properties": {
"coin": {
"description": "Trading pair symbol (deprecated, use symbol instead)",
"type": "string",
"deprecated": true,
"example": "BTC"
},
"count": {
"description": "Total number of liquidations",
"type": "integer",
"example": 42
},
"long_count": {
"description": "Number of long liquidations",
"type": "integer",
"example": 25
},
"long_usd": {
"description": "Long liquidation volume in USD",
"type": "number",
"example": 750000.25
},
"short_count": {
"description": "Number of short liquidations",
"type": "integer",
"example": 17
},
"short_usd": {
"description": "Short liquidation volume in USD",
"type": "number",
"example": 500000.25
},
"symbol": {
"description": "Trading pair symbol",
"type": "string",
"example": "BTC"
},
"timestamp": {
"description": "Bucket start timestamp (UTC)",
"type": "string",
"format": "date-time",
"example": "2025-05-21T10:00:00.000Z"
},
"total_usd": {
"description": "Total liquidation volume in USD",
"type": "number",
"example": 1250000.5
}
}
}
},
"meta": {
"type": "object",
"properties": {
"count": {
"description": "Number of records returned",
"type": "integer"
},
"next_cursor": {
"description": "Cursor for pagination",
"type": "string",
"nullable": true
}
}
},
"success": {
"type": "boolean",
"example": true
}
}
}
Status 400
Invalid requestapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getLighterLiquidationVolume 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": "getLighterLiquidationVolume 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": "getLighterLiquidationVolume 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"
}