📊 AI数据治理产品 API

金融公告采集 → 财务指标提取 → 结构化数据服务 · v1.0.0

📋 目录

鉴权X-API-Key 请求头

所有数据接口需在请求头中携带 X-API-Key

curl -H "X-API-Key: YOUR_API_KEY" https://api.your-domain.com/api/v1/announcements

未携带Key返回 401,Key无效返回 403

限流100次 / 分钟 / Key

每个API Key每分钟最多请求100次。超限返回 429 Too Many Requests

响应头包含 X-RateLimit-LimitX-RateLimit-Remaining

GET /api/v1/announcements 需鉴权

说明

查询公告列表,支持多维度筛选和分页。

参数

参数类型必填说明
sec_codestring股票代码,如 688001
sec_namestring公司名称(模糊匹配)
categorystring公告分类
date_fromstring起始日期 YYYY-MM-DD
date_tostring截止日期 YYYY-MM-DD
keywordstring标题关键词搜索
has_textbool仅返回有文本的公告
pageint页码(默认1)
page_sizeint每页条数(默认20,最大100)

示例

curl -H "X-API-Key: YOUR_API_KEY" "https://api.your-domain.com/api/v1/announcements?sec_code=688001&page=1&page_size=10"
GET /api/v1/announcements/{announcement_id} 需鉴权

说明

查询单条公告详情,可选包含全文内容。

参数

参数类型必填说明
announcement_idstring公告ID(路径参数)
include_textbool是否包含全文(默认false)
GET /api/v1/financial-indicators 需鉴权

说明

查询财务指标列表,支持按股票、报告期、质量状态筛选。

参数

参数类型必填说明
sec_codestring股票代码
sec_namestring公司名称(模糊匹配)
report_periodstring报告期,如 2025年
qualitystring质量状态: passed/warning/failed
pageint页码(默认1)
page_sizeint每页条数(默认20,最大100)
GET /api/v1/financial-indicators/{sec_code} 需鉴权

说明

查询单只股票的全部财务指标记录。

示例

curl -H "X-API-Key: YOUR_API_KEY" "https://api.your-domain.com/api/v1/financial-indicators/688001"
GET /api/v1/stats 需鉴权

返回系统整体统计:公告总量、PDF覆盖、文本覆盖、财务指标数量、质量分布、覆盖股票数。

GET /api/v1/keys POST /api/v1/keys 需鉴权

GET:列出所有API Key(脱敏显示)

POST:创建新API Key,参数:name=Key名称

GET /health 公开

健康检查端点,无需鉴权。返回服务状态和时间戳。