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

//! Compact worldwide financial-summary endpoints.

use crate::{
    Client, Result,
    endpoints::EndpointSpec,
    responses::statements::{
        EnterpriseValue, FinancialScore, LatestFinancialStatement, OwnerEarnings,
    },
};

use super::{
    EnterpriseValuesQuery, FinancialScoresQuery, LATEST_FINANCIAL_STATEMENTS_METADATA,
    LatestFinancialStatementsQuery, OwnerEarningsQuery, WORLDWIDE_FINANCIAL_HISTORY_METADATA,
    WORLDWIDE_FINANCIAL_SUMMARY_METADATA,
};

/// Describes `GET latest-financial-statements` without binding it to a transport.
pub fn latest_financial_statements(
    query: LatestFinancialStatementsQuery,
) -> EndpointSpec<LatestFinancialStatementsQuery, Vec<LatestFinancialStatement>> {
    EndpointSpec::get(
        "latest-financial-statements",
        "latest-financial-statements",
        query,
    )
    .with_metadata(LATEST_FINANCIAL_STATEMENTS_METADATA)
}

/// Describes `GET financial-scores` without binding it to a transport.
pub fn financial_scores(
    query: FinancialScoresQuery,
) -> EndpointSpec<FinancialScoresQuery, Vec<FinancialScore>> {
    EndpointSpec::get("financial-scores", "financial-scores", query)
        .with_metadata(WORLDWIDE_FINANCIAL_SUMMARY_METADATA)
}

/// Describes `GET owner-earnings` without binding it to a transport.
pub fn owner_earnings(
    query: OwnerEarningsQuery,
) -> EndpointSpec<OwnerEarningsQuery, Vec<OwnerEarnings>> {
    EndpointSpec::get("owner-earnings", "owner-earnings", query)
        .with_metadata(WORLDWIDE_FINANCIAL_SUMMARY_METADATA)
}

/// Describes `GET enterprise-values` without binding it to a transport.
pub fn enterprise_values(
    query: EnterpriseValuesQuery,
) -> EndpointSpec<EnterpriseValuesQuery, Vec<EnterpriseValue>> {
    EndpointSpec::get("enterprise-values", "enterprise-values", query)
        .with_metadata(WORLDWIDE_FINANCIAL_HISTORY_METADATA)
}

impl Client {
    /// Retrieves the latest worldwide financial-statement filings.
    pub async fn latest_financial_statements(
        &self,
        query: LatestFinancialStatementsQuery,
    ) -> Result<Vec<LatestFinancialStatement>> {
        self.execute(&latest_financial_statements(query)).await
    }

    /// Retrieves worldwide financial-health scores for one company.
    pub async fn financial_scores(
        &self,
        query: impl Into<FinancialScoresQuery>,
    ) -> Result<Vec<FinancialScore>> {
        self.execute(&financial_scores(query.into())).await
    }

    /// Retrieves worldwide owner earnings for one company.
    pub async fn owner_earnings(
        &self,
        query: impl Into<OwnerEarningsQuery>,
    ) -> Result<Vec<OwnerEarnings>> {
        self.execute(&owner_earnings(query.into())).await
    }

    /// Retrieves worldwide enterprise values for one company.
    pub async fn enterprise_values(
        &self,
        query: impl Into<EnterpriseValuesQuery>,
    ) -> Result<Vec<EnterpriseValue>> {
        self.execute(&enterprise_values(query.into())).await
    }
}