post
https://sandbox.kyan.sh/heartbeat
Send a heartbeat ping to keep your orders alive. If no heartbeat is received within the configured timeout period, all open orders for the maker are automatically cancelled.
This acts as a dead man's switch for automated trading systems: if your bot crashes or loses connectivity, your orders are cancelled to prevent stale orders sitting on the book.
How it works:
- Call
POST /heartbeatwith your desiredtimeout(in seconds) - The server records the heartbeat configuration and last ping time
- Continue calling periodically (before the timeout expires)
- If a ping is missed beyond the timeout, all your open orders are cancelled
Authentication Options:
- Signature: Include
signatureandsignature_deadlinefields (uses EIP-712HeartbeatType) - One-click session: Include
x-one-clickheader with session hash (no signature needed)
Replay Protection:
When using signatures, the signature_deadline must be strictly greater than the last accepted deadline for this maker (deadline monotonicity). This prevents replay attacks without requiring per-call nonce storage. Deadlines are also bounded to at most 30 seconds in the future.
