finance-query 3.0.0

A Rust library for querying financial data
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
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
//! Financial Modeling Prep (FMP) provider implementation.

use super::{
    CalendarProvider, ChartProvider, CommoditiesProvider, CorporateProvider, CryptoProvider,
    DiscoveryProvider, FilingsProvider, ForexProvider, FundamentalsProvider, IndicesProvider,
    MarketProvider, Operation, Provider, ProviderAdapter, ProviderCore, QuoteProvider,
};
use crate::error::Result;

pub(crate) struct FmpProvider;

impl ProviderCore for FmpProvider {
    fn id(&self) -> Provider {
        Provider::Fmp
    }
}

#[async_trait::async_trait]
impl QuoteProvider for FmpProvider {
    async fn fetch_quote(
        &self,
        symbol: &str,
    ) -> Result<crate::models::quote::QuoteSummaryResponse> {
        crate::adapters::fmp::quote::fetch_canonical_quote(symbol).await
    }

    async fn fetch_quotes_batch(
        &self,
        symbols: &[&str],
    ) -> Result<Vec<(String, crate::models::quote::QuoteSummaryResponse)>> {
        crate::adapters::fmp::quote::fetch_canonical_quotes_batch(symbols).await
    }
}

#[async_trait::async_trait]
impl ChartProvider for FmpProvider {
    async fn fetch_chart(
        &self,
        symbol: &str,
        interval: crate::Interval,
        range: crate::TimeRange,
    ) -> Result<crate::models::chart::Chart> {
        let (from, to) = range_dates(range);
        let candles = fetch_candles(symbol, interval, from, to).await?;

        Ok(crate::models::chart::Chart {
            symbol: symbol.to_string(),
            meta: Default::default(),
            candles,
            interval: Some(interval),
            range: Some(range),
            provider_id: Some(Provider::Fmp),
        })
    }

    async fn fetch_chart_range(
        &self,
        symbol: &str,
        interval: crate::Interval,
        start: i64,
        end: i64,
    ) -> Result<crate::models::chart::Chart> {
        let from = timestamp_to_date_str(start);
        let to = timestamp_to_date_str(end);
        let candles = fetch_candles(symbol, interval, from, to).await?;

        Ok(crate::models::chart::Chart {
            symbol: symbol.to_string(),
            meta: Default::default(),
            candles,
            interval: Some(interval),
            range: None,
            provider_id: Some(Provider::Fmp),
        })
    }
}

#[async_trait::async_trait]
impl FundamentalsProvider for FmpProvider {
    async fn fetch_financials(
        &self,
        symbol: &str,
        stmt_type: crate::StatementType,
        frequency: crate::Frequency,
    ) -> Result<crate::models::fundamentals::FinancialStatement> {
        let period = match frequency {
            crate::Frequency::Annual => crate::adapters::fmp::Period::Annual,
            crate::Frequency::Quarterly => crate::adapters::fmp::Period::Quarter,
        };
        let limit = Some(50u32);

        let data = crate::adapters::fmp::fundamentals::fetch_financials_data(
            symbol, stmt_type, period, limit,
        )
        .await?;

        Ok(super::build_financial_statement(
            symbol.to_string(),
            stmt_type.as_str().to_string(),
            frequency.as_str().to_string(),
            Provider::Fmp,
            data,
        ))
    }

    async fn fetch_price_target_consensus(
        &self,
        symbol: &str,
    ) -> Result<crate::models::fundamentals::PriceTargetConsensus> {
        crate::adapters::fmp::fundamentals::consensus::fetch_price_target_consensus_response(symbol)
            .await
    }

    async fn fetch_price_target_summary(
        &self,
        symbol: &str,
    ) -> Result<crate::models::fundamentals::PriceTargetSummary> {
        crate::adapters::fmp::fundamentals::consensus::fetch_price_target_summary_response(symbol)
            .await
    }

    async fn fetch_rating_consensus(
        &self,
        symbol: &str,
    ) -> Result<crate::models::fundamentals::RatingConsensus> {
        crate::adapters::fmp::fundamentals::consensus::fetch_rating_consensus_response(symbol).await
    }

