finagg: 一款强大的财务数据聚合与分析 Python 工具包

finagg: 财务数据处理的利器

在当今数据驱动的金融世界中,快速获取和处理大量金融数据变得越来越重要。finagg 应运而生,它是一款专为财务数据聚合和分析而设计的 Python 工具包,为金融专业人士、数据科学家和开发者提供了强大而灵活的解决方案。

强大功能一览

finagg 的核心功能包括:

实现了多个流行的免费金融 API 接口
提供工具将这些 API 的历史数据聚合到 SQL 数据库中
具备将聚合数据转换为适用于分析和 AI/ML 的特征的能力

这些功能使 finagg 成为处理金融数据的理想工具,无论是进行市场分析、风险评估,还是构建预测模型。

支持的数据源

finagg 支持多个知名的金融数据源,包括:

经济分析局 (BEA) 数据
联邦储备经济数据 (FRED)
证券交易委员会 (SEC) 文件
Yahoo! Finance 的历史股票数据

通过这些多样化的数据源,用户可以获取从宏观经济指标到个股财务报表的广泛数据。

FRED economic data

快速上手

使用 pip 安装最新稳定版本:

pip install finagg

或者从 GitHub 安装最新开发版本:

git clone https://github.com/theOGognf/finagg.git
pip install ./finagg/

安装完成后,可以选择安装推荐的数据集到本地 SQL 数据库:

finagg install -ss economic -ts indices -z -r

这将指导您获取所需的免费 API 密钥,并将它们存储在本地的 .env 文件中。

基本用法示例

finagg 提供了多种方式来访问和处理数据。以下是一些基本用法示例:

直接访问 API 数据:

import finagg

# 获取 BEA 数据
bea_data = finagg.bea.api.gdp_by_industry.get(year=[2019]).head(5)

# 获取 FRED 数据
fred_data = finagg.fred.api.series.observations.get(
    "CPIAUCNS",
    realtime_start=0,
    realtime_end=-1,
    output_type=4
).head(5)

# 获取 SEC 文件数据
sec_data = finagg.sec.api.company_facts.get(ticker="AAPL").head(5)

使用已安装的原始数据探索常用特征:

# 获取 FRED 最常用的经济特征
economic_features = finagg.fred.feat.economic.from_raw().head(5)

# 获取 SEC 季度报告特征
quarterly_features = finagg.sec.feat.quarterly.from_raw("AAPL").head(5)

# 获取特定股票的季度和日线特征聚合
fundamental_features = finagg.fundam.feat.fundam.from_raw("AAPL").head(5)

使用已安装的特征探索精炼的数据聚合:

# 获取某个股票所属行业的平均季度报告特征
industry_features = finagg.sec.feat.quarterly.industry.from_refined(ticker="AAPL").head(5)

# 获取某个股票的行业标准化季度报告特征
normalized_features = finagg.sec.feat.quarterly.normalized.from_refined("AAPL").head(5)

# 获取按某个行业标准化的季度报告特征排序的股票列表
sorted_tickers = finagg.sec.feat.quarterly.normalized.get_tickers_sorted_by(
    "NORM(EarningsPerShareBasic)",
    year=2019
)[:5]

SEC filing data

配置选项

finagg 提供了多种配置选项,使用户可以根据自己的需求进行灵活设置:

API 密钥和用户代理:
- 可以通过环境变量设置,如 BEA_API_KEY, FRED_API_KEY 等
- 也可以在程序中直接传递给 API 实现
数据存储位置:
- 可通过 FINAGG_ROOT_PATH, FINAGG_HTTP_CACHE_PATH, FINAGG_DATABASE_URL 等环境变量自定义
其他行为配置:
- 如 FINAGG_DISABLE_HTTP_CACHE 可用于禁用 HTTP 请求缓存