User Guide

GetStrategyList

The GetStrategyList method is used to retrieve platform strategy information.

Returns


            json
            
            
{
    "code": 0,
    "data": {
        "result": {
            "all": 123,
            "strategies": [{
                "category": 9,
                "date": "2024-11-10 20:40:04",
                "description": "",
                "forked": 0,
                "hits": 0,
                "id": 123,
                "is_buy": false,
                "is_owner": false,
                "language": 0,
                "last_modified": "2024-11-11 17:23:52",
                "name": "HedgeGridStrategy",
                "profile": {
                    "avatar": "...",
                    "nickname": "abc",
                    "uid": "4ed225440db1eda23fe05ed10184113e"
                },
                "public": 0,
                "tags": "",
                "uid": "4ed225440db1eda23fe05ed10184113e",
                "username": "abc"
            }]
        },
        "error": null
    }
}

all: Total number of strategies matching the filter criteria.
strategies: Detailed information of the strategies found; category and language take the values described in the parameters above.

Arguments

Name	Type	Required	Description
offset	number	Yes	Paging offset.
length	number	Yes	Page size; less than or equal to 0 returns everything.
strategyType	number	Yes	Scope of the query: `-1`: your own and rented strategies (official strategies included). `0`: your own and rented strategies (official strategies excluded). `-3`: only your own strategies. `-6`: only rented strategies (expired ones included). `-4`: official strategies. `-2`: public and paid strategies in the Strategy Square. `1`: published strategies. `2`: strategies pending review.
category	number	Yes	Strategy type: `-1`: all. `0`: ordinary strategies. `20`: template libraries. `21`: trading plugins.
language	number	Yes	Programming language of the strategy: `-1`: all languages. `0`: JavaScript (TypeScript strategies are stored as JavaScript with a `//@ts-check` line in the source). `1`: Python. `3`: Blockly. `4`: MyLanguage. `5`: PINE. `6`: Workflow. `7`: Rust.
kw	string	Yes	Keywords matched against strategy names, separated by spaces; an empty string means no filter. Starting with `id:` queries by strategy ID, e.g. `id:123,456`.
groupId	number	No	Strategy group: `-1` all (default), `0` ungrouped, greater than 0 a specific group. Only applies to your own strategies.
orderBy	string	No	Sort field: `name`, `last_modified`, `date`, optionally followed by `asc` for ascending order (default descending); an empty string keeps the default order.

Remarks

There is no needArgs parameter. Passing an extra parameter after category, as older documentation did, shifts all following parameters; pass them in the order above, or by name:


            plaintext
            
            
api('GetStrategyList', 0, 10, -3, -1, -1, '')           # first 10 of your own strategies
api('GetStrategyList', strategyType=-3, language=7)     # all of your own Rust strategies