    async fn fetch_key_metrics_ttm(
        &self,
        symbol: &str,
    ) -> Result<crate::models::fundamentals::KeyMetricsTtm> {
        crate::adapters::fmp::fundamentals::ttm::fetch_key_metrics_ttm_response(symbol).await
    }

    async fn fetch_ratios_ttm(
        &self,
        symbol: &str,
    ) -> Result<crate::models::fundamentals::FinancialRatiosTtm> {
        crate::adapters::fmp::fundamentals::ttm::fetch_ratios_ttm_response(symbol).await
    }

    async fn fetch_share_float(
        &self,
        symbol: &str,
    ) -> Result<crate::models::fundamentals::ShareFloat> {
        crate::adapters::fmp::fundamentals::float::fetch_share_float_response(symbol).await
    }

    async fn fetch_etf_profile(
        &self,
        symbol: &str,
    ) -> Result<crate::models::fundamentals::EtfProfile> {
        crate::adapters::fmp::fundamentals::fund_holdings::fetch_etf_profile_response(symbol).await
    }

    async fn fetch_earnings_surprises(
        &self,
        symbol: &str,
    ) -> Result<Vec<crate::models::fundamentals::EarningsSurprise>> {
        crate::adapters::fmp::fundamentals::estimates::fetch_earnings_surprises_response(symbol)
            .await
    }

    async fn fetch_grading_history(
        &self,
        symbol: &str,
    ) -> Result<Vec<crate::models::fundamentals::GradingAction>> {
        crate::adapters::fmp::fundamentals::estimates::fetch_grading_history_response(symbol, 50)
            .await
    }
}

#[async_trait::async_trait]
impl CorporateProvider for FmpProvider {
    async fn fetch_news(&self, symbol: &str) -> Result<Vec<crate::models::corporate::news::News>> {
        crate::adapters::fmp::corporate::fetch_canonical_news(symbol, 50).await
    }

    async fn fetch_events(
        &self,
        symbol: &str,
    ) -> Result<crate::models::chart::events::ChartEvents> {
        crate::adapters::fmp::corporate::fetch_canonical_events(symbol).await
    }

    async fn fetch_similar_symbols(
        &self,
        symbol: &str,
        limit: u32,
    ) -> Result<Vec<crate::models::corporate::recommendation::SimilarSymbol>> {
        crate::adapters::fmp::quote::fetch_canonical_similar_symbols(symbol, limit).await
    }

    async fn fetch_press_releases(
        &self,
        symbol: &str,
        limit: u32,
    ) -> Result<Vec<crate::models::corporate::press_release::PressRelease>> {
        crate::adapters::fmp::corporate::fetch_press_releases_response(symbol, limit).await
    }

    async fn fetch_executive_compensation(
        &self,
        symbol: &str,
    ) -> Result<Vec<crate::models::corporate::governance::ExecutiveCompensation>> {
        crate::adapters::fmp::corporate::ownership::fetch_executive_compensation_response(symbol)
            .await
    }

    async fn fetch_employee_count(
        &self,
        symbol: &str,
    ) -> Result<Vec<crate::models::corporate::governance::EmployeeCount>> {
        crate::adapters::fmp::corporate::ownership::fetch_employee_count_response(symbol).await
    }
}

/// `fetch_filings` is the trait's required primary operation, but FMP
/// publishes no raw SEC filing surface — only insider, congressional, and
/// fails-to-deliver data — so it reports `NotSupported` there and dispatch
/// falls through to EDGAR.
#[async_trait::async_trait]
impl FilingsProvider for FmpProvider {
    async fn fetch_filings(
        &self,
        _symbol: &str,
    ) -> Result<crate::models::filings::ProviderFilings> {
        Err(self.not_supported(Operation::Filings))
    }

    async fn fetch_insider_trades(
        &self,
        symbol: &str,
        limit: u32,
    ) -> Result<Vec<crate::models::filings::InsiderTrade>> {
        crate::adapters::fmp::corporate::insider_trading::fetch_insider_trades_response(
            symbol, limit,
        )
        .await
    }

