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

//! Compact financial-summary response models.

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

use crate::{
    codecs::FiscalYearString,
    query::FiscalPeriod,
    types::{
        ApiDateTime, CalendarYear, Count, CurrencyCode, Date, MarketCapitalization, Price,
        Quantity, StatementAmount, 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 recently added financial-statement filing.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct LatestFinancialStatement {
    pub symbol: Ticker,
    pub calendar_year: CalendarYear,
    pub period: FiscalPeriod,
    pub date: Date,
    pub date_added: ApiDateTime,
}

/// One company's documented financial-health scores and source values.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct FinancialScore {
    pub symbol: Ticker,
    pub reported_currency: CurrencyCode,
    #[serde(deserialize_with = "required_option")]
    pub altman_z_score: Option<f64>,
    #[serde(deserialize_with = "crate::codecs::count::deserialize")]
    pub piotroski_score: Count,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub working_capital: StatementAmount,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub total_assets: StatementAmount,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub retained_earnings: StatementAmount,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub ebit: StatementAmount,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub market_cap: MarketCapitalization,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub total_liabilities: StatementAmount,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub revenue: StatementAmount,
}

/// One company's owner-earnings calculation.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct OwnerEarnings {
    pub symbol: Ticker,
    pub reported_currency: CurrencyCode,
    pub fiscal_year: FiscalYearString,
    pub period: FiscalPeriod,
    pub date: Date,
    #[serde(rename = "averagePPE")]
    pub average_ppe: f64,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub maintenance_capex: StatementAmount,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub owners_earnings: StatementAmount,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub growth_capex: StatementAmount,
    pub owners_earnings_per_share: Price,
}

/// One historical enterprise-value calculation.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct EnterpriseValue {
    pub symbol: Ticker,
    pub date: Date,
    pub stock_price: Price,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub number_of_shares: Quantity,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub market_capitalization: MarketCapitalization,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub minus_cash_and_cash_equivalents: StatementAmount,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub add_total_debt: StatementAmount,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub enterprise_value: StatementAmount,
}