fmp-rs 0.1.1

Production-grade Rust client for Financial Modeling Prep API with intelligent caching, rate limiting, and comprehensive endpoint coverage
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
//! Historical price chart endpoints

use crate::client::FmpClient;
use crate::error::Result;
use crate::models::charts::{HistoricalDividend, HistoricalPrice, IntradayPrice, StockSplit};
use crate::models::common::Timeframe;
use serde::Serialize;

/// Historical price chart API endpoints
pub struct Charts {
    client: FmpClient,
}

impl Charts {
    pub(crate) fn new(client: FmpClient) -> Self {
        Self { client }
    }

    /// Get historical daily prices (EOD - End of Day)
    pub async fn get_historical_prices(
        &self,
        symbol: &str,
        from: Option<&str>,
        to: Option<&str>,
    ) -> Result<Vec<HistoricalPrice>> {
        #[derive(Serialize)]
        struct Query<'a> {
            symbol: &'a str,
            #[serde(skip_serializing_if = "Option::is_none")]
            from: Option<&'a str>,
            #[serde(skip_serializing_if = "Option::is_none")]
            to: Option<&'a str>,
            apikey: &'a str,
        }

        let url = self.client.build_url("/historical-price-eod/full");
        self.client
            .get_with_query(
                &url,
                &Query {
                    symbol,
                    from,
                    to,
                    apikey: self.client.api_key(),
                },
            )
            .await
    }

    /// Get intraday prices
    pub async fn get_intraday_prices(
        &self,
        symbol: &str,
        timeframe: Timeframe,
        from: Option<&str>,
        to: Option<&str>,
    ) -> Result<Vec<IntradayPrice>> {
        #[derive(Serialize)]
        struct Query<'a> {
            symbol: &'a str,
            #[serde(skip_serializing_if = "Option::is_none")]
            from: Option<&'a str>,
            #[serde(skip_serializing_if = "Option::is_none")]
            to: Option<&'a str>,
            apikey: &'a str,
        }

        let url = self
            .client
            .build_url(&format!("/historical-chart/{}", timeframe));
        self.client
            .get_with_query(
                &url,
                &Query {
                    symbol,
                    from,
                    to,
                    apikey: self.client.api_key(),
                },
            )
            .await
    }

    /// Get 1-minute intraday prices
    pub async fn get_1min_prices(
        &self,
        symbol: &str,
        from: Option<&str>,
        to: Option<&str>,
    ) -> Result<Vec<IntradayPrice>> {
        self.get_intraday_prices(symbol, Timeframe::OneMinute, from, to)
            .await
    }

    /// Get 5-minute intraday prices
    pub async fn get_5min_prices(
        &self,
        symbol: &str,
        from: Option<&str>,
        to: Option<&str>,
    ) -> Result<Vec<IntradayPrice>> {
        self.get_intraday_prices(symbol, Timeframe::FiveMinutes, from, to)
            .await
    }

    /// Get 15-minute intraday prices
    pub async fn get_15min_prices(
        &self,
        symbol: &str,
        from: Option<&str>,
        to: Option<&str>,
    ) -> Result<Vec<IntradayPrice>> {
        self.get_intraday_prices(symbol, Timeframe::FifteenMinutes, from, to)
            .await
    }

    /// Get 30-minute intraday prices
    pub async fn get_30min_prices(
        &self,
        symbol: &str,
        from: Option<&str>,
        to: Option<&str>,
    ) -> Result<Vec<IntradayPrice>> {
        self.get_intraday_prices(symbol, Timeframe::ThirtyMinutes, from, to)
            .await
    }

    /// Get 1-hour intraday prices
    pub async fn get_1hour_prices(
        &self,
        symbol: &str,
        from: Option<&str>,
        to: Option<&str>,
    ) -> Result<Vec<IntradayPrice>> {
        self.get_intraday_prices(symbol, Timeframe::OneHour, from, to)
            .await
    }

    /// Get 4-hour intraday prices
    pub async fn get_4hour_prices(
        &self,
        symbol: &str,
        from: Option<&str>,
        to: Option<&str>,
    ) -> Result<Vec<IntradayPrice>> {
        self.get_intraday_prices(symbol, Timeframe::FourHours, from, to)
            .await
    }

    /// Get historical dividend data
    ///
    /// # Arguments
    /// * `symbol` - Stock symbol (e.g., "AAPL")
    ///
    /// # Example
    /// ```no_run
    /// # use fmp_rs::FmpClient;
    /// # #[tokio::main]
    /// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
    /// let client = FmpClient::new()?;
    /// let dividends = client.charts().get_historical_dividends("AAPL").await?;
    /// for div in dividends.iter().take(5) {
    ///     println!("{}: ${:.2} (Adjusted: ${:.2})",
    ///         div.date, div.dividend, div.adj_dividend);
    /// }
    /// # Ok(())
    /// # }
    /// ```
    pub async fn get_historical_dividends(&self, symbol: &str) -> Result<Vec<HistoricalDividend>> {
        self.client
            .get_with_query(
                &format!("v3/historical-price-full/stock_dividend/{}", symbol),
                &(),
            )
            .await
    }

    /// Get stock split history
    ///
    /// # Arguments
    /// * `symbol` - Stock symbol (e.g., "AAPL")
    ///
    /// # Example
    /// ```no_run
    /// # use fmp_rs::FmpClient;
    /// # #[tokio::main]
    /// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
    /// let client = FmpClient::new()?;
    /// let splits = client.charts().get_stock_splits("AAPL").await?;
    /// for split in splits {
    ///     println!("{}: {}:{} split", split.date, split.numerator, split.denominator);
    /// }
    /// # Ok(())
    /// # }
    /// ```
    pub async fn get_stock_splits(&self, symbol: &str) -> Result<Vec<StockSplit>> {
        self.client
            .get_with_query(
                &format!("v3/historical-price-full/stock_split/{}", symbol),
                &(),
            )
            .await
    }

    /// Get survivor bias free EOD prices
    ///
    /// This includes data for delisted companies, providing a more complete
    /// picture of historical market data without survivor bias.
    ///
    /// # Arguments
    /// * `date` - Date in YYYY-MM-DD format
    ///
    /// # Example
    /// ```no_run
    /// # use fmp_rs::FmpClient;
    /// # #[tokio::main]
    /// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
    /// let client = FmpClient::new()?;
    /// let prices = client.charts().get_survivor_bias_free_eod("2024-01-01").await?;
    /// println!("Total symbols on 2024-01-01: {}", prices.len());
    /// # Ok(())
    /// # }
    /// ```
    pub async fn get_survivor_bias_free_eod(&self, date: &str) -> Result<Vec<HistoricalPrice>> {
        self.client
            .get_with_query(
                &format!("v4/batch-request-end-of-day-prices?date={}", date),
                &(),
            )
            .await
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_new() {
        let client = FmpClient::builder().api_key("test_key").build().unwrap();
        let _ = Charts::new(client);
    }

    // Golden path tests
    #[tokio::test]
    #[ignore = "requires FMP API key"]
    async fn test_get_historical_prices() {
        let client = FmpClient::new().unwrap();
        let result = client
            .charts()
            .get_historical_prices("AAPL", None, None)
            .await;
        assert!(result.is_ok());
        let prices = result.unwrap();
        assert!(!prices.is_empty());
    }

    #[tokio::test]
    #[ignore = "requires FMP API key"]
    async fn test_get_historical_prices_with_date_range() {
        let client = FmpClient::new().unwrap();
        let result = client
            .charts()
            .get_historical_prices("AAPL", Some("2024-01-01"), Some("2024-12-31"))
            .await;
        assert!(result.is_ok());
        let prices = result.unwrap();
        assert!(!prices.is_empty());
    }

    #[tokio::test]
    #[ignore = "requires FMP API key"]
    async fn test_get_1min_prices() {
        let client = FmpClient::new().unwrap();
        let result = client.charts().get_1min_prices("AAPL", None, None).await;
        assert!(result.is_ok());
    }

    #[tokio::test]
    #[ignore = "requires FMP API key"]
    async fn test_get_5min_prices() {
        let client = FmpClient::new().unwrap();
        let result = client.charts().get_5min_prices("AAPL", None, None).await;
        assert!(result.is_ok());
    }

    #[tokio::test]
    #[ignore = "requires FMP API key"]
    async fn test_get_15min_prices() {
        let client = FmpClient::new().unwrap();
        let result = client.charts().get_15min_prices("AAPL", None, None).await;
        assert!(result.is_ok());
    }

    #[tokio::test]
    #[ignore = "requires FMP API key"]
    async fn test_get_30min_prices() {
        let client = FmpClient::new().unwrap();
        let result = client.charts().get_30min_prices("AAPL", None, None).await;
        assert!(result.is_ok());
    }

    #[tokio::test]
    #[ignore = "requires FMP API key"]
    async fn test_get_1hour_prices() {
        let client = FmpClient::new().unwrap();
        let result = client.charts().get_1hour_prices("AAPL", None, None).await;
        assert!(result.is_ok());
    }

    #[tokio::test]
    #[ignore = "requires FMP API key"]
    async fn test_get_4hour_prices() {
        let client = FmpClient::new().unwrap();
        let result = client.charts().get_4hour_prices("AAPL", None, None).await;
        assert!(result.is_ok());
    }

    #[tokio::test]
    #[ignore = "requires FMP API key"]
    async fn test_get_historical_dividends() {
        let client = FmpClient::new().unwrap();
        let result = client.charts().get_historical_dividends("AAPL").await;
        assert!(result.is_ok());
        let dividends = result.unwrap();
        assert!(!dividends.is_empty());
    }

    #[tokio::test]
    #[ignore = "requires FMP API key"]
    async fn test_get_stock_splits() {
        let client = FmpClient::new().unwrap();
        let result = client.charts().get_stock_splits("AAPL").await;
        assert!(result.is_ok());
        // AAPL has had splits in the past
    }

    #[tokio::test]
    #[ignore = "requires FMP API key"]
    async fn test_get_survivor_bias_free_eod() {
        let client = FmpClient::new().unwrap();
        let result = client
            .charts()
            .get_survivor_bias_free_eod("2024-01-01")
            .await;
        assert!(result.is_ok());
        let prices = result.unwrap();
        assert!(!prices.is_empty());
    }

    // Edge case tests
    #[tokio::test]
    #[ignore = "requires FMP API key"]
    async fn test_get_historical_prices_invalid_symbol() {
        let client = FmpClient::new().unwrap();
        let result = client
            .charts()
            .get_historical_prices("INVALID_SYMBOL_XYZ123", None, None)
            .await;
        // Should handle gracefully
        if let Ok(prices) = result {
            assert!(prices.is_empty());
        }
    }

    #[tokio::test]
    #[ignore = "requires FMP API key"]
    async fn test_get_historical_dividends_no_dividends() {
        let client = FmpClient::new().unwrap();
        // Some symbols may not have dividends
        let result = client.charts().get_historical_dividends("TSLA").await;
        assert!(result.is_ok());
        // May be empty if no dividends
    }

    #[tokio::test]
    #[ignore = "requires FMP API key"]
    async fn test_get_stock_splits_no_splits() {
        let client = FmpClient::new().unwrap();
        // Some symbols may not have had splits
        let result = client.charts().get_stock_splits("MSFT").await;
        assert!(result.is_ok());
        // May be empty if no splits
    }

    #[tokio::test]
    #[ignore = "requires FMP API key"]
    async fn test_get_intraday_prices_with_date_range() {
        let client = FmpClient::new().unwrap();
        let result = client
            .charts()
            .get_intraday_prices(
                "AAPL",
                Timeframe::FiveMinutes,
                Some("2024-01-01"),
                Some("2024-01-02"),
            )
            .await;
        assert!(result.is_ok());
    }

    // Error handling tests
    #[tokio::test]
    async fn test_invalid_api_key() {
        let client = FmpClient::builder()
            .api_key("invalid_key_12345")
            .build()
            .unwrap();
        let result = client
            .charts()
            .get_historical_prices("AAPL", None, None)
            .await;
        assert!(result.is_err());
    }

    #[tokio::test]
    async fn test_empty_symbol() {
        let client = FmpClient::builder().api_key("test_key").build().unwrap();
        let result = client.charts().get_historical_prices("", None, None).await;
        // Should handle gracefully
        assert!(result.is_err() || result.unwrap().is_empty());
    }
}