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
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

//! Response models returned by search endpoints.
//!
//! The Python binding exposes these models under `fmp.search`.

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

use crate::types::{
    Change, Cik, CountryCode, CurrencyCode, Cusip, Date, ExchangeCode, Isin, MarketCapitalization,
    PerShareAmount, Price, Ratio, Ticker, Volume,
};

fn required_option<'de, D, T>(deserializer: D) -> Result<Option<T>, D::Error>
where
    D: Deserializer<'de>,
    T: Deserialize<'de>,
{
    Option::<T>::deserialize(deserializer)
}

/// A company or instrument returned by symbol search.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct SymbolSearchResult {
    pub symbol: Ticker,
    pub name: String,
    pub currency: CurrencyCode,
    pub exchange_full_name: String,
    pub exchange: ExchangeCode,
}

/// A company or instrument returned by name search.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct NameSearchResult {
    pub symbol: Ticker,
    pub name: String,
    pub currency: CurrencyCode,
    pub exchange_full_name: String,
    pub exchange: ExchangeCode,
}

/// A US company returned by CIK search.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct CikSearchResult {
    pub symbol: Ticker,
    pub company_name: String,
    pub cik: Cik,
    pub exchange_full_name: String,
    pub exchange: ExchangeCode,
    pub currency: CurrencyCode,
}

/// A security returned by CUSIP search.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct CusipSearchResult {
    pub symbol: Ticker,
    pub company_name: String,
    pub cusip: Cusip,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub market_cap: MarketCapitalization,
}

/// A security returned by ISIN search.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct IsinSearchResult {
    pub symbol: Ticker,
    pub name: String,
    pub isin: Isin,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub market_cap: MarketCapitalization,
}

/// One exchange listing returned by exchange-variants search.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct ExchangeVariant {
    pub symbol: Ticker,
    #[serde(deserialize_with = "required_option")]
    pub price: Option<Price>,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub beta: Ratio,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub vol_avg: Volume,
    #[serde(rename = "mktCap")]
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub market_cap: MarketCapitalization,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub last_div: PerShareAmount,
    #[serde(deserialize_with = "required_option")]
    pub range: Option<String>,
    #[serde(deserialize_with = "required_option")]
    pub changes: Option<Change>,
    pub company_name: String,
    pub currency: CurrencyCode,
    #[serde(deserialize_with = "required_option")]
    pub cik: Option<Cik>,
    #[serde(deserialize_with = "required_option")]
    pub isin: Option<Isin>,
    #[serde(deserialize_with = "crate::codecs::empty_or_null::deserialize")]
    pub cusip: Option<Cusip>,
    /// The provider's `exchange` field is the full exchange name here.
    pub exchange: String,
    /// The provider's `exchangeShortName` field is the exchange code here.
    pub exchange_short_name: ExchangeCode,
    pub industry: String,
    #[serde(deserialize_with = "required_option")]
    pub website: Option<String>,
    pub description: String,
    #[serde(deserialize_with = "required_option")]
    pub ceo: Option<String>,
    pub sector: String,
    pub country: CountryCode,
    #[serde(deserialize_with = "required_option")]
    pub full_time_employees: Option<String>,
    #[serde(deserialize_with = "required_option")]
    pub phone: Option<String>,
    #[serde(deserialize_with = "required_option")]
    pub address: Option<String>,
    #[serde(deserialize_with = "required_option")]
    pub city: Option<String>,
    #[serde(deserialize_with = "required_option")]
    pub state: Option<String>,
    #[serde(deserialize_with = "required_option")]
    pub zip: Option<String>,
    #[serde(deserialize_with = "required_option")]
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize_option")]
    pub dcf_diff: Option<PerShareAmount>,
    #[serde(serialize_with = "crate::codecs::integral_f64::serialize")]
    pub dcf: PerShareAmount,
    pub image: String,
    pub ipo_date: Date,
    pub default_image: bool,
    pub is_etf: bool,
    pub is_actively_trading: bool,
    pub is_adr: bool,
    pub is_fund: bool,
}