libfmp 1.3.1

Async, typed Rust client for the Financial Modeling Prep API
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

//! Response models returned by quote endpoints.

use serde::{Deserialize, Deserializer, Serialize};

use crate::types::{
    Change, ExchangeCode, MarketCapitalization, Percentage, Price, Quantity, Ticker,
    UnixMilliseconds, UnixSeconds, Volume,
};

fn required_option<'de, D, T>(deserializer: D) -> Result<Option<T>, D::Error>
where
    D: Deserializer<'de>,
    T: Deserialize<'de>,
{
    Option::<T>::deserialize(deserializer)
}

/// A detailed real-time stock quote.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct Quote {
    pub symbol: Ticker,
    pub name: String,
    pub price: Price,
    pub change_percentage: Percentage,
    pub change: Change,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub volume: Volume,
    pub day_low: Price,
    pub day_high: Price,
    pub year_high: Price,
    pub year_low: Price,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize_option")]
    pub market_cap: Option<MarketCapitalization>,
    pub price_avg_50: Price,
    pub price_avg_200: Price,
    pub exchange: ExchangeCode,
    pub open: Price,
    pub previous_close: Price,
    pub timestamp: UnixSeconds,
}

/// The compact response returned by quote-short endpoints across asset classes.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct QuoteShort {
    pub symbol: Ticker,
    #[serde(deserialize_with = "required_option")]
    pub price: Option<Price>,
    #[serde(deserialize_with = "required_option")]
    pub change: Option<Change>,
    #[serde(deserialize_with = "required_option")]
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize_option")]
    pub volume: Option<Volume>,
}

/// One trade executed after regular US market hours.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct AftermarketTrade {
    pub symbol: Ticker,
    pub price: Price,
    #[serde(deserialize_with = "required_option")]
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize_option")]
    pub trade_size: Option<Quantity>,
    pub timestamp: UnixMilliseconds,
}

/// One bid-and-ask quote observed after regular US market hours.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct AftermarketQuote {
    pub symbol: Ticker,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub bid_size: Quantity,
    pub bid_price: Price,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub ask_size: Quantity,
    pub ask_price: Price,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub volume: Volume,
    pub timestamp: UnixMilliseconds,
}

/// Percentage changes for one stock across the provider's documented periods.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct StockPriceChange {
    pub symbol: Ticker,
    #[serde(rename = "1D")]
    pub one_day: Percentage,
    #[serde(rename = "5D")]
    pub five_days: Percentage,
    #[serde(rename = "1M")]
    pub one_month: Percentage,
    #[serde(rename = "3M")]
    pub three_months: Percentage,
    #[serde(rename = "6M")]
    pub six_months: Percentage,
    #[serde(rename = "ytd")]
    pub year_to_date: Percentage,
    #[serde(rename = "1Y")]
    pub one_year: Percentage,
    #[serde(rename = "3Y")]
    pub three_years: Percentage,
    #[serde(rename = "5Y")]
    pub five_years: Percentage,
    #[serde(rename = "10Y")]
    pub ten_years: Percentage,
    pub max: Percentage,
}