API ReferenceWebSocket APITrade Actions
WS Action: Health
Keepalive and health checks.
Alpha Version
The Ostium Builder Service is in Alpha. API endpoints, specifications, and builder URLs may change without notice. Use with caution in production environments.
Action: health
The health action is a lightweight keepalive. No headers or payload required.
Request Envelope
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Client-provided ID for correlation. |
action | string | Yes | Always health. |
Example
{ "id": "ping-1", "action": "health" }Response
{
"id": "ping-1",
"ok": true,
"data": {
"status": "healthy",
"endpoint": "exchange",
"version": "v1",
"timestamp": "2026-02-05T12:34:56.789Z"
}
}