订阅K线
API说明
此Websocket API提供指定交易品种的实时K线数据,包括时间戳、最高价格、最低价格、开盘价格、收盘价格和交易量等详细信息。
注意:K线数据可通过RESTful和Websocket接口获取。本页是Websocket接口的描述。如需了解RESTful接口,请参见 跳转
注意事项
- 目前有两种方法可用于K线订阅。用户在创建连接时 应谨慎操作。
方法1
认证
这是一个公共Websocket,不需要认证。有关使用Websocket API的详细信息,请参考简介 > 认证和代码示例 > 现货 > Websocket公共接口 > 方法1
Websocket URL
wss://ws.futurescw.info?token={your_token}
频率限制
无
请求参数
| 参数 | 必填 | 类型 | 描述 |
|---|---|---|---|
| event | True | String | subscribe |
| args | True | String | 格式:"spot/candle-{interval}:symbol" "interval" 指K线间隔。可用选项:1m、3m、5m、15m、30m、1h、2h、4h、6h、12h、1d、1w、1M "symbol" 指要订阅的货币, 如BTC-USDT示例: "spot/candle-1m:BTC-USDT" |
响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| channel | String | 订阅的频道,即"spot/candle-1m:BTC-USDT" |
| subject | String | 主题,即"spot/candle-1m" |
| data | Array | 数据对象 |
| - | String | 时间戳(毫秒) |
| - | String | 报价货币计的开盘价 |
| - | String | 报价货币计的收盘价 |
| - | String | 报价货币计的最高价 |
| - | String | 报价货币计的最低价 |
| - | String | 基础货币计的交易量 |
| - | String | 报价货币计的价格 |
请求示例
以下Python代码展示了如何获取BTC-USDT的K线。
注意:完整代码请参考简介 > 认证和代码示例 > 现货 > Websocket公共接口 > 方法1。
interval= "1m"
symbol = "BTC-USDT"
args = f'spot/candle-{interval}:{symbol}'
SpotWebsocketPublic(args) # 函数SpotWebsocketPublic()在章节(简介 > 认证和代码示例 > 现货 > Websocket公共接口 > 方法1)中定义
注意:完整Java代码请参考简介 > 认证和代码示例 > 现货 > Websocket公共接口 > 方法1。
响应示例
以下是上述Python订阅返回的示例响应。Websocket订阅将实时更新K线数据。为简洁起见,以下仅提供初始响应:
{'channel': 'spot/candle-1m:BTC-USDT',
'subject': 'spot/candle-1m',
'data':
'["1743154440000",
"85366.41",
"85357.8",
"85366.76",
"85357.8",
"2.4926",
"212784.301823"
]'
},......
方法2
认证
这是一个公共Websocket,不需要认证。有关使用Websocket API的详细信息,请参考简介 > 认证和代码示例 > 现货 > Websocket公共接口 > 方法2
Websocket URL
频率限制
无
请求参数
| 参数 | 必填 | 类型 | 描述 |
|---|---|---|---|
| event | true | String | 订阅或取消订阅。sub: 订阅; unsub: 取消订阅。 注意:此参数区分大小写。 |
| params | true | Json | 请求的参数对象,包括: |
| -biz | true | String | 指定频道,例如,"exchange"。注意:建议使用小写。 |
| -type | true | String | 定义功能类型,例如,"candles"。注意:建议使用小写。 |
| -pairCode | true | String | 货币对ID,即78 : BTC_USDT。 注意:货币对ID与交易品种的映射关系可通过 获取所有交易品种24小时交易摘要 接口获取。 |
| -interval | true | String | 表示K线间隔。可用选项:1m、3m、5m、15m、30m、1h、2h、4h、6h、12h、1d、1w和1M |
响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| biz | String | 频道名称,例如,"exchange"。 |
| pairCode | String | 货币对ID,即78 : BTC_USDT。 注意:货币对ID与交易品种的映射关系可通过 获取所有交易品种24小时交易摘要 接口获取。 |
| channel | String | 订阅类型,例如,"subscribe"。 |
| type | String | 定义功能类型,例如,"candles"。 |
| -result | Boolean | 订阅请求的结果:true或false。 |
| data | Json | 数据对象,包含以下字段: |
| - | String | 时间戳(毫秒) |
| - | String | 报价货币计的开盘价 |
| - | String | 报价货币计的收盘价 |
| - | String | 报价货币计的最高价 |
| - | String | 报价货币计的最低价 |
| - | String | 基础货币计的交易量 |
| - | String | 报价货币计的价格 |
请求示例
以下Python代码展示了如何订阅"BTC-USDT"的K线。
注意:完整代码请参考简介 > 认证和代码示例 > 现货 > Websocket公共接口 > 方法2
url = "wss://ws.futurescw.com"
subscription_params = {"event":"sub",
"params":
{"biz":"exchange",
"type":"candles",
"pairCode":"78", # "78"表示BTC-USDT
"interval":"1m"}}
SpotWebsocketPublic(url, subscription_params) # 函数SpotWebsocketPublic()在章节(简介 > 认证和代码示例 > 现货 > Websocket公共接口 > 方法2)中定义
注意:完整Java代码请参考简介 > 认证和代码示例 > 现货 > Websocket公共接口 > 方法2。
响应示例
以下是上述Python订阅返回 的示例响应。Websocket订阅将实时更新K线数据。为简洁起见,以下仅提供初始响应:
{"biz":"exchange","pairCode":"78","data":{"result":true},"channel":"subscribe","interval":"1m","type":"candles"}
{"biz":"exchange","pairCode":"78","data":"
[\"1745823600000\",
\"94580.17\",
\"94600.06\",
\"94600.08\",
\"94579.66\",
\"2.6366\",
\"249401.987844\"
]","interval":"1m","type":"candles"},.....