Endpoint
Request
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
- Don’t over-poll - Check health at reasonable intervals (e.g., every 30 seconds)
- Implement retry logic - Transient failures can occur; retry before alerting
- Cache results - Don’t check health before every API call
- Handle gracefully - If health check fails, queue operations and retry later