libfmp 0.8.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
156
157
158
159
160

//! Response rows returned by crowdfunding and Regulation D fundraising endpoints.
//!
//! Future Python bindings reserve these models under `fmp.fundraising`.

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

use crate::{
    codecs::{DynamicJson, UsDate, YnFlag, empty_date},
    types::{ApiDateTime, Cik, Count, Date, FormType, StatementAmount},
};

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 compact crowdfunding-offering search result.
///
/// The only documented `date` value is JSON null. Its non-null wire contract
/// therefore remains deliberately raw until the provider documentation proves
/// a stable representation. The key itself is required.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CrowdfundingOfferingSearchResult {
    pub cik: Cik,
    pub name: String,
    #[serde(deserialize_with = "required_option")]
    pub date: Option<DynamicJson>,
}

/// One compact Regulation D offering search result.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RegulationDOfferingSearchResult {
    pub cik: Cik,
    pub name: String,
    pub date: ApiDateTime,
}

/// One detailed crowdfunding offering.
///
/// All 48 keys documented by the provider are required. The security's free-form
/// alternative description is the sole nullable value, but its key must remain
/// present. [`Number`] preserves whether the provider spells `offeringPrice` as
/// an integer or decimal JSON number.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CrowdfundingOffering {
    pub cik: Cik,
    pub company_name: String,
    pub date: UsDate,
    pub filing_date: ApiDateTime,
    pub accepted_date: ApiDateTime,
    pub form_type: FormType,
    pub form_signification: String,
    pub name_of_issuer: String,
    pub legal_status_form: String,
    pub jurisdiction_organization: String,
    pub issuer_street: String,
    pub issuer_city: String,
    pub issuer_state_or_country: String,
    pub issuer_zip_code: String,
    pub issuer_website: String,
    pub intermediary_company_name: String,
    pub intermediary_commission_cik: Cik,
    pub intermediary_commission_file_number: String,
    pub compensation_amount: String,
    pub financial_interest: String,
    pub security_offered_type: String,
    #[serde(deserialize_with = "required_option")]
    pub security_offered_other_description: Option<String>,
    pub number_of_security_offered: Count,
    pub offering_price: Number,
    pub offering_amount: StatementAmount,
    pub over_subscription_accepted: YnFlag,
    pub over_subscription_allocation_type: String,
    pub maximum_offering_amount: StatementAmount,
    pub offering_deadline_date: UsDate,
    pub current_number_of_employees: Count,
    pub total_asset_most_recent_fiscal_year: StatementAmount,
    pub total_asset_prior_fiscal_year: StatementAmount,
    #[serde(rename = "cashAndCashEquiValentMostRecentFiscalYear")]
    pub cash_and_cash_equivalent_most_recent_fiscal_year: StatementAmount,
    #[serde(rename = "cashAndCashEquiValentPriorFiscalYear")]
    pub cash_and_cash_equivalent_prior_fiscal_year: StatementAmount,
    pub accounts_receivable_most_recent_fiscal_year: StatementAmount,
    pub accounts_receivable_prior_fiscal_year: StatementAmount,
    pub short_term_debt_most_recent_fiscal_year: StatementAmount,
    pub short_term_debt_prior_fiscal_year: StatementAmount,
    pub long_term_debt_most_recent_fiscal_year: StatementAmount,
    pub long_term_debt_prior_fiscal_year: StatementAmount,
    pub revenue_most_recent_fiscal_year: StatementAmount,
    pub revenue_prior_fiscal_year: StatementAmount,
    pub cost_goods_sold_most_recent_fiscal_year: StatementAmount,
    pub cost_goods_sold_prior_fiscal_year: StatementAmount,
    pub taxes_paid_most_recent_fiscal_year: StatementAmount,
    pub taxes_paid_prior_fiscal_year: StatementAmount,
    pub net_income_most_recent_fiscal_year: StatementAmount,
    pub net_income_prior_fiscal_year: StatementAmount,
}

/// One detailed Regulation D exempt offering.
///
/// All 43 provider keys are required. `incorporatedWithinFiveYears` is the
/// only required-present nullable field documented by the two routes.
/// `dateOfFirstSale` uses the provider's empty-string sentinel rather than
/// JSON null. Amounts and investor counts are nonnegative JSON integers.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RegulationDOffering {
    pub cik: Cik,
    pub company_name: String,
    pub date: Date,
    pub filing_date: ApiDateTime,
    pub accepted_date: ApiDateTime,
    pub form_type: FormType,
    pub form_signification: String,
    pub entity_name: String,
    pub issuer_street: String,
    pub issuer_city: String,
    pub issuer_state_or_country: String,
    pub issuer_state_or_country_description: String,
    pub issuer_zip_code: String,
    pub issuer_phone_number: String,
    pub jurisdiction_of_incorporation: String,
    pub entity_type: String,
    #[serde(deserialize_with = "required_option")]
    pub incorporated_within_five_years: Option<bool>,
    pub year_of_incorporation: String,
    pub related_person_first_name: String,
    pub related_person_last_name: String,
    pub related_person_street: String,
    pub related_person_city: String,
    pub related_person_state_or_country: String,
    pub related_person_state_or_country_description: String,
    pub related_person_zip_code: String,
    pub related_person_relationship: String,
    pub industry_group_type: String,
    pub revenue_range: String,
    pub federal_exemptions_exclusions: String,
    pub is_amendment: bool,
    #[serde(with = "empty_date")]
    pub date_of_first_sale: Option<Date>,
    pub duration_of_offering_is_more_than_year: bool,
    pub securities_offered_are_of_equity_type: bool,
    pub is_business_combination_transaction: bool,
    pub minimum_investment_accepted: u64,
    pub total_offering_amount: u64,
    pub total_amount_sold: u64,
    pub total_amount_remaining: u64,
    pub has_non_accredited_investors: bool,
    pub total_number_already_invested: Count,
    pub sales_commissions: u64,
    pub finders_fees: u64,
    pub gross_proceeds_used: u64,
}