Health
Liveness
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/healthz" \
-H "Authorization: Bearer YOUR_API_KEY"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.
Response Body
application/json
curl -X GET "https://api.fxapis.com/healthz"{ "status": "string"}What is paying for the plan GET
The workspace's subscription, if it has one: plan, card or crypto, status, the current paid period and whether it ends at period end. Null when nothing is being paid for.
Readiness GET
Says the API can serve traffic right now, including storing and using account credentials. Returns 503 when it cannot.