Crate edgar_rs 

edgar-rs

A Rust client for the SEC EDGAR API.

EDGAR (Electronic Data Gathering, Analysis, and Retrieval) is the SEC’s system for receiving, processing, and disseminating company filings.

This client covers the full public EDGAR API:

• Company tickers: CIK-to-ticker mapping
• Submissions: company metadata and filing history
• Documents: individual filing document content
• Company Concepts: XBRL data for a single concept from a company
• Company Facts: all XBRL facts for a company
• Frames: aggregated XBRL data across all companies for a period
• Full-Text Search: search across all filing text content

All requests are rate-limited to 10 requests per second by default, as required by the SEC EDGAR fair access policy.

Example

let client = edgar_rs::ClientBuilder::new("MyApp/1.0 contact@example.com")
    .build()?;

let tickers = client.get_tickers().await?;
let submission = client.get_submission(320193_u64.into()).await?;
let concept = client.get_company_concept(
    320193_u64.into(), "us-gaap", "Revenues"
).await?;

Structs

Address

A physical address associated with a company filing.

Addresses

Mailing and business addresses for a company.

Cik

A Central Index Key (CIK) number identifying a company in SEC EDGAR.

Client

An async HTTP client for the SEC EDGAR API.

ClientBuilder

Builder for constructing a Client.

CompanyConcept

All disclosures for a single XBRL concept from a single company, grouped by unit of measure.

CompanyFacts

All XBRL facts for a company, organized by taxonomy then tag.

ConceptFacts

Label, description, and unit-grouped facts for a single XBRL concept.

Fact

A single XBRL fact disclosure.

FilingFile

Reference to a supplemental filing history JSON file.

FilingHistory

Recent filing set plus references to additional historical files.

FilingSet

Parallel arrays of filing attributes. Each index i across all vectors represents a single filing record.

FormerName

A previous name used by a company.

Frame

Aggregated XBRL data across all companies for a given concept, unit, and period.

FrameData

A single entity’s fact within a Frame.

SearchHit

A single filing match from a full-text search.

SearchOptions

Configuration for a full-text search query.

SearchResult

Response from the EDGAR full-text search endpoint.

Submission

Company submission data from the SEC EDGAR submissions endpoint. Includes company metadata and filing history.

Ticker

A company entry from the SEC EDGAR company tickers list.

Enums

Error

Errors returned by the SEC EDGAR client.

Type Aliases

Result

A specialized Result type for SEC EDGAR operations.