Skip to main content
This endpoint verifies that the BlackSwan API is online and reachable. It returns a simple status string and a Unix timestamp so you can confirm both availability and server-side time. No authentication or parameters are required — making it ideal for lightweight uptime checks and pre-flight validation.

​
Endpoint

​
Request Example

​
Response — 200 OK

​
string
Indicates the current availability of the API. Returns "ok" when the service is healthy and accepting requests.
​
number
The server-side Unix timestamp (seconds since epoch) at the time the health check was processed. You can use this to verify time synchronization between your system and the BlackSwan API.
Integrate this endpoint into your uptime monitoring pipeline (e.g. Datadog, Better Uptime, or a simple cron job) to get alerted the moment the BlackSwan API becomes unreachable. It’s also good practice to call /health before issuing a batch of credit queries — if it returns anything other than "status": "ok", hold off on downstream requests until the service recovers.

​
Error Codes