Skip to content

Latest commit

 

History

History
79 lines (60 loc) · 4.72 KB

File metadata and controls

79 lines (60 loc) · 4.72 KB

REST API 契约

本目录是“同花顺金融数据服务”上游 REST API 在本仓库中的唯一契约源。它面向直接 HTTP 调用者、SDK/CLI 维护者和 AI Agent,统一维护端点、参数、响应字段、错误码与能力边界。

线上 https://fuyao.aicubes.cn/llms-full.txt 是由文档前端生成的 LLM 友好全文聚合,适合检索和阅读,但不是 OpenAPI 等机器契约源。本目录根据后端 OpenAPI、@Capability、DTO、consumer-views.yaml 与 MCP YAML 维护公开 REST 契约;仓库不保存 llms.txtllms-full.txt 副本,避免与线上展示产物形成双份维护。

通用协议

项目 契约
Base URL https://fuyao.aicubes.cn
方法 当前公开数据端点均为 GET
认证 HTTP Header X-api-key: <API_KEY>
成功判断 HTTP 200 且响应 code == 0
响应信封 {code, message, request_id, data}
标的代码 完整 thscode,例如 600519.SH;不要猜交易所后缀
时间戳 毫秒 Unix 时间戳;具体日期字符串格式以端点页为准
空值 null 表示未披露或上游无值,不得自动补零

data 字段始终存在:成功时承载端点数据,业务错误时为 null。调用方不得以“字段缺失”判断旧版错误信封,也不得在错误时把 null 当作成功空结果。

获取统一 API Key:https://fuyao.aicubes.cn/admin。API Key 不得写入代码、Prompt、日志、公开配置或 Git 提交。

最小请求:

curl 'https://fuyao.aicubes.cn/api/meta/tickers/search?q=600519&limit=1' \
  -H 'X-api-key: <API_KEY>'

契约导航

先读 能力与意图路由,再按需要打开一个端点组:

领域 契约
标的检索、代码消歧、代码表 元信息端点
个股行情、历史 K 线、公司行动 行情与公司行为端点
利润表、资产负债表、现金流量表、财务指标 财务数据端点
A 股市盈率、市净率、市销率和市现率快照 估值数据端点
交易日历 交易日历端点
A 股集合竞价快照与短期基准 集合竞价端点
指数/板块目录、成分股、指数行情 指数与板块端点
基金资料、经理、净值、收益、持仓、财务、资讯、回测、指标、QDII 额度和场内行情 公募基金端点
期货与期权品种、合约、持仓、基差、日程和行情 期货与期权端点
涨停、跌停、炸板、连板、异动、热榜、龙虎榜 特色数据端点
全市场 Parquet 与本地建库数据源 全市场数据导出

错误处理

所有响应先检查 code。HTTP 200 不代表业务成功。

code 含义 调用方处理
0 成功 使用 data
1001 缺少必填参数 补齐参数,不重试原请求
1002 参数格式无效 规范化代码、枚举、日期或时间戳
1003 参数超出范围 缩小分页或拆分允许拆分的时间窗口
1004 参数冲突 按端点互斥规则重组参数
2001 未认证 检查 X-api-key 是否存在且格式正确
2003 无权限或 Key 无效 前往 API Key 管理页检查授权或重新签发
3001 标的不存在 先通过元信息端点消歧并核对资产类别与 thscode
3002 数据尚未准备 保留 request_id 与口径,稍后再查,不得补零或使用模拟数据
3004 目标类型不支持该能力 选择适用于该资产类型的端点,不重试原请求
4001 限流 指数退避,最多重试 3 次
5001/5002/5003 服务端或上游异常 退避重试;持续失败时保留 request_id

1xxx2xxx 属于调用方可修复错误,不应无条件重试。网络错误、40015xxx 可在有界次数内退避重试。

大结果规则

全市场、分页全集、多标的或多年数据必须落盘。调用者只在终端或对话中报告文件路径、行数、时间窗口和摘要,不展开原始结果。全市场历史建库优先使用 Market Dumps,不要逐标的请求多年 REST 数据。

维护规则

  1. 先根据上游变更更新本目录。
  2. 运行 python scripts/sync_skill_contracts.py 镜像到独立 Skill。
  3. 运行 python scripts/sync_skill_contracts.py --check 和相关契约测试。
  4. CLI/Python 文档只同步命令或运行方式,不复制本目录的字段契约。