User Guide

GetRobotList

The GetRobotList method returns the live trading bots of the platform account of the API KEY in the request. All parameters are optional.

Returns


            json
            
            
{
    "code": 0,
    "data": {
        "result": {
            "all": 1,
            "concurrent": 0,
            "robots": [{
                "charge_time": 1731654846,
                "date": "2024-11-12 14:05:29",
                "end_time": "2024-11-15 14:56:32",
                "fixed_id": 4509153,
                "id": 591026,
                "is_sandbox": 0,
                "name": "Test",
                "node_guid": "45891bcf3d57f99b08a43dff76ee1ea1",
                "node_id": 4519153,
                "node_public": 0,
                "profit": 0,
                "public": 0,
                "refresh": 1731651257000,
                "start_time": "2024-11-15 14:56:30",
                "status": 3,
                "strategy_id": 411670,
                "strategy_isowner": true,
                "strategy_language": 0,
                "strategy_name": "Test",
                "strategy_public": 0,
                "uid": "105ed6e511cc977921610fdbb7e2a1d6",
                "wd": 0
            }]
        },
        "error": null
    }
}

all: Total number of bots matching the filters.
robots: Live trading bot information; status is the live trading status code.
- group_id: Live trading bot group ID; if the live trading bot is in the default group, the group_id field is not included.

Arguments

Name	Type	Required	Description
offset	number	No	Paging offset, default 0.
length	number	No	Page size; less than or equal to 0 returns everything (default).
customStatus	number	No	Filter by live trading status code, see Live Trading Status Codes; `-1` returns all bots (default), `-2` returns all bots sorted by start time.
appId	string	No	Filter by the bot's custom label (`appid` in `settings` when it was created); an empty string means no filter.
kw	string	No	Keyword matched against bot names; an empty string means no filter.
groupId	number	No	Live trading group: `-1` all (default), `0` ungrouped, greater than 0 a specific group.
orderBy	string	No	Sort field: `name`, `status`, `node`, `profit`, `date`, `refresh`, `start_time`, `strategy_name`, optionally followed by `asc` for ascending order (default descending); an empty string keeps the default order.
strategyId	number	No	When greater than 0, only bots of this strategy are returned; default 0 (no filter).

Remarks

Using api() from the Python example on the signature authentication page:

api('GetRobotList'): all live trading bots.
api('GetRobotList', 'member2'): a single string is taken as the label; all bots labeled member2.
api('GetRobotList', 0, 100, -1, 'member2', ''): positional parameters; up to 100 bots labeled member2, starting at offset 0.
api('GetRobotList', appId='member2', length=100): the same by parameter name.