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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161

//! Forex market endpoints.

use crate::{
    client::FinnhubClient,
    error::Result,
    models::{forex::*, stock::CandleResolution},
};

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

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

    /// Get supported forex symbols.
    pub async fn symbols(&self, exchange: &str) -> Result<Vec<ForexSymbol>> {
        self.client
            .get(&format!("/forex/symbol?exchange={}", exchange))
            .await
    }

    /// Get forex candlestick data.
    ///
    /// Get OHLCV data for forex symbols.
    pub async fn candles(
        &self,
        symbol: &str,
        resolution: CandleResolution,
        from: i64,
        to: i64,
    ) -> Result<ForexCandles> {
        self.client
            .get(&format!(
                "/forex/candle?symbol={}&resolution={}&from={}&to={}",
                symbol, resolution, from, to
            ))
            .await
    }

    /// Get forex exchange rates.
    ///
    /// Get real-time exchange rates for forex pairs.
    pub async fn rates(&self, base: &str) -> Result<ForexRates> {
        self.client
            .get(&format!("/forex/rates?base={}", base))
            .await
    }

    /// Get supported forex exchanges.
    pub async fn exchanges(&self) -> Result<Vec<String>> {
        self.client.get("/forex/exchange").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_forex_symbols() {
        let client = test_client().await;
        let result = client.forex().symbols("OANDA").await;
        assert!(
            result.is_ok(),
            "Failed to get forex symbols: {:?}",
            result.err()
        );

        let symbols = result.unwrap();
        assert!(!symbols.is_empty());

        // Check that symbols have the expected format
        for symbol in &symbols {
            assert!(!symbol.description.is_empty());
            assert!(!symbol.symbol.is_empty());
        }
    }

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

        let exchanges = result.unwrap();
        assert!(!exchanges.is_empty());
        assert!(exchanges.contains(&"OANDA".to_string()));
    }

    #[tokio::test]
    #[ignore = "requires API key"]
    async fn test_forex_rates() {
        let client = test_client().await;
        let result = client.forex().rates("USD").await;
        assert!(
            result.is_ok(),
            "Failed to get forex rates: {:?}",
            result.err()
        );

        let rates = result.unwrap();
        assert_eq!(rates.base, "USD");
        assert!(!rates.quote.is_empty());

        // Check some common currencies
        assert!(rates.quote.contains_key("EUR"));
        assert!(rates.quote.contains_key("GBP"));
        assert!(rates.quote.contains_key("JPY"));

        // All rates should be positive
        for (_, rate) in &rates.quote {
            assert!(*rate > 0.0);
        }
    }

    #[tokio::test]
    #[ignore = "requires API key"]
    async fn test_forex_candles() {
        let client = test_client().await;
        let from = chrono::Utc::now().timestamp() - 86400 * 7; // 7 days ago
        let to = chrono::Utc::now().timestamp();

        let result = client
            .forex()
            .candles("OANDA:EUR_USD", CandleResolution::Daily, from, to)
            .await;
        assert!(
            result.is_ok(),
            "Failed to get forex candles: {:?}",
            result.err()
        );

        let candles = result.unwrap();
        assert_eq!(candles.status, "ok");
        assert!(!candles.close.is_empty());
        assert_eq!(candles.close.len(), candles.open.len());
        assert_eq!(candles.close.len(), candles.high.len());
        assert_eq!(candles.close.len(), candles.low.len());
    }
}