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

//! News endpoints.

use crate::{client::FinnhubClient, error::Result, models::news::*};

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

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

    /// Get market news.
    ///
    /// Get latest market news by category.
    pub async fn market_news(
        &self,
        category: NewsCategory,
        min_id: Option<i64>,
    ) -> Result<Vec<MarketNews>> {
        let url = if let Some(min_id) = min_id {
            format!("/news?category={}&minId={}", category, min_id)
        } else {
            format!("/news?category={}", category)
        };
        self.client.get(&url).await
    }

    /// Get company news.
    ///
    /// Get latest news for a specific company.
    pub async fn company_news(
        &self,
        symbol: &str,
        from: &str,
        to: &str,
    ) -> Result<Vec<CompanyNews>> {
        self.client
            .get(&format!(
                "/company-news?symbol={}&from={}&to={}",
                symbol, from, to
            ))
            .await
    }

    /// Get news sentiment.
    ///
    /// Get sentiment analysis for company news.
    pub async fn news_sentiment(&self, symbol: &str) -> Result<NewsSentiment> {
        self.client
            .get(&format!("/news-sentiment?symbol={}", symbol))
            .await
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    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_market_news() {
        let client = test_client().await;
        let result = client.news().market_news(NewsCategory::General, None).await;
        assert!(
            result.is_ok(),
            "Failed to get market news: {:?}",
            result.err()
        );

        let news = result.unwrap();
        assert!(!news.is_empty());
    }

    #[tokio::test]
    #[ignore = "requires API key"]
    async fn test_company_news() {
        let client = test_client().await;
        let from = "2024-01-01";
        let to = "2024-01-31";
        let result = client.news().company_news("AAPL", from, to).await;
        assert!(
            result.is_ok(),
            "Failed to get company news: {:?}",
            result.err()
        );
    }

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