> ## Documentation Index
> Fetch the complete documentation index at: https://docs.quantcite.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Health Check

> Check system health status and active exchange count

Returns the current health status of the QuantCite API, including active exchange count and system version information.

This endpoint provides a quick way to verify that the API is operational and get basic system statistics without requiring authentication.

### Response

<ResponseField name="status" type="string">
  Current system health status. Always returns "healthy" when the API is operational.
</ResponseField>

<ResponseField name="websocket_endpoint" type="string">
  The WebSocket endpoint path for establishing real-time connections.
</ResponseField>

<ResponseField name="active_exchanges" type="number">
  Number of cryptocurrency exchanges currently active and providing data.
</ResponseField>

<ResponseField name="timestamp" type="string">
  ISO 8601 timestamp of when the health check was performed.
</ResponseField>

<ResponseField name="version" type="string">
  Current version of the QuantCite API.
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl "https://data.quantcite.com/api/v1/health"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://data.quantcite.com/api/v1/health');
  const healthData = await response.json();
  console.log('API Status:', healthData.status);
  ```

  ```python Python theme={null}
  import requests

  response = requests.get('https://data.quantcite.com/api/v1/health')
  health_data = response.json()
  print(f"API Status: {health_data['status']}")
  print(f"Active Exchanges: {health_data['active_exchanges']}")
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "status": "healthy",
    "websocket_endpoint": "/api/v1/ws", 
    "active_exchanges": 52,
    "timestamp": "2025-08-29T21:08:53.451737",
    "version": "2.0.0"
  }
  ```
</ResponseExample>

## Use Cases

* **System Monitoring**: Check if the API is operational before making WebSocket connections
* **Exchange Status**: Monitor how many exchanges are currently providing data
* **Version Tracking**: Verify which version of the API is running
* **Uptime Checks**: Automated health monitoring for production systems

<Note>
  This endpoint does not require authentication and can be called freely without counting against your rate limits or data usage.
</Note>