API Reference#

This section provides detailed, automatically generated documentation for edgar-sec’s modules, classes, and functions. It covers both synchronous and asynchronous clients, helper utilities, and typed object models.

All API documentation is generated from the live source code using Sphinx autodoc and autosummary.

—

API Clients#

edgar_sec.EdgarAPI([cache_mode, cache_size])

Interact with the US Securities and Exchange Commission EDGAR API.

edgar_sec.AsyncAPI(parent)

The Async sub-class contains methods for interacting with the SEC EDGAR API asynchronously.

Utility Helpers#

edgar_sec.helpers.EdgarHelpers()

A class containing helper methods for the Edgar SEC module.

Data Objects#

edgar_sec.objects.Address(address_type, ...)

A class representing an address from SEC filing data.

edgar_sec.objects.FormerName(name, ...)

A class representing a former name of an SEC filing entity.

edgar_sec.objects.File(name, filing_count, ...)

A class representing a file reference in SEC EDGAR submission history.

edgar_sec.objects.Filing(accession_number, ...)

A class representing an SEC filing document.

edgar_sec.objects.SubmissionHistory(cik, ...)

A class representing the complete submission history of an SEC filing entity.

edgar_sec.objects.UnitDisclosure(units, end, ...)

A class representing a specific financial disclosure for a single unit of measurement.

edgar_sec.objects.CompanyConcept(cik, ...)

A class representing a specific financial concept for a company from SEC filings.

edgar_sec.objects.TaxonomyDisclosures(name, ...)

A class representing a specific financial concept disclosure for an entity.

edgar_sec.objects.TaxonomyFacts(taxonomy, ...)

A class representing a collection of financial disclosures for a specific taxonomy.

edgar_sec.objects.CompanyFacts(cik, ...)

A class representing the complete collection of financial facts for a company from SEC filings.

edgar_sec.objects.FrameDisclosure(accn, cik, ...)

A class representing a single financial disclosure from an SEC reporting frame.

edgar_sec.objects.Frame(taxonomy, tag, ccp, ...)

A class representing a collection of financial disclosures across multiple companies for a specific concept and time period.

edgar_sec.objects.Company(cik, ticker, title)

A class representing a company in the Edgar SEC database.

—