跳到主要内容

订阅指数价格

API说明

此websocket允许查询指定交易品种的指数价格。

注意:指数价格数据只能通过 Websocket API 获取。

注意事项

认证

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

Websocket URL

wss://ws.futurescw.com/perpum

频率限制

订阅参数

参数必填类型描述
eventtrueString订阅或取消订阅。sub: 订阅; unsub: 取消订阅。注意:此参数区分大小写。
paramstrueJson请求的参数对象,包括:
-biztrueString指定频道,例如,"futures"。注意:建议使用小写。
-typetrueString定义功能类型,例如,"index_price"。注意:建议使用小写。
-pairCodetrueString交易品种的基础货币。(例如,BTC或btc)。此参数不区分大小写。注意:对于以数字开头的交易品种(例如,1000PEPE),大写和小写格式均有效。

响应参数

参数类型描述
bizString指定频道,例如,"futures"
typeString定义功能类型,例如,"index_price"
resultboolean指示订阅或取消订阅是否成功:true, false。
channelString指定执行的操作:subscribe或unsubscribe。
pairCodeString交易品种的基础货币,例如,BTC。
dataJson数据对象,包含以下字段:
-pBig Decimal指数价格。
-nString交易品种的基础货币,例如,btc

订阅示例

以下Python代码展示了如何订阅"BTC"的指数价格。

注意:完整代码示例请参考简介 > 认证和代码示例 > 合约 > Websocket公共接口。

subscription_params =  { "event": "sub",
"params": {
"biz": "futures",
"pairCode": "BTC",
"type": "index_price"}}
url = "wss://ws.futurescw.com/perpum"
FuturesWebsocketPublic(url, subscription_params) #函数FuturesWebsocketPublic()在章节(简介 > 认证和代码示例 > 合约 > Websocket公共接口)中定义

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

响应示例

Websocket订阅将实时更新指数价格。为简洁起见,以下仅提供Python订阅的初始响应:

{'biz': 'futures',
'pairCode': 'BTC',
'data': {'result': True},
'channel': 'subscribe',
'type': 'index_price'}
{'biz': 'futures',
'pairCode': 'btc',
'data': {'p': 92383.3, 'n': 'btc'},
'type': 'index_price'},....