Crate earningsfeed

Crate earningsfeed 

Source
Expand description

§EarningsFeed

Official Rust client for the EarningsFeed API.

This library provides access to SEC filings, insider transactions, and institutional holdings data.

§Quick Start

use earningsfeed::{EarningsFeed, ListFilingsParams};

#[tokio::main]
async fn main() -> Result<(), earningsfeed::Error> {
    let client = EarningsFeed::new("your_api_key")?;

    let params = ListFilingsParams::builder()
        .ticker("AAPL")
        .forms(vec!["10-K", "10-Q"])
        .limit(10)
        .build();

    let response = client.filings().list(&params).await?;

    for filing in response.items {
        println!("{}: {}", filing.form_type, filing.title);
    }

    Ok(())
}

§Features

  • SEC Filings: Access 10-K, 10-Q, 8-K, and other SEC filings
  • Insider Transactions: Track Form 4 insider trading data
  • Institutional Holdings: 13F institutional holdings data
  • Company Search: Search and lookup company profiles
  • Async/Await: Built on tokio and reqwest
  • Pagination: Automatic pagination with async streams

Structs§

Address
Company address.
ClientConfig
Configuration for the EarningsFeed client.
ClientConfigBuilder
Builder for ClientConfig.
Company
Company profile.
CompanySearchResult
Company search result.
EarningsFeed
Client for the EarningsFeed API.
Filing
SEC filing from the filings feed.
FilingCompany
Company details attached to a filing.
FilingDetail
Detailed filing information.
FilingDocument
Document within a filing.
FilingRole
Entity role in a filing.
InsiderTransaction
Insider transaction from Form 3/4/5.
InstitutionalHolding
Institutional holding from 13F filing.
ListFilingsParams
Parameters for listing filings.
ListInsiderParams
Parameters for listing insider transactions.
ListInstitutionalParams
Parameters for listing institutional holdings.
PaginatedResponse
Paginated API response wrapper.
SearchCompaniesParams
Parameters for searching companies.
SicCode
Standard Industrial Classification code.
Ticker
Stock ticker information.

Enums§

AcquiredDisposed
Direction of transaction (acquired or disposed).
DirectIndirect
Ownership type (direct or indirect).
EntityClass
Entity type classification.
Error
Error types for the EarningsFeed client.
FilingStatus
Filing status filter.
InvestmentDiscretion
Investment discretion type.
PutCall
Put/Call indicator for options.
PutCallFilter
Put/call filter for institutional holdings.
SharesType
Shares type indicator.
TransactionDirection
Transaction direction filter.

Constants§

DEFAULT_BASE_URL
Default base URL for the EarningsFeed API.
DEFAULT_TIMEOUT
Default request timeout (30 seconds).

Type Aliases§

Result
A specialized Result type for EarningsFeed operations.