Stop a bot

POST https://rest.haasapi.com/v1/bots/{bot_id}/stop

Deactivates the bot. Open orders are left on the exchange (the same default the app uses). Idempotent: stopping a bot that is already stopped succeeds.

Requires the bots scope.

Example request

curl "https://rest.haasapi.com/v1/bots/{bot_id}/stop" \
  -X POST \
  -H "Authorization: Bearer hk_live_YOUR_KEY" \
  --data ""

Response

200 OK. Returns a BotAction.

{
  "bot_id": "e7bfbc5292494679bde177d0c1601e65",
  "is_activated": false
}

Fields

BotAction

Field	Type	Description
`bot_id`	string	The bot the action applied to.
`is_activated`	boolean	Whether the bot is activated after this call: true after start, false after stop.

Errors

All errors are RFC 9457 problem documents.

Status	Description
`400`	The request is malformed (invalid limit, unusable cursor, …). (`code: invalid_request`)
`401`	Missing, malformed, disabled, or revoked API key. (`code: invalid_api_key`)
`404`	No accessible bot with that id. (`code: bot_not_found`)
`409`	A request with this Idempotency-Key is still being processed. (`code: idempotency_in_progress`)
`422`	The Idempotency-Key was already used with a different request. (`code: idempotency_key_reuse`)
`500`	An unexpected error inside the API. Nothing about the request caused it; retry, and quote the instance value if it persists. (`code: internal_error`)
`502`	An internal service answered in a way the API could not serve. Retry. (`code: upstream_error`)
`503`	The request could not be served right now. Retry with the same key - do not discard it. (`code: temporarily_unavailable`)
`504`	An internal service did not answer within the deadline. Retry with backoff. (`code: upstream_timeout`)

{
  "type": "https://docs.haasapi.com/errors/invalid_request",
  "title": "Invalid request",
  "status": 400,
  "detail": "The request is malformed (invalid limit, unusable cursor, …).",
  "code": "invalid_request"
}