# 权益频道

### 描述

订阅权益频道

以下事件发生时推送数据：

1. 划转资金到合约账户
2. 活动金， 或者体验金充值到合约账户
3. 开/平仓委托成交

<div className="api-aligning">

```json title="请求示例"
{
    "op": "subscribe",
    "args": [
        {
            "instType": "USDT-FUTURES",
            "channel": "equity"
        }
    ]
}
```

### 请求参数

| 参数名           | 参数类型               | 是否必须 | 描述                                                                               | 
|:--------------|:-------------------|:-----|:---------------------------------------------------------------------------------|
| op            | String             | 是    | 操作, subscribe unsubscribe                                                        |
| args          | List&lt;Object&gt; | 是    | 请求订阅的频道列表                                                                        |
| &gt; instType | String             | 是    | 产品类型<br/>`USDT-FUTURES` U本位合约<br/>`COIN-FUTURES` 币本位合约<br/>`USDC-FUTURES` USDC合约 |
| &gt; channel  | String             | 是    | 频道名                                                                              |

</div>

<div className="api-br-10"></div>

<div className="api-aligning">

```json title="订阅返回示例"
{
  "event": "subscribe",
  "arg": {
    "instType": "USDT-FUTURES",
    "channel": "equity",
    "instId": "default"
  }
}
```

### 返回参数

| 返回字段          | 参数类型   | 字段说明                                                                             | 
|:--------------|:-------|:---------------------------------------------------------------------------------|
| event         | String | 操作                                                                               |
| arg           | Object | 订阅的频道                                                                            |
| &gt; instType | String | 产品类型<br/>`USDT-FUTURES` U本位合约<br/>`COIN-FUTURES` 币本位合约<br/>`USDC-FUTURES` USDC合约 |
| &gt; channel  | String | 频道名                                                                              |
| &gt; instId   | String | 产品ID `default`                                                                   |
| code          | String | 错误码                                                                              |
| msg           | String | 错误消息                                                                             |

</div>

<div className="api-br-10"></div>

<div className="api-aligning">

```json title="推送返回示例"
{
  "action": "snapshot",
  "arg": {
    "instType": "USDT-FUTURES",
    "channel": "equity",
    "instId":"default"
  },
  "data": [
    {
      "btcEquity": "0.0021",
      "usdtEquity": "13.985457617660",
      "usdtUnrealized": "0.000000000000",
      "unionTotalMargin": "100",
      "unionAvailable": "20",
      "unionMm": "15"
    }
  ],
  "ts": 1695717225146
}
```

### 推送数据参数

| 返回字段                 | 参数类型               | 字段说明                                                                             | 
|:---------------------|:-------------------|:---------------------------------------------------------------------------------|
| action               | String             | 推送动作, `snapshot`                                                                 |
| arg                  | Object             | 请求订阅的频道                                                                          |
| &gt; instType        | String             | 产品类型<br/>`USDT-FUTURES` U本位合约<br/>`COIN-FUTURES` 币本位合约<br/>`USDC-FUTURES` USDC合约 |
| &gt; channel         | String             | 频道名                                                                              |
| &gt; instId          | String             | 产品ID `default`                                                                   |
| data                 | List&lt;Object&gt; | 订阅的数据                                                                            |
| &gt;usdtEquity       | String             | 账户权益 (USDT)                                                                      |
| &gt;btcEquity        | String             | 账户权益 (BTC)                                                                       |
| &gt;usdtUnrealized   | String             | 未实现盈亏 (USDT)                                                                     |
| &gt;unionTotalMargin | String             | 联合保证金                                                                            |
| &gt;unionAvailable   | String             | 联合保证金模式下的可用                                                                      |
| &gt;unionMm          | String             | 联合保证金模式下的维持保证金                                                                   |

</div>