Trading heartbeat

POST/api/v1/orders/heartbeatBearer

Trading APIprice E4 · size E2 · amount E6 (integers)YES | NO

A market maker sends a heartbeat at intervals declaring which markets to protect; if it lapses, the exchange cancels every resting order in those markets on their behalf. This returns 200, not 202 — it is not a command; the deadline is written to the registry synchronously. The client logic is one line: send one every timeout/3. timeoutSeconds has deployment-level bounds (5s–300s by default), and marketIds is capped at 64 by default and deduplicated. Where the feature is switched off the response is 501 `heartbeat_disabled`, not 400.

Send Authorization: Bearer <token>. The token is issued by POST /api/v1/auth/verify, and expires after 24h idle or 7d after issuance.

Request body

timeoutSecondsintegerrequired
Your choice within the deployment's bounds (5s–300s by default); send one every timeout/3
Example1
marketIdsstring[]required
Explicit list of the markets to protect (capped at 64 by default, deduplicated automatically)

Response

200Protection is in effect

expiresAtSint64
Deadline for this heartbeat (epoch seconds)
Example1758240000
marketIdsstring[]
The list of protected markets actually in effect

Switch status codes in the response example to view errors. For all codes, see the Errors page.

Request

curl -X POST "$BASE_URL/api/v1/orders/heartbeat" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "timeoutSeconds": 1,
    "marketIds": [
      "mkt-0001",
      "mkt-0002"
    ]
  }'

Response

Protection is in effect

{
  "expiresAtS": 1758240000,
  "marketIds": [
    "mkt-0001",
    "mkt-0002"
  ]
}