    async fn fetch_congressional_trades(
        &self,
        symbol: &str,
    ) -> Result<Vec<crate::models::filings::CongressionalTrade>> {
        crate::adapters::fmp::corporate::insider_trading::fetch_congressional_trades_response(
            symbol,
        )
        .await
    }

    async fn fetch_fails_to_deliver(
        &self,
        symbol: &str,
    ) -> Result<Vec<crate::models::filings::FailToDeliver>> {
        crate::adapters::fmp::corporate::insider_trading::fetch_fails_to_deliver_response(symbol)
            .await
    }
}

/// `fetch_listing_status(active: true)` covers only ETF and mutual-fund
/// listings, not the full equity universe the trait contract describes — FMP
/// has no keyless all-active-stocks endpoint in this adapter.
#[async_trait::async_trait]
impl DiscoveryProvider for FmpProvider {
    async fn fetch_symbol_search(
        &self,
        query: &str,
        limit: u32,
    ) -> Result<Vec<crate::models::discovery::reference::SymbolMatch>> {
        crate::adapters::fmp::discovery::screener::fetch_symbol_search_response(query, limit).await
    }

    async fn fetch_screener(
        &self,
        filters: &crate::models::discovery::reference::ScreenerFilters,
    ) -> Result<Vec<crate::models::discovery::reference::ScreenerMatch>> {
        crate::adapters::fmp::discovery::screener::fetch_screener_response(filters).await
    }

    async fn fetch_listing_status(
        &self,
        active: bool,
    ) -> Result<Vec<crate::models::discovery::reference::SymbolMatch>> {
        if active {
            crate::adapters::fmp::fundamentals::etf_mutual_funds::fetch_active_listing_status_response()
                .await
        } else {
            crate::adapters::fmp::quote::fetch_delisted_listing_status_response().await
        }
    }
}

#[async_trait::async_trait]
impl CalendarProvider for FmpProvider {
    async fn fetch_market_calendar(
        &self,
        kind: crate::models::calendar::market::CalendarKind,
        from: &str,
        to: &str,
    ) -> Result<Vec<crate::models::calendar::market::MarketCalendarEntry>> {
        crate::adapters::fmp::market::calendars::fetch_market_calendar_response(kind, from, to)
            .await
    }
}

#[async_trait::async_trait]
impl MarketProvider for FmpProvider {
    async fn fetch_market_movers(
        &self,
        direction: crate::models::market::performance::MoverDirection,
    ) -> Result<Vec<crate::models::market::performance::MoverQuote>> {
        crate::adapters::fmp::market::market_performance::fetch_market_movers_response(direction)
            .await
    }

    async fn fetch_sector_performance_history(
        &self,
        limit: u32,
    ) -> Result<Vec<crate::models::market::performance::SectorPerformanceHistory>> {
        crate::adapters::fmp::market::market_performance::fetch_sector_performance_history_response(
            limit,
        )
        .await
    }

    async fn fetch_sector_performance(
        &self,
    ) -> Result<Vec<crate::models::market::performance::SectorPerformance>> {
        crate::adapters::fmp::market::market_performance::fetch_sector_performance_response().await
    }

    async fn fetch_sector_pe(&self) -> Result<Vec<crate::models::market::performance::SectorPe>> {
        crate::adapters::fmp::market::market_performance::fetch_sector_pe_response().await
    }

    async fn fetch_industry_pe(
        &self,
    ) -> Result<Vec<crate::models::market::performance::IndustryPe>> {
        crate::adapters::fmp::market::market_performance::fetch_industry_pe_response().await
    }
}

#[async_trait::async_trait]
impl ForexProvider for FmpProvider {
    async fn fetch_forex_quote(
        &self,
        from: &str,
        to: &str,
    ) -> Result<crate::models::forex::ForexQuote> {
        crate::adapters::fmp::forex::fetch_canonical_forex_quote(from, to).await
    }

