Struct Client 

pub struct Client { /* private fields */ }

Reusable, asynchronous FMP connector. Clones share the connection pool. API keys travel in a sensitive header, and redirects are rejected.

Implementations

impl Client

pub async fn probe_access<Q>( &self, path: &str, params: &Q, ) -> Result<AccessReport>

where Q: Serialize + ?Sized,

Verifies whether the key can call an endpoint with these parameters. This costs a real API request. Invalid keys, rate limits, outages, and unclassified forbidden responses propagate as errors; they never become evidence of a lower plan. FMP does not expose a documented billing-plan lookup, so the report keeps the configured plan separate from the result. Successful bodies are not checked against a dataset schema; use a typed endpoint method or get when the data itself must also be validated.

impl Client

pub fn new(api_key: &str, subscription: Subscription) -> Result<Self>

Creates a client for the Stable API with a 30-second timeout and two transient-error retries. The supplied subscription is user configuration.

pub fn with_config( api_key: &str, subscription: Subscription, config: ClientConfig, ) -> Result<Self>

Creates a client with explicit transport settings.

pub const fn subscription(&self) -> &Subscription

Returns the configured plan and cluster grants. They are not server-verified.

pub async fn get<T, Q>(&self, path: &str, params: &Q) -> Result<T>

where T: DeserializeOwned, Q: Serialize + ?Sized,

Requests any Stable JSON endpoint and validates its response against T. Define a Deserialize model for endpoints without a named SDK wrapper. Paths must be relative (e.g. "quote"); serialize query parameters through params, never append them to the path. An API error inside HTTP 200 is returned as an error even if T could deserialize that object.

pub async fn get_text<Q>(&self, path: &str, params: &Q) -> Result<String>

where Q: Serialize + ?Sized,

Requests a text endpoint, including FMP CSV bulk datasets. Provider errors are still checked before returning the UTF-8 text.

pub async fn get_bytes<Q>(&self, path: &str, params: &Q) -> Result<Vec<u8>>

where Q: Serialize + ?Sized,

Requests a binary endpoint, such as financial reports in XLSX format.

impl Client

pub fn from_env(websocket_entitlements: WebSocketEntitlements) -> Result<Self>

Creates a client from FMP_API_KEY and optional FMP_PLAN in the process environment.

The API key is required. A missing or blank plan uses the free plan (Plan::Basic). WebSocket cluster grants are supplied explicitly.

pub fn from_dotenv( path: &Path, websocket_entitlements: WebSocketEntitlements, ) -> Result<Self>

Creates a client from the selected dotenv file without populating the process environment.

The file must contain FMP_API_KEY. Missing or blank FMP_PLAN uses the free plan (Plan::Basic). Unrelated entries are ignored, and duplicate FMP settings return an error. Quoting and variable expansion follow dotenvy syntax.

use std::path::Path;
use fmp_rust_sdk::{Client, WebSocketEntitlements};
let client = Client::from_dotenv(Path::new(".env"), WebSocketEntitlements::none())?;

impl Client

pub async fn profile(&self, symbol: &str) -> Result<Vec<Profile>>

Company information from Stable profile.

impl Client

pub async fn stock_peers(&self, symbol: &str) -> Result<Vec<Peer>>

Comparable companies from Stable stock-peers.

impl Client

pub async fn quote(&self, symbol: &str) -> Result<Vec<Quote>>

A full quote from Stable quote for any supported stock, ETF, index, crypto, forex, or commodity symbol.

impl Client

pub async fn quote_short(&self, symbol: &str) -> Result<Vec<ShortQuote>>

A compact quote from Stable quote-short.

impl Client

pub async fn aftermarket_trade( &self, symbol: &str, ) -> Result<Vec<AftermarketTrade>>

The latest after-hours trade from Stable aftermarket-trade.

impl Client

pub async fn aftermarket_quote( &self, symbol: &str, ) -> Result<Vec<AftermarketQuote>>

After-hours bid and ask data from Stable aftermarket-quote.

impl Client

pub async fn stock_price_change(&self, symbol: &str) -> Result<Vec<PriceChange>>

Changes across multiple time horizons from Stable stock-price-change.

impl Client

pub async fn market_capitalization( &self, symbol: &str, ) -> Result<Vec<MarketCapitalization>>

Current market capitalization from Stable market-capitalization.

impl Client

pub async fn shares_float(&self, symbol: &str) -> Result<Vec<ShareFloat>>

Available share float from Stable shares-float.

impl Client

pub async fn income_statement_ttm( &self, symbol: &str, ) -> Result<Vec<IncomeStatement>>

Trailing twelve-month income statements from Stable income-statement-ttm.

impl Client

pub async fn balance_sheet_statement_ttm( &self, symbol: &str, ) -> Result<Vec<BalanceSheetStatement>>

Trailing twelve-month balance sheets from Stable balance-sheet-statement-ttm.

impl Client

pub async fn cash_flow_statement_ttm( &self, symbol: &str, ) -> Result<Vec<CashFlowStatement>>

Trailing twelve-month cash flow statements from Stable cash-flow-statement-ttm.

impl Client

