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

//! Cryptocurrency catalog and quote endpoints.
//!
//! Cryptocurrency-specific facades keep shared quote routes discoverable
//! without duplicating their query or response contracts.

use crate::{
    Client, Result,
    endpoints::EndpointSpec,
    responses::{
        chart::{StockChartFullBar, StockChartIntradayBar, StockChartLightBar},
        crypto::{CryptocurrencyListing, Quote, QuoteShort},
    },
};

pub use super::asset_chart::AssetChartQuery;
pub use super::quote::{QuoteQuery, QuoteShortQuery, ShortOnlyQuery};

/// Describes `GET cryptocurrency-list` without binding it to a transport.
pub fn cryptocurrency_list() -> EndpointSpec<(), Vec<CryptocurrencyListing>> {
    EndpointSpec::get("cryptocurrency-list", "cryptocurrency-list", ())
}

/// Describes the cryptocurrency-specific `GET quote` contract.
pub fn cryptocurrency_quote(query: QuoteQuery) -> EndpointSpec<QuoteQuery, Vec<Quote>> {
    EndpointSpec::get("quote", "quote", query)
}

/// Describes the cryptocurrency-specific `GET quote-short` contract.
pub fn cryptocurrency_quote_short(
    query: QuoteShortQuery,
) -> EndpointSpec<QuoteShortQuery, Vec<QuoteShort>> {
    EndpointSpec::get("quote-short", "quote-short", query)
}

/// Describes compact `GET batch-crypto-quotes`.
///
/// The returned query always emits `short=true`; the undocumented full batch
/// response shape is deliberately deferred.
pub fn cryptocurrency_quotes() -> EndpointSpec<ShortOnlyQuery, Vec<QuoteShort>> {
    super::quote::cryptocurrency_quotes()
}

/// Describes compact cryptocurrency `GET historical-price-eod/light` history.
pub fn cryptocurrency_chart_light(
    query: AssetChartQuery,
) -> EndpointSpec<AssetChartQuery, Vec<StockChartLightBar>> {
    super::asset_chart::chart_light(query)
}

/// Describes detailed cryptocurrency `GET historical-price-eod/full` history.
pub fn cryptocurrency_chart_full(
    query: AssetChartQuery,
) -> EndpointSpec<AssetChartQuery, Vec<StockChartFullBar>> {
    super::asset_chart::chart_full(query)
}

/// Describes cryptocurrency `GET historical-chart/1min` history.
pub fn cryptocurrency_chart_one_minute(
    query: AssetChartQuery,
) -> EndpointSpec<AssetChartQuery, Vec<StockChartIntradayBar>> {
    super::asset_chart::chart_one_minute(query)
}

/// Describes cryptocurrency `GET historical-chart/5min` history.
pub fn cryptocurrency_chart_five_minutes(
    query: AssetChartQuery,
) -> EndpointSpec<AssetChartQuery, Vec<StockChartIntradayBar>> {
    super::asset_chart::chart_five_minutes(query)
}

/// Describes cryptocurrency `GET historical-chart/1hour` history.
pub fn cryptocurrency_chart_one_hour(
    query: AssetChartQuery,
) -> EndpointSpec<AssetChartQuery, Vec<StockChartIntradayBar>> {
    super::asset_chart::chart_one_hour(query)
}

impl Client {
    /// Lists the provider's documented cryptocurrency catalog.
    pub async fn cryptocurrency_list(&self) -> Result<Vec<CryptocurrencyListing>> {
        self.execute(&cryptocurrency_list()).await
    }

    /// Retrieves a detailed quote for one cryptocurrency.
    pub async fn cryptocurrency_quote(&self, query: impl Into<QuoteQuery>) -> Result<Vec<Quote>> {
        self.execute(&cryptocurrency_quote(query.into())).await
    }

    /// Retrieves a compact quote for one cryptocurrency.
    pub async fn cryptocurrency_quote_short(
        &self,
        query: impl Into<QuoteShortQuery>,
    ) -> Result<Vec<QuoteShort>> {
        self.execute(&cryptocurrency_quote_short(query.into()))
            .await
    }

    /// Retrieves compact end-of-day cryptocurrency history.
    ///
    /// The documented 5,000-row maximum is advisory metadata. Use
    /// [`EndpointBounds::accepts_response_rows`](super::metadata::EndpointBounds::accepts_response_rows)
    /// for optional preflight validation.
    pub async fn cryptocurrency_chart_light(
        &self,
        query: impl Into<AssetChartQuery>,
    ) -> Result<Vec<StockChartLightBar>> {
        self.execute(&cryptocurrency_chart_light(query.into()))
            .await
    }

    /// Retrieves detailed end-of-day cryptocurrency history.
    ///
    /// The documented 5,000-row maximum is advisory metadata. Use
    /// [`EndpointBounds::accepts_response_rows`](super::metadata::EndpointBounds::accepts_response_rows)
    /// for optional preflight validation.
    pub async fn cryptocurrency_chart_full(
        &self,
        query: impl Into<AssetChartQuery>,
    ) -> Result<Vec<StockChartFullBar>> {
        self.execute(&cryptocurrency_chart_full(query.into())).await
    }

    /// Retrieves one-minute cryptocurrency history.
    pub async fn cryptocurrency_chart_one_minute(
        &self,
        query: impl Into<AssetChartQuery>,
    ) -> Result<Vec<StockChartIntradayBar>> {
        self.execute(&cryptocurrency_chart_one_minute(query.into()))
            .await
    }

    /// Retrieves five-minute cryptocurrency history.
    pub async fn cryptocurrency_chart_five_minutes(
        &self,
        query: impl Into<AssetChartQuery>,
    ) -> Result<Vec<StockChartIntradayBar>> {
        self.execute(&cryptocurrency_chart_five_minutes(query.into()))
            .await
    }

    /// Retrieves one-hour cryptocurrency history.
    pub async fn cryptocurrency_chart_one_hour(
        &self,
        query: impl Into<AssetChartQuery>,
    ) -> Result<Vec<StockChartIntradayBar>> {
        self.execute(&cryptocurrency_chart_one_hour(query.into()))
            .await
    }
}