Expand description
SEC EDGAR API client for filing history, XBRL data, and full-text search. SEC EDGAR API client.
Provides access to SEC EDGAR data including filing history, structured XBRL financial data, and full-text search.
All requests are rate-limited to 10 per second as required by SEC. Rate limiting, HTTP connection pooling, and CIK caching are managed internally via a process-global singleton.
§Quick Start
Initialize once at application startup, then use anywhere:
use finance_query::edgar;
// Initialize once (required)
edgar::init("user@example.com")?;
// Use anywhere
let cik = edgar::resolve_cik("AAPL").await?;
let submissions = edgar::submissions(cik).await?;
let facts = edgar::company_facts(cik).await?;
// Search filings
let results = edgar::search(
"artificial intelligence",
Some(&["10-K"]),
Some("2024-01-01"),
None,
None,
None,
).await?;Functions§
- company_
facts - Fetch structured XBRL financial data for a CIK.
- filing_
index - Fetch the filing index for a specific accession number.
- init
- Initialize the global EDGAR client with a contact email.
- init_
with_ config - Initialize the global EDGAR client with full configuration.
- resolve_
cik - Resolve a ticker symbol to its SEC CIK number.
- search
- Search SEC EDGAR filings by text content.
- submissions
- Fetch filing history and company metadata for a CIK.