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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
//! ESG and Social endpoints
use crate::{client::FmpClient, error::Result, models::esg::*};
use serde::Serialize;
/// ESG and Social API endpoints
pub struct Esg {
client: FmpClient,
}
impl Esg {
pub(crate) fn new(client: FmpClient) -> Self {
Self { client }
}
/// Get ESG scores for a company
///
/// Returns Environmental, Social, and Governance scores and ratings.
///
/// # Arguments
/// * `symbol` - Stock symbol (e.g., "AAPL")
///
/// # Example
/// ```no_run
/// # use fmp_rs::FmpClient;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let client = FmpClient::new()?;
/// let esg_scores = client.esg().get_esg_score("AAPL").await?;
/// for score in esg_scores.iter().take(3) {
/// println!("{}: ESG Score = {:.1}",
/// score.company_name.as_deref().unwrap_or("N/A"),
/// score.esg_score.unwrap_or(0.0));
/// println!(" E: {:.1}, S: {:.1}, G: {:.1}",
/// score.environment_score.unwrap_or(0.0),
/// score.social_score.unwrap_or(0.0),
/// score.governance_score.unwrap_or(0.0));
/// }
/// # Ok(())
/// # }
/// ```
pub async fn get_esg_score(&self, symbol: &str) -> Result<Vec<EsgScore>> {
#[derive(Serialize)]
struct Query<'a> {
apikey: &'a str,
}
let url = self.client.build_url(&format!("/esg-score/{}", symbol));
self.client
.get_with_query(
&url,
&Query {
apikey: self.client.api_key(),
},
)
.await
}
/// Get ESG risk ratings for a company
///
/// Returns ESG risk assessment and industry rankings.
///
/// # Arguments
/// * `symbol` - Stock symbol
///
/// # Example
/// ```no_run
/// # use fmp_rs::FmpClient;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let client = FmpClient::new()?;
/// let esg_risk = client.esg().get_esg_risk_rating("TSLA").await?;
/// for risk in esg_risk.iter().take(3) {
/// println!("{}: Risk Score = {:.1} ({})",
/// risk.company_name.as_deref().unwrap_or("N/A"),
/// risk.esg_risk_score.unwrap_or(0.0),
/// risk.esg_risk_level.as_deref().unwrap_or("N/A"));
/// }
/// # Ok(())
/// # }
/// ```
pub async fn get_esg_risk_rating(&self, symbol: &str) -> Result<Vec<EsgRiskRating>> {
#[derive(Serialize)]
struct Query<'a> {
apikey: &'a str,
}
let url = self.client.build_url(&format!(
"/esg-environmental-social-governance-data-ratings/{}",
symbol
));
self.client
.get_with_query(
&url,
&Query {
apikey: self.client.api_key(),
},
)
.await
}
/// Get ESG benchmark data by industry
///
/// Returns industry ESG benchmark scores for comparison.
///
/// # Arguments
/// * `year` - Year for benchmark data (optional)
///
/// # Example
/// ```no_run
/// # use fmp_rs::FmpClient;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let client = FmpClient::new()?;
/// let benchmarks = client.esg().get_esg_sector_benchmark(Some("2023")).await?;
/// for benchmark in benchmarks.iter().take(5) {
/// println!("{}: ESG Benchmark = {:.1}",
/// benchmark.industry.as_deref().unwrap_or("N/A"),
/// benchmark.esg_benchmark.unwrap_or(0.0));
/// }
/// # Ok(())
/// # }
/// ```
pub async fn get_esg_sector_benchmark(&self, year: Option<&str>) -> Result<Vec<EsgBenchmark>> {
#[derive(Serialize)]
struct Query<'a> {
#[serde(skip_serializing_if = "Option::is_none")]
year: Option<&'a str>,
apikey: &'a str,
}
let url = self.client.build_url("/esg-sector-benchmark");
self.client
.get_with_query(
&url,
&Query {
year,
apikey: self.client.api_key(),
},
)
.await
}
/// Get Congressional trading data
///
/// Returns stock transactions by US Congress members.
///
/// # Arguments
/// * `symbol` - Stock symbol (optional, filters by specific stock)
///
/// # Example
/// ```no_run
/// # use fmp_rs::FmpClient;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let client = FmpClient::new()?;
/// let congress_trades = client.esg().get_senate_trading(None).await?;
/// for trade in congress_trades.iter().take(10) {
/// println!("{}: {} {} {} ({})",
/// trade.transaction_date.as_deref().unwrap_or("N/A"),
/// trade.representative.as_deref().unwrap_or("N/A"),
/// trade.transaction.as_deref().unwrap_or("N/A"),
/// trade.ticker.as_deref().unwrap_or("N/A"),
/// trade.amount.as_deref().unwrap_or("N/A"));
/// }
/// # Ok(())
/// # }
/// ```
pub async fn get_senate_trading(
&self,
symbol: Option<&str>,
) -> Result<Vec<CongressionalTrading>> {
#[derive(Serialize)]
struct Query<'a> {
#[serde(skip_serializing_if = "Option::is_none")]
symbol: Option<&'a str>,
apikey: &'a str,
}
let url = self.client.build_url("/senate-trading");
self.client
.get_with_query(
&url,
&Query {
symbol,
apikey: self.client.api_key(),
},
)
.await
}
/// Get House of Representatives trading data
///
/// Returns stock transactions by US House members.
///
/// # Arguments
/// * `symbol` - Stock symbol (optional)
///
/// # Example
/// ```no_run
/// # use fmp_rs::FmpClient;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let client = FmpClient::new()?;
/// let house_trades = client.esg().get_house_disclosure(None).await?;
/// for trade in house_trades.iter().take(10) {
/// println!("{}: {} {} {} ({})",
/// trade.transaction_date.as_deref().unwrap_or("N/A"),
/// trade.representative.as_deref().unwrap_or("N/A"),
/// trade.transaction.as_deref().unwrap_or("N/A"),
/// trade.ticker.as_deref().unwrap_or("N/A"),
/// trade.amount.as_deref().unwrap_or("N/A"));
/// }
/// # Ok(())
/// # }
/// ```
pub async fn get_house_disclosure(
&self,
symbol: Option<&str>,
) -> Result<Vec<CongressionalTrading>> {
#[derive(Serialize)]
struct Query<'a> {
#[serde(skip_serializing_if = "Option::is_none")]
symbol: Option<&'a str>,
apikey: &'a str,
}
let url = self.client.build_url("/senate-disclosure");
self.client
.get_with_query(
&url,
&Query {
symbol,
apikey: self.client.api_key(),
},
)
.await
}
/// Get social sentiment data
///
/// Returns social media sentiment analysis for stocks.
///
/// # Arguments
/// * `symbol` - Stock symbol
///
/// # Example
/// ```no_run
/// # use fmp_rs::FmpClient;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let client = FmpClient::new()?;
/// let sentiment = client.esg().get_social_sentiment("GME").await?;
/// for data in sentiment.iter().take(5) {
/// println!("{}: Sentiment = {} (Twitter: {:.2}, StockTwits: {:.2})",
/// data.date,
/// data.general_sentiment.as_deref().unwrap_or("N/A"),
/// data.twitter_sentiment.unwrap_or(0.0),
/// data.stocktwits_sentiment.unwrap_or(0.0));
/// }
/// # Ok(())
/// # }
/// ```
pub async fn get_social_sentiment(&self, symbol: &str) -> Result<Vec<SocialSentiment>> {
#[derive(Serialize)]
struct Query<'a> {
apikey: &'a str,
}
let url = self
.client
.build_url(&format!("/social-sentiment/{}", symbol));
self.client
.get_with_query(
&url,
&Query {
apikey: self.client.api_key(),
},
)
.await
}
}
#[cfg(test)]
mod tests {
use super::*;
// Golden path tests
#[tokio::test]
#[ignore = "requires FMP API key"]
async fn test_get_esg_score() {
let client = FmpClient::new().unwrap();
let result = client.esg().get_esg_score("AAPL").await;
assert!(result.is_ok());
let esg_scores = result.unwrap();
assert!(!esg_scores.is_empty());
}
#[tokio::test]
#[ignore = "requires FMP API key"]
async fn test_get_esg_risk_rating() {
let client = FmpClient::new().unwrap();
let result = client.esg().get_esg_risk_rating("TSLA").await;
assert!(result.is_ok());
let risk_ratings = result.unwrap();
assert!(!risk_ratings.is_empty());
}
#[tokio::test]
#[ignore = "requires FMP API key"]
async fn test_get_esg_sector_benchmark() {
let client = FmpClient::new().unwrap();
let result = client.esg().get_esg_sector_benchmark(None).await;
assert!(result.is_ok());
let benchmarks = result.unwrap();
assert!(!benchmarks.is_empty());
}
#[tokio::test]
#[ignore = "requires FMP API key"]
async fn test_get_senate_trading() {
let client = FmpClient::new().unwrap();
let result = client.esg().get_senate_trading(None).await;
assert!(result.is_ok());
let trades = result.unwrap();
// May be empty if no recent trades
assert!(trades.len() >= 0);
}
#[tokio::test]
#[ignore = "requires FMP API key"]
async fn test_get_social_sentiment() {
let client = FmpClient::new().unwrap();
let result = client.esg().get_social_sentiment("AAPL").await;
assert!(result.is_ok());
let sentiment = result.unwrap();
// Sentiment data may be limited
assert!(sentiment.len() >= 0);
}
// Edge case tests
#[tokio::test]
#[ignore = "requires FMP API key"]
async fn test_esg_with_year_filter() {
let client = FmpClient::new().unwrap();
let result = client.esg().get_esg_sector_benchmark(Some("2023")).await;
assert!(result.is_ok());
}
#[tokio::test]
#[ignore = "requires FMP API key"]
async fn test_senate_trading_with_symbol() {
let client = FmpClient::new().unwrap();
let result = client.esg().get_senate_trading(Some("AAPL")).await;
assert!(result.is_ok());
}
#[tokio::test]
#[ignore = "requires FMP API key"]
async fn test_multiple_esg_symbols() {
let client = FmpClient::new().unwrap();
// Test ESG scores for different companies
for symbol in &["AAPL", "TSLA", "MSFT"] {
let result = client.esg().get_esg_score(symbol).await;
assert!(result.is_ok());
}
}
#[tokio::test]
#[ignore = "requires FMP API key"]
async fn test_social_sentiment_validation() {
let client = FmpClient::new().unwrap();
let result = client.esg().get_social_sentiment("GME").await;
assert!(result.is_ok());
let sentiment = result.unwrap();
// Validate sentiment scores are in expected ranges
for data in sentiment.iter().take(3) {
if let Some(twitter_sentiment) = data.twitter_sentiment {
assert!(twitter_sentiment >= -1.0 && twitter_sentiment <= 1.0);
}
if let Some(stocktwits_sentiment) = data.stocktwits_sentiment {
assert!(stocktwits_sentiment >= -1.0 && stocktwits_sentiment <= 1.0);
}
}
}
// Error handling tests
#[tokio::test]
async fn test_invalid_api_key() {
let client = FmpClient::builder()
.api_key("invalid_key_12345")
.build()
.unwrap();
let result = client.esg().get_esg_score("AAPL").await;
assert!(result.is_err());
}
#[tokio::test]
#[ignore = "requires FMP API key"]
async fn test_invalid_symbol() {
let client = FmpClient::new().unwrap();
let result = client.esg().get_esg_score("INVALIDSTOCK123").await;
// Should return empty or error
match result {
Ok(data) => assert!(data.is_empty()),
Err(_) => {} // Error is acceptable for invalid symbol
}
}
#[tokio::test]
#[ignore = "requires FMP API key"]
async fn test_house_disclosure() {
let client = FmpClient::new().unwrap();
let result = client.esg().get_house_disclosure(None).await;
assert!(result.is_ok());
let trades = result.unwrap();
assert!(trades.len() >= 0);
}
}