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
213
214
215
216
217
218
219

//! Response rows returned by Commitment of Traders endpoints.

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

use crate::types::{ApiDateTime, Sector, Ticker};

/// One provider-listed Commitment of Traders report.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct CotReportListing {
    pub symbol: Ticker,
    pub name: String,
}

/// Provider-derived market positioning and sentiment for one contract.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct CotAnalysis {
    pub symbol: Ticker,
    pub date: ApiDateTime,
    pub name: String,
    pub sector: Sector,
    pub exchange: String,
    pub current_long_market_situation: f64,
    pub current_short_market_situation: f64,
    pub market_situation: String,
    pub previous_long_market_situation: f64,
    pub previous_short_market_situation: f64,
    pub previous_market_situation: String,
    #[serde(rename = "netPostion")]
    pub net_position: i64,
    pub previous_net_position: i64,
    pub change_in_net_position: f64,
    pub market_sentiment: String,
    pub reversal_trend: bool,
}

/// A complete, lossless provider Commitment of Traders report row.
///
/// Percentage and concentration values use `Number` because the provider
/// distinguishes integer JSON spellings such as `100` from decimal spellings
/// such as `20.6` in the same response.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct CotReport {
    pub symbol: Ticker,
    pub date: ApiDateTime,
    pub name: String,
    pub sector: Sector,
    pub market_and_exchange_names: String,
    pub cftc_contract_market_code: String,
    pub cftc_market_code: String,
    pub cftc_region_code: String,
    pub cftc_commodity_code: String,

    pub open_interest_all: u64,
    pub noncomm_positions_long_all: u64,
    pub noncomm_positions_short_all: u64,
    pub noncomm_positions_spread_all: u64,
    pub comm_positions_long_all: u64,
    pub comm_positions_short_all: u64,
    pub tot_rept_positions_long_all: u64,
    pub tot_rept_positions_short_all: u64,
    pub nonrept_positions_long_all: u64,
    pub nonrept_positions_short_all: u64,

    pub open_interest_old: u64,
    pub noncomm_positions_long_old: u64,
    pub noncomm_positions_short_old: u64,
    pub noncomm_positions_spread_old: u64,
    pub comm_positions_long_old: u64,
    pub comm_positions_short_old: u64,
    pub tot_rept_positions_long_old: u64,
    pub tot_rept_positions_short_old: u64,
    pub nonrept_positions_long_old: u64,
    pub nonrept_positions_short_old: u64,

    pub open_interest_other: u64,
    pub noncomm_positions_long_other: u64,
    pub noncomm_positions_short_other: u64,
    pub noncomm_positions_spread_other: u64,
    pub comm_positions_long_other: u64,
    pub comm_positions_short_other: u64,
    pub tot_rept_positions_long_other: u64,
    pub tot_rept_positions_short_other: u64,
    pub nonrept_positions_long_other: u64,
    pub nonrept_positions_short_other: u64,

    pub change_in_open_interest_all: i64,
    pub change_in_noncomm_long_all: i64,
    pub change_in_noncomm_short_all: i64,
    #[serde(rename = "changeInNoncommSpeadAll")]
    pub change_in_noncomm_spread_all: i64,
    pub change_in_comm_long_all: i64,
    pub change_in_comm_short_all: i64,
    pub change_in_tot_rept_long_all: i64,
    pub change_in_tot_rept_short_all: i64,
    pub change_in_nonrept_long_all: i64,
    pub change_in_nonrept_short_all: i64,

    pub pct_of_open_interest_all: Number,
    pub pct_of_oi_noncomm_long_all: Number,
    pub pct_of_oi_noncomm_short_all: Number,
    pub pct_of_oi_noncomm_spread_all: Number,
    pub pct_of_oi_comm_long_all: Number,
    pub pct_of_oi_comm_short_all: Number,
    pub pct_of_oi_tot_rept_long_all: Number,
    pub pct_of_oi_tot_rept_short_all: Number,
    pub pct_of_oi_nonrept_long_all: Number,
    pub pct_of_oi_nonrept_short_all: Number,

    #[serde(rename = "pctOfOpenInterestOl")]
    pub pct_of_open_interest_old: Number,
    #[serde(rename = "pctOfOiNoncommLongOl")]
    pub pct_of_oi_noncomm_long_old: Number,
    #[serde(rename = "pctOfOiNoncommShortOl")]
    pub pct_of_oi_noncomm_short_old: Number,
    #[serde(rename = "pctOfOiNoncommSpreadOl")]
    pub pct_of_oi_noncomm_spread_old: Number,
    #[serde(rename = "pctOfOiCommLongOl")]
    pub pct_of_oi_comm_long_old: Number,
    #[serde(rename = "pctOfOiCommShortOl")]
    pub pct_of_oi_comm_short_old: Number,
    #[serde(rename = "pctOfOiTotReptLongOl")]
    pub pct_of_oi_tot_rept_long_old: Number,
    #[serde(rename = "pctOfOiTotReptShortOl")]
    pub pct_of_oi_tot_rept_short_old: Number,
    #[serde(rename = "pctOfOiNonreptLongOl")]
    pub pct_of_oi_nonrept_long_old: Number,
    #[serde(rename = "pctOfOiNonreptShortOl")]
    pub pct_of_oi_nonrept_short_old: Number,

    pub pct_of_open_interest_other: Number,
    pub pct_of_oi_noncomm_long_other: Number,
    pub pct_of_oi_noncomm_short_other: Number,
    pub pct_of_oi_noncomm_spread_other: Number,
    pub pct_of_oi_comm_long_other: Number,
    pub pct_of_oi_comm_short_other: Number,
    pub pct_of_oi_tot_rept_long_other: Number,
    pub pct_of_oi_tot_rept_short_other: Number,
    pub pct_of_oi_nonrept_long_other: Number,
    pub pct_of_oi_nonrept_short_other: Number,

    pub traders_tot_all: u64,
    pub traders_noncomm_long_all: u64,
    pub traders_noncomm_short_all: u64,
    pub traders_noncomm_spread_all: u64,
    pub traders_comm_long_all: u64,
    pub traders_comm_short_all: u64,
    pub traders_tot_rept_long_all: u64,
    pub traders_tot_rept_short_all: u64,

    #[serde(rename = "tradersTotOl")]
    pub traders_tot_old: u64,
    #[serde(rename = "tradersNoncommLongOl")]
    pub traders_noncomm_long_old: u64,
    #[serde(rename = "tradersNoncommShortOl")]
    pub traders_noncomm_short_old: u64,
    #[serde(rename = "tradersNoncommSpeadOl")]
    pub traders_noncomm_spread_old: u64,
    #[serde(rename = "tradersCommLongOl")]
    pub traders_comm_long_old: u64,
    #[serde(rename = "tradersCommShortOl")]
    pub traders_comm_short_old: u64,
    #[serde(rename = "tradersTotReptLongOl")]
    pub traders_tot_rept_long_old: u64,
    #[serde(rename = "tradersTotReptShortOl")]
    pub traders_tot_rept_short_old: u64,

    pub traders_tot_other: u64,
    pub traders_noncomm_long_other: u64,
    pub traders_noncomm_short_other: u64,
    pub traders_noncomm_spread_other: u64,
    pub traders_comm_long_other: u64,
    pub traders_comm_short_other: u64,
    pub traders_tot_rept_long_other: u64,
    pub traders_tot_rept_short_other: u64,

    pub conc_gross_le4_tdr_long_all: Number,
    pub conc_gross_le4_tdr_short_all: Number,
    pub conc_gross_le8_tdr_long_all: Number,
    pub conc_gross_le8_tdr_short_all: Number,
    pub conc_net_le4_tdr_long_all: Number,
    pub conc_net_le4_tdr_short_all: Number,
    pub conc_net_le8_tdr_long_all: Number,
    pub conc_net_le8_tdr_short_all: Number,

    #[serde(rename = "concGrossLe4TdrLongOl")]
    pub conc_gross_le4_tdr_long_old: Number,
    #[serde(rename = "concGrossLe4TdrShortOl")]
    pub conc_gross_le4_tdr_short_old: Number,
    #[serde(rename = "concGrossLe8TdrLongOl")]
    pub conc_gross_le8_tdr_long_old: Number,
    #[serde(rename = "concGrossLe8TdrShortOl")]
    pub conc_gross_le8_tdr_short_old: Number,
    #[serde(rename = "concNetLe4TdrLongOl")]
    pub conc_net_le4_tdr_long_old: Number,
    #[serde(rename = "concNetLe4TdrShortOl")]
    pub conc_net_le4_tdr_short_old: Number,
    #[serde(rename = "concNetLe8TdrLongOl")]
    pub conc_net_le8_tdr_long_old: Number,
    #[serde(rename = "concNetLe8TdrShortOl")]
    pub conc_net_le8_tdr_short_old: Number,

    pub conc_gross_le4_tdr_long_other: Number,
    pub conc_gross_le4_tdr_short_other: Number,
    pub conc_gross_le8_tdr_long_other: Number,
    pub conc_gross_le8_tdr_short_other: Number,
    pub conc_net_le4_tdr_long_other: Number,
    pub conc_net_le4_tdr_short_other: Number,
    pub conc_net_le8_tdr_long_other: Number,
    pub conc_net_le8_tdr_short_other: Number,

    pub contract_units: String,
}