Skip to main content

Account channel

Description

Subscribe account channel

Data will be pushed when the following events occurred:

  1. Transfer balance to Futures account
  2. Trading voucher deposit
  3. Open/close orders are filled
Request Example
{
"op": "subscribe",
"args": [
{
"instType": "USDT-FUTURES",
"channel": "account",
"coin": "default"
}
]
}

Request Parameters

ParameterTypeRequiredDescription
opStringYesOperation, subscribe unsubscribe
argsList<Object>YesList of channels to request subscription
> instTypeStringYesProduct type
USDT-FUTURES USDT professional futures
COIN-FUTURES Mixed futures
USDC-FUTURES USDC professional futures
SUSDT-FUTURES USDT professional futures demo
SCOIN-FUTURES Mixed futures demo
SUSDC-FUTURES USDC professional futures demo
> channelStringYesChannel name
> coinStringYesCoin name,default represents all the coins,Only default is supported now
Response Example
{
"event": "subscribe",
"arg": {
"instType": "USDT-FUTURES",
"channel": "account",
"coin": "default"
}
}

Response Parameters

ParameterTypeDescription
eventStringYes
Operation
argObjectSubscribed channels
> instTypeStringProduct type
USDT-FUTURES USDT professional futures
COIN-FUTURES Futures settled in cryptocurrencies
USDC-FUTURES USDC professional futures
SUSDT-FUTURES USDT professional futures demo trading
SCOIN-FUTURES Futures settled in cryptocurrencies demo traing
SUSDC-FUTURES USDC professional futures demo trading
> channelStringChannel name
> coinStringdefault
codeStringError code
msgStringError message
Push Data
{
"action": "snapshot",
"arg": {
"instType": "USDT-FUTURES",
"channel": "account",
"coin": "default"
},
"data": [
{
"marginCoin": "USDT",
"frozen": "0.00000000",
"available": "11490.16841069",
"maxOpenPosAvailable": "10940.45841069",
"maxTransferOut": "10940.45841069",
"equity": "11489.96841069",
"usdtEquity": "11489.968410691679"
}
],
"ts": 1695717225146
}

Push Parameters

ParameterTypeDescription
argObjectChannels to request subscription
> instTypeStringProduct type
USDT-FUTURES USDT professional futures
COIN-FUTURES Futures settled in cryptocurrencies
USDC-FUTURES USDC professional futures
SUSDT-FUTURES USDT professional futures demo trading
SCOIN-FUTURES Futures settled in cryptocurrencies demo traing
SUSDC-FUTURES USDC professional futures demo trading
> channelStringChannel name
> coinStringdefault
dataList<Object>Subscription data
>marginCoinStringMargin coin
>frozenStringLocked quantity (margin coin)
>availableStringCurrently available assets
>maxOpenPosAvailableStringMaximum available balance to open positions
>maxTransferOutStringMaximum transferable amount
>equityStringAccount assets
>usdtEquityStringAccount equity in USD

How was your Reading Experience with us?