finance-query 2.5.1

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

//! Crypto snapshot endpoints: all tickers, single ticker, top movers.

use crate::adapters::common::encode_path_segment;
use crate::error::{FinanceError, Result};

use super::super::build_client;
use super::super::models::*;

/// Fetch snapshots for all crypto tickers.
///
/// * `tickers` - Optional comma-separated list of tickers to filter (e.g., `"X:BTCUSD,X:ETHUSD"`)
pub async fn crypto_snapshots_all(tickers: Option<&str>) -> Result<SnapshotsResponse> {
    let client = build_client()?;
    let path = "/v2/snapshot/locale/global/markets/crypto/tickers";
    let params: Vec<(&str, &str)> = match tickers {
        Some(t) => vec![("tickers", t)],
        None => vec![],
    };
    let json = client.get_raw(path, &params).await?;
    serde_json::from_value(json).map_err(|e| FinanceError::ResponseStructureError {
        field: "crypto_snapshots".to_string(),
        context: format!("Failed to parse crypto snapshots response: {e}"),
    })
}

/// Fetch snapshot for a single crypto ticker.
///
/// * `ticker` - Crypto ticker symbol with `X:` prefix (e.g., `"X:BTCUSD"`)
pub async fn crypto_snapshot(ticker: &str) -> Result<SingleSnapshotResponse> {
    let client = build_client()?;
    let path = format!(
        "/v2/snapshot/locale/global/markets/crypto/tickers/{}",
        ticker
    );
    let json = client.get_raw(&path, &[]).await?;
    serde_json::from_value(json).map_err(|e| FinanceError::ResponseStructureError {
        field: "crypto_snapshot".to_string(),
        context: format!("Failed to parse crypto snapshot response: {e}"),
    })
}

/// Fetch top gainers or losers for crypto.
///
/// * `direction` - `"gainers"` or `"losers"`
pub async fn crypto_top_movers(direction: &str) -> Result<SnapshotsResponse> {
    let client = build_client()?;
    let path = format!(
        "/v2/snapshot/locale/global/markets/crypto/{}",
        encode_path_segment(direction)
    );
    let json = client.get_raw(&path, &[]).await?;
    serde_json::from_value(json).map_err(|e| FinanceError::ResponseStructureError {
        field: "crypto_top_movers".to_string(),
        context: format!("Failed to parse crypto top movers response: {e}"),
    })
}

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

    #[tokio::test]
    async fn test_crypto_snapshot_mock() {
        let mut server = mockito::Server::new_async().await;
        let _mock = server
            .mock(
                "GET",
                "/v2/snapshot/locale/global/markets/crypto/tickers/X:BTCUSD",
            )
            .match_query(mockito::Matcher::AllOf(vec![
                mockito::Matcher::UrlEncoded("apiKey".into(), "test-key".into()),
            ]))
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body(
                serde_json::json!({
                    "request_id": "abc123",
                    "status": "OK",
                    "ticker": {
                        "ticker": "X:BTCUSD",
                        "todaysChange": 1200.0,
                        "todaysChangePerc": 2.85,
                        "updated": 1705363200000000000_i64,
                        "day": { "o": 42000.0, "h": 43500.0, "l": 41800.0, "c": 43200.0, "v": 12345.67 },
                        "prevDay": { "o": 41500.0, "h": 42200.0, "l": 41000.0, "c": 42000.0, "v": 11000.0 },
                        "lastTrade": { "price": 43200.0, "size": 0.25, "exchange": 2, "sip_timestamp": 1705363200000000000_i64 },
                        "min": { "o": 43100.0, "h": 43250.0, "l": 43050.0, "c": 43200.0, "v": 50.5 }
                    }
                })
                .to_string(),
            )
            .create_async()
            .await;

        let client = super::super::super::build_test_client(&server.url()).unwrap();
        let json = client
            .get_raw(
                "/v2/snapshot/locale/global/markets/crypto/tickers/X:BTCUSD",
                &[],
            )
            .await
            .unwrap();

        let resp: SingleSnapshotResponse = serde_json::from_value(json).unwrap();
        assert_eq!(resp.status.as_deref(), Some("OK"));
        let snap = resp.ticker.unwrap();
        assert_eq!(snap.ticker.as_deref(), Some("X:BTCUSD"));
        assert!((snap.todays_change.unwrap() - 1200.0).abs() < 0.01);
    }
}