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(¶ms).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.
- Client
Config - Configuration for the EarningsFeed client.
- Client
Config Builder - Builder for
ClientConfig. - Company
- Company profile.
- Company
Search Result - Company search result.
- Earnings
Feed - Client for the EarningsFeed API.
- Filing
- SEC filing from the filings feed.
- Filing
Company - Company details attached to a filing.
- Filing
Detail - Detailed filing information.
- Filing
Document - Document within a filing.
- Filing
Role - Entity role in a filing.
- Insider
Transaction - Insider transaction from Form 3/4/5.
- Institutional
Holding - Institutional holding from 13F filing.
- List
Filings Params - Parameters for listing filings.
- List
Insider Params - Parameters for listing insider transactions.
- List
Institutional Params - Parameters for listing institutional holdings.
- Paginated
Response - Paginated API response wrapper.
- Search
Companies Params - Parameters for searching companies.
- SicCode
- Standard Industrial Classification code.
- Ticker
- Stock ticker information.
Enums§
- Acquired
Disposed - Direction of transaction (acquired or disposed).
- Direct
Indirect - Ownership type (direct or indirect).
- Entity
Class - Entity type classification.
- Error
- Error types for the EarningsFeed client.
- Filing
Status - Filing status filter.
- Investment
Discretion - Investment discretion type.
- PutCall
- Put/Call indicator for options.
- PutCall
Filter - Put/call filter for institutional holdings.
- Shares
Type - Shares type indicator.
- Transaction
Direction - 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
Resulttype for EarningsFeed operations.