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

//! Response rows returned by analyst endpoints.

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

use crate::types::{Count, Date, Price, StatementAmount, Ticker};

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

/// One dated set of analyst financial estimates.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct FinancialEstimate {
    pub symbol: Ticker,
    pub date: Date,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub revenue_low: StatementAmount,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub revenue_high: StatementAmount,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub revenue_avg: StatementAmount,
    #[serde(deserialize_with = "required_option")]
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize_option")]
    pub ebitda_low: Option<StatementAmount>,
    #[serde(deserialize_with = "required_option")]
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize_option")]
    pub ebitda_high: Option<StatementAmount>,
    #[serde(deserialize_with = "required_option")]
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize_option")]
    pub ebitda_avg: Option<StatementAmount>,
    #[serde(deserialize_with = "required_option")]
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize_option")]
    pub ebit_low: Option<StatementAmount>,
    #[serde(deserialize_with = "required_option")]
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize_option")]
    pub ebit_high: Option<StatementAmount>,
    #[serde(deserialize_with = "required_option")]
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize_option")]
    pub ebit_avg: Option<StatementAmount>,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub net_income_low: StatementAmount,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub net_income_high: StatementAmount,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub net_income_avg: StatementAmount,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub sga_expense_low: StatementAmount,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub sga_expense_high: StatementAmount,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub sga_expense_avg: StatementAmount,
    pub eps_avg: f64,
    pub eps_high: f64,
    pub eps_low: f64,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub num_analysts_revenue: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub num_analysts_eps: Count,
}

/// One current financial-rating snapshot.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct RatingSnapshot {
    pub symbol: Ticker,
    pub rating: String,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub overall_score: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub discounted_cash_flow_score: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub return_on_equity_score: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub return_on_assets_score: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub debt_to_equity_score: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub price_to_earnings_score: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub price_to_book_score: Count,
}

/// One dated historical financial rating.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct HistoricalRating {
    pub symbol: Ticker,
    pub date: Date,
    pub rating: String,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub overall_score: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub discounted_cash_flow_score: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub return_on_equity_score: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub return_on_assets_score: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub debt_to_equity_score: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub price_to_earnings_score: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub price_to_book_score: Count,
}

/// Price-target averages and publisher text across documented time windows.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct PriceTargetSummary {
    pub symbol: Ticker,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub last_month_count: Count,
    pub last_month_avg_price_target: Price,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub last_quarter_count: Count,
    pub last_quarter_avg_price_target: Price,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub last_year_count: Count,
    pub last_year_avg_price_target: Price,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub all_time_count: Count,
    pub all_time_avg_price_target: Price,
    /// The exact provider string, whose contents happen to be JSON-array text.
    pub publishers: String,
}

/// Aggregated high, low, consensus, and median analyst price targets.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct PriceTargetConsensus {
    pub symbol: Ticker,
    pub target_high: Price,
    pub target_low: Price,
    pub target_consensus: Price,
    pub target_median: Price,
}

/// One dated stock-grade action from an analyst or institution.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct StockGrade {
    pub symbol: Ticker,
    pub date: Date,
    pub grading_company: String,
    pub previous_grade: String,
    pub new_grade: String,
    pub action: String,
}

/// One dated historical count of analyst rating buckets.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct HistoricalStockGrade {
    pub symbol: Ticker,
    pub date: Date,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub analyst_ratings_strong_buy: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub analyst_ratings_buy: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub analyst_ratings_hold: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub analyst_ratings_sell: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub analyst_ratings_strong_sell: Count,
}

/// Current analyst rating-bucket counts and their consensus label.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct StockGradesSummary {
    pub symbol: Ticker,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub strong_buy: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub buy: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub hold: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub sell: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub strong_sell: Count,
    pub consensus: String,
}