Skip to main content
The Health Check endpoint allows you to verify the API service status before making trading requests.

Endpoint

Request

No authentication is required for the health check endpoint.

Response

Response Fields

Use Cases

Pre-flight Check

Before initiating trading operations, verify the API is healthy:

Monitoring

Use the health endpoint for:
  • Load balancer health checks - Configure your load balancer to poll this endpoint
  • Alerting systems - Set up alerts when the endpoint fails
  • Dashboard status - Display real-time service status in your application

Best Practices

  1. Don’t over-poll - Check health at reasonable intervals (e.g., every 30 seconds)
  2. Implement retry logic - Transient failures can occur; retry before alerting
  3. Cache results - Don’t check health before every API call
  4. Handle gracefully - If health check fails, queue operations and retry later