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
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

use super::formatted_value::FormattedValue;
/// Summary Detail module
///
/// Contains detailed trading and valuation metrics for the symbol.
use serde::{Deserialize, Serialize};
use serde_json::Value;

/// Summary detail trading and valuation metrics
///
/// Contains detailed information about price, volume, market cap, and other trading data.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SummaryDetail {
    /// Algorithm (for crypto/special assets)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub algorithm: Option<Value>,

    /// All-time high price
    #[serde(skip_serializing_if = "Option::is_none")]
    pub all_time_high: Option<FormattedValue<f64>>,

    /// All-time low price
    #[serde(skip_serializing_if = "Option::is_none")]
    pub all_time_low: Option<FormattedValue<f64>>,

    /// Current ask price
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ask: Option<FormattedValue<f64>>,

    /// Ask size (shares)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ask_size: Option<FormattedValue<i64>>,

    /// Average daily trading volume (10 day)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub average_daily_volume10_day: Option<FormattedValue<i64>>,

    /// Average trading volume
    #[serde(skip_serializing_if = "Option::is_none")]
    pub average_volume: Option<FormattedValue<i64>>,

    /// Average trading volume (10 days)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub average_volume10days: Option<FormattedValue<i64>>,

    /// Beta coefficient (volatility vs market)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub beta: Option<FormattedValue<f64>>,

    /// Current bid price
    #[serde(skip_serializing_if = "Option::is_none")]
    pub bid: Option<FormattedValue<f64>>,

    /// Bid size (shares)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub bid_size: Option<FormattedValue<i64>>,

    /// Circulating supply (for crypto)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub circulating_supply: Option<Value>,

    /// CoinMarketCap link (for crypto)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub coin_market_cap_link: Option<Value>,

    /// Currency code
    #[serde(skip_serializing_if = "Option::is_none")]
    pub currency: Option<String>,

    /// Day's high price
    #[serde(skip_serializing_if = "Option::is_none")]
    pub day_high: Option<FormattedValue<f64>>,

    /// Day's low price
    #[serde(skip_serializing_if = "Option::is_none")]
    pub day_low: Option<FormattedValue<f64>>,

    /// Annual dividend rate
    #[serde(skip_serializing_if = "Option::is_none")]
    pub dividend_rate: Option<FormattedValue<f64>>,

    /// Dividend yield percentage
    #[serde(skip_serializing_if = "Option::is_none")]
    pub dividend_yield: Option<FormattedValue<f64>>,

    /// Ex-dividend date
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ex_dividend_date: Option<FormattedValue<i64>>,

    /// Expiration date (for options/futures)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub expire_date: Option<Value>,

    /// 50-day moving average
    #[serde(skip_serializing_if = "Option::is_none")]
    pub fifty_day_average: Option<FormattedValue<f64>>,

    /// 52-week high price
    #[serde(skip_serializing_if = "Option::is_none")]
    pub fifty_two_week_high: Option<FormattedValue<f64>>,

    /// 52-week low price
    #[serde(skip_serializing_if = "Option::is_none")]
    pub fifty_two_week_low: Option<FormattedValue<f64>>,

    /// 5-year average dividend yield
    #[serde(skip_serializing_if = "Option::is_none")]
    pub five_year_avg_dividend_yield: Option<FormattedValue<f64>>,

    /// Forward price-to-earnings ratio
    #[serde(skip_serializing_if = "Option::is_none")]
    pub forward_pe: Option<FormattedValue<f64>>,

    /// From currency (for currency pairs)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub from_currency: Option<String>,

    /// Last market (for crypto)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub last_market: Option<String>,

    /// Market capitalization
    #[serde(skip_serializing_if = "Option::is_none")]
    pub market_cap: Option<FormattedValue<i64>>,

    /// Maximum age of data in seconds
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_age: Option<i64>,

    /// Maximum supply (for crypto)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_supply: Option<Value>,

    /// Net asset value price (for funds)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub nav_price: Option<FormattedValue<f64>>,

    /// Opening price
    #[serde(skip_serializing_if = "Option::is_none")]
    pub open: Option<FormattedValue<f64>>,

    /// Open interest (for options/futures)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub open_interest: Option<Value>,

    /// Dividend payout ratio
    #[serde(skip_serializing_if = "Option::is_none")]
    pub payout_ratio: Option<FormattedValue<f64>>,

    /// Previous closing price
    #[serde(skip_serializing_if = "Option::is_none")]
    pub previous_close: Option<FormattedValue<f64>>,

    /// Price hint (decimal places)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub price_hint: Option<FormattedValue<i64>>,

    /// Price to sales ratio (trailing 12 months)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub price_to_sales_trailing12_months: Option<FormattedValue<f64>>,

    /// Quarter-to-date return
    #[serde(skip_serializing_if = "Option::is_none")]
    pub qtd_return: Option<Value>,

    /// Regular market day high
    #[serde(skip_serializing_if = "Option::is_none")]
    pub regular_market_day_high: Option<FormattedValue<f64>>,

    /// Regular market day low
    #[serde(skip_serializing_if = "Option::is_none")]
    pub regular_market_day_low: Option<FormattedValue<f64>>,

    /// Regular market opening price
    #[serde(skip_serializing_if = "Option::is_none")]
    pub regular_market_open: Option<FormattedValue<f64>>,

    /// Regular market previous close
    #[serde(skip_serializing_if = "Option::is_none")]
    pub regular_market_previous_close: Option<FormattedValue<f64>>,

    /// Regular market trading volume
    #[serde(skip_serializing_if = "Option::is_none")]
    pub regular_market_volume: Option<FormattedValue<i64>>,

    /// Start date (for funds/special assets)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub start_date: Option<Value>,

    /// Strike price (for options)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub strike_price: Option<Value>,

    /// To currency (for currency pairs)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub to_currency: Option<String>,

    /// Total assets (for funds)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub total_assets: Option<FormattedValue<i64>>,

    /// Whether the security is tradeable
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tradeable: Option<bool>,

    /// Trailing annual dividend rate
    #[serde(skip_serializing_if = "Option::is_none")]
    pub trailing_annual_dividend_rate: Option<FormattedValue<f64>>,

    /// Trailing annual dividend yield
    #[serde(skip_serializing_if = "Option::is_none")]
    pub trailing_annual_dividend_yield: Option<FormattedValue<f64>>,

    /// Trailing price-to-earnings ratio
    #[serde(skip_serializing_if = "Option::is_none")]
    pub trailing_pe: Option<FormattedValue<f64>>,

    /// 200-day moving average
    #[serde(skip_serializing_if = "Option::is_none")]
    pub two_hundred_day_average: Option<FormattedValue<f64>>,

    /// Trading volume
    #[serde(skip_serializing_if = "Option::is_none")]
    pub volume: Option<FormattedValue<i64>>,

    /// 24-hour trading volume (for crypto)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub volume24_hr: Option<Value>,

    /// Volume across all currencies (for crypto)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub volume_all_currencies: Option<Value>,

    /// Yield (for bonds/funds)
    #[serde(rename = "yield", skip_serializing_if = "Option::is_none")]
    pub yield_value: Option<FormattedValue<f64>>,

    /// Year-to-date return
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ytd_return: Option<Value>,
}

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

    #[test]
    fn test_deserialize_summary_detail() {
        let json = r#"{
            "currency": "USD",
            "previousClose": {"fmt": "275.00", "raw": 275.0},
            "marketCap": {"fmt": "4.09T", "longFmt": "4,090,000,000,000", "raw": 4090000000000},
            "beta": {"fmt": "1.11", "raw": 1.109},
            "tradeable": true
        }"#;

        let detail: SummaryDetail = serde_json::from_str(json).unwrap();
        assert_eq!(detail.currency.as_deref(), Some("USD"));
        assert_eq!(
            detail.previous_close.as_ref().map(|v| v.raw),
            Some(Some(275.0))
        );
        assert_eq!(
            detail.market_cap.as_ref().map(|v| v.raw),
            Some(Some(4090000000000))
        );
        assert_eq!(detail.tradeable, Some(true));
    }
}