    async fn fetch_forex_news(
        &self,
        limit: u32,
    ) -> Result<Vec<crate::models::corporate::news::News>> {
        crate::adapters::fmp::corporate::news::fetch_forex_news_response(limit).await
    }
}

#[async_trait::async_trait]
impl IndicesProvider for FmpProvider {
    async fn fetch_indices_quote(
        &self,
        symbol: &str,
    ) -> Result<crate::models::indices::IndexQuote> {
        crate::adapters::fmp::indices::fetch_canonical_index_quote(symbol).await
    }

    async fn fetch_index_constituents(
        &self,
        index: crate::models::indices::MajorIndex,
    ) -> Result<Vec<crate::models::indices::IndexConstituent>> {
        crate::adapters::fmp::indices::fetch_index_constituents_response(index).await
    }

    async fn fetch_index_constituent_changes(
        &self,
        index: crate::models::indices::MajorIndex,
    ) -> Result<Vec<crate::models::indices::IndexConstituentChange>> {
        crate::adapters::fmp::indices::fetch_index_constituent_changes_response(index).await
    }
}

#[async_trait::async_trait]
impl CommoditiesProvider for FmpProvider {
    async fn fetch_commodities_quote(
        &self,
        symbol: &str,
    ) -> Result<crate::models::commodities::CommodityQuote> {
        crate::adapters::fmp::commodities::fetch_canonical_commodity_quote(symbol).await
    }
}

#[async_trait::async_trait]
impl CryptoProvider for FmpProvider {
    async fn fetch_crypto_quote(
        &self,
        id: &str,
        vs_currency: &str,
    ) -> Result<crate::models::crypto::CryptoQuote> {
        crate::adapters::fmp::crypto::fetch_canonical_crypto_quote(id, vs_currency).await
    }

    async fn fetch_crypto_news(
        &self,
        limit: u32,
    ) -> Result<Vec<crate::models::corporate::news::News>> {
        crate::adapters::fmp::corporate::news::fetch_crypto_news_response(limit).await
    }
}

#[async_trait::async_trait]
impl ProviderAdapter for FmpProvider {
    async fn initialize(&self) -> Result<()> {
        let _ = crate::adapters::fmp::build_client()?;
        Ok(())
    }

    fn rate_limit_remaining(&self) -> Option<f64> {
        crate::adapters::fmp::rate_limiter().and_then(|l| l.available_estimate())
    }

    fn as_quote(&self) -> Option<&dyn QuoteProvider> {
        Some(self)
    }
    fn as_chart(&self) -> Option<&dyn ChartProvider> {
        Some(self)
    }
    fn as_fundamentals(&self) -> Option<&dyn FundamentalsProvider> {
        Some(self)
    }
    fn as_corporate(&self) -> Option<&dyn CorporateProvider> {
        Some(self)
    }
    fn as_discovery(&self) -> Option<&dyn DiscoveryProvider> {
        Some(self)
    }
    fn as_calendar(&self) -> Option<&dyn CalendarProvider> {
        Some(self)
    }
    fn as_market(&self) -> Option<&dyn MarketProvider> {
        Some(self)
    }
    fn as_crypto(&self) -> Option<&dyn CryptoProvider> {
        Some(self)
    }
    fn as_forex(&self) -> Option<&dyn ForexProvider> {
        Some(self)
    }
    fn as_indices(&self) -> Option<&dyn IndicesProvider> {
        Some(self)
    }
    fn as_commodities(&self) -> Option<&dyn CommoditiesProvider> {
        Some(self)
    }
    fn as_filings(&self) -> Option<&dyn FilingsProvider> {
        Some(self)
    }
}

