Skip to main content
GET
/
health
Get System Status
curl --request GET \
  --url https://api.tide.ag/health \
  --header 'X-API-KEY: <api-key>'
{
  "timestamp": 123,
  "adapters": {}
}
Get real-time health status of the Tide aggregation system and all connected exchange adapters. This endpoint provides operational status, performance metrics, and issue reporting.

​
Request

  • Method: GET
  • Endpoint: /health
  • Authentication: Not required
curl -X GET https://api.tide.ag/health \
  -H "Content-Type: application/json"

​
Status Levels

  • Operational: All systems functioning normally
  • Degraded: Some performance issues but service available
  • Partial Outage: Some services unavailable
  • Major Outage: Significant service disruption
  • Maintenance: Planned maintenance in progress

​
Exchange Adapter Status

Each exchange adapter reports:
  • Connection Status: Online/offline status
  • Latency: Current response times
  • Error Rates: Request failure percentages
  • Data Quality: Order book depth and update frequency
  • Trading Status: Order placement and execution capability

​
Performance Metrics

  • System Uptime: Overall system availability
  • Order Processing: Orders per second and success rates
  • Data Feeds: Update frequencies and data integrity
  • Response Times: API endpoint performance

​
Use Cases

  • Monitor system health before placing orders
  • Implement circuit breakers and fallback logic
  • Display service status in trading applications
  • Track historical system performance
Subscribe to our status page for real-time incident notifications and maintenance schedules.

Authorizations

​
X-API-KEY
string
header
required

Response

200 - application/json

System status and health information

​
status
enum<string>
Available options:
operational,
degraded,
partial_outage,
major_outage,
maintenance
​
timestamp
integer
​
adapters
object