Module fmp

Expand description

Financial Modeling Prep (FMP) financial data API (requires fmp feature). Financial Modeling Prep API client for financial data.

Requires the fmp feature flag and an API key from https://financialmodelingprep.com/.

Call [init] once at startup before using any query functions.

§Quick Start

use finance_query::adapters::fmp;
use finance_query::adapters::fmp::Period;

fmp::init("YOUR_API_KEY")?;

// Real-time quote
let quotes = fmp::quote("AAPL").await?;

// Income statement
let income = fmp::income_statement("AAPL", Period::Quarter, Some(4)).await?;

// Company profile
let profile = fmp::company_profile("AAPL").await?;

Re-exports§

pub use models::*;

Modules§

models: Shared types for Financial Modeling Prep API responses.

Structs§

AnalystEstimate: Analyst estimate entry.
AnalystRecommendation: Analyst recommendation entry.
AvailableSymbol: An available cryptocurrency or forex/commodity symbol.
BalanceSheet: Balance sheet statement from FMP.
CashFlow: Cash flow statement from FMP.
CikMapping: CIK mapping entry.
CikResult: A result from the CIK search endpoint.
CompanyOutlook: Company outlook from FMP (v4 endpoint).
CompanyProfile: Company profile from FMP.
CompanyRating: Company rating from FMP.
CongressionalTrade: Congressional/senate trading record.
CotAnalysis: A Commitment of Traders analysis entry.
CotReport: A Commitment of Traders report entry.
CotSymbol: A symbol available in the Commitment of Traders report.
DelistedCompany: Delisted company from FMP.
DiscountedCashFlow: Discounted cash flow valuation from FMP.
DividendCalendarEntry: Dividend calendar entry.
DividendHistory: A single historical dividend record.
DividendHistoryResponse: Historical dividend response wrapper.
EarningsCalendarEntry: Earnings calendar entry.
EarningsSurprise: Earnings surprise entry.
EarningsTranscript: Earnings call transcript entry.
EarningsTranscriptRef: Earnings transcript list entry (available transcripts).
EconomicCalendarEntry: Economic calendar entry.
EnterpriseValue: Enterprise value from FMP.
EtfCountryWeighting: ETF country weighting entry.
EtfHolder: ETF holder entry.
EtfHolding: ETF holding entry.
EtfSectorWeighting: ETF sector weighting entry.
FailToDeliver: Fail-to-deliver record.
FinancialGrowth: Financial growth metrics from FMP.
FinancialRatios: Financial ratios from FMP.
FmpArticle: FMP article from their own editorial.
FmpArticlesResponse: FMP articles response wrapper (paginated).
Form13F: Form 13F filing entry.
HistoricalConstituent: A historical change in index constituency.
HistoricalDcf: Historical discounted cash flow from FMP.
HistoricalPriceParams: Optional parameters for historical price queries.
HistoricalSectorPerformance: Historical sector performance entry.
IncomeStatement: Income statement from FMP.
IndexConstituent: A constituent of a major index (S&P 500, Nasdaq, Dow Jones).
IndustryPe: Industry price-to-earnings ratio entry.
InsiderTrade: Insider trading transaction record.
InstitutionalHolder: Institutional holder entry.
IpoCalendarEntry: IPO calendar entry.
KeyExecutive: Key executive from FMP.
KeyMetrics: Key metrics from FMP.
MarketCap: Market capitalization from FMP.
MarketMover: Market mover entry (gainers, losers, most active).
MutualFundHolder: Mutual fund holder entry.
PressRelease: Press release.
ScreenerResult: A result from the stock screener endpoint.
SearchResult: A result from the symbol search endpoint.
SectorPe: Sector price-to-earnings ratio entry.
SectorPerformance: Sector performance entry.
SicCode: Standard Industrial Classification code entry.
SicEntry: Detailed SIC entry for a specific code.
SplitHistory: A single historical stock split record.
SplitHistoryResponse: Historical stock split response wrapper.
StockGrade: Stock grade entry.
StockListEntry: An entry from the stock/ETF list endpoints.
StockNews: Stock news article.
StockPeers: Stock peer from FMP (v4 endpoint).
StockPriceChange: Stock price change from FMP.
StockSplitCalendarEntry: Stock split calendar entry.
TechnicalIndicatorValue: A single technical indicator data point.

