README.md

FinancialModelingPrep

Financial Modeling Prep API wrapper with Julia

Disclaimer

Data is provided by Financial Modeling Prep and requires a paid subscription to access some endpoints.

Only endpoints available with a starter plan have been implemented. Function to endpoint mappings are provided below.

Installation

pkg> add FinancialModelingPrep

Getting Started

using FinancialModelingPrep

# load your API key
FMP_API_KEY = ENV["FMP_API_KEY"]

# create a new FMP API instance
fmp = FMP(apikey = FMP_API_KEY)

# pass API instance to any endpoint method
data = income_statements(fmp, "AAPL")

using DataFrames

# load the response data into a data frame
df = DataFrame(data)

# sample data frame output 
df[1:5, 1:4]
5×4 DataFrame
 Row │ incomeTaxExpense  reportedCurrency  incomeBeforeTaxRatio  depreciationAndAmortization 
     │ Int64             String            Float64               Int64                       
─────┼───────────────────────────────────────────────────────────────────────────────────────
   1 │      19300000000  USD                           0.30204                   11104000000
   2 │      14527000000  USD                           0.298529                  11284000000
   3 │       9680000000  USD                           0.244398                  11056000000
   4 │      10481000000  USD                           0.252666                  12547000000
   5 │      13372000000  USD                           0.274489                  10903000000

Price Quotes

Function	Endpoint(s)
price_quote price_quotes	Company-Quote Index-Quote Euronext-Quote TSX-Quote Crypto-Quote Forex-Quote Commodity-Quote
historical_price_quote	Historical-Stock-Quote Historical-Index-Quote Historical-Euronext-Quote Historical-TSX-Quote Historical-Cryptocurrencies-Quote Historical-Forex-Quote Historical-Commodities-Quote

Stock Fundamentals

Function	Endpoint(s)
symbols_with_financials	Financial-Statements-List
income_statements	Income-Statements Income-Statements-As-Reported
balance_sheet_statements	Balance-Sheet-Statements Balance-Sheet-Statements-As-Reported
cash_flow_statements	Cash-Flow-Statements Cash-Flow-Statements-As-Reported
financial_statements	Full-Financial-Statements-As-Reported
financial_reports	Annual-Reports-on-Form-10-K Quarterly-Earnings-Reports
revenue_segments	Sales-Revenue-By-Segments Revenue-Geographic-by-Segments
shares_float	Shares-Float
earnings_call_transcripts	Earnings-Call-Transcript
sec_filings	SEC-Filings
company_notes	Company-Notes-Due

Stock Fundamentals Analysis

Function	Endpoint(s)
financial_ratios	Financial-Ratios
financial_scores	Financial-Scores
owners_earnings	Owners-Earnings
enterprise_values	Enterprise-Value
income_statements_growth	Income-Statements-Growth
balance_sheet_statements_growth	Balance-Sheet-Statements-Growth
cash_flow_statements_growth	Cash-Flow-Statements-Growth
financial_statements_growth	Financial-Statements-Growth
key_metrics	Key-Metrics
company_rating	Company-Rating
historical_ratings	Historical-Ratings
discounted_cash_flows	Discounted-Cash-Flow
advanced_discounted_cash_flows	Discounted-Cash-Flow
historical_discounted_cash_flows	Historical-Discounted-Cash-Flow

Institutional Stock Ownership

Function	Endpoint(s)
institutional_positions	Institutional-Stock-Ownership
institutional_ownership_percentages	Stock-Ownership-by-Holders
institutional_ownership_weightings	Institutional-Stock-by-Shares-Held-and-Date
institutional_ownership_feed	Institutional-Holder-Rss-Feed
institution_search	Institutional-Holders-Search
institution_portfolio_dates	Institutional-Holders-Available-Date
institution_portfolio_summary	Institutional-Holdings-Portfolio-Positions-Summary
institution_portfolio_industry_summary	Institutional-Holdings-Portfolio-Industry-Summary
institution_portfolio_composition	Institutional-Holdings-Portfolio-Composition

ESG Score

Function	Endpoint(s)
esg_scores	ESG-Score
esg_ratings	ESG-Ratings
esg_score_benchmarks	ESG-Benchmarking

Private Companies Fundraising Data

Function	Endpoint(s)
crowdfunding_offerings_feed	Crowdfunding-Offerings-Rss-Feed
crowdfunding_offerings_search	Crowdfunding-Offerings-Company-Search
crowdfunding_offerings	Crowdfunding-Offerings-by-CIK
equity_offerings_feed	Equity-Offerings-Fundraising-Rss-feed
equity_offerings_search	Equity-Offerings-Fundraising-Company-Search
equity_offerings	Equity-Offerings-Fundraising-by-CIK

Price Target

Function	Endpoint(s)
price_targets	Price-Target
price_targets_by_analyst	Price-Target-by-Analyst-Name
price_targets_by_company	Price-Target-by-Analyst-Company
price_targets_summary	Price-Target-Summary
price_targets_consensus	Price-Target-Consensus
price_targets_feed	Price-Target-RSS-Feed

Upgrades & Downgrades

Function	Endpoint(s)
upgrades_and_downgrades	Upgrades-&-Downgrades
upgrades_and_downgrades_feed	Upgrades-&-Downgrades-RSS-Feed
upgrades_and_downgrades_consensus	Upgrades-&-Downgrades-Consensus
upgrades_and_downgrades_by_company	Upgrades-&-Downgrades-by-Company

Historical ETF and Mutual Fund Holdings