pub async fn key_metrics_ttm(&self, symbol: &str) -> Result<Vec<KeyMetricsTtm>>

Trailing twelve-month metrics from Stable key-metrics-ttm.

impl Client

pub async fn ratios_ttm(&self, symbol: &str) -> Result<Vec<FinancialRatiosTtm>>

Trailing twelve-month ratios from Stable ratios-ttm.

impl Client

pub async fn earnings(&self, symbol: &str) -> Result<Vec<Earnings>>

Company earnings history and scheduled reports from Stable earnings.

impl Client

pub async fn dividends(&self, symbol: &str) -> Result<Vec<Dividend>>

Company dividend events from Stable dividends.

impl Client

pub async fn splits(&self, symbol: &str) -> Result<Vec<StockSplit>>

Company split events from Stable splits.

impl Client

pub async fn price_target_consensus( &self, symbol: &str, ) -> Result<Vec<PriceTargetConsensus>>

Consensus analyst price targets from Stable price-target-consensus.

impl Client

pub async fn ratings_snapshot( &self, symbol: &str, ) -> Result<Vec<RatingSnapshot>>

Fundamental ratings from Stable ratings-snapshot.

impl Client

pub async fn discounted_cash_flow( &self, symbol: &str, ) -> Result<Vec<DiscountedCashFlow>>

Company DCF valuation from Stable discounted-cash-flow.

impl Client

pub async fn levered_discounted_cash_flow( &self, symbol: &str, ) -> Result<Vec<DiscountedCashFlow>>

Levered company DCF valuation from Stable levered-discounted-cash-flow.

impl Client

pub async fn etf_holdings(&self, symbol: &str) -> Result<Vec<EtfHolding>>

Underlying securities and weights from Stable etf/holdings.

impl Client

pub async fn batch_quote(&self, symbols: &[&str]) -> Result<Vec<Quote>>

Full quotes for multiple symbols from Stable batch-quote.

impl Client

pub async fn batch_quote_short( &self, symbols: &[&str], ) -> Result<Vec<ShortQuote>>

Compact quotes for multiple symbols from Stable batch-quote-short.

impl Client

pub async fn batch_aftermarket_trade( &self, symbols: &[&str], ) -> Result<Vec<AftermarketTrade>>

After-hours trades for multiple symbols from Stable batch-aftermarket-trade.

impl Client

pub async fn batch_aftermarket_quote( &self, symbols: &[&str], ) -> Result<Vec<AftermarketQuote>>

After-hours quotes for multiple symbols from Stable batch-aftermarket-quote.

impl Client

pub async fn batch_market_capitalization( &self, symbols: &[&str], ) -> Result<Vec<MarketCapitalization>>

Market capitalizations for multiple symbols from Stable market-capitalization-batch.

impl Client

pub async fn stock_list(&self) -> Result<Vec<DirectorySymbol>>

Company symbols from Stable stock-list.

impl Client

pub async fn etf_list(&self) -> Result<Vec<DirectorySymbol>>

ETF symbols from Stable etf-list.

impl Client

pub async fn actively_trading_list(&self) -> Result<Vec<DirectorySymbol>>

Actively traded symbols from Stable actively-trading-list.

impl Client

pub async fn biggest_gainers(&self) -> Result<Vec<MarketMover>>

Top gaining stocks from Stable biggest-gainers.

impl Client

pub async fn biggest_losers(&self) -> Result<Vec<MarketMover>>

Top losing stocks from Stable biggest-losers.

impl Client

pub async fn most_actives(&self) -> Result<Vec<MarketMover>>

Most active stocks from Stable most-actives.

impl Client

pub async fn etf_quotes(&self) -> Result<Vec<Quote>>

ETF quotes from Stable batch-etf-quotes.

impl Client

pub async fn crypto_quotes(&self) -> Result<Vec<Quote>>

Cryptocurrency quotes from Stable batch-crypto-quotes.

impl Client

pub async fn forex_quotes(&self) -> Result<Vec<Quote>>

Forex quotes from Stable batch-forex-quotes.

impl Client

pub async fn commodity_quotes(&self) -> Result<Vec<Quote>>

Commodity quotes from Stable batch-commodity-quotes.

impl Client

pub async fn index_quotes(&self) -> Result<Vec<Quote>>

Index quotes from Stable batch-index-quotes.

impl Client

pub async fn income_statement( &self, symbol: &str, options: StatementOptions, ) -> Result<Vec<IncomeStatement>>

Historical income statements from Stable income-statement.

impl Client

pub async fn balance_sheet_statement( &self, symbol: &str, options: StatementOptions, ) -> Result<Vec<BalanceSheetStatement>>

Historical balance sheets from Stable balance-sheet-statement.

impl Client

pub async fn cash_flow_statement( &self, symbol: &str, options: StatementOptions, ) -> Result<Vec<CashFlowStatement>>

Historical cash flow statements from Stable cash-flow-statement.

impl Client

pub async fn key_metrics( &self, symbol: &str, options: StatementOptions, ) -> Result<Vec<KeyMetrics>>

Historical key metrics from Stable key-metrics.

impl Client

