接入文档
接口简介
本接口提供主流外盘期货品种的实时报价数据。通过传入特定的期货品种代码(symbol),即可获取包括最新价、买卖盘口、成交量、持仓量、涨跌幅等核心行情字段。数据适用于需要监控国际大宗商品及金融衍生品价格的业务场景。
适用场景
- 金融资讯平台:展示国际期货市场的实时动态与行情走势。
- 量化交易辅助:为策略模型提供基础的价格与量能数据输入。
- 企业风险管理:监控原材料(如原油、金属、农产品)的国际价格波动。
- 个人投资工具:开发看盘软件或价格预警通知服务。
请求与返回说明
- 请求方式:POST
- 关键参数:
symbol(必填),即期货品种代码,需参考官方代码表传入有效值。 - 返回结构:
code/msg:接口状态码及描述,200 表示成功。data:包含具体行情数据的对象。price:实时最新价格。bid/ask:买一价与卖一价。volume/hold:成交量与持仓量。change/changeRate:涨跌额与涨跌率。update_time:数据更新时间戳。
接入建议
- 代码映射:请务必维护一份有效的
symbol代码表,避免传入无效代码导致查询失败。 - 频率控制:实时行情数据更新频繁,建议根据业务实际需求设置合理的轮询间隔,避免高频无效请求。
- 数据校验:解析返回数据时,请检查
code字段确保请求成功,并注意处理网络异常或超时情况。 - 时区注意:
update_time为时间戳格式,前端展示时需转换为用户本地时区。
接入示例代码
提供 Shell、Python、Go、Java、PHP 等常见接入示例,便于直接接到现有项目里。
请求示例
{
"symbol": "期货品种代码,详见代码表"
}响应示例
{
"msg": "成功",
"code": 200,
"taskNo": "883993816152322760914592",
"data": {
"change": "5.0300",
"ask_vol": "3",
"bid_vol": "10",
"hold": "249261.000",
"volume": "5347",
"high": "312.800",
"update_time": 1721629440,
"low": "307.600",
"price": "312.530",
"name": "美黄豆粉",
"ask": "312.600",
"changeRate": "1.6358",
"preclose": "307.500",
"bid": "312.500",
"open": "307.600"
}
}请求字段
以下字段根据示例 JSON 自动提取,仅作接入参考。
| 字段路径 | 类型 | 示例值 |
|---|---|---|
| type | string | object |
| properties | object | {...} |
| properties.symbol | object | {...} |
| properties.symbol.type | string | string |
| properties.symbol.description | string | 期货品种代码,详见代码表 |
| required | array | "symbol" |
| required[] | string | symbol |
响应字段
以下字段根据示例 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 | {...} |