libfmp 0.9.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
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
147
148
149
150
151
152
153
154
155

//! Response rows returned by ETF and mutual-fund endpoints.

use serde::{Deserialize, Serialize};

use crate::{
    codecs::{IsoTimestamp, NumericString, PercentString, YnFlag},
    types::{
        ApiDateTime, Cik, Count, CountryCode, CurrencyCode, Cusip, Date, Industry, Isin, Lei,
        MarketValue, Percentage, Sector, Ticker, Volume,
    },
};

/// One asset held by an ETF or mutual fund.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct EtfFundHolding {
    pub symbol: Ticker,
    pub asset: Ticker,
    pub name: String,
    pub isin: Isin,
    pub security_cusip: Cusip,
    pub shares_number: Count,
    pub weight_percentage: Percentage,
    pub market_value: MarketValue,
    pub updated_at: ApiDateTime,
}

/// One sector exposure nested within a fund-information row.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct EtfSectorExposure {
    pub industry: Industry,
    pub exposure: Percentage,
}

/// Descriptive, structural, and trading information for an ETF or mutual fund.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct EtfFundInfo {
    pub symbol: Ticker,
    pub name: String,
    pub description: String,
    pub isin: Isin,
    pub asset_class: String,
    pub security_cusip: Cusip,
    pub domicile: CountryCode,
    pub website: String,
    pub etf_company: String,
    pub expense_ratio: Percentage,
    pub assets_under_management: u64,
    pub avg_volume: Volume,
    pub inception_date: Date,
    pub nav: f64,
    pub nav_currency: CurrencyCode,
    pub holdings_count: Count,
    pub is_actively_trading: bool,
    pub updated_at: IsoTimestamp,
    pub sectors_list: Vec<EtfSectorExposure>,
}

/// One country allocation reported as an exact percent-bearing string.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct EtfCountryWeighting {
    pub country: String,
    pub weight_percentage: PercentString,
}

/// One ETF's exposure to a requested asset.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct EtfAssetExposure {
    pub symbol: Ticker,
    pub asset: Ticker,
    pub shares_number: Count,
    pub weight_percentage: Percentage,
    pub market_value: MarketValue,
}

/// One numeric sector allocation for an ETF or mutual fund.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct EtfSectorWeighting {
    pub symbol: Ticker,
    pub sector: Sector,
    pub weight_percentage: Percentage,
}

/// One fund holder from the latest disclosure for a security.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct FundDisclosureHolder {
    pub cik: Cik,
    pub holder: String,
    pub security_cusip: Cusip,
    pub shares: Count,
    pub date_reported: Date,
    pub change: i64,
    pub weight_percent: Percentage,
}

/// One position in a mutual-fund disclosure filing.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct FundDisclosure {
    pub cik: Cik,
    pub date: Date,
    pub accepted_date: ApiDateTime,
    pub symbol: Ticker,
    pub name: String,
    pub lei: Lei,
    pub title: String,
    pub cusip: Cusip,
    pub isin: Isin,
    pub balance: Count,
    pub units: String,
    #[serde(rename = "cur_cd")]
    pub currency_code: CurrencyCode,
    pub val_usd: MarketValue,
    pub pct_val: Percentage,
    pub payoff_profile: String,
    pub asset_cat: String,
    pub issuer_cat: String,
    pub inv_country: CountryCode,
    pub is_restricted_sec: YnFlag,
    pub fair_val_level: NumericString,
    pub is_cash_collateral: YnFlag,
    pub is_non_cash_collateral: YnFlag,
    pub is_loan_by_fund: YnFlag,
}

/// One result from searching disclosure holders by fund or ETF name.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct FundDisclosureSearchResult {
    pub symbol: Ticker,
    pub cik: Cik,
    pub class_id: String,
    pub series_id: String,
    pub entity_name: String,
    pub entity_org_type: NumericString,
    pub series_name: String,
    pub class_name: String,
    pub reporting_file_number: String,
    pub address: String,
    pub city: String,
    pub zip_code: String,
    pub state: String,
}

/// One available fund-disclosure reporting date and calendar period.
///
/// Fund disclosures and Form 13F filings use the same exact three-field wire
/// contract, so this endpoint-facing name reuses that existing response row.
pub type FundDisclosureDate = crate::responses::institutional_ownership::Form13fFilingDate;