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

use super::FormattedValue;
use serde::{Deserialize, Serialize};

/// Index trend data (growth estimates for the index)
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct IndexTrend {
    /// Maximum age of the data in seconds
    #[serde(default)]
    pub max_age: Option<i64>,

    /// Index symbol
    #[serde(default)]
    pub symbol: Option<String>,

    /// Growth estimates for different periods
    #[serde(default)]
    pub estimates: Option<Vec<TrendEstimate>>,

    /// PE ratio (may be FormattedValue or plain number)
    #[serde(default)]
    pub pe_ratio: Option<FormattedValue<f64>>,

    /// PEG ratio (may be FormattedValue or plain number)
    #[serde(default)]
    pub peg_ratio: Option<FormattedValue<f64>>,
}

/// Industry trend data
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct IndustryTrend {
    /// Maximum age of the data in seconds
    #[serde(default)]
    pub max_age: Option<i64>,

    /// Industry symbol
    #[serde(default)]
    pub symbol: Option<String>,

    /// Growth estimates for different periods
    #[serde(default)]
    pub estimates: Option<Vec<TrendEstimate>>,

    /// PE ratio (may be FormattedValue or plain number)
    #[serde(default)]
    pub pe_ratio: Option<FormattedValue<f64>>,

    /// PEG ratio (may be FormattedValue or plain number)
    #[serde(default)]
    pub peg_ratio: Option<FormattedValue<f64>>,
}

/// Sector trend data
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SectorTrend {
    /// Maximum age of the data in seconds
    #[serde(default)]
    pub max_age: Option<i64>,

    /// Sector symbol
    #[serde(default)]
    pub symbol: Option<String>,

    /// Growth estimates for different periods
    #[serde(default)]
    pub estimates: Option<Vec<TrendEstimate>>,

    /// PE ratio (may be FormattedValue or plain number)
    #[serde(default)]
    pub pe_ratio: Option<FormattedValue<f64>>,

    /// PEG ratio (may be FormattedValue or plain number)
    #[serde(default)]
    pub peg_ratio: Option<FormattedValue<f64>>,
}

/// Growth estimate for a specific period
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TrendEstimate {
    /// Period (e.g., "0q", "+1q", "0y", "+1y", "LTG")
    #[serde(default)]
    pub period: Option<String>,

    /// Growth rate (formatted value)
    #[serde(default)]
    pub growth: Option<FormattedValue<f64>>,
}

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

    #[test]
    fn test_index_trend_deserialize() {
        let json = r#"{
          "maxAge": 1,
          "symbol": "SP5",
          "estimates": [
            {
              "period": "0q",
              "growth": {"raw": 0.1516, "fmt": "0.15"}
            },
            {
              "period": "+1q",
              "growth": {"raw": 0.067600004, "fmt": "0.07"}
            }
          ],
          "peRatio": {},
          "pegRatio": {}
        }"#;

        let result: Result<IndexTrend, _> = serde_json::from_str(json);
        assert!(
            result.is_ok(),
            "IndexTrend should deserialize successfully: {:?}",
            result.err()
        );

        let trend = result.unwrap();
        assert_eq!(trend.max_age, Some(1));
        assert_eq!(trend.symbol, Some("SP5".to_string()));
        assert!(trend.estimates.is_some());
        assert_eq!(trend.estimates.as_ref().unwrap().len(), 2);

        // Verify empty peRatio and pegRatio deserialize as None
        assert_eq!(
            trend.pe_ratio,
            Some(FormattedValue {
                fmt: None,
                long_fmt: None,
                raw: None
            })
        );
        assert_eq!(
            trend.peg_ratio,
            Some(FormattedValue {
                fmt: None,
                long_fmt: None,
                raw: None
            })
        );
    }

    #[test]
    fn test_index_trend_empty() {
        let json = r#"{"maxAge": 1, "symbol": null, "estimates": []}"#;
        let result: Result<IndexTrend, _> = serde_json::from_str(json);
        assert!(result.is_ok());
    }
}