SEC API Python 使用教程

项目介绍

sec-api-python 是一个用于访问美国证券交易委员会（SEC）电子数据收集、分析和检索系统（EDGAR）的Python库。该库允许用户通过编程方式搜索和下载SEC提交的文件，如10-K、10-Q、8-K等，以及执行更复杂的查询和数据提取操作。

项目快速启动

安装

首先，通过pip安装sec-api-python库：

pip install sec-api

获取API密钥

在使用之前，你需要从sec-api.io获取一个免费的API密钥。

示例代码

以下是一个简单的示例，展示如何使用sec-api库来查询特定公司的10-Q文件：

from sec_api import QueryApi

api_key = "YOUR_API_KEY"
queryApi = QueryApi(api_key=api_key)

query = {
    "query": {
        "query_string": {
            "query": "ticker:TSLA AND formType:10-Q"
        }
    },
    "from": "0",
    "size": "10",
    "sort": [{ "filedAt": { "order": "desc" } }]
}

filings = queryApi.get_filings(query)
print(filings)

应用案例和最佳实践

应用案例

1. 财务分析：通过提取和分析公司的10-K和10-Q文件，进行财务健康状况评估。
2. 市场监控：实时监控特定公司的8-K文件，以获取即时市场变动信息。
3. 合规性检查：检查公司是否按时提交所有必要的SEC文件。

最佳实践

• 合理使用API：遵循SEC的访问频率限制，避免过度请求。
• 数据验证：在处理和分析数据之前，确保数据的准确性和完整性。
• 错误处理：实现适当的错误处理机制，以应对API请求失败或数据不完整的情况。

典型生态项目

• sec-edgar-api：一个轻量级的非官方Python API包装器，用于SEC EDGAR REST API。
• XBRL-to-JSON Converter API：用于将XBRL格式的财务报告转换为JSON格式，便于进一步分析。
• 10-K/10-Q Section Extraction API：用于从10-K和10-Q文件中提取特定部分的API。

通过这些工具和库，开发者可以更高效地访问和分析SEC EDGAR的数据，从而支持各种金融分析和市场监控任务。