start, end, and interval to bound the returned window.
Route Metadata
| Field | Value |
|---|---|
| Method | GET |
| Path | /v1/hyperliquid/cvd/{symbol} |
| operationId | getHyperliquidCvd |
| Tag | Hyperliquid - Convenience |
| Family | Hyperliquid Core |
| Deprecated or legacy | no |
Request Parameters
Path Parameters
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHyperliquidCvd path parameters",
"type": "object",
"required": [
"symbol"
],
"properties": {
"symbol": {
"description": "Trading pair symbol (e.g., BTC, ETH)",
"type": "string",
"example": "BTC",
"x-parameter-location": "path"
}
}
}
Query Parameters
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHyperliquidCvd 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"
},
"interval": {
"description": "Aggregation interval. Supported public buckets are 1h, 4h, 1d, and 1w.",
"type": "string",
"enum": [
"1h",
"4h",
"1d",
"1w"
],
"default": "1h",
"x-parameter-location": "query"
}
}
}
Response Contracts
Status 200
CVD bucketsapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHyperliquidCvd response 200",
"description": "API response containing CVD buckets.",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"description": "Cumulative volume delta bucket.",
"type": "object",
"required": [
"buy_volume",
"cumulative_delta",
"delta",
"sell_volume",
"timestamp"
],
"properties": {
"buy_volume": {
"description": "Buy-side volume for the bucket.",
"type": "number",
"example": 30160211.46768
},
"cumulative_delta": {
"description": "Running cumulative delta over the returned window.",
"type": "number",
"example": -2740918.55881
},
"delta": {
"description": "buy_volume minus sell_volume for this bucket.",
"type": "number",
"example": -2740918.55881
},
"sell_volume": {
"description": "Sell-side volume for the bucket.",
"type": "number",
"example": 32901130.02649
},
"timestamp": {
"description": "Bucket timestamp in Unix milliseconds.",
"type": "integer",
"format": "int64",
"example": 1781593200000
}
}
}
},
"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": "getHyperliquidCvd 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": "getHyperliquidCvd 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": "getHyperliquidCvd 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"
}