Balance

Topic:/contractAccount/wallet

Description

You will receive this message when an account balance changes. The message contains the details of the change.

After the user 【First time】switches the margin mode (switching from isolated margin to cross margin), the following subjects of this topic will stop pushing

"subject": "orderMargin.change",

"subject": "availableBalance.change",

"subject": "withdrawHold.change",

Use the following subject to replace

"subject": "walletBalance.change"

Push frequency: real-time

{
  "id": 1545910660739,
  "type": "subscribe",
  "topic": "/contractAccount/wallet",
  "response": true,
  "privateChannel": "true"
}

Response

Data Schema

balance

topic

string

required

type

string

required

subject

string

required

string

required

userId

string

required

channelType

string

required

data

object

required

currency

string

required

Currency Symbol

equity

string

required

Equity

walletBalance

string

required

Wallet Balance

availableBalance

string

required

Available Balance

holdBalance

string

required

Frozen Balance

totalCrossMargin

string

required

Total margin under cross margin mode

crossPosMargin

string

required

Margin of the cross margin position

crossOrderMargin

string

required

Margin of the cross margin order

crossUnPnl

string

required

Unrealized PNL in cross margin mode

isolatedPosMargin

string

required

Margin of the isolated margin position, including isolated margin funding fees

isolatedOrderMargin

string

required

Margin of the isolated margin order

isolatedFundingFeeMargin

string

required

Isolated margin funding fee

isolatedUnPnl

string

required

Unrealized PNL in isolated margin mode

version

string

required

Version. When holding a cross margin position, the available balance may change with fluctuations in the mark price, leading to discrepancies in the available balance for the same version number.

timestamp

string

required

Last modified time

Example

//Asset Overview by Currency Push
{
    "topic": "/contractAccount/wallet",
    "type": "message",
    "subject": "walletBalance.change",
    "id": "67c811885b87be0001a4880e",
    "userId": "633559791e1cbc0001f319bc",
    "channelType": "private",
    "data": {
        "crossPosMargin": "17.551016",
        "isolatedOrderMargin": "0",
        "holdBalance": "0",
        "equity": "387.224858816",
        "version": "2118",
        "availableBalance": "285.652001096",
        "isolatedPosMargin": "63.98342359",
        "maxWithdrawAmount": "285.645841096",
        "walletBalance": "371.394298816",
        "isolatedFundingFeeMargin": "2.89220199",
        "crossUnPnl": "2.95996",
        "totalCrossMargin": "310.370835226",
        "currency": "USDT",
        "isolatedUnPnl": "12.8706",
        "crossOrderMargin": "10.06002012",
        "timestamp": "1741164936624"
    }
}

//Order Margin Event(Deprecate)
{
  "userId": "xbc453tg732eba53a88ggyt8c", // Deprecated, will detele later
  "topic": "/contractAccount/wallet",
  "subject": "orderMargin.change",
  "data": {
    "orderMargin": 5923, //Current order margin
    "currency": "USDT", //Currency
    "timestamp": 1553842862614
  }
}
 
//Available Balance Event(Deprecate)
{
  "userId": "xbc453tg732eba53a88ggyt8c", // Deprecated, will detele later
  "topic": "/contractAccount/wallet",
  "subject": "availableBalance.change",
  "data": {
    "availableBalance": 5923, //Current available amount
    "holdBalance": 2312, //Frozen amount = positionMargin + orderMargin + frozenFunds
    "currency": "USDT", //Currency
    "timestamp": 1553842862614
  }
}
      
//Withdrawal Amount & Transfer-Out Amount Event(Deprecate)
{
  "userId": "xbc453tg732eba53a88ggyt8c", // Deprecated, will detele later
  "topic": "/contractAccount/wallet",
  "subject": "withdrawHold.change",
  "data": {
    "withdrawHold": 5923, // Current frozen amount for withdrawal
    "currency": "USDT", //Currency
    "timestamp": 1553842862614
  }
}

Request

Query Params

token

string

required

The token required to establish a websocket connection

Example:

2neAiuYvAU737TOajb2U3uT8AEZqSWYe0fBD4LoHuXJDSC7gIzJiH4kNTWhCPISWo6nDpAe7aUaaHJ4fG8oRjFgMfUI2sM4IySWHrBceFocY8pKy2REU1HwZIngtMdMrjqPnP-biofFWbNaP1cl0X1pZc2SQ-33hDH1LgNP-yg-Wt-I9quoduuP419Vg1VTH.Yo6N4Kw984ZF0vzkbXMdHw==

connectId

string

optional

Connection Id, a unique value taken from the client side. Both the id of the welcome message and the id of the error message are connectId.

Example:

121345

Topic:/contractAccount/wallet#

Subscribe Message#

Response#

Request

Topic:/contractAccount/wallet

Subscribe Message

Response