Skip to main content

Stop Grid Bot (MCP Tool)

Description​

Based on: /docs/rest-api/stop-grid-bot

Set stopCondition to stop_only to leave positions open, stop_and_close_all to request closing them, or stop_and_close_all_and_convert_to_profit_currency to also convert proceeds (spot only). For webhook bots, awaitStartSignal: true allows another start alert; the cabinet form defaults to true, while this API defaults to false. If 2FA is enabled, send twoFactorCode; 2faComplete: false means no state change. Position closing is asynchronous.

Required permission: grid_bot:write.

Prompt example

Stop Grid Bot bot-code and close its positions.

Input Schema​

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "minLength": 1,
      "description": "Code that identifies the bot, available in bot list results."
    },
    "stopCondition": {
      "type": "string",
      "enum": [
        "stop_only",
        "stop_and_close_all",
        "stop_and_close_all_and_convert_to_profit_currency"
      ],
      "description": "Stop only keeps positions; stop and close requests closing; close and convert also converts proceeds to the configured profit currency and is spot only."
    },
    "awaitStartSignal": {
      "type": "boolean",
      "description": "For webhook alert bots: true allows a future start alert after stopping. The cabinet form defaults to true; this API defaults to false if omitted."
    },
    "twoFactorCode": {
      "type": "string",
      "description": "Current authenticator code if two-factor authentication is enabled for this account."
    }
  },
  "required": [
    "code",
    "stopCondition"
  ],
  "additionalProperties": false
}