libfmp 0.12.0

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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266

//! Response rows returned by institutional-ownership filing endpoints.

use serde::{Deserialize, Serialize};

use crate::types::{
    ApiDateTime, CalendarQuarter, CalendarYear, Cik, Cusip, Date, MarketValue, Price, Quantity,
    Ticker,
};

/// One recent institutional-ownership filing.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct InstitutionalOwnershipFiling {
    pub cik: Cik,
    pub name: String,
    pub date: Date,
    pub filing_date: ApiDateTime,
    pub accepted_date: ApiDateTime,
    pub form_type: String,
    pub link: String,
    pub final_link: String,
}

/// One security position extracted from an institutional-ownership filing.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct InstitutionalHolding {
    pub date: Date,
    pub filing_date: Date,
    pub accepted_date: Date,
    pub cik: Cik,
    pub security_cusip: Cusip,
    pub symbol: Ticker,
    pub name_of_issuer: String,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub shares: Quantity,
    pub title_of_class: String,
    pub shares_type: String,
    pub put_call_share: String,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub value: MarketValue,
    pub link: String,
    pub final_link: String,
}

/// One available Form 13F reporting date and its numeric calendar period.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct Form13fFilingDate {
    pub date: Date,
    pub year: CalendarYear,
    pub quarter: CalendarQuarter,
}

/// One holder's analytical position in a security for a filing period.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct InstitutionalHolderAnalytics {
    pub date: Date,
    pub cik: Cik,
    pub filing_date: Date,
    pub investor_name: String,
    pub symbol: Ticker,
    pub security_name: String,
    pub type_of_security: String,
    pub security_cusip: Cusip,
    pub shares_type: String,
    pub put_call_share: String,
    pub investment_discretion: String,
    pub industry_title: String,
    pub weight: f64,
    pub last_weight: f64,
    pub change_in_weight: f64,
    pub change_in_weight_percentage: f64,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub market_value: MarketValue,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub last_market_value: MarketValue,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub change_in_market_value: MarketValue,
    pub change_in_market_value_percentage: f64,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub shares_number: Quantity,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub last_shares_number: Quantity,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub change_in_shares_number: Quantity,
    pub change_in_shares_number_percentage: f64,
    pub quarter_end_price: Price,
    pub avg_price_paid: Price,
    pub is_new: bool,
    pub is_sold_out: bool,
    pub ownership: f64,
    pub last_ownership: f64,
    pub change_in_ownership: f64,
    pub change_in_ownership_percentage: f64,
    pub holding_period: u64,
    pub first_added: Date,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub performance: MarketValue,
    pub performance_percentage: f64,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub last_performance: MarketValue,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub change_in_performance: MarketValue,
    pub is_counted_for_performance: bool,
}

/// One institutional holder's portfolio and benchmark performance summary.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct HolderPerformanceSummary {
    pub date: Date,
    pub cik: Cik,
    pub investor_name: String,
    pub portfolio_size: u64,
    pub securities_added: u64,
    pub securities_removed: u64,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub market_value: MarketValue,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub previous_market_value: MarketValue,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub change_in_market_value: MarketValue,
    pub change_in_market_value_percentage: f64,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub average_holding_period: f64,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub average_holding_period_top10: f64,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub average_holding_period_top20: f64,
    pub turnover: f64,
    pub turnover_alternate_sell: f64,
    pub turnover_alternate_buy: f64,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub performance: MarketValue,
    pub performance_percentage: f64,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub last_performance: MarketValue,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub change_in_performance: MarketValue,
    #[serde(rename = "performance1year")]
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub performance_1_year: MarketValue,
    #[serde(rename = "performancePercentage1year")]
    pub performance_percentage_1_year: f64,
    #[serde(rename = "performance3year")]
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub performance_3_year: MarketValue,
    #[serde(rename = "performancePercentage3year")]
    pub performance_percentage_3_year: f64,
    #[serde(rename = "performance5year")]
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub performance_5_year: MarketValue,
    #[serde(rename = "performancePercentage5year")]
    pub performance_percentage_5_year: f64,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub performance_since_inception: MarketValue,
    pub performance_since_inception_percentage: f64,
    #[serde(rename = "performanceRelativeToSP500Percentage")]
    pub performance_relative_to_sp500_percentage: f64,
    #[serde(rename = "performance1yearRelativeToSP500Percentage")]
    pub performance_1_year_relative_to_sp500_percentage: f64,
    #[serde(rename = "performance3yearRelativeToSP500Percentage")]
    pub performance_3_year_relative_to_sp500_percentage: f64,
    #[serde(rename = "performance5yearRelativeToSP500Percentage")]
    pub performance_5_year_relative_to_sp500_percentage: f64,
    #[serde(rename = "performanceSinceInceptionRelativeToSP500Percentage")]
    pub performance_since_inception_relative_to_sp500_percentage: f64,
}

/// One industry allocation and performance row for an institutional holder.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct HolderIndustryBreakdown {
    pub date: Date,
    pub cik: Cik,
    pub investor_name: String,
    pub industry_title: String,
    pub weight: f64,
    pub last_weight: f64,
    pub change_in_weight: f64,
    pub change_in_weight_percentage: f64,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub performance: MarketValue,
    pub performance_percentage: f64,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub last_performance: MarketValue,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub change_in_performance: MarketValue,
}

/// Cross-holder position totals and changes for one security and filing period.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct InstitutionalPositionSummary {
    pub symbol: Ticker,
    pub cik: Cik,
    pub date: Date,
    pub investors_holding: u64,
    pub last_investors_holding: u64,
    pub investors_holding_change: i64,
    #[serde(rename = "numberOf13Fshares")]
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub number_of_13f_shares: Quantity,
    #[serde(rename = "lastNumberOf13Fshares")]
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub last_number_of_13f_shares: Quantity,
    #[serde(rename = "numberOf13FsharesChange")]
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub number_of_13f_shares_change: Quantity,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub total_invested: MarketValue,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub last_total_invested: MarketValue,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub total_invested_change: MarketValue,
    pub ownership_percent: f64,
    pub last_ownership_percent: f64,
    pub ownership_percent_change: f64,
    pub new_positions: u64,
    pub last_new_positions: u64,
    pub new_positions_change: i64,
    pub increased_positions: u64,
    pub last_increased_positions: u64,
    pub increased_positions_change: i64,
    pub closed_positions: u64,
    pub last_closed_positions: u64,
    pub closed_positions_change: i64,
    pub reduced_positions: u64,
    pub last_reduced_positions: u64,
    pub reduced_positions_change: i64,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub total_calls: Quantity,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub last_total_calls: Quantity,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub total_calls_change: Quantity,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub total_puts: Quantity,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub last_total_puts: Quantity,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub total_puts_change: Quantity,
    pub put_call_ratio: f64,
    pub last_put_call_ratio: f64,
    pub put_call_ratio_change: f64,
}

/// Aggregate value for one US industry and filing date.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct InstitutionalIndustrySummary {
    pub industry_title: String,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub industry_value: MarketValue,
    pub date: Date,
}