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

//! Response rows returned by calendar endpoints.

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

use crate::{
    codecs::{DynamicJson, IsoTimestamp, empty_or_null_date},
    types::{Cik, Count, Date, ExchangeCode, MarketValue, Percentage, Price, 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 or market-wide dividend event.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct DividendEvent {
    pub symbol: Ticker,
    pub date: Date,
    pub record_date: Date,
    pub payment_date: Date,
    #[serde(with = "empty_or_null_date")]
    pub declaration_date: Option<Date>,
    pub adj_dividend: Price,
    pub dividend: Price,
    pub r#yield: Percentage,
    pub frequency: String,
}

/// One company or market-wide earnings event.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct EarningsEvent {
    pub symbol: Ticker,
    pub date: Date,
    #[serde(deserialize_with = "required_option")]
    pub eps_actual: Option<f64>,
    pub eps_estimated: f64,
    #[serde(deserialize_with = "required_option")]
    pub revenue_actual: Option<u64>,
    pub revenue_estimated: u64,
    pub last_updated: Date,
}

/// One worldwide IPO calendar event.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct IpoCalendarEvent {
    pub symbol: Ticker,
    pub date: Date,
    pub daa: IsoTimestamp,
    pub company: String,
    pub exchange: ExchangeCode,
    pub actions: String,
    #[serde(deserialize_with = "required_option")]
    pub shares: Option<DynamicJson>,
    #[serde(deserialize_with = "required_option")]
    pub price_range: Option<DynamicJson>,
    #[serde(deserialize_with = "required_option")]
    pub market_cap: Option<DynamicJson>,
}

/// One US IPO disclosure filing.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct IpoDisclosure {
    pub symbol: Ticker,
    pub filing_date: Date,
    pub accepted_date: Date,
    pub effectiveness_date: Date,
    pub cik: Cik,
    pub form: String,
    pub url: String,
}

/// One US IPO prospectus filing and its documented offering values.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct IpoProspectus {
    pub symbol: Ticker,
    pub accepted_date: Date,
    pub filing_date: Date,
    pub ipo_date: Date,
    pub cik: Cik,
    pub price_public_per_share: Price,
    pub price_public_total: MarketValue,
    pub discounts_and_commissions_per_share: Price,
    pub discounts_and_commissions_total: MarketValue,
    pub proceeds_before_expenses_per_share: Price,
    pub proceeds_before_expenses_total: MarketValue,
    pub form: String,
    pub url: String,
}

/// One company or market-wide stock-split event.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct StockSplitEvent {
    pub symbol: Ticker,
    pub date: Date,
    pub numerator: Count,
    pub denominator: Count,
    pub split_type: String,
}