Skip to main content

Account Channel

Get the account balance and margin information

Request Parameters

ParameterTypeRequiredDescription
opstringYesOperation, subscribe unsubscribe
argslistYesList of channels to request subscription
> instTypestringYesProduct type: USDT-FUTURES
> channelstringYesChannel name: account
> instIdstringNoProduct ID (optional, use default)

Request Example

{
"op": "subscribe",
"args": [
{
"instType": "USDT-FUTURES",
"channel": "account",
"instId": "default"
}
]
}

Response Example

{
"event": "subscribe",
"arg": {
"instType": "USDT-FUTURES",
"channel": "account",
"instId": "default"
}
}

Push Parameters

ParameterTypeDescription
actionstringPush data action
argobjectChannels with successful subscription
> instTypestringProduct type
> channelstringChannel name
> instIdstringProduct ID
dataobjectSubscription data
> marginCoinstringMargin coin (USDT)
> lockedstringLocked balance
> availablestringAvailable balance
> crossedMaxAvailablestringMax available for cross margin
> isolatedMaxAvailablestringMax available for isolated margin
> maxTransferOutstringMax transferable amount
> accountEquitystringAccount equity
> unrealizedPLstringUnrealized profit and loss
> couponstringCoupon balance
tsnumberPush timestamp

Push Data

{
"action": "snapshot",
"arg": {
"instType": "USDT-FUTURES",
"channel": "account",
"instId": "default"
},
"data": {
"marginCoin": "USDT",
"locked": "500.00",
"available": "8500.00",
"crossedMaxAvailable": "8500.00",
"isolatedMaxAvailable": "8500.00",
"maxTransferOut": "8500.00",
"accountEquity": "10000.00",
"unrealizedPL": "150.50",
"coupon": "0"
},
"ts": 1695716761589
}