Private

Equity Channel

Description

Subscribe equity channel

Data will be pushed when the following events occurred:

Transfer balance to Futures account
Trading voucher deposit
Open/close orders are filled


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

Request Parameters

Parameter	Type	Required	Description
op	String	Yes	Operation, subscribe unsubscribe
args	List<Object>	Yes	List of channels to request subscription
> instType	String	Yes	Product type `USDT-FUTURES` USDT-M Futures `COIN-FUTURES` Coin-M Futures `USDC-FUTURES` USDC-M Futures
> channel	String	Yes	Channel name


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

Response Parameters

Parameter	Type	Description
event	String	Yes Operation
arg	Object	Subscribed channels
> instType	String	Product type `USDT-FUTURES` USDT-M Futures `COIN-FUTURES` Coin-M Futures `USDC-FUTURES` USDC-M Futures
> channel	String	Channel name
> instId	String	Product ID `default`
code	String	Error code
msg	String	Error message


Code
{
  "action": "snapshot",
  "arg": {
    "instType": "USDT-FUTURES",
    "channel": "equity",
    "instId": "default"
  },
  "data": [
    {
      "btcEquity": "0.0021",
      "usdtEquity": "13.985457617660",
      "usdtUnrealized": "0.000000000000",
      "unionTotalMargin": "100",
      "unionAvailable": "11",
      "unionMm": "11"
    }
  ],
  "ts": 1695717225146
}

Push Parameters

Parameter	Type	Description
action	String	action, `snapshot`
arg	Object	Channel
> instType	String	Product type `USDT-FUTURES` USDT-M Futures `COIN-FUTURES` Coin-M Futures `USDC-FUTURES` USDC-M Futures
> channel	String	Channel name
> instId	String	Product ID `default`
data	List<Object>	Subscribed data
>usdtEquity	String	Account equity (USDT)
>btcEquity	String	Account equity (BTC)
>usdtUnrealized	String	Unrealized profit and loss （USDT）
>unionTotalMargin	String	Total multi-asset margin
>unionAvailable	String	Available balance under multi-asset margin mode
>unionMm	String	Maintenance margin under multi-asset margin mode

Account channel Fill Channel

Parameter

Type

Required

Description

String

Yes

Operation, subscribe unsubscribe

args

List<Object>

Yes

List of channels to request subscription

> instType

String

Yes

Product type
USDT-FUTURES USDT-M Futures
COIN-FUTURES Coin-M Futures
USDC-FUTURES USDC-M Futures

> channel

String

Yes

Channel name

Parameter

Type

Description

event

String

Yes
Operation

arg

Object

Subscribed channels

> instType

String

Product type
USDT-FUTURES USDT-M Futures
COIN-FUTURES Coin-M Futures
USDC-FUTURES USDC-M Futures

> channel

String

Channel name

> instId

String

Product ID default

code

String

Error code

msg

String

Error message

{
  "action": "snapshot",
  "arg": {
    "instType": "USDT-FUTURES",
    "channel": "equity",
    "instId": "default"
  },
  "data": [
    {
      "btcEquity": "0.0021",
      "usdtEquity": "13.985457617660",
      "usdtUnrealized": "0.000000000000",
      "unionTotalMargin": "100",
      "unionAvailable": "11",
      "unionMm": "11"
    }
  ],
  "ts": 1695717225146
}

Parameter

Type

Description

action

String

action, snapshot

arg

Object

Channel

> instType

String

Product type
USDT-FUTURES USDT-M Futures
COIN-FUTURES Coin-M Futures
USDC-FUTURES USDC-M Futures

> channel

String

Channel name

> instId

String

Product ID default

data

List<Object>

Subscribed data

>usdtEquity

String

Account equity (USDT)

>btcEquity

String

Account equity (BTC)

>usdtUnrealized

String

Unrealized profit and loss （USDT）

>unionTotalMargin

String

Total multi-asset margin

>unionAvailable

String

Available balance under multi-asset margin mode

>unionMm

String

Maintenance margin under multi-asset margin mode