HKFilings API 文档

主要端点

• POST /v1/hk-tasks —— 提交一次分析任务（按代号 + 年份，或上传 PDF）
• GET /v1/hk-tasks/{task_id} —— 查询任务状态
• GET /v1/hk-tasks/{task_id}/events —— SSE 事件流（pipeline 进度 + LLM delta）
• GET /v1/hk-facts —— 查询已抽取的结构化事实（按 ticker / period 过滤）
• GET /v1/hk-companies/{ticker}/matrix —— 跨期指标矩阵
• GET /v1/schema/financial_fact —— 冻结的 JSON Schema（向后兼容只增不减）
• GET /v1/openapi.json —— 完整 OpenAPI 3.1 规范

错误处理

错误以标准 RFC 7807 problem+json 形式返回。状态码：

• 400 —— 请求字段缺失或非法
• 401 —— API key 缺失或不匹配
• 404 —— task_id 或资源未找到
• 409 —— 重复任务（duplicate=true 时仍返回 200）
• 500 —— 服务端内部异常 / LLM 失败

SSE 事件流

GET /v1/hk-tasks/{task_id}/events 返回 text/event-stream，每条消息是一个完整的任务快照。其中 events 数组承载 LLM 的 thinking / content delta、stream_stage、chunk 计数等元信息，可直接驱动前端实时面板。

Python SDK

pypi.org/project/hkfilings · GitHub 源代码。 pip install hkfilings，开箱可用。