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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212

//! Response rows returned by TipRanks add-on endpoints.
//!
//! The Python binding exposes these models under `fmp.tipranks`.

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

use crate::{
    codecs::IsoTimestamp,
    types::{Count, CurrencyCode, Date, Ticker, TipRanksExpertUid},
};

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 individual analyst rating returned by the TipRanks ratings search.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct TipRanksRatingSearchResult {
    pub symbol: Ticker,
    pub date: IsoTimestamp,
    pub recommendation_date: Date,
    #[serde(rename = "expertUID")]
    pub expert_uid: TipRanksExpertUid,
    pub analyst_name: String,
    pub firm_name: String,
    pub recommendation: String,
    pub analyst_action: String,
    pub article_title: String,
    pub article_site: String,
    pub price_target: Number,
    pub price_target_currency: CurrencyCode,
    pub url: String,
}

/// One analyst's active rating in a point-in-time symbol or analyst snapshot.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct TipRanksPointInTimeRating {
    pub symbol: Ticker,
    pub date: IsoTimestamp,
    #[serde(rename = "expertUID")]
    pub expert_uid: TipRanksExpertUid,
    pub analyst_name: String,
    pub stock_success_rate: Number,
    pub firm_name: String,
    pub last_recommendation: String,
    pub last_recommendation_date: Date,
    pub article_title: String,
    pub article_site: String,
    #[serde(deserialize_with = "required_option")]
    pub price_target: Option<Number>,
    #[serde(deserialize_with = "required_option")]
    pub price_target_currency: Option<CurrencyCode>,
    pub url: String,
    pub last_analyst_action: String,
    #[serde(deserialize_with = "required_option")]
    pub stock_return: Option<Number>,
    #[serde(deserialize_with = "required_option")]
    pub beat_target: Option<bool>,
}

/// Recommendation counts in a TipRanks ratings summary.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct TipRanksRecommendationCounts {
    #[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,
}

/// Analyst-action counts in a TipRanks ratings summary.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct TipRanksAnalystActionCounts {
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub initiated: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub maintained: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub upgraded: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub downgraded: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub reiterated: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub resumed: Count,
}

/// Aggregated TipRanks ratings for one ticker over a date window.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct TipRanksSymbolSummary {
    pub symbol: Ticker,
    pub from: Date,
    pub to: Date,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub total_recommendations: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub distinct_symbols: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub distinct_analysts: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub valid_price_targets: Count,
    pub recommendations: TipRanksRecommendationCounts,
    #[serde(rename = "analystAction")]
    pub analyst_action: TipRanksAnalystActionCounts,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub compared_price_targets: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub beats: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub misses: Count,
    pub average_return: Number,
    pub top_return: Number,
    pub worst_return: Number,
}

/// Aggregated TipRanks ratings for one analyst over a date window.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct TipRanksAnalystSummary {
    #[serde(rename = "expertUID")]
    pub expert_uid: TipRanksExpertUid,
    pub from: Date,
    pub to: Date,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub total_recommendations: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub distinct_symbols: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub distinct_analysts: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub valid_price_targets: Count,
    pub recommendations: TipRanksRecommendationCounts,
    #[serde(rename = "analystAction")]
    pub analyst_action: TipRanksAnalystActionCounts,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub compared_price_targets: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub beats: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub misses: Count,
    pub average_return: Number,
    pub top_return: Number,
    pub worst_return: Number,
}

/// Aggregated TipRanks ratings for one firm over a date window.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct TipRanksFirmSummary {
    pub firm_name: String,
    pub from: Date,
    pub to: Date,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub total_recommendations: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub distinct_symbols: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub distinct_analysts: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub valid_price_targets: Count,
    pub recommendations: TipRanksRecommendationCounts,
    #[serde(rename = "analystAction")]
    pub analyst_action: TipRanksAnalystActionCounts,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub compared_price_targets: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub beats: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub misses: Count,
    pub average_return: Number,
    pub top_return: Number,
    pub worst_return: Number,
}

/// One analyst profile returned by the TipRanks directory.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct TipRanksAnalystProfile {
    #[serde(rename = "expertUID")]
    pub expert_uid: TipRanksExpertUid,
    pub analyst_name: String,
    pub firm_name: String,
    pub success_rate: Number,
    pub excess_return: Number,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub total_recommendations: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub good_recommendations: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub analyst_rank: Count,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub num_of_stars: Count,
}