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

//! Technical analysis scanner endpoints.

use crate::{
    client::FinnhubClient,
    error::Result,
    models::scanner::{AggregateIndicators, PatternRecognition, SupportResistance},
};

/// Scanner/Technical Analysis endpoints.
pub struct ScannerEndpoints<'a> {
    client: &'a FinnhubClient,
}

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

    /// Run pattern recognition algorithm on a symbol.
    /// Supports double top/bottom, triple top/bottom, head and shoulders, triangle, wedge, channel, flag, and candlestick patterns.
    pub async fn pattern_recognition(
        &self,
        symbol: &str,
        resolution: &str,
    ) -> Result<PatternRecognition> {
        self.client
            .get(&format!(
                "/scan/pattern?symbol={}&resolution={}",
                symbol, resolution
            ))
            .await
    }

    /// Get support and resistance levels for a symbol.
    pub async fn support_resistance(
        &self,
        symbol: &str,
        resolution: &str,
    ) -> Result<SupportResistance> {
        self.client
            .get(&format!(
                "/scan/support-resistance?symbol={}&resolution={}",
                symbol, resolution
            ))
            .await
    }

    /// Get aggregate signal of multiple technical indicators.
    /// Includes MACD, RSI, Moving Average and more.
    pub async fn aggregate_indicators(
        &self,
        symbol: &str,
        resolution: &str,
    ) -> Result<AggregateIndicators> {
        self.client
            .get(&format!(
                "/scan/technical-indicator?symbol={}&resolution={}",
                symbol, resolution
            ))
            .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_pattern_recognition() {
        let client = test_client().await;
        let result = client.scanner().pattern_recognition("AAPL", "D").await;
        assert!(
            result.is_ok(),
            "Failed to get pattern recognition: {:?}",
            result.err()
        );
    }

    #[tokio::test]
    #[ignore = "requires API key"]
    async fn test_support_resistance() {
        let client = test_client().await;
        let result = client.scanner().support_resistance("AAPL", "D").await;
        assert!(
            result.is_ok(),
            "Failed to get support resistance: {:?}",
            result.err()
        );
    }

    #[tokio::test]
    #[ignore = "requires API key"]
    async fn test_aggregate_indicators() {
        let client = test_client().await;
        let result = client.scanner().aggregate_indicators("AAPL", "D").await;
        assert!(
            result.is_ok(),
            "Failed to get aggregate indicators: {:?}",
            result.err()
        );
    }
}