https://github.com/earningsfeed/earningsfeed-rust
Official Rust SDK for the EarningsFeed API - SEC filings, insider transactions, and institutional holdings
https://github.com/earningsfeed/earningsfeed-rust
13f api-client finance form-4 insider-trading rust rust-sdk sec sec-filings stocks
Last synced: 6 months ago
JSON representation
Official Rust SDK for the EarningsFeed API - SEC filings, insider transactions, and institutional holdings
- Host: GitHub
- URL: https://github.com/earningsfeed/earningsfeed-rust
- Owner: earningsfeed
- License: mit
- Created: 2025-12-24T20:15:34.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-12-24T20:36:59.000Z (6 months ago)
- Last Synced: 2025-12-26T10:37:53.043Z (6 months ago)
- Topics: 13f, api-client, finance, form-4, insider-trading, rust, rust-sdk, sec, sec-filings, stocks
- Language: Rust
- Size: 45.9 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EarningsFeed Rust SDK
[](https://crates.io/crates/earningsfeed)
[](https://docs.rs/earningsfeed)
Official Rust client for the [EarningsFeed API](https://earningsfeed.com/api) — SEC filings, insider transactions, and institutional holdings.
## Installation
Add to your `Cargo.toml`:
```toml
[dependencies]
earningsfeed = "0.1"
tokio = { version = "1", features = ["rt-multi-thread", "macros"] }
```
## Quick Start
```rust
use earningsfeed::EarningsFeed;
#[tokio::main]
async fn main() -> Result<(), earningsfeed::Error> {
let client = EarningsFeed::new("your_api_key")?;
// Get recent 10-K and 10-Q filings
let params = earningsfeed::ListFilingsParams::builder()
.forms(vec!["10-K", "10-Q"])
.limit(10)
.build();
let filings = client.filings().list(¶ms).await?;
for filing in filings.items {
println!("{}: {} - {}", filing.form_type, filing.company_name, filing.title);
}
// Get a company profile
let apple = client.companies().get(320193).await?;
println!("{} ({})", apple.name, apple.primary_ticker.unwrap_or_default());
Ok(())
}
```
## Features
- **Async/await** — Built on tokio and reqwest
- **Streaming pagination** — Auto-pagination with `Stream`
- **Type-safe** — Full Rust type definitions
- **Builder patterns** — Ergonomic parameter construction
## Usage
### SEC Filings
```rust
use earningsfeed::{EarningsFeed, ListFilingsParams};
use futures::StreamExt;
use std::pin::pin;
let client = EarningsFeed::new("your_api_key")?;
// List filings with filters
let params = ListFilingsParams::builder()
.ticker("AAPL")
.forms(vec!["10-K", "10-Q", "8-K"])
.limit(25)
.build();
let filings = client.filings().list(¶ms).await?;
// Iterate through all filings (auto-pagination)
let params = ListFilingsParams::builder()
.ticker("AAPL")
.forms(vec!["8-K"])
.build();
let filings_resource = client.filings();
let mut stream = pin!(filings_resource.iter(params));
while let Some(result) = stream.next().await {
let filing = result?;
println!("{}", filing.title);
}
// Get filing details with documents
let detail = client.filings().get("0000320193-24-000123").await?;
for doc in detail.documents {
println!("{}: {}", doc.doc_type, doc.filename);
}
```
### Insider Transactions
```rust
use earningsfeed::{EarningsFeed, ListInsiderParams, TransactionDirection};
use futures::StreamExt;
use std::pin::pin;
let client = EarningsFeed::new("your_api_key")?;
// Recent insider purchases
let params = ListInsiderParams::builder()
.ticker("AAPL")
.direction(TransactionDirection::Buy)
.codes(vec!["P"]) // Open market purchases
.limit(50)
.build();
let purchases = client.insider().list(¶ms).await?;
for txn in purchases.items {
println!(
"{}: {} shares @ ${:.2}",
txn.person_name,
txn.shares.unwrap_or_default(),
txn.price_per_share.unwrap_or_default()
);
}
// Large sales across all companies
let params = ListInsiderParams::builder()
.direction(TransactionDirection::Sell)
.min_value(1_000_000)
.build();
let insider_resource = client.insider();
let mut stream = pin!(insider_resource.iter(params));
while let Some(result) = stream.next().await {
let txn = result?;
println!("{}: ${}", txn.company_name.unwrap_or_default(), txn.transaction_value.unwrap_or_default());
}
```
### Institutional Holdings (13F)
```rust
use earningsfeed::{EarningsFeed, ListInstitutionalParams};
use futures::StreamExt;
use std::pin::pin;
let client = EarningsFeed::new("your_api_key")?;
// Who owns Apple?
let params = ListInstitutionalParams::builder()
.ticker("AAPL")
.min_value(1_000_000_000) // $1B+ positions
.build();
let holdings = client.institutional().list(¶ms).await?;
for h in holdings.items {
println!("{}: {} shares (${:.0})", h.manager_name, h.shares, h.value);
}
// Track a specific fund (Berkshire Hathaway)
let params = ListInstitutionalParams::builder()
.manager_cik(1067983)
.build();
let institutional_resource = client.institutional();
let mut stream = pin!(institutional_resource.iter(params));
while let Some(result) = stream.next().await {
let h = result?;
println!("{}: {} shares", h.issuer_name, h.shares);
}
```
### Companies
```rust
use earningsfeed::{EarningsFeed, SearchCompaniesParams};
let client = EarningsFeed::new("your_api_key")?;
// Get company profile
let company = client.companies().get(320193).await?;
println!("{}", company.name);
println!("Ticker: {}", company.primary_ticker.unwrap_or_default());
if let Some(sic) = company.sic_codes.first() {
println!("Industry: {}", sic.description.as_deref().unwrap_or("Unknown"));
}
// Search companies
let params = SearchCompaniesParams::builder()
.q("software")
.state("CA")
.limit(10)
.build();
let results = client.companies().search(¶ms).await?;
for company in results.items {
println!("{} ({})", company.name, company.ticker.unwrap_or_default());
}
```
## Error Handling
```rust
use earningsfeed::{EarningsFeed, Error};
let client = EarningsFeed::new("your_api_key")?;
match client.filings().get("invalid-accession").await {
Ok(filing) => println!("Found: {}", filing.title),
Err(Error::NotFound { path }) => println!("Filing not found: {}", path),
Err(Error::RateLimit { reset_at }) => {
println!("Rate limited. Resets at: {:?}", reset_at);
}
Err(Error::Authentication) => println!("Invalid API key"),
Err(e) => println!("Error: {}", e),
}
```
## Configuration
```rust
use earningsfeed::{EarningsFeed, ClientConfig};
use std::time::Duration;
// Custom configuration
let config = ClientConfig::builder()
.api_key("your_api_key")
.timeout(Duration::from_secs(60))
.base_url("https://earningsfeed.com") // Optional, this is the default
.build()?;
let client = EarningsFeed::with_config(config)?;
```
## API Reference
Full API documentation: [earningsfeed.com/api/docs](https://earningsfeed.com/api/docs)
## License
MIT