Edgar-SEC API Overview#
Edgar-SEC provides a modular, typed client interface for interacting with the SEC EDGAR® API, supporting both synchronous and asynchronous workflows with a consistent dataclass model layer.
This page summarizes the main client components, supported endpoints, and enhanced runtime features.
—
Client Architecture#
Expand Client Class Hierarchy
edgar_sec.EdgarAPI
- Unified synchronous clientedgar_sec.AsyncAPI
- Asynchronous client wrapper
Each interface shares a common internal design:
edgar_sec.EdgarAPI.get_submissions()
→ synchronous
edgar_sec.AsyncAPI.get_submissions()
→ asynchronous
Each class is accessed as an attribute:
edgar_sec.EdgarAPI.Async
→ instance of the asynchronous client (edgar_sec.AsyncAPI
)
Helpers are exposed via edgar_sec.EdgarHelpers
for common tasks like CIK lookups, pagination, and data validation.
edgar_sec.EdgarHelpers.get_cik()
→ CIK search (synchronous)
edgar_sec.EdgarHelpers.get_cik_async()
→ CIK search (asynchronous)
—
Client Capabilities#
—
Enhanced API Features#
—