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

//! Response models owned by stock-market index endpoints.
//!
//! Generic detailed and compact quotes reuse [`super::quote::Quote`] and
//! [`super::quote::QuoteShort`] rather than duplicating their wire contracts.

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

use crate::{
    codecs::OpaqueDateText,
    types::{Cik, CurrencyCode, Date, ExchangeCode, 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 stock-market index in the provider's worldwide index directory.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct IndexListing {
    pub symbol: Ticker,
    pub name: String,
    pub exchange: ExchangeCode,
    pub currency: CurrencyCode,
}

/// One company currently included in a major US stock-market index.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct IndexConstituent {
    pub symbol: Ticker,
    pub name: String,
    pub sector: Sector,
    pub sub_sector: Industry,
    pub head_quarter: String,
    #[serde(deserialize_with = "required_option")]
    pub date_first_added: Option<Date>,
    pub cik: Cik,
    pub founded: Date,
}

/// One documented historical addition to and removal from a major US index.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct HistoricalIndexConstituent {
    pub date_added: OpaqueDateText,
    pub added_security: String,
    #[serde(deserialize_with = "required_option")]
    pub removed_ticker: Option<Ticker>,
    #[serde(deserialize_with = "required_option")]
    pub removed_security: Option<String>,
    pub date: Date,
    pub symbol: Ticker,
    pub reason: String,
}