finnhub

A comprehensive Rust client for the Finnhub.io financial data API.

Features

🚀 Full async/await support with Tokio
📊 Extensive API coverage (103/107 endpoints - 96.3%)
🔒 Type-safe request and response models
⚡ Built-in rate limiting (30 requests/second)
🔄 WebSocket support (minimal implementation, feature-gated)
🛡️ Comprehensive error handling
📝 Well-organized module structure
🎯 Zero-copy deserialization where possible

Installation

Add this to your Cargo.toml:

[dependencies]
finnhub = "0.2.0"

# For WebSocket support
finnhub = { version = "0.2.0", features = ["websocket"] }

Quick Start

use finnhub::{FinnhubClient, Result};

#[tokio::main]
async fn main() -> Result<()> {
    // Create client with your API key
    let client = FinnhubClient::new("your-api-key");
    
    // Get a stock quote
    let quote = client.stock().quote("AAPL").await?;
    println!("AAPL price: ${:.2}", quote.current_price);
    
    // Get company profile
    let profile = client.stock().company_profile("AAPL").await?;
    println!("Company: {}", profile.name.unwrap_or_default());
    
    // Search for symbols
    let results = client.misc().symbol_search("apple", Some("US")).await?;
    println!("Found {} results for 'apple'", results.count);
    
    Ok(())
}

Authentication

The library uses header authentication (X-Finnhub-Token) by default for better security. Both header and URL parameter authentication are supported by Finnhub.

use finnhub::{FinnhubClient, ClientConfig, auth::AuthMethod};

// Default: Header authentication (more secure)
let client = FinnhubClient::new("your-api-key");

// Alternative: URL parameter authentication
let config = ClientConfig {
    auth_method: AuthMethod::UrlParameter,
    ..ClientConfig::default()
};
let client = FinnhubClient::with_config("your-api-key", config);

API Coverage

Stock Market Data (52/54 endpoints - 96.3%)

✅ Quotes & Prices: Real-time quotes, candles (OHLCV), ⚠️ bid/ask [Premium], ⚠️ tick data [Premium]
✅ Company Info: Profile, peers, executives, ⚠️ market cap history [Premium]
✅ Fundamentals: Financials, metrics, earnings, dividends
✅ Estimates: Price targets, recommendations, earnings estimates
⚠️ Alternative Data: ESG scores, patents, visa applications, lobbying [Most require Premium]
✅ Insider Data: Transactions, ownership, ⚠️ sentiment [Premium]
✅ Market Info: Symbols, market status, holidays

Other Markets

✅ ETFs (4/4): Profile, holdings, country/sector exposure
⚠️ Forex (4/4): Symbols, candles, rates, exchanges [Premium]
⚠️ Crypto (4/4): Exchanges, symbols, candles, profile [Premium]
⚠️ Bonds (4/4): Profile, price, tick data, yield curve [Premium]
⚠️ Mutual Funds (6/6): Profile, holdings, performance, ESG data [Premium]
⚠️ Indices (2/2): Constituents, historical constituents [Premium]

Data & Analytics

✅ Economic Data (2/2): Economic indicators and codes
✅ News (3/3): Market news, company news, sentiment
✅ Calendar (3/3): Earnings, economic events, IPO calendar
✅ Technical Analysis (3/3): Pattern recognition, support/resistance, aggregate indicators

Miscellaneous

✅ Search & Lookup: Symbol search, country metadata
✅ Alternative Data: COVID-19, FDA calendar, airline price index
✅ Market Analysis: Sector metrics, press releases, technical indicators
🚧 AI Features: AI chat (requires POST support)

Advanced Features

⚠️ WebSocket: Basic structure only (not production-ready)
✅ Rate Limiting: Automatic 30 req/s limit with flexible strategies
✅ Error Handling: Typed errors with context and retry helpers

Examples

Stock Market Data

use finnhub::models::stock::{StatementType, StatementFrequency};

// Get financials
let financials = client.stock()
    .financials("AAPL", StatementType::IncomeStatement, StatementFrequency::Annual)
    .await?;

// Get insider transactions
let insiders = client.stock().insider_transactions("AAPL").await?;

// Get price target consensus
let target = client.stock().price_target("AAPL").await?;
println!("Average target: ${:.2}", target.target_mean);

Alternative Data

Many alternative data endpoints require premium API access:

// Social sentiment (available with basic access)
let sentiment = client.stock()
    .social_sentiment("AAPL", "2024-01-01", "2024-01-07")
    .await?;
println!("Symbol: {}", sentiment.symbol);
println!("Total data points: {}", sentiment.data.len());

