Route Metadata
| Field | Value |
|---|---|
| Method | GET |
| Path | /v1/symbols |
| operationId | listSymbols |
| Tag | System |
| Family | System |
| Deprecated or legacy | no |
Human endpoint reference
OpenGET /v1/symbols for authentication, parameters, responses, and examples.
Response Contracts
Status 200
Public symbol universeapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "listSymbols response 200",
"description": "Public symbol universe response.",
"type": "object",
"required": [
"symbols"
],
"properties": {
"symbols": {
"type": "array",
"items": {
"description": "Public market symbol entry.",
"type": "object",
"required": [
"data_types",
"exchange",
"symbol"
],
"properties": {
"coverage_by_type": {
"type": "object",
"additionalProperties": {
"type": "string",
"format": "date-time"
}
},
"coverage_from": {
"type": "string",
"format": "date-time",
"nullable": true
},
"coverage_to": {
"type": "string",
"format": "date-time",
"nullable": true
},
"data_types": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"l2_orderbook",
"trades",
"liquidations"
]
},
"display_title": {
"type": "string",
"nullable": true
},
"exchange": {
"description": "Venue-family key.",
"type": "string",
"example": "hyperliquid"
},
"is_active": {
"type": "boolean",
"nullable": true
},
"is_settled": {
"type": "boolean",
"nullable": true
},
"outcome_pair": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
},
"minItems": 2,
"maxItems": 2
},
"size_per_day": {
"type": "object",
"additionalProperties": {
"type": "number"
}
},
"slug": {
"description": "HIP-4 slug when available.",
"type": "string",
"nullable": true
},
"symbol": {
"type": "string",
"example": "BTC"
}
},
"additionalProperties": false
}
}
}
}
Status 400
Invalid requestapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "listSymbols 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"
},
"param": {
"description": "The parameter at fault, when the error is about one parameter.",
"type": "string"
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
},
"success": {
"description": "Always false on an error.",
"type": "boolean",
"example": false
}
}
}
OpenAPI example
{
"code": 400,
"error": "Failed to deserialize query string: limit: invalid digit found in string",
"error_code": "invalid_query_params",
"param": "limit",
"request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05",
"success": false
}
Status 429
Rate limit exceededapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "listSymbols 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"
},
"param": {
"description": "The parameter at fault, when the error is about one parameter.",
"type": "string"
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
},
"success": {
"description": "Always false on an error.",
"type": "boolean",
"example": false
}
}
}
OpenAPI example
{
"code": 429,
"error": "Rate limit exceeded"
}