pub async fn ratios( &self, symbol: &str, options: StatementOptions, ) -> Result<Vec<FinancialRatios>>

Historical financial ratios from Stable ratios.

impl Client

pub async fn financial_growth( &self, symbol: &str, options: StatementOptions, ) -> Result<Vec<FinancialGrowth>>

Growth rates from Stable financial-growth.

impl Client

pub async fn search_symbol( &self, query: &str, options: SearchOptions<'_>, ) -> Result<Vec<SearchResult>>

Find symbols through Stable search-symbol.

pub async fn search_name( &self, query: &str, options: SearchOptions<'_>, ) -> Result<Vec<SearchResult>>

Find company names through Stable search-name.

pub async fn profile_by_cik(&self, cik: &str) -> Result<Vec<Profile>>

Get company profiles through Stable profile-cik.

pub async fn exchange_quotes(&self, exchange: &str) -> Result<Vec<Quote>>

Get all quotes for an exchange through Stable batch-exchange-quote.

pub async fn historical_prices( &self, symbol: &str, dates: DateRange, ) -> Result<Vec<HistoricalPrice>>

Daily split-adjusted OHLCV bars from Stable historical-price-eod/full.

pub async fn historical_prices_light( &self, symbol: &str, dates: DateRange, ) -> Result<Vec<HistoricalPriceLight>>

Daily closes from Stable historical-price-eod/light.

pub async fn intraday_prices( &self, symbol: &str, interval: IntradayInterval, dates: DateRange, ) -> Result<Vec<IntradayPrice>>

Intraday OHLCV bars at the chosen documented Stable chart interval.

pub async fn historical_market_capitalization( &self, symbol: &str, dates: DateRange, limit: u32, ) -> Result<Vec<MarketCapitalization>>

Market cap history through Stable historical-market-capitalization.

pub async fn analyst_estimates( &self, symbol: &str, period: EstimatePeriod, pagination: Pagination, ) -> Result<Vec<AnalystEstimate>>

Analyst projections through Stable analyst-estimates.

pub async fn earnings_transcript( &self, symbol: &str, year: u16, quarter: u8, ) -> Result<Vec<EarningsTranscript>>

Full earnings call content through Stable earning-call-transcript.

pub async fn earnings_calendar(&self, dates: DateRange) -> Result<Vec<Earnings>>

Earnings calendar through Stable earnings-calendar.

pub async fn dividends_calendar( &self, dates: DateRange, ) -> Result<Vec<Dividend>>

Dividend calendar through Stable dividends-calendar.

pub async fn splits_calendar(&self, dates: DateRange) -> Result<Vec<StockSplit>>

Split calendar through Stable splits-calendar.

pub async fn latest_stock_news( &self, options: NewsOptions, ) -> Result<Vec<NewsArticle>>

Latest company news through Stable news/stock-latest.

pub async fn general_news( &self, options: NewsOptions, ) -> Result<Vec<NewsArticle>>

General news through Stable news/general-latest.

pub async fn latest_press_releases( &self, options: NewsOptions, ) -> Result<Vec<NewsArticle>>

Latest press releases through Stable news/press-releases-latest.

pub async fn stock_news( &self, symbols: &[&str], options: NewsOptions, ) -> Result<Vec<NewsArticle>>

Company news selected by symbol through Stable news/stock.

pub async fn press_releases( &self, symbols: &[&str], options: NewsOptions, ) -> Result<Vec<NewsArticle>>

Press releases selected by symbol through Stable news/press-releases.

pub async fn crypto_news( &self, symbols: &[&str], options: NewsOptions, ) -> Result<Vec<NewsArticle>>

Cryptocurrency news through Stable news/crypto.

pub async fn forex_news( &self, symbols: &[&str], options: NewsOptions, ) -> Result<Vec<NewsArticle>>

Foreign exchange news through Stable news/forex.

pub async fn treasury_rates( &self, dates: DateRange, ) -> Result<Vec<TreasuryRate>>

Historical Treasury yields through Stable treasury-rates.

pub async fn economic_indicators( &self, name: &str, dates: DateRange, ) -> Result<Vec<EconomicIndicator>>

A named economic series through Stable economic-indicators. Indicator names are supplied explicitly as documented by FMP.

pub async fn economic_calendar( &self, dates: DateRange, ) -> Result<Vec<EconomicEvent>>

Scheduled economic releases through Stable economic-calendar.

pub async fn sector_performance( &self, date: NaiveDate, exchange: Option<&str>, sector: Option<&str>, ) -> Result<Vec<SectorPerformance>>

Sector performance for a date through Stable sector-performance-snapshot.

pub async fn industry_performance( &self, date: NaiveDate, exchange: Option<&str>, industry: Option<&str>, ) -> Result<Vec<IndustryPerformance>>

Industry performance for a date through Stable industry-performance-snapshot.

impl Client

pub async fn connect_streams( &self, entitlements: StreamEntitlements, config: StreamConfig, ) -> Result<StandardWebSocketClient, WebSocketError>

Opens an authenticated current market-stream connection for this client.

Explicit stream grants are independent of the client’s configured plan.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.