// Premium endpoints (require additional access):
// - ESG scores: client.stock().esg("AAPL")
// - Patent applications: client.stock().uspto_patents("NVDA", from, to)  
// - Congressional trading: client.stock().congressional_trading("AAPL", None, None)
// - Lobbying data: client.stock().lobbying("AAPL", from, to)

Calendar Events

// Earnings calendar
let earnings = client.calendar()
    .earnings(Some("2024-01-01"), Some("2024-01-07"), None)
    .await?;
println!("Upcoming earnings: {} companies", earnings.earnings_calendar.len());

// IPO calendar  
let ipos = client.calendar()
    .ipo("2024-01-01", "2024-01-31")
    .await?;
println!("Recent IPOs: {} companies", ipos.ipo_calendar.len());

News & Sentiment

use finnhub::models::news::NewsCategory;

// Company news with sentiment
let news = client.news().company_news("AAPL", "2024-12-01", "2024-12-07").await?;

// Market-wide news
let market_news = client.news().market_news(NewsCategory::General, None).await?;

Technical Analysis

// Support and resistance levels
let levels = client.scanner().support_resistance("AAPL", "D").await?;

// Aggregate technical indicators
let indicators = client.scanner().aggregate_indicators("AAPL", "D").await?;
println!("Signal: {} (Buy: {}, Sell: {})", 
    indicators.technical_analysis.signal,
    indicators.technical_analysis.count.buy,
    indicators.technical_analysis.count.sell
);

Search & Discovery

// Symbol search
let results = client.misc().symbol_search("tesla", Some("US")).await?;
println!("Found {} results", results.count);

// Country information
let countries = client.misc().country().await?;
println!("Available in {} countries", countries.len());

// FDA calendar
let fda = client.misc().fda_calendar().await?;
println!("Upcoming FDA events: {}", fda.len());

Project Structure

finnhub/
├── src/
│   ├── client.rs           # Main client implementation
│   ├── auth.rs             # Authentication handling
│   ├── error.rs            # Error types
│   ├── rate_limiter.rs     # Rate limiting
│   ├── models/             # Response models
│   │   ├── stock/          # Stock models (14 modules)
│   │   ├── forex.rs        # Forex models
│   │   ├── crypto.rs       # Crypto models
│   │   └── ...             # Other market models
│   └── endpoints/          # API endpoint implementations
│       ├── stock/          # Stock endpoints (14 modules)
│       ├── forex.rs        # Forex endpoints
│       └── ...             # Other endpoints
└── examples/               # Usage examples

Error Handling

The library provides comprehensive error handling:

use finnhub::Error;

match client.stock().quote("AAPL").await {
    Ok(quote) => println!("Price: ${}", quote.current_price),
    Err(Error::RateLimitExceeded { retry_after }) => {
        println!("Rate limit hit, retry after {} seconds", retry_after);
    },
    Err(Error::Unauthorized) => {
        println!("Invalid API key");
    },
    Err(e) => println!("Error: {}", e),
}

Rate Limiting

The client includes built-in rate limiting to comply with Finnhub's API limits:

// Default: 30 requests/second with burst capacity
let client = FinnhubClient::new("your-api-key");

// For batch processing: 15-second window (450 request burst)
let mut config = ClientConfig::default();
config.rate_limit_strategy = RateLimitStrategy::FifteenSecondWindow;
let client = FinnhubClient::with_config("your-api-key", config);

// Rate limiting is automatic
for symbol in ["AAPL", "GOOGL", "MSFT"] {
    let quote = client.stock().quote(symbol).await?;
    // Client automatically manages request rate
}

Production Best Practices

Retry Logic

This library intentionally does not implement automatic retry logic, allowing applications to implement context-aware retry strategies. The library provides helpers to make this easy:

use finnhub::{Error, Result};
use std::time::Duration;
use tokio::time::sleep;

async fn with_retry<T, F, Fut>(mut f: F, max_attempts: u32) -> Result<T>
where
    F: FnMut() -> Fut,
    Fut: std::future::Future<Output = Result<T>>,
{
    let mut attempt = 0;
    loop {
        attempt += 1;
        match f().await {
            Ok(result) => return Ok(result),
            Err(e) if e.is_retryable() && attempt < max_attempts => {
                let delay = e.retry_after()
                    .unwrap_or(1)  // Default 1 second
                    .max(1);       // At least 1 second
                sleep(Duration::from_secs(delay)).await;
                continue;
            }
            Err(e) => return Err(e),
        }
    }
}

// Usage
let quote = with_retry(|| client.stock().quote("AAPL"), 3).await?;

Caching

Response caching is best implemented at the application layer where you understand data freshness requirements:

use finnhub::models::stock::Quote;
use std::collections::HashMap;
use std::time::{Duration, Instant};

struct CachedQuote {
    quote: Quote,
    fetched_at: Instant,
}

