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

//! Market Summary Response Model
//!
//! Represents market summary quotes from Yahoo Finance

use crate::models::quote::FormattedValue;
use serde::{Deserialize, Serialize};

/// A single market summary quote (index, currency, commodity, etc.)
#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "dataframe", derive(crate::ToDataFrame))]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct MarketSummaryQuote {
    /// Stock symbol
    pub symbol: String,
    /// Full market name
    pub full_exchange_name: Option<String>,
    /// Exchange code
    pub exchange: Option<String>,
    /// Short name
    pub short_name: Option<String>,
    /// Quote type (INDEX, CURRENCY, FUTURE, etc.)
    pub quote_type: Option<String>,
    /// Market state (REGULAR, PRE, POST, CLOSED)
    pub market_state: Option<String>,
    /// Regular market price
    #[serde(default)]
    pub regular_market_price: Option<FormattedValue<f64>>,
    /// Regular market change
    #[serde(default)]
    pub regular_market_change: Option<FormattedValue<f64>>,
    /// Regular market change percent
    #[serde(default)]
    pub regular_market_change_percent: Option<FormattedValue<f64>>,
    /// Regular market previous close
    #[serde(default)]
    pub regular_market_previous_close: Option<FormattedValue<f64>>,
    /// Regular market time (Unix timestamp)
    #[serde(default)]
    pub regular_market_time: Option<FormattedValue<i64>>,
    /// Spark chart data (if available)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub spark: Option<SparkData>,
}

/// Spark chart mini-data for market summary
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SparkData {
    /// Close prices
    #[serde(default)]
    pub close: Option<Vec<Option<f64>>>,
    /// Timestamps
    #[serde(default)]
    pub timestamp: Option<Vec<i64>>,
    /// Symbol
    #[serde(default)]
    pub symbol: Option<String>,
    /// Previous close
    #[serde(default)]
    pub previous_close: Option<f64>,
    /// Chart previous close
    #[serde(default)]
    pub chart_previous_close: Option<f64>,
}

/// Raw response from market summary endpoint
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct RawMarketSummaryResponse {
    pub market_summary_response: Option<MarketSummaryResult>,
}

#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct MarketSummaryResult {
    pub result: Option<Vec<MarketSummaryQuote>>,
}

impl MarketSummaryQuote {
    /// Parse market summary quotes from the raw JSON response
    pub(crate) fn from_response(value: serde_json::Value) -> Result<Vec<Self>, serde_json::Error> {
        let raw: RawMarketSummaryResponse = serde_json::from_value(value)?;
        Ok(raw
            .market_summary_response
            .and_then(|r| r.result)
            .unwrap_or_default())
    }
}