FA3-Datafetch/legacy/DOC/requirements.md
2026-01-03 18:27:19 +08:00

46 lines
2.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 需求文档:公司财务数据获取与分析系统
## 1. 项目概述
构建一个后端系统,根据证券代码和所属市场,获取目标公司的财务数据(资产负债表、利润表、现金流量表)。系统将保存原始数据,计算关键财务指标,并生成一份带有样式(背景色)的 Markdown 格式报告。
## 2. 项目范围
- **目标市场**
- **中国 (CN)**: 使用 Tushare API。
- **香港 (HK)**: 使用 Tushare API (已确认支持)。
- **美国 (US)**: 使用 Alpha Vantage API。
- **日本 (JP)**: 尝试使用 Alpha Vantage API (需验证数据完整性)。
- **数据覆盖**:最近 10 年的年度数据(或可获取的历史数据)。
- **数据内容**:三大主要财务报表(利润表、资产负债表、现金流量表)。
## 3. 功能需求
### 3.1 数据获取
- **输入**`证券代码` (Stock Code), `市场` (CN, HK, US, JP)。
- **逻辑**
-`市场 == CN``HK`: 调用 Tushare API。
-`市场 == US`: 调用 Alpha Vantage API。
-`市场 == JP`: 尝试调用 Alpha Vantage API。
- **规模**:获取过去 10 年的数据。
### 3.2 数据存储
- 将获取的原始财务报表保存为本地文件。
- **格式**CSV (推荐,便于后续处理)。
- **命名规范**`data/{市场}/{代码}_{报表类型}.csv`。
### 3.3 数据分析
- 读取本地保存的财务报表文件。
- 计算关键财务指标 (具体指标待定预设包含ROE, 净利率, 负债率等)。
### 3.4 报告生成
- 生成 Markdown 格式的汇总报告。
- **样式要求**:表格需包含背景色(如根据指标优劣显示红/绿,或隔行变色)。
- *注*:由于标准 Markdown 不支持背景色,将采用嵌入 HTML 的方式实现。
## 4. 技术需求
- **开发语言**Python。
- **配置管理**API Key (Tushare, Alpha Vantage) 需可配置(建议使用环境变量或配置文件)。
## 5. 待确认事项
1. **日本市场数据源**Alpha Vantage 对日本市场的财务报表支持程度需在实施阶段验证。
2. **具体的财务指标**:用户需通过文档或沟通确认具体需要计算哪些指标。