Skip to main content
POST
Send orders heartbeat
A safety mechanism: send a heartbeat with a timeout (in seconds). If the next heartbeat is not received within timeout seconds, all of your open orders are cancelled. Use this endpoint in any client that places resting orders — if your process crashes or loses connectivity, the heartbeat ensures stale orders get pulled instead of staying on the book.

Request

POST /user/ordersHeartbeat
integer
required
Cancel-after timeout, in seconds. Must be greater than 5.

Response

The response is forwarded from the orders service:

Errors

Authorizations

Authorization
string
header
required

Pass your auth token in the Authorization header. The Bearer prefix is optional; the server also accepts a signed auth cookie or a token field in the request body.

Body

application/json
timeout
integer
required

Cancel-after timeout, in seconds.

Required range: x >= 6

Response

Heartbeat acknowledged. The response shape is forwarded from the orders service.