libfmp 1.0.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

//! Financial-report discovery and dynamic JSON response models.

use serde::{Deserialize, Deserializer, Serialize, Serializer, de, ser::SerializeMap};

use crate::{
    codecs::{DynamicObject, FiscalYearString},
    error::SecretUrl,
    query::FiscalPeriod,
    types::{CalendarYear, Ticker},
};

/// One available financial-report period and its protected download links.
#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct FinancialReportDate {
    pub symbol: Ticker,
    pub fiscal_year: CalendarYear,
    pub period: FiscalPeriod,
    pub link_json: SecretUrl,
    pub link_xlsx: SecretUrl,
}

/// One dynamic financial report with strict identifying headers.
#[derive(Debug, Clone, PartialEq)]
#[non_exhaustive]
pub struct FinancialReportJson {
    pub symbol: Ticker,
    pub period: FiscalPeriod,
    pub year: FiscalYearString,
    pub sections: DynamicObject,
}

impl Serialize for FinancialReportJson {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        for reserved in ["symbol", "period", "year"] {
            if self.sections.contains_key(reserved) {
                return Err(serde::ser::Error::custom(format_args!(
                    "financial report section key `{reserved}` is reserved"
                )));
            }
        }

        let mut map = serializer.serialize_map(Some(self.sections.len() + 3))?;
        map.serialize_entry("symbol", &self.symbol)?;
        map.serialize_entry("period", &self.period)?;
        map.serialize_entry("year", &self.year)?;
        for (name, value) in &self.sections {
            map.serialize_entry(name, value)?;
        }
        map.end()
    }
}

impl<'de> Deserialize<'de> for FinancialReportJson {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        let mut sections = DynamicObject::deserialize(deserializer)?;
        Ok(Self {
            symbol: take_header(&mut sections, "symbol")?,
            period: take_header(&mut sections, "period")?,
            year: take_header(&mut sections, "year")?,
            sections,
        })
    }
}

fn take_header<T, E>(sections: &mut DynamicObject, name: &'static str) -> Result<T, E>
where
    T: serde::de::DeserializeOwned,
    E: de::Error,
{
    let value = sections
        .remove(name)
        .ok_or_else(|| E::missing_field(name))?;
    serde_json::from_value(value).map_err(E::custom)
}