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

//! Index-related endpoints.

use crate::{
    client::FinnhubClient,
    error::Result,
    models::index::{IndicesConstituents, IndicesHistoricalConstituents},
};

/// Index-related API endpoints.
pub struct IndexEndpoints<'a> {
    client: &'a FinnhubClient,
}

impl<'a> IndexEndpoints<'a> {
    /// Create a new index endpoints instance.
    #[must_use]
    pub fn new(client: &'a FinnhubClient) -> Self {
        Self { client }
    }

    /// Get index constituents.
    ///
    /// Get a list of index's constituents.
    ///
    /// # Arguments
    /// * `symbol` - Index symbol (e.g., "^GSPC" for S&P 500, "^NDX" for Nasdaq 100)
    ///
    /// # Errors
    /// Returns an error if the API request fails.
    pub async fn constituents(&self, symbol: &str) -> Result<IndicesConstituents> {
        self.client
            .get(&format!("/index/constituents?symbol={}", symbol))
            .await
    }

    /// Get historical index constituents.
    ///
    /// Get full history of index's constituents including symbols and dates of joining and leaving.
    /// Currently supports ^GSPC, ^NDX, ^DJI.
    ///
    /// # Arguments
    /// * `symbol` - Index symbol
    ///
    /// # Errors
    /// Returns an error if the API request fails.
    pub async fn historical_constituents(
        &self,
        symbol: &str,
    ) -> Result<IndicesHistoricalConstituents> {
        self.client
            .get(&format!("/index/historical-constituents?symbol={}", symbol))
            .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_constituents() {
        let client = test_client().await;
        let result = client.index().constituents("^GSPC").await;
        assert!(
            result.is_ok(),
            "Failed to get index constituents: {:?}",
            result.err()
        );
    }

    #[tokio::test]
    #[ignore = "requires API key"]
    async fn test_historical_constituents() {
        let client = test_client().await;
        let result = client.index().historical_constituents("^GSPC").await;
        assert!(
            result.is_ok(),
            "Failed to get historical constituents: {:?}",
            result.err()
        );
    }
}