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

Gets the exchanges the platform supports and the configuration fields each of them needs.

Examples

List the supported exchange IDs and names (summary).

python
# api() is the function in the Python example on the signature authentication page r = api('GetExchangeList', True) for e in r['data']['result']['exchanges']: print(e['eid'], e['name'])

Returns

TypeDescription

object

On success data.result.exchanges is the array of exchanges; fields are in the attributes table below.

Arguments

NameTypeRequiredDescription

isSummary

bool

Yes

true returns only summary information, without meta and stocks; false returns everything.

Attributes

NameTypeDescription

exchanges[].eid

string

Exchange ID, e.g. Futures_Binance; used when a robot configuration passes an exchange configuration directly.

exchanges[].name

string

Display name, written Chinese|English.

exchanges[].category

string

Category.

exchanges[].meta

string

Metadata of the exchange's configuration fields (JSON text), returned only when isSummary is false; the field names of meta in a robot configuration come from here.

exchanges[].stocks

string

Common trading pairs, comma-separated, returned only when isSummary is false.

Remarks

Example response (isSummary false)
json
{ "code": 0, "data": { "result": { "exchanges": [{ "category": "加密货币||Crypto", "eid": "Futures_Binance", "id": 74, "logo": "/upload/asset/d8d84b23e573e9326b99.svg", "meta": "[...]", "name": "币安期货|Futures_Binance", "priority": 200, "stocks": "BTC_USDT,ETH_USDT,ETH_USD", "website": "https://accounts.binance.com/zh-TC/register?ref=45110270" }] }, "error": null } }

meta is JSON text; parsed, it is an array of configuration fields:

json
[ {"desc": "Access Key", "qr": "apiKey", "required": true, "type": "string", "name": "AccessKey", "label": "Access Key"}, {"encrypt": true, "qr": "secretKey", "name": "SecretKey", "required": true, "label": "Secret Key", "type": "password", "desc": "Secret Key"} ]

Example response (isSummary true)
json
{ "code": 0, "data": { "result": { "exchanges": [{ "category": "加密货币||Crypto", "eid": "Futures_Binance", "id": 74, "logo": "/upload/asset/d8d84b23e573e9326b99.svg", "name": "币安期货|Futures_Binance", "priority": 200, "website": "https://accounts.binance.com/zh-TC/register?ref=45110270" }] }, "error": null } }