SuperAPI AI 工具集

sec-edgar

办公与效率

查看项目

更新于 10-15 22:13

技能介绍

用途:sec-edgar 是 Vibe-Trading 的抓取层技能,通过内置的 sec_edgar_client 传输层和 get_sec_filings 智能体工具,从美国 SEC EDGAR 获取申报索引、文档 URL 和 us-gaap 指标序列。仅覆盖美国市场,A 股、港股等非美市场需改用 tushare、yfinance 或 akshare。

主要能力:将美股代码解析为 CIK;列出近期申报文件(10-K、10-Q、8-K、DEF 14A、4 等),可省略表单类型返回全部;获取主文档 URL;按 XBRL us-gaap 概念名(如 Revenues、NetIncomeLoss、Assets、StockholdersEquity)拉取指标序列。

使用方式:首选 get_sec_filings 工具,只读、限流、返回严格 JSON,参数如 {"ticker": "AAPL", "form": "10-K", "limit": 5} 或 {"ticker": "MSFT", "metric": "Revenues", "limit": 8}。需要工具未暴露的原始 JSON 时,可直接调用传输层:from backtest.loaders.sec_edgar_client import cik_for, get_submissions, get_company_facts;cik_for("AAPL") 返回 "0000320193" 或 None,get_submissions(cik) 返回申报索引与公司元数据,get_company_facts(cik) 返回全部 XBRL 概念。可运行示例见 sec-edgar/scripts/sec_filings_example.py。

参数与格式:代码不区分大小写;CIK 规范化为 10 位补零字符串,submissions 与 companyfacts 端点需补零形式,文档 URL 用未补零形式;表单类型不区分大小写;指标名区分大小写,为精确分类元素名;日期为 ISO YYYY-MM-DD。工具返回 JSON 字符串信封,客户端返回已解码 dict。

限制:免费、无需 API Key,但需带联系地址的描述性 User-Agent,客户端提供合规默认值并支持 VIBE_TRADING_SEC_UA 覆盖;SEC 按 IP 限流,所有请求经共享 backtest.loaders._http 的 "sec" 桶(约 0.12 秒间隔下限,可用 VIBE_TRADING_SEC_MIN_INTERVAL 覆盖),不要用原始请求循环绕过客户端;非美代码无法解析为 CIK;sec_edgar_client 是轻量 REST 客户端,不是 DataLoaderProtocol,没有 source: "sec_edgar" 回测模式;申报存在提交后延迟,XBRL companyfacts 滞后于申报;数据仅供研究,不构成投资建议。方法论层见 edgar-sec-filings 技能。