finance-query 2.6.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

//! Forex endpoints for Financial Modeling Prep.

#![allow(dead_code)]
use crate::adapters::common::encode_path_segment;
use crate::error::Result;

use crate::adapters::fmp::build_client;
use crate::adapters::fmp::crypto::AvailableSymbolDTO;
use crate::adapters::fmp::models::{FmpQuoteDTO, HistoricalPriceResponseDTO, IntradayPriceDTO};

/// Convert FMP quote DTOs into a canonical ForexQuote.
fn forex_quote_to_canonical(
    pair: &str,
    from: &str,
    to: &str,
    quotes: &[FmpQuoteDTO],
) -> crate::models::forex::ForexQuote {
    let q = quotes.first();
    let price = q.and_then(|q| q.price);
    crate::models::forex::ForexQuote {
        symbol: pair.to_string(),
        base_currency: Some(from.to_uppercase()),
        quote_currency: Some(to.to_uppercase()),
        bid: price,
        ask: None,
        price,
        change: None,
        change_percent: None,
        timestamp: q.and_then(|q| q.timestamp),
    }
}

/// Fetch a canonical forex quote.
pub async fn fetch_canonical_forex_quote(
    from: &str,
    to: &str,
) -> Result<crate::models::forex::ForexQuote> {
    let pair = format!("{}{}", from.to_uppercase(), to.to_uppercase());
    let quotes = forex_quote(&pair).await?;
    Ok(forex_quote_to_canonical(&pair, from, to, &quotes))
}

/// Fetch a real-time forex quote.
///
/// * `symbol` - e.g., `"EURUSD"`
pub async fn forex_quote(symbol: &str) -> Result<Vec<FmpQuoteDTO>> {
    let client = build_client()?;
    let path = format!("/api/v3/quote/{}", encode_path_segment(symbol));
    client.get(&path, &[]).await
}

/// List all available forex currency pairs.
pub async fn forex_available() -> Result<Vec<AvailableSymbolDTO>> {
    let client = build_client()?;
    client
        .get("/api/v3/symbol/available-forex-currency-pairs", &[])
        .await
}

/// Fetch daily historical prices for a forex pair.
///
/// * `symbol` - e.g., `"EURUSD"`
/// * `params` - Optional query params such as `from`, `to`
pub async fn forex_historical(
    symbol: &str,
    params: &[(&str, &str)],
) -> Result<HistoricalPriceResponseDTO> {
    let client = build_client()?;
    let path = format!(
        "/api/v3/historical-price-full/{}",
        encode_path_segment(symbol)
    );
    client.get(&path, params).await
}

/// Fetch intraday prices for a forex pair.
///
/// * `symbol` - e.g., `"EURUSD"`
/// * `interval` - e.g., `"1min"`, `"5min"`, `"15min"`, `"30min"`, `"1hour"`, `"4hour"`
/// * `params` - Optional query params such as `from`, `to`
pub async fn forex_intraday(
    symbol: &str,
    interval: &str,
    params: &[(&str, &str)],
) -> Result<Vec<IntradayPriceDTO>> {
    let client = build_client()?;
    let path = format!(
        "/api/v3/historical-chart/{}/{}",
        encode_path_segment(interval),
        encode_path_segment(symbol)
    );
    client.get(&path, params).await
}

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

    #[tokio::test]
    async fn test_forex_available_mock() {
        let mut server = mockito::Server::new_async().await;
        let _mock = server
            .mock("GET", "/api/v3/symbol/available-forex-currency-pairs")
            .match_query(mockito::Matcher::AllOf(vec![mockito::Matcher::UrlEncoded(
                "apikey".into(),
                "test-key".into(),
            )]))
            .with_status(200)
            .with_body(
                serde_json::json!([
                    {
                        "symbol": "EURUSD",
                        "name": "EUR/USD",
                        "currency": "USD",
                        "stockExchange": "CCY",
                        "exchangeShortName": "FOREX"
                    }
                ])
                .to_string(),
            )
            .create_async()
            .await;

        let client = crate::adapters::fmp::build_test_client(&server.url()).unwrap();
        let result: Vec<AvailableSymbolDTO> = client
            .get("/api/v3/symbol/available-forex-currency-pairs", &[])
            .await
            .unwrap();
        assert_eq!(result.len(), 1);
        assert_eq!(result[0].symbol.as_deref(), Some("EURUSD"));
    }
}