Skip to main content



ApiProfile

API Profile

exchange object

Supported exchange

codestring

Exchange code.

Example: BINANCE
namestring

Exchange human readable name.

Example: BINANCE-SPOT
codestring

API profile code.

Example: 1234abcde
statusstring

API profile status.

Possible values: [active, no_assets, error, disabled]

Example: active
namestring

API profile name.

Example: My-API-Account
demoboolean

Is Demo trading API or not.

Example: false
balance object
assets objectnullable

Assets map

property name* object

Asset balance

freenumber

Free balance of the asset.

Example: 314.14
usednumber

Used balance of the asset.

Example: 0
totalnumber

Total balance of the asset.

Example: 314.14
collateral objectnullable

Collateral balance

freenumber

Free balance of the asset.

Example: 314.14
usednumber

Used balance of the asset.

Example: 0
totalnumber

Total balance of the asset.

Example: 314.14



ApiProfile
{
"exchange": {
"code": "BINANCE",
"name": "BINANCE-SPOT"
},
"code": "1234abcde",
"status": "active",
"name": "My-API-Account",
"demo": false,
"balance": {
"assets": {
"USDT": {
"free": 314.14,
"used": 0,
"total": 314.14
}
},
"collateral": {
"free": 314.14,
"used": 0,
"total": 314.14
}
}
}