Get All Sub-Accounts Balance - Futures
HTTP REQUEST
GET /api/v1/account-overview-all
Example
GET /api/v1/account-overview-all?currency=USDT
{
"success": true,
"code": "200",
"msg": "success",
"retry": false,
"data": {
"summary": {
"accountEquityTotal": 9.99,
"unrealisedPNLTotal": 0,
"marginBalanceTotal": 9.99,
"positionMarginTotal": 0,
"orderMarginTotal": 0,
"frozenFundsTotal": 0,
"availableBalanceTotal": 9.99,
"currency": "USDT"
},
"accounts": [
{
"accountName": "main",
"accountEquity": 9.99,
"unrealisedPNL": 0,
"marginBalance": 9.99,
"positionMargin": 0,
"orderMargin": 0,
"frozenFunds": 0,
"availableBalance": 9.99,
"currency": "USDT"
},
{
"accountName": "subacct",
"accountEquity": 0,
"unrealisedPNL": 0,
"marginBalance": 0,
"positionMargin": 0,
"orderMargin": 0,
"frozenFunds": 0,
"availableBalance": 0,
"currency": "USDT"
}
]
}
}
API KEY PERMISSIONS
This endpoint requires the General permission.
REQUEST URL
This endpoint support Futures URL
REQUEST RATE LIMIT
Futures weight
:6
PARAMETERS
Param | Type | Mandatory | Description |
---|---|---|---|
currency | String | No | Currecny ,including XBT,USDT,Default XBT |
RESPONSES
Param | Description |
---|---|
accountEquityTotal | Total Account Equity |
unrealisedPNLTotal | Total unrealisedPNL |
marginBalanceTotal | Total Margin Balance |
positionMarginTotal | Total Position margin |
orderMarginTotal | Total Order Margin |
frozenFundsTotal | Total frozen funds for withdrawal and out-transfer |
availableBalanceTotal | total available balance |
accountName | Account name, main account is main |
accountEquity | Account Equity = marginBalance + unrealisedPNL |
unrealisedPNL | unrealisedPNL |
marginBalance | Margin Balance = positionMargin + orderMargin + frozenFunds + availableBalance - unrealisedPNL |
positionMargin | Position margin |
orderMargin | Order Margin |
frozenFunds | Frozen funds for withdrawal and out-transfer |
availableBalance | Available balance |
currency | currency |