获取指定交易品种的历史K线数据
API说明
该接口用于查询指定交易品种的历史和最新K线数据,返回包括最高价、最低价、开盘价、收盘价、时间戳以及成交量等信息。
注意:K线数据可通过RESTful和Websocket接口获取。本页是RESTful接口的描述, 支持查询 最新和历史 K 线数据。如需实时 K 线更新,请参阅 WebSocket API,UTC+0 时区请点击 跳转,UTC+8 时区请点击 跳转
注意事项
- 单次请求最多返回1500条记录。 建议在查询历史K线数据时,合理使用 ‘sinceStr’(起始时间戳)与 ‘sinceEndStr’(结束时间戳)进行分页。同时需遵守接口的频率限制。
- 本接口返回的数据与 CoinW 网站显示一致,K线起始时间为该交易品种上线 CoinW 的时间。例如:BTC 永续合约数据自 2019-10-26 起提供。部分时间段因交易所数据缺失或系统维护,可能存在遗漏,建议用户进行数据完整性校验。
- 若查询时间区间包含当前尚未结束的K线,返回的该条K线为非完整K线。
认证
这是一个公共接口,不需要认证。有关使用RESTful API的详细信息,请参考简介 > 认证和代码示例 > 合约 > RESTful公共接口。
请求方法
GET
接口地址
频率限制
该接口的调用频率限制为:每个 IP 和用户 ID 每2秒最多请求20次。
此外,该接口还受到全局频率限制的约束。
有关"全局速率限制"和"多阶段风控限频机制"的详细信息,请参阅“频率限制”部分,跳转
请求参数
| 参数 | 必填 | 类型 | 描述 |
|---|---|---|---|
| currencyCode | true | String | 交易品种的基础货币。(例如,BTC或btc)。此参数不区分大小写。 注意:对于以数字开头的交易品种(例如,1000PEPE),大写和小写格式均有效。 |
| granuality | true | String | K线时间间隔,由整数0到9表示,其中0:1分钟,1:5分钟,2:15分钟,3:1小时,4:4小时,5:1天,6:1周,7:3分钟,8:30分钟,9:1个月。 |
| limit | false | Integer | 指定返回的 K 线记录(蜡烛图)数量,有效范围为 1 到 1,500。无论选择的 granularity 如何,默认返回记录数为 100,且最大不能超过 1,500 条。 注意: 此外,如果无法获取请求的全部记录数的历史数据,则响应将仅包含截至该时间点的可用数据。 |
| klineType | false | String | 时区类型: "0" = UTC, "1" = UTC+8。 注意: 默认值为 UTC+8。 |
| sinceStr | false | String | 起始时间戳(毫秒)。 注意: 获取最新 K 线时可不传该参数。 |
| sinceEndStr | false | String | 结束时间戳(毫秒)。 注意: 获取最新 K 线时可不传该参数。 |
响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| - | Long | 时间戳 |
| - | BigDecimal | 最高价格 |
| - | BigDecimal | 开盘价格 |
| - | BigDecimal | 最低价格 |
| - | BigDecimal | 收盘价格 |
| - | BigDecimal | 交易量 |