订阅资产

API说明

此Websocket接口允许用户检索合约账户资产信息，包括可用保证金、USDT余额和冻结资产等。

注意：资产数据可通过RESTful和Websocket接口获取。本页是Websocket接口的描述。如需了解RESTful接口，请参见 跳转

注意事项

1. 除非资产发生变化，否则Websocket连接不会返回任何响应。如果没有变化发生，Websocket将不提供更新。用户应确保有活跃的交易活动以接收实时资产更新。

认证

这是一个私有Websocket，需要认证。有关使用Websocket API的详细信息，请参考简介 > 认证和代码示例 > 合约 > Websocket私有接口。

Websocket URL

wss://ws.futurescw.com/perpum

频率限制

此订阅的频率限制为每用户ID每2秒10个请求。

订阅参数

参数	必填	类型	描述
event	true	String	订阅或取消订阅。sub：订阅；unsub：取消订阅。注意：此参数区分大小写。
params	true	Json	数据对象，包含以下字段：
-biz	true	String	指定频道，例如"futures"。
-type	true	String	定义功能类型，例如"assets"。

响应参数

参数	类型	描述
biz	String	指定频道，例如"futures"。
type	String	功能类型，例如"assets"
result	boolean	表示订阅或取消订阅是否成功：true, false。
channel	String	指定执行的操作：subscribe或unsubscribe。
pairCode	String	交易品种的基础货币，即BTC
data	Json	包含以下字段的数据对象：
-margin	BigDecimal	为持仓分配的保证金金额
-profitUnreal	BigDecimal	持仓的未实现盈亏
-freeze	BigDecimal	由于未成交订单或其他限制而冻结的资金金额
-size	BigDecimal	持有的合约总规模或资产数量
-available	BigDecimal	可用于交易或提款的USDT余额
-currency	String	报价货币（例如，USDT）
-type	Integer	账户类型或分类（用户可忽略）
-almightyGold	BigDecimal	万能金余额
-transferAvailable	BigDecimal	可用于转账的金额
-userId	Long	合约账户用户ID
-availableMargin	BigDecimal	可用保证金
-hold	BigDecimal	当前在订单/持仓中持有的金额

订阅示例

以下Python代码展示了如何使用Websocket订阅资产。

注意：完整代码示例请参考简介 > 认证和代码示例 > 合约 > Websocket私有接口。

url = "wss://ws.futurescw.com/perpum"
subscription_payload = {"event": "sub",
                         "params": {"biz": "futures",
                                    "type": "assets"}}
api_key= "your_api_key" 
sec_key = "your_sec_key"

FuturesWebsocketPrivate(url, api_key, sec_key, subscription_payload) # function FuturesWebsocketPrivate() is defined in section (Introduction > Authentication & Code Snippet > Futures > Websocket Private Interface)

注意：完整Java代码示例请参考简介 > 认证和代码示例 > 合约 > Websocket私有接口。

响应示例

以下是上述Python订阅返回的示例响应，它会实时更新：

{'biz': 'futures',
 'data': {'result': True},
 'channel': 'subscribe',
 'type': 'assets'}
{'biz': 'futures',
 'pairCode': 'USDT',
 'data': [{'margin': 0.0,
   'profitUnreal': 0,
   'freeze': 0.0,
   'size': 0,
   'available': 488.53777423,
   'currency': 'usdt',
   'type': 7,
   'almightyGold': 0,
   'transferAvailable': 488.53777423,
   'userId': 1162061,
   'availableMargin': 488.53777423,
   'hold': 0.0},
  {'margin': 0.0,
   'profitUnreal': 0,
   'freeze': 0.0,
   'size': 0,
   'available': 488.53777423,
   'currency': 'usdt',
   'type': 7,
   'almightyGold': 0,
   'transferAvailable': 488.53777423,
   'userId': 1162061,
   'availableMargin': 488.53777423,
   'hold': 0.0}],
 'type': 'assets'},.........