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

//! Index snapshot endpoints.

use serde::{Deserialize, Serialize};

use crate::error::{FinanceError, Result};

use super::super::build_client;

/// Session data within an index snapshot.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct IndexSession {
    /// Change from previous close.
    pub change: Option<f64>,
    /// Change percent from previous close.
    pub change_percent: Option<f64>,
    /// Close value.
    pub close: Option<f64>,
    /// High value.
    pub high: Option<f64>,
    /// Low value.
    pub low: Option<f64>,
    /// Open value.
    pub open: Option<f64>,
    /// Previous close value.
    pub previous_close: Option<f64>,
}

/// A single index snapshot.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct IndexSnapshot {
    /// Current index value.
    pub value: Option<f64>,
    /// Name of the index.
    pub name: Option<String>,
    /// Type of the index.
    #[serde(rename = "type")]
    pub index_type: Option<String>,
    /// Ticker symbol (e.g., `"I:SPX"`).
    pub ticker: Option<String>,
    /// Market status.
    pub market_status: Option<String>,
    /// Session data.
    pub session: Option<IndexSession>,
}

/// Response wrapper for index snapshots.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct IndexSnapshotResponse {
    /// Response status.
    pub status: Option<String>,
    /// Request identifier.
    pub request_id: Option<String>,
    /// Index snapshot results.
    pub results: Option<Vec<IndexSnapshot>>,
}

/// Fetch snapshot for a single index ticker.
///
/// * `ticker` - Index ticker symbol with `I:` prefix (e.g., `"I:SPX"`)
pub async fn index_snapshot(ticker: &str) -> Result<IndexSnapshotResponse> {
    let client = build_client()?;
    let path = "/v3/snapshot/indices";
    let params = [("ticker.any_of", ticker)];
    let json = client.get_raw(path, &params).await?;
    serde_json::from_value(json).map_err(|e| FinanceError::ResponseStructureError {
        field: "index_snapshot".to_string(),
        context: format!("Failed to parse index snapshot response: {e}"),
    })
}

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

    #[tokio::test]
    async fn test_index_snapshot_mock() {
        let mut server = mockito::Server::new_async().await;
        let _mock = server
            .mock("GET", "/v3/snapshot/indices")
            .match_query(mockito::Matcher::AllOf(vec![
                mockito::Matcher::UrlEncoded("apiKey".into(), "test-key".into()),
                mockito::Matcher::UrlEncoded("ticker.any_of".into(), "I:SPX".into()),
            ]))
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body(
                serde_json::json!({
                    "status": "OK",
                    "request_id": "abc123",
                    "results": [
                        {
                            "value": 4790.0,
                            "name": "S&P 500",
                            "type": "indices",
                            "ticker": "I:SPX",
                            "market_status": "open",
                            "session": {
                                "change": 20.0,
                                "change_percent": 0.42,
                                "close": 4790.0,
                                "high": 4800.0,
                                "low": 4760.0,
                                "open": 4770.0,
                                "previous_close": 4770.0
                            }
                        }
                    ]
                })
                .to_string(),
            )
            .create_async()
            .await;

        let client = super::super::super::build_test_client(&server.url()).unwrap();
        let json = client
            .get_raw("/v3/snapshot/indices", &[("ticker.any_of", "I:SPX")])
            .await
            .unwrap();

        let resp: IndexSnapshotResponse = serde_json::from_value(json).unwrap();
        assert_eq!(resp.status.as_deref(), Some("OK"));
        let results = resp.results.unwrap();
        assert_eq!(results.len(), 1);
        assert_eq!(results[0].ticker.as_deref(), Some("I:SPX"));
        assert!((results[0].value.unwrap() - 4790.0).abs() < 0.01);
        let session = results[0].session.as_ref().unwrap();
        assert!((session.change.unwrap() - 20.0).abs() < 0.01);
    }
}