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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

//! Corporate actions endpoints.

use crate::{
    client::FinnhubClient,
    error::Result,
    models::stock::{Dividend, DividendsV2, StockSplit},
};

/// Corporate actions endpoints.
pub struct CorporateActionsEndpoints<'a> {
    client: &'a FinnhubClient,
}

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

    /// Get dividends data.
    ///
    /// Returns dividend history with dates and amounts.
    pub async fn dividends(&self, symbol: &str, from: &str, to: &str) -> Result<Vec<Dividend>> {
        self.client
            .get(&format!(
                "/stock/dividend?symbol={}&from={}&to={}",
                symbol, from, to
            ))
            .await
    }

    /// Get stock splits history.
    ///
    /// Returns stock split history with dates and split ratios.
    pub async fn splits(&self, symbol: &str, from: &str, to: &str) -> Result<Vec<StockSplit>> {
        self.client
            .get(&format!(
                "/stock/split?symbol={}&from={}&to={}",
                symbol, from, to
            ))
            .await
    }

    /// Get dividends v2.
    ///
    /// Get dividend data including dividend yield and ex-dividend dates.
    ///
    /// # Arguments
    /// * `symbol` - Stock symbol
    pub async fn dividends_v2(&self, symbol: &str) -> Result<DividendsV2> {
        self.client
            .get(&format!("/stock/dividend2?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_dividends() {
        let client = test_client().await;
        let from = "2023-01-01";
        let to = "2023-12-31";
        let result = client.stock().dividends("AAPL", from, to).await;

        // Just verify the API call completes successfully
        assert!(
            result.is_ok(),
            "Failed to get dividends: {:?}",
            result.err()
        );
    }

    #[tokio::test]
    #[ignore = "requires API key"]
    async fn test_splits() {
        let client = test_client().await;
        let from = "2020-01-01";
        let to = "2024-12-31";
        let result = client.stock().splits("AAPL", from, to).await;

        // Just verify the API call completes successfully
        assert!(result.is_ok(), "Failed to get splits: {:?}", result.err());
    }

    #[tokio::test]
    #[ignore = "requires API key"]
    async fn test_dividends_v2() {
        let client = test_client().await;
        let result = client.stock().dividends_v2("MSFT").await;

        // Just verify the API call completes successfully
        assert!(
            result.is_ok(),
            "Failed to get dividends v2: {:?}",
            result.err()
        );
    }

    #[tokio::test]
    #[ignore = "requires API key"]
    async fn test_no_dividends_company() {
        let client = test_client().await;
        let from = "2023-01-01";
        let to = "2023-12-31";
        // Tesla historically has not paid dividends
        let result = client.stock().dividends("TSLA", from, to).await;

        // Just verify the API call completes successfully (empty array is still success)
        assert!(
            result.is_ok(),
            "Failed to get dividends for TSLA: {:?}",
            result.err()
        );
    }
}