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

//! Sentiment analysis endpoints.

use crate::{
    client::FinnhubClient,
    error::Result,
    models::stock::{FilingSentiment, SocialSentiment},
};

/// Sentiment analysis endpoints.
pub struct SentimentEndpoints<'a> {
    client: &'a FinnhubClient,
}

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

    /// Get social sentiment data.
    ///
    /// Returns social media sentiment data for a company.
    pub async fn social(&self, symbol: &str, from: &str, to: &str) -> Result<SocialSentiment> {
        self.client
            .get(&format!(
                "/stock/social-sentiment?symbol={}&from={}&to={}",
                symbol, from, to
            ))
            .await
    }

    /// Get filing sentiment analysis.
    ///
    /// Analyze sentiment of company filings using NLP.
    ///
    /// # Arguments
    /// * `access_number` - Access number of the filing
    pub async fn filing(&self, access_number: &str) -> Result<FilingSentiment> {
        self.client
            .get(&format!(
                "/stock/filings-sentiment?accessNumber={}",
                access_number
            ))
            .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_social_sentiment() {
        let client = test_client().await;
        let from = "2024-01-01";
        let to = "2024-01-31";
        let result = client.stock().social_sentiment("AAPL", from, to).await;

        assert!(
            result.is_ok(),
            "Failed to get social sentiment: {:?}",
            result.err()
        );
    }

    #[tokio::test]
    #[ignore = "requires API key"]
    async fn test_filing_sentiment() {
        let client = test_client().await;
        // This requires a valid access number from an SEC filing
        // We'll use a known access number for testing
        let access_number = "0000320193-24-000123"; // Example Apple filing
        let result = client.stock().filing_sentiment(access_number).await;

        assert!(
            result.is_ok(),
            "Failed to get filing sentiment: {:?}",
            result.err()
        );
    }

    #[tokio::test]
    #[ignore = "requires API key"]
    async fn test_social_sentiment_date_range() {
        let client = test_client().await;
        let from = "2024-06-01";
        let to = "2024-06-07"; // One week
        let result = client.stock().social_sentiment("TSLA", from, to).await;

        assert!(
            result.is_ok(),
            "Failed to get social sentiment with date range: {:?}",
            result.err()
        );
    }
}