使用说明
EdgarTools - Python Library for SEC EDGAR Filings
The AI Native Python library for SEC EDGAR Data
The only SEC EDGAR library built from the ground up for AI agents and LLMs. Extract financial data in 3 lines of code instead of 100+. Production-ready MCP server included.
Built with AI-assisted development • 3-10x faster velocity • Support this project
EdgarTools 是一个用于下载和分析SEC EDGAR文件的Python库。提取10-K、10-Q、8-K报告,解析XBRL财务报表,并使用简单的Python API访问内幕交易数据(表4)。免费和开源。
为什么选择EdgarTools?
EdgarTools是 最快、最强大的开源库 用于SEC EDGAR数据提取。专为需要可靠、生产就绪的SEC文件访问权限的金融分析师、数据科学家和人工智能开发人员而设计。
|
Lightning Fast 10-30x faster than alternatives Optimized with lxml & PyArrow |
AI Native Built-in MCP server for Claude LLM-optimized text extraction |
Production Quality 1000+ tests, type hints Battle-tested by analysts |
|
XBRL Native Full XBRL standardization Cross-company comparisons |
Rich Data Objects Smart parsing for every form Pandas-ready DataFrames |
Open Source MIT license, community-driven Transparent & auditable |
运作原理
# Install the SEC EDGAR Python library
pip install edgartools
# Set your identity (required by SEC regulations)
from edgar import *
set_identity("your.name@example.com")
# Get SEC 10-K, 10-Q filings and XBRL financial statements
balance_sheet = Company("AAPL").get_financials().balance_sheet()
# Access any company's SEC filings
company = Company("MSFT")
# Parse Form 4 insider trading transactions
filings = company.get_filings(form="4")
form4_filing = filings[0]
form4 = form4_filing.obj()
用例
分析13F机构控股和对冲基金投资组合
通过分析SEC 13F文件来追踪对冲基金和机构投资者拥有的资产。EdgarTools提取完整的投资组合持有量,包括头寸规模、价值和季度变化。
from edgar import get_filings
thirteenf = get_filings(form="13F-HR")[0].obj()
thirteenf.holdings # DataFrame of all portfolio positions
使用美国证券交易委员会表格4追踪内幕交易
根据美国证券交易委员会表格4的文件监控内幕人士的买卖活动。查看哪些高管正在购买或出售股票、期权行使和净头寸变动。
company = Company("TSLA")
form4 = company.get_filings(form="4")[0].obj()
form4.transactions # Insider buy/sell transactions
从10-K和10-Q文件中提取财务报表
从美国证券交易委员会的年度和季度报告中获取损益表、资产负债表和现金流量表。从XBRL中解析数据,并使用标准化标签进行跨公司比较。
financials = Company("MSFT").get_financials()
financials.balance_sheet() # Balance sheet with all line items
financials.income_statement() # Revenue, net income, EPS
解析8-K公司活动当前报告
访问公司发生的重大事件——收益发布、收购、高管变动等。EdgarTools通过全文提取将8-K文件解析为结构化项目。
eightk = get_filings(form="8-K")[0].obj()
eightk.items # List of reported event items
跨公司查询XBRL财务数据
访问任何SEC申报人的结构化XBRL财务事实。查询特定的行项目,如收入或总资产随时间的变化,并使用标准化的概念在公司之间进行比较。
facts = Company("AAPL").get_facts()
facts.to_pandas("us-gaap:Revenues") # Revenue history as DataFrame
全面的SEC数据访问
|
财务报表(XBRL)
基金控股(13F)
公司数据集和参考数据
内幕交易
|
归档情报
性能和可靠性
开发者体验
|
EdgarTools支持所有SEC表单类型,包括 10-K年度报告, 10-Q季度报告, 8-K当前报告, 13F机构持股, 表格4内幕交易, 委托书(DEF 14A),以及 S-1注册声明解析XBRL财务数据,提取文本部分,并将文件转换为pandas DataFrames。
与备选方案的比较
| 功能 | EdgarTools | sec-api(付费) | OpenEDGAR | 手动报废 |
|---|---|---|---|---|
| AI/MCP集成 | ||||
| 成本 | 免费 | 每月150美元以上 | 免费 | 免费 |
| 速度 | 10-30x基线 | 快(API) | 慢 | 慢 |
| XBRL支持 | 满 | 部分 | ||
| 财务报表 | 已解析 | 已解析 | 基础 | DIY |
| LLM就绪输出 | ||||
| 类型提示 | ||||
| 速率限制 | 自动 | N/A(API) | 手册 | 手册 |
| 开源 | 麻省理工学院 | 专有 | Apache | 不适用 |
使用EdgarTools与克劳德代码和克劳德桌面
EdgarTools提供 人工智能技能 这使得Claude和其他人工智能助理能够执行复杂的SEC文件分析。配置后,您可以向Claude提出以下问题:
- “比较苹果和微软过去3年的收入增长率”
- “在过去6个月里,哪些特斯拉高管出售了超过100万美元的股票?”
- “查找所有提交了高管薪酬变更委托书的科技公司”
Claude将编写Python代码,执行它,并解释结果——所有这些都由EdgarTools提供支持。
Setup Instructions
选项1:人工智能技能(推荐)
为Claude Code或Claude Desktop安装EdgarTools技能:
pip install "edgartools[ai]"
python -c "from edgar.ai import install_skill; install_skill()"
这为Claude添加了SEC分析功能,包括3450多行API文档、代码示例和表单类型引用。
选项2:MCP服务器
将EdgarTools作为Claude Code或Claude Desktop的MCP服务器运行:
pip install "edgartools[ai]"
python -m edgar.ai
添加到Claude桌面配置(~/Library/Application Support/Claude/claude_desktop_config.json):
{
"mcpServers": {
"edgartools": {
"command": "python",
"args": ["-m", "edgar.ai"],
"env": {
"EDGAR_IDENTITY": "Your Name your.email@example.com"
}
}
}
}
看 AI集成指南 以获取完整的文档。
支持人工智能驱动的开发
我使用人工智能辅助开发独自构建和维护EdgarTools。 您的支持直接为Claude Max订阅提供资金,使这种非凡的速度成为可能。
良性循环
|
You Support Buy Me A Coffee contributions fund Claude Max |
AI Acceleration Specialized agents deliver 3-10x faster development |
Rapid Delivery Features in days instead of weeks 24 releases / 60 days |
You Benefit More features, faster fixes, free forever |
实际影响:过去60天
24Releases1 every 2.5 days |
322Commits5.4 per day |
3-10xVelocityvs traditional dev |
DaysNot Weeksfor major features |
最近的例子
| 功能 | 传统估算 | 人工智能 | 加速 |
|---|---|---|---|
| XBRL周期选择 | 3-4周 | 5天 | 快7倍 |
| MCP工作流工具 | 2-3周 | 2天 | 快10倍 |
| HTML解析重写 | 2周 | 3天 | 快4倍 |
| API标准化概念 | 2周 | 2-3天 | 速度提高5倍 |
您的支持能够实现:
- Claude Max订阅(编写、测试和记录代码的AI代理)
- 持续3-10x的开发速度(功能以天为单位,而不是以周为单位)
- 快速响应SEC格式更改和错误报告
- 基于社区需求的新功能
- 人人免费访问,永远(无API密钥,无费率限制)
其他支持方式:
- 在GitHub上标记仓库
- 报告错误并提供修复
- 改进文档
- 回答讨论中的问题
- 与同事共享EdgarTools
企业用户:如果您的组织依赖EdgarTools进行SEC合规或监管报告, GitHub赞助商 提供针对关键任务依赖性设计的战略赞助选项。
文档和资源
获取帮助和连接
贡献
我们欢迎社区的贡献!以下是您可以提供帮助的方式:
- 代码:修复错误、添加功能、改进文档
- 例子:分享有趣的用例和示例
- 反馈:报告问题或提出改进建议
- 散布消息:标记回购,与同事分享
查看我们的 贡献指南 了解详情。
EdgarTools is distributed under the MIT License