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

//! Response rows returned by environmental, social, and governance endpoints.
//!
//! The Python binding exposes these models under `fmp.esg`.

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

use crate::types::{CalendarYear, Cik, Date, Industry, Sector, 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 company ESG disclosure filing and its component scores.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct EsgDisclosure {
    pub date: Date,
    pub accepted_date: Date,
    pub symbol: Ticker,
    pub cik: Cik,
    #[serde(deserialize_with = "required_option")]
    pub company_name: Option<String>,
    #[serde(deserialize_with = "required_option")]
    pub form_type: Option<crate::types::FormType>,
    pub environmental_score: f64,
    pub social_score: f64,
    pub governance_score: f64,
    #[serde(rename = "ESGScore")]
    pub esg_score: f64,
    pub url: String,
}

/// One company's ESG risk rating for a fiscal year.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct EsgRating {
    pub symbol: Ticker,
    pub cik: Cik,
    #[serde(deserialize_with = "required_option")]
    pub company_name: Option<String>,
    pub industry: Industry,
    pub fiscal_year: CalendarYear,
    #[serde(rename = "ESGRiskRating")]
    pub esg_risk_rating: String,
    pub industry_rank: String,
}

/// One sector ESG benchmark for a fiscal year.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct EsgBenchmark {
    pub fiscal_year: CalendarYear,
    pub sector: Sector,
    pub environmental_score: f64,
    pub social_score: f64,
    pub governance_score: f64,
    #[serde(rename = "ESGScore")]
    pub esg_score: f64,
}