finagg

finagg

用于聚合和规范化来自流行和免费金融 API 的历史数据的Python 包

通过Python包整合多种热门免费金融API,便于历史数据聚合到SQL数据库中,并转换为分析和AI/ML有用的特征。支持实时数据获取和金融数据分析,还可用于强化学习环境的搭建。兼容Python 3.10及以上版本,适用于Linux和Windows系统。详细信息请参阅文档和示例。

finaggPython财务数据聚合APISQL数据库Github开源项目

finagg:Python 金融数据聚合工具包

finagg 是一个 Python 包,专门提供热门免费金融 API 的实现,帮助用户将这些 API 获得的历史数据聚合到 SQL 数据库中,并将聚合数据转化为适用于分析和人工智能/机器学习的特征。

快速开始

安装

用户可以通过 pip 安装最新的稳定版本:

pip install finagg

或者从 GitHub 安装最新的不稳定版本:

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

还可以选择从第三方 API 安装推荐的数据集(例如,经济数据、公司财务、股票历史等)到本地 SQL 数据库中:

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

安装过程将指导用户如何获得免费 API 密钥,并将这些密钥存储在本地的 .env 文件中。用户可以通过运行 finagg install --help 查看更多安装选项和细节。

基本用法

本部分提供了一些 finagg 的使用示例。对于支持的所有 API 和功能,请参阅相关文档。

  1. 直接探索 API

    • 需要互联网访问和 API 密钥/用户代理声明。
    >>> finagg.bea.api.gdp_by_industry.get(year=[2019]).head(5)
  2. 利用已安装的原始数据探索热门特征

    • 需要下载和安装原始数据。
    >>> finagg.fred.feat.economic.from_raw().head(5)
  3. 利用已安装的特征探索原始数据的精炼汇总

    • 需要通过安装命令载入精炼数据。
    >>> finagg.sec.feat.quarterly.industry.from_refined(ticker="AAPL").head(5)

配置

API 密钥和用户代理

大多数 API 需要 API 密钥和用户代理声明。可以通过设置环境变量或程序化地传递这些信息来配置 finagg

  • BEA_API_KEY:用于获取经济分析局的 API 密钥。
  • FRED_API_KEY:用于获取联邦储备经济数据的国家 API 密钥。
  • SEC_API_USER_AGENT:证券交易委员会的 API 用户代理声明,格式为 FIRST_NAME LAST_NAME E_MAIL

数据位置

finagg 的根路径、HTTP 缓存路径和数据库路径均可通过环境变量进行配置。

  • FINAGG_ROOT_PATH:指向 ./findata 目录的父目录,默认为当前工作目录。
  • FINAGG_HTTP_CACHE_PATH:指向 HTTP 请求缓存的 SQLite 存储,默认为 ./findata/http_cache.sqlite
  • FINAGG_DATABASE_URL:指向 finagg 数据存储,默认为 ./findata/finagg.sqlite

依赖项

  • pandas:用于快速、灵活和富有表现力的关系数据表示。
  • requests:用于对第三方 API 的 HTTP 请求。
  • requests-cache:用于缓存 HTTP 请求以避免被第三方 API 服务器限速。
  • SQLAlchemy:用于 SQL 的 Python 接口。
  • yfinance:用于从 Yahoo! Finance 获取历史股票数据。

相关项目

  • FinRL:集合金融强化学习环境和工具。
  • fredapi:FRED API 的实现。
  • OpenBBTerminal:Bloomberg 终端的开源版本。
  • sec-edgar:文件型 SEC EDGAR 解析器的实现。
  • sec-edgar-api:SEC EDGAR REST API 的实现。

常见问题解答

  1. 应该从哪里开始?

    聚合数据、创建分析笔记本,或利用实现的数据特征和 SQL 表创建 RL 环境。

  2. 为什么特定标的或经济数据系列无法安装特征?

    API 可能相对新,未提供特定标的或经济数据的相应数据。

  3. 支持哪些 Python 版本?

    支持 Python 版本 3.10 及以上。

  4. 支持哪些操作系统?

    在 Linux 和 Windows 上开发和测试,推荐在实践中使用 Linux 或 WSL。

编辑推荐精选

Vora

Vora

免费创建高清无水印Sora视频

Vora是一个免费创建高清无水印Sora视频的AI工具

Refly.AI

Refly.AI

最适合小白的AI自动化工作流平台

无需编码,轻松生成可复用、可变现的AI自动化工作流

酷表ChatExcel

酷表ChatExcel

大模型驱动的Excel数据处理工具

基于大模型交互的表格处理系统,允许用户通过对话方式完成数据整理和可视化分析。系统采用机器学习算法解析用户指令,自动执行排序、公式计算和数据透视等操作,支持多种文件格式导入导出。数据处理响应速度保持在0.8秒以内,支持超过100万行数据的即时分析。

AI工具酷表ChatExcelAI智能客服AI营销产品使用教程
TRAE编程

TRAE编程

AI辅助编程,代码自动修复

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
AIWritePaper论文写作

AIWritePaper论文写作

AI论文写作指导平台

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

AI辅助写作AI工具AI论文工具论文写作智能生成大纲数据安全AI助手热门
博思AIPPT

博思AIPPT

AI一键生成PPT,就用博思AIPPT!

博思AIPPT,新一代的AI生成PPT平台,支持智能生成PPT、AI美化PPT、文本&链接生成PPT、导入Word/PDF/Markdown文档生成PPT等,内置海量精美PPT模板,涵盖商务、教育、科技等不同风格,同时针对每个页面提供多种版式,一键自适应切换,完美适配各种办公场景。

AI办公办公工具AI工具博思AIPPTAI生成PPT智能排版海量精品模板AI创作热门
潮际好麦

潮际好麦

AI赋能电商视觉革命,一站式智能商拍平台

潮际好麦深耕服装行业,是国内AI试衣效果最好的软件。使用先进AIGC能力为电商卖家批量提供优质的、低成本的商拍图。合作品牌有Shein、Lazada、安踏、百丽等65个国内外头部品牌,以及国内10万+淘宝、天猫、京东等主流平台的品牌商家,为卖家节省将近85%的出图成本,提升约3倍出图效率,让品牌能够快速上架。

iTerms

iTerms

企业专属的AI法律顾问

iTerms是法大大集团旗下法律子品牌,基于最先进的大语言模型(LLM)、专业的法律知识库和强大的智能体架构,帮助企业扫清合规障碍,筑牢风控防线,成为您企业专属的AI法律顾问。

SimilarWeb流量提升

SimilarWeb流量提升

稳定高效的流量提升解决方案,助力品牌曝光

稳定高效的流量提升解决方案,助力品牌曝光

Sora2视频免费生成

Sora2视频免费生成

最新版Sora2模型免费使用,一键生成无水印视频

最新版Sora2模型免费使用,一键生成无水印视频

下拉加载更多