跳到主要内容

订阅K线（UTC+8）数据

API说明​

此Websocket API提供指定交易品种的K线数据，包括时间戳、最高价格、最低价格、开盘价格、收盘价格和交易量。每个蜡烛图根据UTC+8时区进行时间戳标记。

注意：K线（UTC+8）数据可通过RESTful和Websocket接口获取。本页是Websocket接口的描述。如需了解RESTful接口，请参见 跳转

注意事项​

  1. 每个蜡烛图根据UTC+8时区进行时间戳标记。
  2. Websocket API不支持指定时间跨度来查询K线数据。
  3. 它提供实时K线数据，但不明确指示何时间隔已结束。用户必须监控开盘价的变化以确定新间隔的开始。
  4. 此外，时间戳在每个间隔结束时更新，作为前一间隔已结束的指示。

认证​

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

Websocket URL​

wss://ws.futurescw.com/perpum

频率限制​

此订阅的频率限制为每IP每2秒20个请求。

订阅参数​

参数必填类型描述
eventtrueString订阅或取消订阅。sub：订阅；unsub：取消订阅。注意：此参数区分大小写。
paramstrueJson请求参数对象，包括：
-biztrueString指定频道，例如"futures"。注意：建议使用小写。
-typetrueString定义功能类型，例如"candles_swap"。注意：建议使用小写。
-pairCodetrueString交易品种基础货币（例如，BTC或btc）。此参数不区分大小写。注意：对于以数字开头的合约（例如1000PEPE），大写和小写格式都有效。
-intervaltrueStringK线间隔，表示为："1"（1分钟）、"3"（3分钟）、"5"（5分钟）、"15"（15分钟）、"30"（30分钟）、"1H"（1小时）、"4H"（4小时）、"1D"（1天）、"1W"（1周）、"1M"（1月）。注意：此参数不区分大小写。1H和1h都有效。

响应参数​

参数类型描述
bizString指定频道，例如"futures"
typeString定义功能类型，例如"candles_swap"
resultboolean表示订阅或取消订阅是否成功：true，false
channelString指定执行的操作：subscribe或unsubscribe
pairCodeString交易品种基础货币，即BTC
dataJson数据对象，包含以下字段：
-BigDecimal创建时间（时间戳）
-BigDecimal区间开盘价格
-BigDecimal区间内最高价格
-BigDecimal区间内最低价格
-BigDecimal区间收盘价格
-BigDecimal区间交易量（以基础货币计）
intervalStringK线时间间隔，表示为："1"（1分钟），"3"（3分钟），"5"（5分钟），"15"（15分钟），"30"（30分钟），"1H"（1小时），"4H"（4小时），"1D"（1天），"1W"（1周），"1M"（1个月）

订阅示例​

以下Python代码展示了如何订阅K线数据。

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

subscription_params =  {
              "event": "sub",
              "params": {
                  "biz": "futures",
                  "pairCode": "btc",
                  "type": "candles_swap",
                  "interval":"1"
              }}
url = "wss://ws.futurescw.com/perpum"
FuturesWebsocketPublic(url, subscription_params)  # function FuturesWebsocketPublic() is defined in section (Introduction > Authentication & Code Snippet > Futures > Websocket Public Interface)

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

响应示例​

Websocket将实时更新BTC的1分钟K线数据。为简洁起见，以下仅显示Python订阅的一条K线：

{'biz': 'futures',
 'pairCode': 'BTC',
 'data': {'result': True},
 'channel': 'subscribe',
 'interval': '1',
 'type': 'candles_swap'}
{'biz': 'futures',
 'pairCode': 'BTC',
 'data': ['1740333420000',
  '95585.5',
  '95616.1',
  '95583.3',
  '95583.5',
  '32.661'],
 'interval': '1',
 'type': 'candles_swap'},........