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

Stops a robot of the account; stopping does not close positions.

Examples

Stop robot 123.

python
# api() is the function in the Python example on the signature authentication page r = api('StopRobot', 123) print(r['data']['result']) # output: 2 (stopping)

Returns

TypeDescription

number

data.result is the robot status code: 2 (stopping) means the stop command was sent to the docker; 4 (stopped) means the robot's docker has been deleted, so the robot was set to stopped directly; 3, 4 or 5 may also mean the robot had already ended.

Arguments

NameTypeRequiredDescription

robotId

number

Yes

Robot ID; see GetRobotList.

Remarks

While the robot is starting or stopping (robot is busy), or when its docker is offline (docker not found), an error with code 6 is returned.