订阅万能金

API说明

此Websocket提供万能金的实时更新，仅在万能金发放或接近过期时推送信息。它提供余额、状态、有效期以及是否需要高级KYC验证等关键详情，有助于高效的资产管理。

有关万能金的更多详情，请参考 https://coinw.zendesk.com/hc/en-us/articles/23111150445977-Introduction-to-Futures-Mega-Coupon

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

注意事项

此Websocket仅在万能金发放或接近过期时推送更新。

认证

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

Websocket URL

wss://ws.futurescw.com/perpum

频率限制

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

订阅参数

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

响应参数

参数	类型	描述
biz	String	指定频道，例如"futures"。
type	String	功能类型，例如"assets_ag"。
result	boolean	表示订阅或取消订阅是否成功：true, false。
channel	String	指定执行的操作：subscribe或unsubscribe。
pairCode	String	交易品种的基础货币，即BTC
data	Json	包含以下字段的数据对象：
-agRecordId	Long	万能金ID
-updateDate	Long	更新时间（时间戳）
-backAmount	BigDecimal	逾期金额
-currentAmount	BigDecimal	剩余金额
-remark	String	备注
-userId	Long	用户ID
-totalAmount	BigDecimal	万能金总额
-createdDate	Long	创建时间（时间戳）
-kyc	Integer	高级KYC要求：1：是，0：否
-assetsOut	BigDecimal	转出的资产是否无效：1：是，0：否
-startTime	Long	有效期开始时间（时间戳）
-endTime	Long	有效期截止日期（时间戳）
-status	Integer	状态：0：待生效，1：未使用，2：已使用，3：已过期，4：发放失败

订阅示例

以下Python代码展示了如何使用Websocket订阅万能金。

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

url = "wss://ws.futurescw.com/perpum"
subscription_payload = {"event": "sub",
                         "params": {"biz": "futures",
                                    "type": "assets_ag"}}
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订阅返回的示例响应，它会实时更新：

{'event': 'sub', 'params': {'biz': 'futures', 'type': 'assets_ag'}}
{'biz': 'futures',
 'data': [{'agRecordId': 475,
   'updateDate': 1713192123887,
   'backAmount': 0,
   'currentAmount': 11,
   'remark': '',
   'userId': 600001274,
   'totalAmount': 11,
   'createdDate': 1713192123887,
   'kyc': 1,
   'assetsOut': 1,
   'startTime': 1713192110000,
   'endTime': 1713278512000,
   'status': 1}],
 'type': 'assets_ag'}.........

API说明​

注意事项​

认证​

Websocket URL​

频率限制​

订阅参数​

响应参数​

订阅示例​

响应示例​