Service health
const url = 'https://api.hyperstream.dev/v2/health';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.hyperstream.dev/v2/healthGlobal liveness of the order pipeline. Not your readiness: use /v2/params for that.
Responses
Section titled “Responses”Healthy.
Liveness of the order pipeline, global across integrators.
object
degraded when the order store could not be read. The response is then a 503 with counts: null.
object
Every order ever built.
pending_deposit orders still inside their deposit window.
withdrawn_on_hub: settled, delivery not yet fully recorded.
Mid-flight orders that automated recovery has handed to an operator.
Orders whose deposit never arrived before expiry. No funds moved.
Settled 12h+ ago with a payout or refund leg still unrecorded. Counted inside withdrawn, not beside it.
Example
{ "status": "ok", "counts": { "totalOrders": 1250, "pending": 3, "deposited": 1, "published": 4, "partiallyFilled": 1, "terminalChain": 0, "withdrawn": 12, "delivered": 1180, "deliveryFailed": 0, "stuck": 0, "abandoned": 49, "undelivered": 0 }, "lastBuildAt": 1786999700, "lastWithdrawnAt": 1786999790}Unhandled failure. Retry once, then escalate with the x-request-id response header.
Maintenance, a malformed JSON body, or an unhandled failure. Carries message, not error.
object
MaintenanceException (503), BadRequestException (malformed JSON) or InternalErrorException (500).
Example
{ "message": "Internal Error", "name": "InternalErrorException"}The order store could not be read.
Liveness of the order pipeline, global across integrators.
object
degraded when the order store could not be read. The response is then a 503 with counts: null.
object
Every order ever built.
pending_deposit orders still inside their deposit window.
withdrawn_on_hub: settled, delivery not yet fully recorded.
Mid-flight orders that automated recovery has handed to an operator.
Orders whose deposit never arrived before expiry. No funds moved.
Settled 12h+ ago with a payout or refund leg still unrecorded. Counted inside withdrawn, not beside it.
Example
{ "status": "degraded", "counts": null, "lastBuildAt": null, "lastWithdrawnAt": null}