POST /heartbeat/v3 registers a timer that is meant to cancel
your resting orders if you do not send a heartbeat in time by calling the same endpoint
Arming and refreshing
Arming and refreshing are the same request. The body is one field,timeoutSeconds, from 0 to 3600.
When it lapses
Every open order is cancelled for your account. It has the same effect asDELETE /orders-v3/all. The cancels are asynchronous, so orders will be
cancelled shortly after with inactiveReason: "HEARTBEAT_TIMEOUT".
Stop the heartbeat
To clear the heartbeat, callPOST /heartbeat/v3 again with timeoutSeconds: 0. That
deactivates the timer.
Related
Set heartbeat
The
POST /heartbeat/v3 endpoint reference.Cancelling orders
The shutdown path that confirms each cancel.
Order lifecycle
Every way an order leaves the book, and how to distinguish them.