接入文档
接口简介
本接口提供港股市场股票的实时行情排行服务。开发者可通过指定排序字段(目前仅支持涨跌率 changeRate)及排序顺序,获取分页后的股票列表。返回数据涵盖股票代码、名称、实时价格、涨跌额、总市值、成交量、市盈率及52周高低点等关键财务与交易指标,数据带有时间戳,便于追踪更新时效。
适用场景
- 金融资讯应用:展示港股涨跌幅榜、活跃股榜单,为用户提供市场热点概览。
- 量化交易辅助:作为策略筛选的初步数据源,快速定位高波动或特定趋势的标的。
- 投资监控看板:集成至个人或机构投资仪表盘,实时监控持仓或关注池外的市场异动。
请求与返回说明
请求方式:POST 核心参数:
sort(必填):排序字段,当前仅支持changeRate(涨跌率)。asc:排序顺序,0为倒序(由高到低),1为正序(由低到高),默认为0。page:页码,默认第 1 页。limit:每页条数,最大支持 100 条,默认 10 条。
返回结果:
code/msg:业务状态码及描述,注意区分于 HTTP 状态码。data.list:股票对象数组,包含symbol(代码)、name(名称)、price(现价)、changeRate(涨跌率)、market_value(总市值)、volume(成交量)、pe(市盈率)等字段。taskNo:任务订单号,用于问题排查与服务复核。
接入建议
- 缓存策略:鉴于行情数据的高频变动特性,建议前端根据业务需求设置合理的轮询间隔(如 3-5 秒),避免高频请求导致资源浪费或触发限流。
- 异常处理:务必校验返回体中的
code字段,仅当 code 为 200 时解析data内容;非成功状态应结合msg进行用户提示或日志记录。 - 数据展示:返回的数值型字段(如价格、市值)多为字符串格式,前端展示时需根据区域习惯进行格式化(如千分位分隔、保留小数位),并注意处理负值(如亏损股的 EPS 或 PE)。
接入示例代码
提供 Shell、Python、Go、Java、PHP 等常见接入示例,便于直接接到现有项目里。
请求示例
{
"sort": "排序字段,目前仅支持:changeRate 涨跌率排序",
"asc": "排序顺序,0 倒序(由大到小), 1正序(由小到大),默认0",
"page": "页码,默认1",
"limit": "每页条数,最大100条,默认10"
}响应示例
{
"msg": "成功",
"code": 200,
"taskNo": "202960247220113090298671",
"data": {
"list": [
{
"symbol": "02203",
"market_value": "75200000.000",
"change": "0.044",
"eps": "-0.006",
"volume": "17180000",
"shares": "800000000",
"high": "0.111",
"update_time": 1713755536,
"low": "0.064",
"pe": "-15.6666667",
"price": "0.094",
"name": "脑洞科技",
"ask": "0.094",
"dividend": "0.000",
"52week_low": "0.038",
"preclose": "0.050",
"bid": "0.091",
"changeRate": "88.0000000",
"value": "1586410",
"open": "0.057",
"52week_high": "0.210"
}
]
}
}请求字段
以下字段根据示例 JSON 自动提取,仅作接入参考。
| 字段路径 | 类型 | 示例值 |
|---|---|---|
| type | string | object |
| properties | object | {...} |
| properties.sort | object | {...} |
| properties.sort.type | string | string |
| properties.sort.description | string | 排序字段,目前仅支持:changeRate 涨跌率排序 |
| properties.asc | object | {...} |
| properties.asc.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 | {...} |