Common Parameters
All tools support these optional output parameters:| Parameter | Type | Description |
|---|---|---|
response_format | "json" | "markdown" | Output format (default: "json") |
preview_limit | number | Number of rows to show in markdown tables (default: 25, max: 200) |
save | object | Save data to file with format ("csv" | "json") and optional filename |
Tools by Category
Market Data
Download historical prices and data for single or multiple tickers
Company Information
Company profiles, fast info, and news feeds
Financial Statements
Income statements, balance sheets, and cash flow data
Corporate Actions
Dividends, stock splits, and capital gains
Analyst Data
Recommendations, price targets, and earnings estimates
Ownership
Institutional holders, insiders, and mutual fund ownership
Options
Options chains and expiration dates
Screening
Search, lookup, screen, and calendar tools
Markets & Sectors
Market summaries, sector performance, and industry data
Reference
Field definitions and data schema documentation
Market Data
Tools for downloading and accessing historical market data.| Tool | Description |
|---|---|
yf_download | Download market data for multiple tickers with various intervals and periods |
yf_ticker_history | Get historical market data for a single ticker with OHLCV data |
yf_tickers_history | Get historical market data for multiple tickers with grouping options |
period:1d,5d,1mo,3mo,6mo,1y,2y,5y,10y,ytd,maxinterval:1m,2m,5m,15m,30m,60m,90m,1h,1d,5d,1wk,1mo,3mostart/end: Date strings for custom rangesauto_adjust: Apply dividend/split adjustmentsactions: Include dividends and splits in data
Company Information
Basic company data and news feeds.| Tool | Description |
|---|---|
yf_ticker_info | Complete info dictionary with company details, financials, and metrics |
yf_ticker_fast_info | Lightweight info for quick access to key metrics |
yf_ticker_news | News articles for a single ticker |
yf_tickers_news | News articles for multiple tickers |
Financial Statements
Complete financial statement data with multiple frequency options.| Tool | Description |
|---|---|
yf_ticker_income_stmt | Income statement data (revenue, expenses, net income) |
yf_ticker_balance_sheet | Balance sheet data (assets, liabilities, equity) |
yf_ticker_cash_flow | Cash flow statement (operating, investing, financing activities) |
yf_ticker_earnings | Earnings data including quarterly and annual results |
yf_ticker_calendar | Upcoming calendar events (earnings dates, ex-dividend dates) |
yf_ticker_earnings_dates | Historical and upcoming earnings announcement dates |
freq:"yearly","quarterly", or"trailing"(TTM)as_dict: Return as dictionary instead of DataFramepretty: Human-readable formatting
Corporate Actions
Historical corporate action events.| Tool | Description |
|---|---|
yf_ticker_actions | All corporate actions (dividends and splits combined) |
yf_ticker_dividends | Dividend payment history |
yf_ticker_splits | Stock split history |
yf_ticker_capital_gains | Capital gains distributions (mutual funds/ETFs) |
Analyst Data
Analyst recommendations, price targets, and earnings estimates.| Tool | Description |
|---|---|
yf_ticker_recommendations | Detailed analyst recommendations over time |
yf_ticker_recommendations_summary | Summary of current recommendation consensus |
yf_ticker_upgrades_downgrades | Recent analyst upgrades and downgrades |
yf_ticker_analyst_price_targets | Analyst price target data |
yf_ticker_earnings_estimate | Earnings estimates by analysts |
yf_ticker_revenue_estimate | Revenue estimates by analysts |
yf_ticker_earnings_history | Historical earnings vs. estimates |
yf_ticker_eps_trend | EPS trend analysis |
yf_ticker_eps_revisions | EPS estimate revisions |
yf_ticker_growth_estimates | Growth rate estimates |
Ownership
Shareholder and ownership data.| Tool | Description |
|---|---|
yf_ticker_major_holders | Major holder breakdown percentages |
yf_ticker_institutional_holders | Top institutional shareholders |
yf_ticker_mutualfund_holders | Top mutual fund holders |
yf_ticker_insider_purchases | Recent insider purchase transactions |
yf_ticker_insider_transactions | All insider transaction history |
yf_ticker_insider_roster_holders | Current insider roster |
yf_ticker_shares | Outstanding shares data |
yf_ticker_shares_full | Full historical shares outstanding with date range |
Options
Options chain data and analysis.| Tool | Description |
|---|---|
yf_ticker_options | Options chain for calls and puts at a specific expiration date |
date: Expiration date (optional, defaults to nearest expiration)tz: Timezone for the data
Screening
Search, discovery, and screening tools.| Tool | Description |
|---|---|
yf_search | Search for quotes, news, and research by query string |
yf_lookup | Lookup ticker symbols and asset types |
yf_screen | Run equity or fund screener queries with custom filters |
yf_calendars | Fetch earnings calendars, IPO calendars, splits, and economic events |
equity: Screen stocks with custom filtersfund: Screen mutual funds and ETFs
earnings: Upcoming earnings announcementsipo: Upcoming IPO datessplits: Upcoming stock splitseconomic_events: Economic calendar events
Markets & Sectors
Market-level, sector, and industry data.| Tool | Description |
|---|---|
yf_market | Fetch market summary or trading status for a specific market |
yf_sector | Sector-level data including overview, top companies, ETFs, and industries |
yf_industry | Industry-level data including overview, top companies, and performance metrics |
EUROPE, US, ASIA, etc.
Sector fields: overview, top_companies, research_reports, top_etfs, top_mutual_funds, industries
Industry fields: overview, top_companies, top_performing_companies, top_growth_companies, sector_key
Reference
Data schema and field reference documentation.| Tool | Description |
|---|---|
yf_field_definitions | Complete list of available fields and valid modules in yfinance |
yf_field_categories | Field category groups for organizing yfinance data |
Additional Features
SEC Filings
| Tool | Description |
|---|---|
yf_ticker_sec_filings | Recent SEC filing documents and links |
Sustainability
| Tool | Description |
|---|---|
yf_ticker_sustainability | ESG (Environmental, Social, Governance) scores and sustainability metrics |
Fund Data
| Tool | Description |
|---|---|
yf_ticker_funds_data | Detailed fund data for ETFs and mutual funds (holdings, allocations, etc.) |
Next Steps
Market Data Guide
Learn how to download and work with historical price data
Financial Analysis
Analyze financial statements and company metrics
Screening Stocks
Use screeners and calendars to discover opportunities
Options Analysis
Work with options chains and derivatives data