接入文档
接口简介
本接口提供主流外汇品种的K线历史与实时行情数据。开发者可通过指定品种代码(symbol)及时间周期(type),获取包含开盘价、收盘价、最高价、最低价、涨跌幅及时间戳的结构化数组数据,适用于构建金融图表或进行技术分析。
适用场景
- 量化交易策略回测:获取不同时间粒度(如1分钟、5分钟、日线)的历史价格序列。
- 金融终端开发:为外汇交易软件提供实时的蜡烛图数据源。
- 市场行情监控:监测特定货币对的短期波动趋势与价格异动。
请求与返回说明
- 请求方式:POST
- 核心参数:
symbol(必填):外汇品种代码,如 FXINDEX,具体需参照代码表。type(必填):K线周期,支持0(日k)、1(1分钟)、5(5分钟)、15、30、60、120、240分钟等。limit(选填):返回数据条数,默认为10条。- 返回结果:
data.lines:二维数组,每项对应一根K线,顺序对应fields定义的字段(如 open, close, high, low, change, changeRate, tick_at)。data.fields:字段定义数组,明确 lines 中数值的具体含义。code/msg:接口状态码及描述,200表示成功。
接入建议
- 周期选择:根据业务需求选择合适的
type值,高频交易建议选择分钟级,趋势分析建议选择日线。 - 数据解析:返回的 K 线数据为紧凑数组格式,请严格依据
fields数组的顺序解析lines中的数值,避免错位。 - 频率控制:请注意 API 调用频率限制,建议在客户端增加缓存机制,减少对同一周期数据的重复请求。
接入示例代码
提供 Shell、Python、Go、Java、PHP 等常见接入示例,便于直接接到现有项目里。
请求示例
{
"symbol": "品种代码,如:FXINDEX。详见代码表",
"type": "k线类型,0:日k,1:1分钟,5:五分钟;15:十五分钟;30:30分钟,60:60分钟,120:120分钟,240:240分钟",
"limit": "返回条数,默认10"
}响应示例
{
"msg": "成功",
"code": 200,
"taskNo": "202960247220113090298671",
"data": {
"lines": [
[
12.879,
12.8786,
12.879,
12.8786,
"-0.00040",
"-0.0031",
1713761100
]
],
"fields": [
"open",
"close",
"high",
"low",
"change",
"changeRate",
"tick_at"
]
}
}请求字段
以下字段根据示例 JSON 自动提取,仅作接入参考。
| 字段路径 | 类型 | 示例值 |
|---|---|---|
| type | string | object |
| properties | object | {...} |
| properties.symbol | object | {...} |
| properties.symbol.type | string | string |
| properties.symbol.description | string | 品种代码,如:FXINDEX。详见代码表 |
| properties.type | object | {...} |
| properties.type.type | string | string |
响应字段
以下字段根据示例 JSON 自动提取,仅作接入参考。
| 字段路径 | 类型 | 示例值 |
|---|---|---|
| type | string | object |
| properties | object | {...} |
| properties.msg | object | {...} |
| properties.msg.type | string | string |
| properties.msg.example | string | 成功 |
| properties.msg.description | string | 返回码对应描述 |
| properties.code | object | {...} |