Create a bot
create_botCreate and start an automated trading bot from an account script, selecting exchanges and paper or live mode; paper is default, live trades real funds.
Instructions
Creates and starts a bot running one of the account's scripts. Answers 409 if the name is taken and 403 if the plan's bot limit is reached, naming the limit. Mode defaults to paper; sim settings are refused on a live bot rather than ignored. A live bot trades real funds.
Requires the bots:write scope.
Rate limit: 30 requests per minute for your key, shared across every tool in the control-plane group. Changing configuration is metered far more tightly than reading it. Creating, reconfiguring, stopping and deleting all share this budget, so make one considered change rather than a sequence of adjustments.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sim | No | Simulator settings, for a paper bot only. Refused on a live bot. | |
| mode | No | Paper simulates; live trades real funds. Defaults to paper. | |
| name | Yes | Name for the new bot: 3 to 22 characters of lowercase letters, digits and dashes, starting and ending with a letter or digit. Must be unused. Stored lower-cased; later tools take the name this answers with. | |
| config | No | Overrides for the script's own settings, for this bot only. Checked against the script. | |
| script | Yes | The script's name. | |
| exchanges | Yes | Venues this bot trades on. | |
| killSwitch | No | Per-market loss limit. A bare number is the limit for every market; the object form is {"currency": "USDT", "max_loss": 250, "limits": {"binance_spot:BTCUSDT": 100}} — note max_loss is snake_case. The first market to exceed its limit ends the run for good. |