finnhub 0.2.2

A comprehensive Rust client for the Finnhub.io financial data API with 96% endpoint coverage, flexible rate limiting, and WebSocket support
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

//! Company information endpoints.

use crate::{
    client::FinnhubClient,
    error::Result,
    models::stock::{CompanyProfile, Symbol},
};

/// Company information endpoints.
pub struct CompanyEndpoints<'a> {
    client: &'a FinnhubClient,
}

impl<'a> CompanyEndpoints<'a> {
    /// Create a new company endpoints instance.
    pub fn new(client: &'a FinnhubClient) -> Self {
        Self { client }
    }

    /// Get company profile.
    pub async fn profile(&self, symbol: &str) -> Result<CompanyProfile> {
        self.client
            .get(&format!("/stock/profile2?symbol={}", symbol))
            .await
    }

    /// Get company peers.
    ///
    /// Returns a list of peers operating in the same country and sector/industry.
    pub async fn peers(&self, symbol: &str, grouping: Option<&str>) -> Result<Vec<String>> {
        let url = if let Some(grouping) = grouping {
            format!("/stock/peers?symbol={}&grouping={}", symbol, grouping)
        } else {
            format!("/stock/peers?symbol={}", symbol)
        };
        self.client.get(&url).await
    }

    /// Get list of supported stocks.
    ///
    /// List all supported stocks for a given exchange.
    pub async fn symbols(&self, exchange: &str) -> Result<Vec<Symbol>> {
        self.client
            .get(&format!("/stock/symbol?exchange={}", exchange))
            .await
    }
}

#[cfg(test)]
mod tests {
    use crate::{ClientConfig, FinnhubClient, RateLimitStrategy};

    async fn test_client() -> FinnhubClient {
        dotenv::dotenv().ok();
        let api_key = std::env::var("FINNHUB_API_KEY").unwrap_or_else(|_| "test_key".to_string());

        let mut config = ClientConfig::default();
        config.rate_limit_strategy = RateLimitStrategy::FifteenSecondWindow;
        FinnhubClient::with_config(api_key, config)
    }

    #[tokio::test]
    #[ignore = "requires API key"]
    async fn test_company_profile() {
        let client = test_client().await;
        let result = client.stock().company_profile("AAPL").await;
        assert!(
            result.is_ok(),
            "Failed to get company profile: {:?}",
            result.err()
        );

        let profile = result.unwrap();
        assert!(profile.name.is_some());
        assert_eq!(profile.ticker.as_deref(), Some("AAPL"));
    }

    #[tokio::test]
    #[ignore = "requires API key"]
    async fn test_peers() {
        let client = test_client().await;
        let result = client.stock().peers("AAPL", None).await;
        assert!(result.is_ok(), "Failed to get peers: {:?}", result.err());

        let peers = result.unwrap();
        assert!(!peers.is_empty());
        assert!(peers.len() <= 10); // Usually returns up to 10 peers
    }

    #[tokio::test]
    #[ignore = "requires API key"]
    async fn test_symbols() {
        let client = test_client().await;
        let result = client.stock().symbols("US").await;
        assert!(result.is_ok(), "Failed to get symbols: {:?}", result.err());

        let symbols = result.unwrap();
        assert!(!symbols.is_empty());
        // Check that symbols have the expected fields
        if let Some(symbol) = symbols.first() {
            assert!(!symbol.symbol.is_empty());
            assert!(!symbol.description.is_empty());
        }
    }
}