/// Fetch daily or intraday candles for `[from, to]`, picking the endpoint by
/// interval granularity.
async fn fetch_candles(
    symbol: &str,
    interval: crate::Interval,
    from: String,
    to: String,
) -> Result<Vec<crate::models::chart::Candle>> {
    let params = crate::adapters::fmp::quote::HistoricalPriceParams {
        from: Some(from),
        to: Some(to),
    };
    match interval {
        crate::Interval::OneDay
        | crate::Interval::OneWeek
        | crate::Interval::OneMonth
        | crate::Interval::ThreeMonths => {
            crate::adapters::fmp::quote::fetch_daily_chart_candles(symbol, Some(params)).await
        }
        _ => {
            let code = fmp_interval_str(interval)
                .ok_or_else(|| Operation::Chart.not_supported(Provider::Fmp))?;
            crate::adapters::fmp::quote::fetch_intraday_chart_candles(symbol, code, Some(params))
                .await
        }
    }
}

fn range_dates(range: crate::TimeRange) -> (String, String) {
    super::range_to_dates(range)
}

/// Convert a unix timestamp to YYYY-MM-DD date string.
fn timestamp_to_date_str(ts: i64) -> String {
    chrono::DateTime::from_timestamp(ts, 0)
        .map(|dt| dt.format("%Y-%m-%d").to_string())
        .unwrap_or_else(|| "1970-01-01".to_string())
}

/// Map crate::Interval to FMP's intraday interval string. `TwoMinutes`,
/// `NinetyMinutes`, and `FiveDays` have no FMP equivalent (its
/// historical-chart endpoint only documents
/// 1min/5min/15min/30min/1hour/4hour) and return `None`.
fn fmp_interval_str(interval: crate::Interval) -> Option<&'static str> {
    Some(match interval {
        crate::Interval::OneMinute => "1min",
        crate::Interval::FiveMinutes => "5min",
        crate::Interval::FifteenMinutes => "15min",
        crate::Interval::ThirtyMinutes => "30min",
        crate::Interval::OneHour => "1hour",
        crate::Interval::TwoMinutes
        | crate::Interval::NinetyMinutes
        | crate::Interval::FiveDays => {
            return None;
        }
        _ => "1hour",
    })
}

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

    #[test]
    fn timestamp_to_date_str_formats_utc_day() {
        // 2024-01-02T00:00:00Z.
        assert_eq!(timestamp_to_date_str(1_704_153_600), "2024-01-02");
        // Within the day still rounds to the same date string.
        assert_eq!(timestamp_to_date_str(1_704_153_600 + 3_600), "2024-01-02");
    }

    #[test]
    fn timestamp_to_date_str_clamps_invalid_to_epoch() {
        assert_eq!(timestamp_to_date_str(i64::MAX), "1970-01-01");
    }

    #[test]
    fn fmp_interval_str_maps_intraday_and_falls_back() {
        assert_eq!(fmp_interval_str(Interval::OneMinute), Some("1min"));
        assert_eq!(fmp_interval_str(Interval::FiveMinutes), Some("5min"));
        assert_eq!(fmp_interval_str(Interval::FifteenMinutes), Some("15min"));
        assert_eq!(fmp_interval_str(Interval::ThirtyMinutes), Some("30min"));
        assert_eq!(fmp_interval_str(Interval::OneHour), Some("1hour"));
        // Daily/weekly/monthly aren't intraday intervals → documented fallback.
        assert_eq!(fmp_interval_str(Interval::OneDay), Some("1hour"));
        assert_eq!(fmp_interval_str(Interval::OneWeek), Some("1hour"));
    }

    #[test]
    fn fmp_interval_str_has_no_mapping_for_unsupported_granularities() {
        assert_eq!(fmp_interval_str(Interval::TwoMinutes), None);
        assert_eq!(fmp_interval_str(Interval::NinetyMinutes), None);
        assert_eq!(fmp_interval_str(Interval::FiveDays), None);
    }

    #[test]
    fn range_dates_returns_well_formed_ordered_bounds() {
        let (from, to) = range_dates(crate::TimeRange::OneMonth);
        // YYYY-MM-DD shape.
        assert_eq!(from.len(), 10);
        assert_eq!(to.len(), 10);
        assert_eq!(from.matches('-').count(), 2);
        // Start precedes end (lexicographic works for ISO dates).
        assert!(from <= to, "from {from} should be <= to {to}");
    }
}