sec-api-python 项目使用文档

鲁日姝Hunter

于 2024-09-02 07:07:07 发布

阅读量660

点赞数 28

本文链接：https://blog.csdn.net/gitblog_00446/article/details/141794939

版权

sec-api-python 项目使用文档

sec-api-pythonPython SEC EDGAR Filings API. Over 18 million filings, all 150 filing types supported. Query, full-text search and real-time stream API. Convert XBRL-to-JSON and access standardized financial statements from 10-K and 10-Q filings.项目地址:https://gitcode.com/gh_mirrors/se/sec-api-python

1. 项目的目录结构及介绍

sec-api-python/
├── README.md
├── requirements.txt
├── sec_api/
│   ├── __init__.py
│   ├── api.py
│   ├── config.py
│   └── main.py
└── tests/
    ├── __init__.py
    └── test_api.py

README.md: 项目说明文件，包含项目的基本信息和使用指南。
requirements.txt: 项目依赖文件，列出了运行该项目所需的所有Python包。
sec_api/: 项目的主要代码目录。
- init.py: 使 sec_api 成为一个Python包。
- api.py: 包含与SEC API交互的函数和类。
- config.py: 项目的配置文件，包含API密钥等配置信息。
- main.py: 项目的启动文件，包含主程序入口。
tests/: 项目的测试代码目录。
- init.py: 使 tests 成为一个Python包。
- test_api.py: 包含对 api.py 中函数的单元测试。

2. 项目的启动文件介绍

main.py 是项目的启动文件，负责初始化API客户端并调用相关功能。以下是 main.py 的基本结构：

from sec_api import ApiClient
from config import API_KEY

def main():
    client = ApiClient(API_KEY)
    # 调用API客户端的功能
    client.search_filings(...)

if __name__ == "__main__":
    main()

导入模块: 导入了 ApiClient 类和 API_KEY 配置。
main 函数: 初始化 ApiClient 实例并调用其方法。
入口点: if __name__ == "__main__": 确保脚本作为主程序运行时执行 main 函数。