edgartools-mcp

<p align="center"> <a href="https://github.com/dgunning/edgartools"> <img src="docs/images/edgartools-logo.png" alt="EdgarTools Python SEC EDGAR library logo" height="80"> </a> </p> <h1 align="center">EdgarTools - Python 库用于 SEC EDGAR 文件</h1> <h3 align="center">为 AI 代理和大型语言模型（LLM）打造的原生 Python 库，用于 SEC EDGAR 数据</h3> <p align="center"> <a href="https://pypi.org/project/edgartools"><img src="https://img.shields.io/pypi/v/edgartools.svg" alt="PyPI - 版本"></a> <a href="https://github.com/dgunning/edgartools/actions"><img src="https://img.shields.io/github/actions/workflow/status/dgunning/edgartools/python-hatch-workflow.yml" alt="GitHub 工作流状态"></a> <a href="https://www.codefactor.io/repository/github/dgunning/edgartools"><img src="https://www.codefactor.io/repository/github/dgunning/edgartools/badge" alt="CodeFactor"></a> <a href="https://github.com/pypa/hatch"><img src="https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg" alt="Hatch 项目"></a> <a href="https://github.com/dgunning/edgartools/blob/main/LICENSE"><img src="https://img.shields.io/github/license/dgunning/edgartools" alt="GitHub"></a> <a href="https://pypi.org/project/edgartools"><img src="https://img.shields.io/pypi/dm/edgartools" alt="PyPI - 下载量"></a> </p> <p align="center"> <img src="docs/images/badges/badge-ai-native.svg" alt="AI 原生"> <img src="docs/images/badges/badge-10x-faster.svg" alt="10 倍更快"> <img src="docs/images/badges/badge-zero-cost.svg" alt="零成本"> <img src="docs/images/badges/badge-production-ready.svg" alt="生产就绪"> <img src="docs/images/badges/badge-open-source.svg" alt="开源"> <img src="docs/images/badges/badge-financial-data.svg" alt="金融数据"> </p> <p align="center"> <b>唯一从头到尾为 AI 代理和大型语言模型（LLM）构建的 SEC EDGAR 库。仅需 3 行代码即可提取财务数据，而非 100+ 行。包含生产就绪的 MCP 服务器。</b> </p> <p align="center"> _{使用 AI 辅助开发构建 • 3-10 倍更快的开发速度 • <a href="#-support-ai-powered-development">支持该项目</a>} </p> **EdgarTools** 是一个用于下载和分析 SEC EDGAR 文件的 Python 库。可以轻松提取 10-K、10-Q、8-K 报告，解析 XBRL 财务报表，并访问内幕交易数据（Form 4），只需使用简单的 Python API。免费且开源。  <p align="center"> <img src="docs/images/dividers/divider-hexagons.svg" alt=""> </p> ## 为什么选择 EdgarTools？ EdgarTools 是 **最快、最强大的开源库**，用于 SEC EDGAR 数据提取。专为需要可靠、生产就绪的 SEC 文件访问的金融分析师、数据科学家和 AI 开发人员而建。 <table align="center"> <tr> <td align="center" width="33%"> <img src="docs/images/icons/icon-speed.svg" width="80" alt="闪电快"><br> <b>闪电快</b><br> 比其他库快 10-30 倍<br> 使用 lxml 和 PyArrow 优化 </td> <td align="center" width="33%"> <img src="docs/images/icons/icon-ai.svg" width="80" alt="AI 原生"><br> <b>AI 原生</b><br> 内置 MCP 服务器，适用于 Claude<br> LLM 优化的文本提取 </td> <td align="center" width="33%"> <img src="docs/images/icons/icon-quality.svg" width="80" alt="数据质量"><br> <b>生产质量</b><br> 1000+ 测试，类型提示<br> 经分析师验证 </td> </tr> <tr> <td align="center" width="33%"> <img src="docs/images/icons/icon-xbrl.svg" width="80" alt="XBRL 支持"><br> <b>XBRL 原生</b><br> 完整的 XBRL 标准化<br> 跨公司比较 </td> <td align="center" width="33%"> <img src="docs/images/icons/icon-data.svg" width="80" alt="丰富的数据"><br> <b>丰富的数据对象</b><br> 智能解析每种表单<br> 适用于 pandas 的 DataFrame </td> <td align="center" width="33%"> <img src="docs/images/icons/icon-community.svg" width="80" alt="开源"><br> <b>开源</b><br> MIT 许可证，社区驱动<br> 透明且可审计 </td> </tr> </table> <p align="center"> <img src="docs/images/dividers/divider-hexagons.svg" alt=""> </p> ## 它是如何工作的 <p align="center"> <img src="docs/images/how-it-works.svg" alt="EdgarTools Python 库如何提取 SEC EDGAR 文件数据"> </p> <p align="center"> <img src="docs/images/dividers/divider-hexagons.svg" alt=""> </p> <p align="center"> <img src="docs/images/sections/section-quick-start.svg" alt="快速入门"> </p> ```python # 安装 SEC EDGAR Python 库 pip install edgartools # 设置您的身份（受 SEC 法规要求） from edgar import * set_identity("your.name@example.com") # 获取 SEC 10-K、10-Q 文件和 XBRL 财务报表 balance_sheet = Company("AAPL").get_financials().balance_sheet() # 访问任何公司的 SEC 文件 company = Company("MSFT") # 解析 Form 4 内幕交易交易 filings = company.get_filings(form="4") form4_filing = filings[0] form4 = form4_filing.obj() ```  <p align="center"> <img src="docs/images/dividers/divider-hexagons.svg" alt=""> </p> ## 用例 ### 分析 13F 机构持仓和对冲基金投资组合 跟踪对冲基金和机构投资者通过解析 SEC 13F 文件拥有哪些资产。EdgarTools 提取完整的投资组合持仓，包括仓位规模、价值和季度环比变化。 ```python from edgar import get_filings thirteenf = get_filings(form="13F-HR")[0].obj() thirteenf.holdings # 所有投资组合仓位的 DataFrame ``` ### 使用 SEC Form 4 跟踪内幕交易 监控内幕买卖活动从 SEC Form 4 文件。查看哪些高管正在购买或出售股票、期权行使和净仓位变化。 ```python company = Company("TSLA") form4 = company.get_filings(form="4")[0].obj() form4.transactions # 内幕买卖交易 ``` ### 从 10-K 和 10-Q 文件中提取财务报表 获取 SEC 年度报告和季度报告中的损益表、资产负债表和现金流量表。数据从 XBRL 中解析，具有标准化的标签，以便跨公司比较。 ```python financials = Company("MSFT").get_financials() financials.balance_sheet() # 资产负债表，包含所有行项目 financials.income_statement() # 收入、净利润、EPS ``` ### 解析 8-K 当前报告的公司事件 访问重要的公司事件 - 收益发布、收购、高管变更等。EdgarTools 将 8-K 文件解析为结构化项目，具有完整的文本提取。 ```python eightk = get_filings(form="8-K")[0].obj() eightk.items # 报告的事件项目列表 ``` ### 跨公司查询 XBRL 财务数据 访问任何 SEC 提交者的结构化 XBRL 财务事实。查询特定行项目，如收入或总资产，随时间推移，并使用标准化概念跨公司比较。 ```python facts = Company("AAPL").get_facts() facts.to_pandas("us-gaap:Revenues") # 收入历史的 DataFrame ``` <p align="center"> <img src="docs/images/dividers/divider-hexagons.svg" alt=""> </p> <p align="center"> <img src="docs/images/sections/section-features.svg" alt="主要功能"> </p> ### 全面的 SEC 数据访问 <table> <tr> <td width="50%" valign="top"> **财务报表（XBRL）** - 资产负债表、损益表、现金流 - 通过 XBRL 标签获取单个行项目 - 多期比较，包括比较期间 - 标准化跨公司数据 - 自动单位转换 - 元数据列（维度、成员、单位） - 完整的维度数据支持 **基金持仓（13F）** - 完整的 13F 文件历史 - 投资组合组成分析 - 随时间跟踪仓位 - 所有权百分比 - 价值计算 **公司数据集和参考数据** - 行业和状态过滤 - 公司子集和元数据 - 标准化的行业分类 - SEC 证券代码/CIK 查询 - 交易所信息 **内幕交易** - Form 3、4、5 结构化数据 - 按内幕交易者划分的交易历史 - 所有权变更 - 授予和执行详情 - 自动解析 </td> <td width="50%" valign="top"> **文件智能** - 任何类型的表格（10-K、10-Q、8-K、S-1 等） - 自 1994 年以来的完整历史 - 每种表单的智能数据对象 - 自动 HTML 转纯文本 - 章节提取（风险因素、MD&A） **性能和可靠性** - 比其他库快 10-30 倍 - 可配置的速率限制（支持企业镜像） - 自定义 SEC 数据源（企业/学术镜像） - 智能缓存（30 秒新鲜文件缓存） - 强大的错误处理 - SSL 验证，快速失败重试 - 整个类型提示 - [企业配置 →](docs/configuration.md#enterprise-configuration) **开发者体验** - 直观、一致的 API - pandas DataFrame 集成 - 丰富的终端输出 - 全面的文档 - 1000+ 测试 </td> </tr> </table> EdgarTools 支持所有 SEC 表格类型，包括 **10-K 年度报告**、**10-Q 季度文件**、**8-K 当前报告**、**13F 机构持仓**、**Form 4 内幕交易**、**委托书（DEF 14A）** 和 **S-1 注册声明**。解析 XBRL 财务数据，提取文本章节，将文件转换为 pandas DataFrame。 <p align="center"> <img src="docs/images/dividers/divider-hexagons.svg" alt=""> </p> ## 与其他库的比较 | 功能 | EdgarTools | sec-api（付费） | OpenEDGAR | 手动抓取 | |---------|------------|----------------|-----------|-----------------| | **AI/MCP 集成** | <img src="docs/images/icons/compare-check.svg" width="20"> | <img src="docs/images/icons/compare-cross.svg" width="20"> | <img src="docs/images/icons/compare-cross.svg" width="20"> | <img src="docs/images/icons/compare-cross.svg" width="20"> | | **成本** | 免费 | $150+/月 | 免费 | 免费 | | **速度** | 10-30 倍基线 | 快速（API） | 慢 | 慢 | | **XBRL 支持** | <img src="docs/images/icons/compare-check.svg" width="20"> | <img src="docs/images/icons/compare-partial.svg" width="20"> | <img src="docs/images/icons/compare-cross.svg" width="20"> | <img src="docs/images/icons/compare-cross.svg" width="20"> | | **财务报表** | <img src="docs/images/icons/compare-check.svg" width="20"> | <img src="docs/images/icons/compare-check.svg" width="20"> | <img src="docs/images/icons/compare-partial.svg" width="20"> | <img src="docs/images/icons/compare-cross.svg" width="20"> | | **LLM 就绪输出** | <img src="docs/images/icons/compare-check.svg" width="20"> | <img src="docs/images/icons/compare-cross.svg" width="20"> | <img src="docs/images/icons/compare-cross.svg" width="20"> | <img src="docs/images/icons/compare-cross.svg" width="20"> | | **类型提示**类型提示** | <img src="docs/images/icons/compare-check.svg" width="20"> | <img src="docs/images/icons/compare-cross.svg" width="20"> | <img src="docs/images/icons/compare-partial.svg" width="20"> | <img src="docs/images/icons/compare-cross.svg" width="20"> | | **速率限制** | <img src="docs/images/icons/compare-check.svg" width="20"> | 无（API） | <img src="docs/images/icons/compare-cross.svg" width="20"> | <img src="docs/images/icons/compare-cross.svg" width="20"> | | **开源** | <img src="docs/images/icons/compare-check.svg" width="20"> MIT | <img src="docs/images/icons/compare-cross.svg" width="20"> 专有 | <img src="docs/images/icons/compare-check.svg" width="20"> Apache | 无 | <p align="center"> <img src="docs/images/dividers/divider-hexagons.svg" alt=""> </p> <p align="center"> <img src="docs/images/sections/section-ai-integration.svg" alt="AI 集成"> </p> ### 将 EdgarTools 与 Claude Code 和 Claude Desktop 一起使用 EdgarTools 提供了 **AI 技能**，使 Claude 和其他 AI 助手能够执行复杂的 SEC 文件分析。配置后，您可以向 Claude 提问： - *"比较 Apple 和 Microsoft 的收入增长率，过去 3 年"* - *"哪些 Tesla 高管在过去 6 个月内出售了超过 100 万美元的股票？"* - *"查找所有提交了包含高管薪酬变更的委托书的科技公司"* Claude 将编写 Python 代码，执行它，并解释结果 - 所有这些都由 EdgarTools 提供支持。 <details> <summary><b>安装说明</b></summary> ### 选项 1：AI 技能（推荐） 使用以下命令为 Claude Code 或 Claude Desktop 安装 EdgarTools 技能： ```bash pip install "edgartools[ai]" python -c "from edgar.ai import install_skill; install_skill()" ``` 这为 SEC 分析添加了 3450+ 行 API 文档、代码示例和表单类型参考。 ### 选项 1：MCP 服务器 以 MCP 服务器身份运行 EdgarTools，适用于 Claude Code 或 Claude Desktop： ```bash pip install "edgartools[ai]" python -m edgar.ai ``` 在 Claude Desktop 配置文件（`~/Library/Application Support/Claude/claude_desktop_config.json`）中添加： ```json { "mcpServers": { "edgartools": { "command": "python", "args": ["-m", "edgar.ai"], "env": { "EDGAR_IDENTITY": "您的姓名 您的邮箱@example.com" } } } } ``` 有关完整文档，请参阅 [AI 集成指南](docs/ai-integration.md)。 </details> <p align="center"> <img src="docs/images/dividers/divider-hexagons.svg" alt=""> </p> ## <img src="docs/images/icons/emoji-heart.svg" width="24" height="24"> 支持 AI 驱动的开发 **我使用 AI 辅助开发单独构建和维护 EdgarTools。** 您的支持直接资助 Claude Max 订阅，使这种非凡的速度成为可能。 ### 善意循环 <table align="center"> <tr> <td align="center" width="25%" valign="top"> <img src="docs/images/icons/emoji-1.svg" width="24" height="24"><br> <b>您支持</b><br><br> 买我一杯咖啡<br> 贡献资金用于<br> Claude Max </td> <td align="center" width="25%" valign="top"> <img src="docs/images/icons/emoji-2.svg" width="24" height="24"><br> <b>AI 加速</b><br><br> 专用代理<br> 提供 <b>3-10 倍</b> 更快的<br> 开发速度 </td> <td align="center" width="25%" valign="top"> <img src="docs/images/icons/emoji-3.svg" width="24" height="24"><br> <b>快速交付</b><br><br> 功能在<b>天</b>内<br> 而不是周<br> 24 次发布 / 60 天 </td> <td align="center" width="25%" valign="top"> <img src="docs/images/icons/emoji-4.svg" width="24" height="24"><br> <b>您受益</b><br><br> 更多功能,<br> 更快的修复,<br> 永久免费 </td> </tr> </table> ### 实际影响：最近 60 天 <table align="center"> <tr> <td align="center" width="25%" valign="top"> <img src="docs/images/icons/emoji-rocket.svg" width="24" height="24"><br> <h3>24</h3> <b>版本</b><br> _{每 2.5 天 1 个} </td> <td align="center" width="25%" valign="top"> <img src="docs/images/icons/emoji-lightning.svg" width="24" height="24"><br> <h3>322</h3> <b>提交</b><br> _{每天 5.4 次} </td> <td align="center" width="25%" valign="top"> <img src="docs/images/icons/emoji-target.svg" width="24" height="24"><br> <h3>3-10 倍</h3> <b>速度</b><br> _{与传统开发相比} </td> <td align="center" width="25%" valign="top"> <img src="docs/images/icons/emoji-timer.svg" width="24" height="24"><br> <h3>天</h3> <b>而不是周</b><br> _{对于主要功能} </td> </tr> </table> ### 最近的例子 | 功能 | 传统估计 | 使用 AI | 速度提升 | |---------|---------------------|---------|---------| | XBRL 期间选择 | 3-4 周 | 5 天 | **7 倍更快** | | MCP 工作流工具 | 2-3 周 | 2 天 | **10 倍更快** | | HTML 解析重写 | 2 周 | 3 天 | **4 倍更快** | | 标准化概念 API | 2 周 | 2-3 天 | **5 倍更快** | <p align="center"> <a href="https://github.com/sponsors/dgunning" target="_blank"> <img src="https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#EA4AAA" alt="GitHub Sponsors" height="40"> </a> &nbsp;&nbsp; <a href="https://www.buymeacoffee.com/edgartools" target="_blank"> <img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="40"> </a> </p> **您的支持使以下功能成为可能：** - <img src="docs/images/icons/emoji-check.svg" width="16" height="16"> Claude Max 订阅（编写、测试和记录代码的 AI 代理） - <img src="docs/images/icons/emoji-check.svg" width="16" height="16"> 持续的 3-10 倍开发速度（功能在几天内，而不是几周内） - <img src="docs/images/icons/emoji-check.svg" width="16" height="16"> 快速响应 SEC 格式变化和错误报告 - <img src="docs/images/icons/emoji-check.svg" width="16" height="16"> 根据社区需求的新功能 - <img src="docs/images/icons/emoji-check.svg" width="16" height="16"> 永久免费访问（无 API 密钥，无速率限制） **替代支持方式：** - <img src="docs/images/icons/emoji-star.svg" width="16" height="16"> 在 GitHub 上给仓库加星 - <img src="docs/images/icons/emoji-bug.svg" width="16" height="16"> 报告错误并贡献修复 - <img src="docs/images/icons/emoji-book.svg" width="16" height="16"> 改进文档 - <img src="docs/images/icons/emoji-speech.svg" width="16" height="16"> 在讨论中回答问题 - <img src="docs/images/icons/emoji-link.svg" width="16" height="16"> 与同事分享 EdgarTools **企业用户**：如果您的组织依赖 EdgarTools 进行 SEC 合规或监管报告，[GitHub Sponsors](https://github.com/sponsors/dgunning) 提供针对关键依赖项的战略赞助选项。 <p align="center"> <img src="docs/images/dividers/divider-hexagons.svg" alt=""> </p> <p align="center"> <img src="docs/images/sections/section-community.svg" alt="社区和支持"> </p> ### 文档和资源 - [用户旅程 / 示例](https://edgartools.readthedocs.io/en/latest/examples/) - [快速指南](https://edgartools.readthedocs.io/en/latest/quick-guide/) - [完整 API 文档](https://edgartools.readthedocs.io/) - [EdgarTools 博客](https://www.edgartools.io) ### 获取帮助和联系 - [GitHub 问题](https://github.com/dgunning/edgartools/issues) - 错误报告和功能请求 - [讨论](https://github.com/dgunning/edgartools/discussions) - 问题和社区讨论 ### 贡献 我们欢迎社区贡献！以下是您可以提供帮助的方式： - **代码**：修复错误，添加功能，改进文档 - **示例**：分享有趣的用例和示例 - **反馈**：报告问题或建议改进 - **传播**：给仓库加星，与同事分享 查看我们的 [贡献指南](CONTRIBUTING.md) 获取详细信息。 --- <p align="center"> EdgarTools 在 <a href="LICENSE">MIT 许可证</a> 下分发 </p> ## 星级历史 [](https://star-history.com/#dgunning/edgartools&Timeline)