GET /api/v1/
Returns general API information and WebSocket endpoints.
Request
curl "https://data.quantcite.com/api/v1/"
Response
{
"message": "This API uses WebSocket-only communication for real-time data",
"websocket_endpoint": "/api/v1/ws?api_key=YOUR_API_KEY",
"authentication": {
"required": true,
"method": "API Key",
"parameter": "api_key (query parameter)"
},
"connection_example": "wss://data.quantcite.com/api/v1/ws?api_key=your_api_key",
"features": [
"Real-time aggregated orderbook across multiple exchanges",
"WebSocket-based streaming data",
"50GB monthly data limits per API key",
"Multi-exchange subscription management"
]
}
Response Fields
| Field | Type | Description |
|---|
message | string | Brief description of the API |
websocket_endpoint | string | WebSocket connection endpoint pattern |
authentication | object | Authentication requirements and method |
connection_example | string | Example WebSocket connection URL |
features | array | List of key API features |
Authentication Object
| Field | Type | Description |
|---|
required | boolean | Whether authentication is required |
method | string | Authentication method used |
parameter | string | How to provide the API key |
Usage Example
This endpoint is useful for API discovery and getting connection information:
import requests
def get_api_info():
"""Get QuantCite API information"""
response = requests.get("https://data.quantcite.com/api/v1/")
if response.status_code == 200:
data = response.json()
print("QuantCite API Information:")
print(f"- {data['message']}")
print(f"- WebSocket: {data['websocket_endpoint']}")
print(f"- Authentication: {data['authentication']['method']}")
print("\nFeatures:")
for feature in data['features']:
print(f" • {feature}")
return data
else:
print(f"Error: {response.status_code}")
return None
# Get API information
api_info = get_api_info()
Error Handling
HTTP Status Codes
| Code | Description |
|---|
200 | Success - API information returned |
500 | Internal Server Error |
Error Response
{
"error": "internal_server_error",
"message": "Unable to retrieve API information",
"timestamp": "2025-09-18T10:30:00.000Z"
}
This endpoint provides general information about the API and is typically used for service discovery and initial connection setup.
