Type/to search
Getting Started
Platform Basics
Writing Strategies
Development Tools
Backtesting System
Advanced Topics
Data and Research
Extended API Interface
AI Integration
Create ApiKey
Authentication Methods
Extended API Interface Details
GetAccount
GetNodeList
DeleteNode
GetExchangeList
GetPlatformList
GetStrategyList
GetRobotGroupList
GetRobotList
GetRobotDetail
GetRobotLogs
NewRobot
RestartRobot
StopRobot
CommandRobot
DeleteRobot
PluginRun
pub
Extended API Interface Return Codes
Live Trading Status Codes

Deletes a robot of the account; a running robot must be stopped first, and deletion cannot be undone.

Examples

Delete the stopped robot 123 together with its log data on the docker.

python
# api() is the function in the Python example on the signature authentication page r = api('DeleteRobot', robotId=123, removeLog=True) print(r['data']['result']) # output: 0 (deleted)

Returns

TypeDescription

number

data.result: 0 deleted; -1 not deleted (the robot does not exist, or is running, starting or stopping); -2 the robot was deleted but its docker could not be reached, so the log data was not deleted and must be removed by hand from logs/storage/<robotId>/ in the docker directory (e.g. 123.db3).

Arguments

NameTypeRequiredDescription

robotId

number

Yes

Robot ID; see GetRobotList.

removeLog

bool

No

Whether to delete the robot's log data on the docker as well. Defaults to true when passed by name, and to false when only [robotId] is passed by position. Passing it explicitly is recommended.