Function	Endpoint(s)
mutual_fund_portfolio_dates	Historical-Mutual-Fund-Holdings-Available-Dates
mutual_fund_portfolio	Historical-Mutual-Fund-Holdings-Portfolio
mutual_fund_search	Mutual-Fund-Holdings-Search
etf_portfolio_dates	Historical-Mutual-Fund-Holdings-Available-Dates
etf_portfolio	Historical-Mutual-Fund-Holdings-Portfolio

Historical Number of Employees

Function	Endpoint(s)
historical_employee_counts	Historical-Number-of-Employees

Executive Compensation

Function	Endpoint(s)
executive_compensation	Executive-Compensation
executive_compensation_benchmarks	Executive-Compensation

Individual Beneficial Ownership

Function	Endpoint(s)
beneficial_ownership	Individual-Beneficial-Ownership

Stock Calendars

Function	Endpoint(s)
earnings_calendar	Earnings-Calendar
historical_earnings_calendar	Earnings-Calendar
earnings_calendar_confirmed	Earnings-Calendar-Confirmed
ipo_calendar	IPO-Calendar
ipo_calendar_with_prospectus	IPO-Calendar-with-Prospectus
ipo_calendar_confirmed	IPO-Calendar-Confirmed
stock_split_calendar	Stock-Split-Calendar
dividend_calendar	Dividend-Calendar
historical_dividends	Historical-Dividends
economic_calendar	Economic-Calendar

Stock Look Up Tool

Function	Endpoint(s)
search_symbol	Symbol-Search
search_name	Name-Search
stock_screener	Stock-Screener
available_countries	Stock-Screener

Company Information

Function	Endpoint(s)
company_profile	Company-Profile
key_executives	Key-Executives
company_outlook	Company-Outlook
stock_peers	Stock-Peers
nyse_schedule	NYSE-Schedule
delisted_companies	Delisted-Companies
symbol_changes	Symbol-Change
company_information	Stock-Peers

Stock News

Function	Endpoint(s)
fmp_articles	FMP-Articles
stock_news	Stock-News
stock_news_sentiment_feed	Stock-Sentiment
crypto_news	Crypto-News
forex_news	Forex-News
general_news	General-News
press_releases	Press-Releases

Market Performance

Function	Endpoint(s)
sector_pe_ratios	Sectors-PE-Ratio
industry_pe_ratios	Industries-PE-Ratio
sector_performances	Sectors-Performance
historical_sector_performances	Sectors-Performance
gainers	Most-Gainer
losers	Most-Loser
most_active	Most-Active

Advanced Data

Skipped:

Stock Statistics

Function	Endpoint(s)
historical_social_sentiment	Social-Sentiment
social_sentiment_trends	Social-Sentiment
social_sentiment_changes	Social-Sentiment
stock_grades	Stock-Grade
earnings_surprises	Earnings-Surprises
analyst_estimates	Analyst-Estimates
mergers_and_acquisitions_feed	Mergers-and-Acquisitions-RSS-Feed
mergers_and_acquisitions_search	Mergers-and-Acquisitions

Insider Trading

Function	Endpoint(s)
insider_trading_types	Insider-Trading
insider_trades	Insider-Trading
insider_trades_feed	Insider-Trading-RSS-Feed
insiders_list	CIK-Mapper
cik_from_insider	CIK-Mapper
cik_from_symbol	CIK-Mapper
insider_roster	Insider-Roster
insider_roster_statistics	Insider-Roster-Statistics
fails_to_deliver	Fails-to-Deliver

Senate Trading

Function	Endpoint(s)
senate_trades	Senate-Trading
senate_trades_feed	Senate-Trading-RSS-Feed
senate_disclosures	Senate-Disclosure
senate_disclosures_feed	Senate-Disclosure-RSS-Feed

Economics

Function	Endpoint(s)
market_risk_premium	Market-Risk-Premium
treasury_rates	Treasury-Rates
economic_indicator	Economic-Indicator

Stock Price

Function	Endpoint(s)
otc_quote	OTC-Quote
price_change	Price-Change
historical_splits	Historical-Stock-Splits
survivorship_bias	Survivorship-Bias
technical_indicators	Daily-Indicators Intraday-Indicators

Fund Holdings

Function	Endpoint(s)
etf_holders	ETF-Holders
etf_summary	ETF-Info
institutional_holders	Institutional-Holders
mutual_fund_holders	Mutual-Fund-Holders
etf_sector_weightings	ETF-Sector-Weightings
etf_country_weightings	ETF-Country-Weightings
etf_exposure	ETF-Stock-Exposure
institutions_list	Institutions-List
cik_search	Form-13F-Search
company_from_cik	CIK-Mapper
forms_13f	Form-13F
filing_dates	Form-13F-Filing-Dates
company_from_cusip	Cusip-Mapper

Stock List

Function	Endpoint(s)
available_symbols	Symbols-List
tradeable_symbols	Tradeable-Symbols-List
etf_symbols	ETF-Symbols

Bulk and Batch

Skipped: Fund holdings endpoints require a professional plan.

Market Indexes

Function	Endpoint(s)
available_indexes	Available-Indexes
sp500_companies	List-of-S&P-500-Companies Historical-S&P-500-Companies
nasdaq_companies	List-of-Nasdaq-100-Companies
dowjones_companies	List-of-Dow-Jones-Companies Historical-Dow-Jones-Companies

Euronext

Function	Endpoint(s)
available_euronext	Euronext-List

TSX

Function	Endpoint(s)
available_tsx	TSX-List

Crypto, Forex, and Commodities

Function	Endpoint(s)
available_cryptocurrencies	Cryptocurrencies-List
available_forex_pairs	Forex-Pairs-List
exchange_rates	Crypto-Quote
available_commodities	Commodities-List