edgar¶
Use when: You need to resolve tickers to CIKs, list filings, fetch HTML from SEC EDGAR, or locate prior comparable filings for diffs.
Start here¶
resolve_filing()— resolve ticker + fiscal year + form to aFilingRefresolve_prior_filing()— find the prior comparable filing for diffsload_filing_html()— download (or read from cache) filing HTMLresolve_cik()/list_filings()— ticker lookup and filing indexfetch_json()/fetch_text()— low-level SEC HTTP helpers
Requires SEC_USER_AGENT in the environment. See SEC EDGAR Setup.
Example¶
import os
os.environ["SEC_USER_AGENT"] = "YourName your@email.com"
from disclosure_alpha.edgar.resolver import resolve_filing, load_filing_html
ref = resolve_filing("AAPL", fiscal_year=2025, form_type="10-K")
html = load_filing_html(ref)
Full API¶
-
disclosure_alpha.edgar.resolver.resolve_cik(ticker: str, *, tickers: dict[str, tuple[str, str]] | None =
None) str[source]¶
-
disclosure_alpha.edgar.resolver.list_filings(ticker: str, fiscal_year: int, *, form_type: str | None =
None, use_cache: bool =True, cache_dir=None) list[FilingRef][source]¶
-
disclosure_alpha.edgar.resolver.resolve_filing(ticker: str, fiscal_year: int, form_type: str =
'10-K', quarter: str | None =None, *, use_cache: bool =True, cache_dir=None) FilingRef[source]¶
-
disclosure_alpha.edgar.resolver.resolve_prior_filing(ref: FilingRef, *, use_cache: bool =
True, cache_dir=None) FilingRef | None[source]¶
-
disclosure_alpha.edgar.resolver.load_filing_html(ref: FilingRef, *, use_cache: bool =
True, cache_dir=None) str[source]¶
- disclosure_alpha.edgar.client.fetch_company_tickers() dict[str, tuple[str, str]][source]¶
Return ticker -> (cik_padded, company_name).
- disclosure_alpha.edgar.client.filing_document_url(cik: str, accession_number: str, primary_document: str) str[source]¶