Kardlane
API Reference

Pause the bot on a trade

POSThttps://api.kardlane.com/v1/trades/{id}/pause

Hold everything where it is. The bot keeps listening — vendor messages are still recorded — but sends nothing and decides nothing, and its clocks stop: rate deadlines and the confirmation timeout are pushed back by the time paused.

Authorization#

Authorizationheaderrequired

Bearer token: Bearer <your project API key>. Create keys in the dashboard under your project’s Integration page.

Path parameters#

idstringrequired

The trade.

Body#

bystring

Who is pausing it (shown on the timeline as “… (API)”).

Responses#

200Paused.
409Not possible now (already paused, stopped or finished).
curl -X POST https://api.kardlane.com/v1/trades/6abea25d-0c1f-4a43-9d1e-3b5c2f0edad5/pause \
  -H "Authorization: Bearer $KARDLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "by": "ops@yourcompany.com"
  }'
{
  "tradeId": "6abea25d-0c1f-4a43-9d1e-3b5c2f0edad5",
  "status": "UPLOADED",
  "bot": {
    "state": "paused",
    "pausedAt": null,
    "pausedBy": "ops@yourcompany.com (API)",
    "pauseScope": "trade",
    "stoppedAt": null,
    "stoppedBy": null,
    "canPause": false,
    "canResume": true,
    "canStop": true,
    "resumeBlocked": null
  }
}