Docs
Health

Readiness

Request

Synthetic example for the production API. Replace YOUR_API_KEY and the ids. Do not send it against a live account until you mean to.

curl -X GET "https://api.fxapis.com/readyz" \
  -H "Authorization: Bearer YOUR_API_KEY"
GET
/readyz

Says the API can serve traffic right now, including storing and using account credentials. Returns 503 when it cannot.

Response Body

application/json

application/json

curl -X GET "https://api.fxapis.com/readyz"
{  "status": "string",  "checks": {    "property1": "string",    "property2": "string"  }}

Liveness GET

Says the fxapis API process is up, for liveness probes and uptime monitors. Checks nothing else and never returns anything but 200; use /readyz to know whether it can serve traffic.