Functions§

analyst_estimates: Fetch analyst estimates for a symbol.
analyst_recommendations: Fetch analyst stock recommendations.
balance_sheet: Fetch balance sheet statements for a symbol.
balance_sheet_as_reported: Fetch balance sheet statements as reported for a symbol.
batch_quote: Fetch real-time quotes for multiple symbols (comma-separated).
bulk_balance_sheets: Fetch bulk balance sheet statements as raw JSON.
bulk_cash_flow: Fetch bulk cash flow statements as raw JSON.
bulk_income_statements: Fetch bulk income statements as raw JSON.
bulk_key_metrics: Fetch bulk key metrics as raw JSON.
bulk_profiles: Fetch all company profiles as raw JSON.
bulk_ratios: Fetch bulk financial ratios as raw JSON.
cash_flow: Fetch cash flow statements for a symbol.
cash_flow_as_reported: Fetch cash flow statements as reported for a symbol.
cik_mapper: Search CIK mappings by name.
cik_mapper_by_company: Fetch CIK mapping by company name/identifier.
cik_search: Look up a company by CIK number.
commodity_available: List all available commodities.
commodity_historical: Fetch daily historical prices for a commodity.
commodity_quote: Fetch a real-time commodity quote.
company_outlook: Fetch company outlook for a symbol (v4 endpoint).
company_profile: Fetch company profile for a symbol.
company_rating: Fetch company rating for a symbol.
congressional_trading: Fetch congressional (senate) trading data for a symbol.
cot_analysis: Fetch a Commitment of Traders analysis for a symbol.
cot_report: Fetch a Commitment of Traders report for a symbol.
cot_symbols: Fetch available COT report symbols.
crypto_available: List all available cryptocurrency pairs.
crypto_historical: Fetch daily historical prices for a cryptocurrency.
crypto_intraday: Fetch intraday prices for a cryptocurrency.
crypto_news: Fetch crypto news.
crypto_quote: Fetch a real-time crypto quote.
daily_adx: Fetch daily Average Directional Index (ADX).
daily_dema: Fetch daily Double Exponential Moving Average (DEMA).
daily_ema: Fetch daily Exponential Moving Average (EMA).
daily_macd: Fetch daily MACD.
daily_rsi: Fetch daily Relative Strength Index (RSI).
daily_sma: Fetch daily Simple Moving Average (SMA).
daily_tema: Fetch daily Triple Exponential Moving Average (TEMA).
daily_williams: Fetch daily Williams %R.
daily_wma: Fetch daily Weighted Moving Average (WMA).
delisted_companies: Fetch delisted companies.
discounted_cash_flow: Fetch current discounted cash flow valuation for a symbol.
dividend_calendar: Fetch dividend calendar within a date range.
dow_constituents: Fetch current Dow Jones constituents.
earnings_calendar: Fetch earnings calendar within a date range.
earnings_surprises: Fetch earnings surprises for a symbol.
earnings_transcript: Fetch an earnings call transcript.
earnings_transcript_list: Fetch a list of available earnings transcripts for a symbol.
economic_calendar: Fetch economic calendar within a date range.
enterprise_value: Fetch enterprise values for a symbol.
etf_available: List all available ETFs.
etf_country_weightings: Fetch ETF country weightings.
etf_historical: Fetch daily historical prices for an ETF.
etf_holders: Fetch ETF holders of a stock.
etf_holdings: Fetch ETF holdings (same endpoint as ETF holder).
etf_list: Fetch the full list of ETFs.
etf_quote: Fetch a real-time ETF quote.
etf_sector_weightings: Fetch ETF sector weightings.
fail_to_deliver: Fetch fail-to-deliver data for a symbol.
financial_growth: Fetch financial growth metrics for a symbol.
financial_ratios: Fetch financial ratios for a symbol.
financial_statement_symbols: Fetch symbols that have financial statements available.
fmp_articles: Fetch FMP editorial articles.
forex_available: List all available forex currency pairs.
forex_historical: Fetch daily historical prices for a forex pair.
forex_intraday: Fetch intraday prices for a forex pair.
forex_news: Fetch forex news.
forex_quote: Fetch a real-time forex quote.
form_13f: Fetch Form 13F filings for a CIK.
full_financial_statement: Fetch full financial statement as reported for a symbol.
historical_dcf: Fetch historical discounted cash flow for a symbol.
historical_dividends: Fetch historical dividend data for a symbol.
historical_market_cap: Fetch historical market capitalization for a symbol.
historical_price_daily: Fetch historical daily prices for a symbol.
historical_price_intraday: Fetch intraday historical prices for a symbol.
historical_rating: Fetch historical ratings for a symbol.
historical_sector_performance: Fetch historical sector performance.
historical_sp500: Fetch historical S&P 500 constituent changes.
historical_splits: Fetch historical stock split data for a symbol.
income_statement: Fetch income statements for a symbol.
income_statement_as_reported: Fetch income statements as reported for a symbol.
index_historical: Fetch daily historical prices for an index.
industries_pe: Fetch industry PE ratios.
init: Initialize the global FMP client with an API key.
init_with_timeout: Initialize the FMP client with a custom timeout.
insider_trading: Fetch insider trading transactions for a symbol.
insider_trading_rss: Fetch the insider trading RSS feed.
institutional_holders: Fetch institutional holders of a stock.
intraday_adx: Fetch intraday Average Directional Index (ADX).
intraday_dema: Fetch intraday Double Exponential Moving Average (DEMA).
intraday_ema: Fetch intraday Exponential Moving Average (EMA).
intraday_macd: Fetch intraday MACD.
intraday_rsi: Fetch intraday Relative Strength Index (RSI).
intraday_sma: Fetch intraday Simple Moving Average (SMA).
intraday_tema: Fetch intraday Triple Exponential Moving Average (TEMA).
intraday_williams: Fetch intraday Williams %R.
intraday_wma: Fetch intraday Weighted Moving Average (WMA).
ipo_calendar: Fetch IPO calendar within a date range.
key_executives: Fetch key executives for a symbol.
key_metrics: Fetch key metrics for a symbol.
major_indexes_quote: Fetch real-time quotes for all major indexes.
market_cap: Fetch market capitalization for a symbol.
mutual_fund_available: List all available mutual funds.
mutual_fund_historical: Fetch daily historical prices for a mutual fund.
mutual_fund_holders: Fetch mutual fund holders of a stock.
mutual_fund_quote: Fetch a real-time mutual fund quote.
nasdaq_constituents: Fetch current Nasdaq constituents.
press_releases: Fetch press releases for a symbol.
quote: Fetch real-time quote for a symbol.
sector_performance: Fetch current sector performance.
sectors_pe: Fetch sector PE ratios.
sic_by_code: Fetch companies by SIC code.
sic_codes: Fetch all SIC codes.
sp500_constituents: Fetch current S&P 500 constituents.
stock_grade: Fetch stock grade history for a symbol.
stock_market_gainers: Fetch top stock market gainers.
stock_market_losers: Fetch top stock market losers.
stock_market_most_active: Fetch most active stocks.
stock_news: Fetch stock news articles.
stock_peers: Fetch stock peers for a symbol (v4 endpoint).
stock_price: Fetch stock price change percentages for a symbol.
stock_screener: Screen stocks by various financial criteria.
stock_split_calendar: Fetch stock split calendar within a date range.
symbol_search: Search for symbols matching a query string.
symbols_list: Fetch the full list of stocks.
tradable_symbols_list: Fetch all tradable symbols.

Module fmp

Module fmp Copy item path

§Quick Start

Re-exports§

Modules§

Structs§

Functions§

Module fmp