Equity Channel

Get the account equity data including BTC/USDT equity and unrealized P&L

Request Parameters

Parameter	Type	Required	Description
op	string	Yes	Operation, subscribe unsubscribe
args	list	Yes	List of channels to request subscription
> instType	string	Yes	Product type: USDT-FUTURES
> channel	string	Yes	Channel name: equity
> instId	string	No	Product ID (optional, use default)

Request Example

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

Response Example

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

Push Parameters

Parameter	Type	Description
action	string	Push data action
arg	object	Channels with successful subscription
> instType	string	Product type
> channel	string	Channel name
> instId	string	Product ID
data	object	Subscription data
> btcEquity	string	Account equity in BTC
> usdtEquity	string	Account equity in USDT
> unrealizedPL	string	Unrealized profit and loss
> totalMargin	string	Total margin (balance + unrealized)
> available	string	Available balance
ts	number	Push timestamp

Push Data

{
  "action": "snapshot",
  "arg": {
    "instType": "USDT-FUTURES",
    "channel": "equity",
    "instId": "default"
  },
  "data": {
    "btcEquity": "0.37037037",
    "usdtEquity": "10000.00",
    "unrealizedPL": "150.50",
    "totalMargin": "10150.50",
    "available": "8500.00"
  },
  "ts": 1695716761589
}