struct QuoteCache {
    cache: HashMap<String, CachedQuote>,
    ttl: Duration,
}

impl QuoteCache {
    async fn get_quote(&mut self, client: &FinnhubClient, symbol: &str) -> Result<Quote> {
        if let Some(cached) = self.cache.get(symbol) {
            if cached.fetched_at.elapsed() < self.ttl {
                return Ok(cached.quote.clone());
            }
        }
        
        let quote = client.stock().quote(symbol).await?;
        self.cache.insert(symbol.to_string(), CachedQuote {
            quote: quote.clone(),
            fetched_at: Instant::now(),
        });
        Ok(quote)
    }
}

Error Handling

Always handle specific error types appropriately:

match client.stock().quote("AAPL").await {
    Ok(quote) => process_quote(quote),
    Err(Error::RateLimitExceeded { retry_after }) => {
        // Back off and retry later
        sleep(Duration::from_secs(retry_after)).await;
    }
    Err(Error::Unauthorized) => {
        // Check API key configuration
        panic!("Invalid API key");
    }
    Err(e) => {
        // Log and handle other errors
        eprintln!("API error: {}", e);
    }
}

Concurrent Requests

When making multiple requests, consider rate limits and use concurrency control:

use futures::stream::{self, StreamExt};

let symbols = vec!["AAPL", "GOOGL", "MSFT", "AMZN", "FB"];

// Process 3 symbols concurrently to stay well under rate limit
let quotes: Vec<_> = stream::iter(symbols)
    .map(|symbol| async move {
        client.stock().quote(symbol).await
    })
    .buffer_unordered(3)
    .collect()
    .await;

WebSocket Support (Minimal)

Basic WebSocket structure is implemented but requires significant work:

// Requires 'websocket' feature
use finnhub::websocket::{WebSocketClient, WebSocketMessage};

let client = WebSocketClient::new("your-api-key");
let mut stream = client.connect().await?;

// Subscribe to symbols
stream.subscribe("AAPL").await?;

// Process messages
match stream.next().await? {
    Some(WebSocketMessage::Trade { data }) => {
        for trade in data {
            println!("Trade: {} @ ${}", trade.symbol, trade.price);
        }
    }
    Some(WebSocketMessage::Ping) => {
        println!("Received ping");
    }
    Some(WebSocketMessage::Error { msg }) => {
        eprintln!("Error: {}", msg);
    }
    None => println!("Stream closed"),
}

See examples/websocket_basic.rs for a complete example.

Note: WebSocket support is minimal and not recommended for production use. It lacks:

Automatic reconnection
Heartbeat handling
Convenient subscription methods
Proper error recovery

Environment Variables

For examples and tests, you can use environment variables:

# .env file
FINNHUB_API_KEY=your_api_key_here

// In your code
dotenv::dotenv().ok();
let api_key = std::env::var("FINNHUB_API_KEY")
    .expect("FINNHUB_API_KEY must be set");

Troubleshooting

Common Issues

401 Unauthorized: Check your API key is valid and has appropriate permissions
429 Rate Limit: You're exceeding 30 requests/second. The client should handle this automatically
Empty responses: Some endpoints return empty data outside market hours or for invalid symbols

Debug Logging

Enable debug logging to see request details:

RUST_LOG=finnhub=debug cargo run

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. See CLAUDE.md for development guidelines and architecture details.

Development Setup

# Clone the repository
git clone https://github.com/jbradenbrown/finnhub
cd finnhub

# Run tests (requires API key)
FINNHUB_API_KEY=your_key cargo test

# Run specific example
FINNHUB_API_KEY=your_key cargo run --example basic_usage

# Check formatting and lints
cargo fmt -- --check
cargo clippy -- -D warnings

Development

This library was developed with assistance from Claude, Anthropic's AI assistant, using the Claude Code development environment. The AI helped with implementation, documentation, and best practices while maintaining human oversight and decision-making throughout the development process.

License

Licensed under either of:

MIT license (LICENSE-MIT)
Apache License, Version 2.0 (LICENSE-APACHE)

at your option.

finnhub 0.2.2

finnhub

Features

Installation

Quick Start

Authentication

API Coverage

Stock Market Data (52/54 endpoints - 96.3%)

Other Markets

Data & Analytics

Miscellaneous

Advanced Features

Examples

Stock Market Data

Alternative Data

Calendar Events

News & Sentiment

Technical Analysis

Search & Discovery

Project Structure

Error Handling

Rate Limiting

Production Best Practices

Retry Logic

Caching

Error Handling

Concurrent Requests

WebSocket Support (Minimal)

Environment Variables

Troubleshooting

Common Issues

Debug Logging

Contributing

Development Setup

Development

License