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

//! Response models for SEC filings, company lookup, profiles, and SIC data.
//!
//! The provider documents every SEC-filings route as available for
//! US-based companies only. The Python binding exposes these models under
//! `fmp.sec_filings`.

use serde::{Deserialize, Serialize};

use crate::{
    codecs::{DynamicJson, NumericString},
    types::{
        ApiDateTime, Cik, CountryCode, CurrencyCode, Date, ExchangeCode, FormType, Isin, Sector,
        Ticker,
    },
};

/// One SEC filing row shared by all five filing feeds and searches.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct SecFiling {
    pub symbol: Ticker,
    pub cik: Cik,
    pub filing_date: ApiDateTime,
    pub accepted_date: ApiDateTime,
    pub form_type: FormType,
    #[serde(default)]
    pub has_financials: Option<bool>,
    pub link: String,
    pub final_link: String,
}

/// One company identity returned by the three SEC company-search routes.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct SecCompanySearchResult {
    pub symbol: Ticker,
    pub name: String,
    pub cik: Cik,
    pub sic_code: String,
    pub industry_title: String,
    pub business_address: String,
    pub phone_number: String,
}

/// One full SEC company profile.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct SecCompanyProfile {
    pub symbol: Ticker,
    pub cik: Cik,
    pub registrant_name: String,
    pub sic_code: String,
    pub sic_description: String,
    pub sic_group: String,
    pub isin: Isin,
    pub business_address: String,
    pub mailing_address: String,
    pub phone_number: String,
    pub postal_code: String,
    pub city: String,
    pub state: String,
    pub country: CountryCode,
    pub description: String,
    pub ceo: String,
    pub website: String,
    pub exchange: ExchangeCode,
    pub state_location: String,
    pub state_of_incorporation: String,
    pub fiscal_year_end: String,
    pub ipo_date: Date,
    pub employees: NumericString,
    pub sec_filings_url: String,
    pub tax_identification_number: String,
    pub fifty_two_week_range: String,
    pub is_active: bool,
    pub asset_type: String,
    pub open_figi_composite: String,
    pub price_currency: CurrencyCode,
    pub market_sector: Sector,
    #[serde(deserialize_with = "required_option")]
    pub security_type: Option<DynamicJson>,
    pub is_etf: bool,
    pub is_adr: bool,
    pub is_fund: bool,
}

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

/// One Standard Industrial Classification directory row.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct SicClassification {
    pub office: String,
    pub sic_code: String,
    pub industry_title: String,
}