获取K线
API说明
此接口允许查询指定交易品种的K线(蜡烛图)数据,包括开盘价、收盘价、最高价、最低价和交易量。
注意:K线数据可通过RESTful和Websocket接口获取。本页是RESTful接口的描述。如需了解Websocket接口,请参见 跳转
注意事项
- 此接口返回当前时间的K线数据,间隔可能已完成或未完成。
- 如果未指定 开始或结束时间戳,接口将默认返回为每个交易品种100条K线数据。
认证
这是一个公共接口,不需要认证。有关使用RESTful API的详细信息,请参考简介 > 认证和代码示例 > 现货 > RESTful公共接口。
请求方法
GET
接口地址
/api/v1/public?command=returnChartData
频率限制
该接口的调用频率限制为:每个 IP 每秒最多请求10次。
此外,该接口还受到全局频率限制的约束。
有关"全局速率限制"和"API限频策略"的详细信息,请参阅“频率限制”部分,跳转
请求参数
| 参数 | 必填 | 类型 | 描述 |
|---|---|---|---|
| period | Integer | True | K线间隔(秒),例如,60:1分钟,180:3分钟,300:5分钟,900:15分钟,1800:30分钟,7200:2小时,14400:4小时 |
| currencyPair | String | True | 交易对。允许输入多个交易对,以逗号分隔。 示例:"BTC_USDT,ETH_USDT" 注意:每次请求最多可输入 20 个交易对 |
| start | String | False | K线开始时间(Unix 毫秒级时间戳) |
| end | String | False | K线结束时间(Unix 毫秒级时间戳) |
响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| date | Long | K线时间戳 |
| high | String | 最高价 |
| low | String | 最低价 |
| open | String | 开盘价 |
| close | String | 收盘价 |
| volume | String | 交易量 |
| pair | String | 交易品种 |
请求示例
以下Python代码展示了如何获取BTC_USDT和ETH_USDT的5分钟K线数据。
注意:完整代码示例请参考简介 > 认证和代码示例 > 现货 > RESTful公共接口。
api_url= "/api/v1/public?command=returnChartData"
params={
"currencyPair":"BTC_USDT,ETH_USDT",
"period":300,
# "start": "1579238517000",
# "end": "1581916917660"
}
SpotRestfulPublic(api_url, params) # 函数SpotRestfulPublic()在章节(简介 > 认证和代码示例 > 现货 > RESTful公共接口)中定义
注意:完整Java代码示例请参考简介 > 认证和代码示例 > 现货 > RESTful公共接口。
响应示例
以下是上述Python请求返回的示例响应。每个品种实际响应返回100条K线信息。为简洁起见,以下每个品种仅显示三条K线:
{'code': '200',
'data': [{'open': '87610.75', # BTC_USDT
'high': '87614.4',
'low': '87573.42',
'close': '87573.42',
'volume': '10.554',
'pair': 'BTC_USDT',
'date': 1764077100000},
{'open': '87605.86',
'high': '87650.21',
'low': '87516.5',
'close': '87593.07',
'volume': '85.8893',
'pair': 'BTC_USDT',
'date': 1764076800000},,.........
{'open': '88212.98',
'high': '88253.05',
'low': '88165.65',
'close': '88173.03',
'volume': '36.0383',
'pair': 'BTC_USDT',
'date': 1764047400000},
{'open': '2927.57', # ETH_USDT
'high': '2928.05',
'low': '2927.2',
'close': '2927.56',
'volume': '69.016',
'pair': 'ETH_USDT',
'date': 1764077100000},
{'open': '2929.82',
'high': '2930.11',
'low': '2924.49',
'close': '2927.18',
'volume': '295.2313',
'pair': 'ETH_USDT',
'date': 1764076800000},.......
{'open': '2930.78',
'high': '2931.52',
'low': '2928.45',
'close': '2929.39',
'volume': '142.3569',
'pair': 'ETH_USDT',
'date': 1764047400000}],
'msg': 'SUCCESS',
'success': True,
'failed': False}