FMP Tools Documentation
Tool Categories
A comprehensive overview of all available FMP Tools organized by category for easy selection and integration.
Overview
FMP Tools are organized into logical categories based on the type of financial data they provide. Each category contains related tools that work together to provide comprehensive financial insights. You can import entire categories or individual tools based on your needs.
Available Categories
📊 Quote Tools
Real-time and historical price data for stocks and other securities.
Tools:
getStockQuote
- Get real-time stock quote for a company
Use Cases:
- Real-time price monitoring
- Portfolio tracking
- Price alerts and notifications
🏢 Company Tools
Company profiles, descriptions, and basic information.
Tools:
getCompanyProfile
- Get comprehensive company profile and informationgetCompanySharesFloat
- Get company shares float and liquidity datagetCompanyExecutiveCompensation
- Get executive compensation information
Use Cases:
- Company research and analysis
- Due diligence processes
- Investment screening
- Executive compensation analysis
- Share liquidity assessment
💰 Financial Tools
Financial statements, ratios, and detailed financial metrics.
Tools:
getBalanceSheet
- Get balance sheet statements (annual/quarterly)getIncomeStatement
- Get income statements (annual/quarterly)getCashFlowStatement
- Get cash flow statements (annual/quarterly)getKeyMetrics
- Get key financial metrics and KPIs (annual/quarterly)getFinancialRatios
- Get financial ratios and metrics (annual/quarterly)getEnterpriseValue
- Get enterprise value calculations (annual/quarterly)getCashflowGrowth
- Get cash flow growth analysis (annual/quarterly)getIncomeGrowth
- Get income growth analysis (annual/quarterly)
Use Cases:
- Financial analysis and modeling
- Investment research
- Credit analysis
- Valuation models
- Growth trend analysis
- Enterprise value calculations
📈 Market Tools
Market-wide data including indices, sectors, gainers, losers, and trading activity.
Tools:
getMarketPerformance
- Get overall market performance datagetSectorPerformance
- Get sector performance datagetGainers
- Get top gaining stocksgetLosers
- Get top losing stocksgetMostActive
- Get most actively traded stocks
Use Cases:
- Market analysis and trends
- Sector rotation strategies
- Trading opportunities identification
- Market sentiment analysis
🏛️ Economic Tools
Economic indicators, treasury rates, and macroeconomic data.
Tools:
getTreasuryRates
- Get treasury rates and yieldsgetEconomicIndicators
- Get economic indicators including GDP, CPI, unemployment, inflation, retail sales, consumer sentiment, durable goods, housing starts, vehicle sales, and more
Use Cases:
- Economic analysis and forecasting
- Interest rate monitoring
- Macroeconomic research
- Policy impact assessment
- Consumer behavior analysis
- Housing market analysis
📋 ETF Tools
ETF profiles, holdings, and composition data.
Tools:
getETFHoldings
- Get holdings for a specific ETFgetETFProfile
- Get ETF profile and information
Use Cases:
- ETF research and analysis
- Portfolio diversification
- Asset allocation strategies
- ETF comparison and selection
📅 Calendar Tools
Earnings calendars and economic event schedules.
Tools:
getEarningsCalendar
- Get upcoming earnings calendargetEconomicCalendar
- Get economic calendar events
Use Cases:
- Earnings season planning
- Event-driven trading strategies
- Economic event monitoring
- Corporate calendar tracking
🏛️ Congressional Tools
Congressional trading activity and disclosures.
Tools:
getSenateTrading
- Get recent Senate trading activity by symbolgetHouseTrading
- Get recent House trading activity by symbolgetSenateTradingByName
- Get Senate trading by politician namegetHouseTradingByName
- Get House trading by politician namegetSenateTradingRSSFeed
- Get Senate trading RSS feed with paginationgetHouseTradingRSSFeed
- Get House trading RSS feed with pagination
Use Cases:
- Political trading analysis
- Insider trading research
- Policy impact assessment
- Regulatory compliance monitoring
- Congressional activity tracking
🏢 Institutional Tools
Institutional ownership and holdings data.
Tools:
getInstitutionalHolders
- Get institutional holders for a company
Use Cases:
- Institutional ownership analysis
- Shareholder research
- Corporate governance analysis
- Investment flow tracking
👤 Insider Tools
Insider trading transactions and disclosures.
Tools:
getInsiderTrading
- Get insider trading data for a company
Use Cases:
- Insider trading analysis
- Corporate insider research
- Regulatory compliance
- Investment signal analysis
📊 Stock Tools
Stock-specific data like market cap, splits, and dividends.
Tools:
getMarketCap
- Get market capitalization for a companygetStockSplits
- Get historical stock splits for a companygetDividendHistory
- Get dividend history and payments for a company
Use Cases:
- Market capitalization analysis
- Stock split tracking
- Dividend analysis
- Historical stock data research
Tool Selection Guide
For Financial Analysis Applications
Recommended Categories:
- Company Tools
- Financial Tools
- Quote Tools
Example Use Case: Building a comprehensive financial analysis tool that provides company profiles, financial statements, and real-time quotes.
For Market Research Applications
Recommended Categories:
- Market Tools
- Economic Tools
- Calendar Tools
Example Use Case: Creating a market research platform that tracks market performance, economic indicators, and upcoming events.
For Investment Research Applications
Recommended Categories:
- Quote Tools
- Company Tools
- Financial Tools
- Market Tools
- ETF Tools
Example Use Case: Developing an investment research tool that provides comprehensive analysis across multiple asset classes.
For Trading Applications
Recommended Categories:
- Quote Tools
- Market Tools
- Calendar Tools
- Congressional Tools
Example Use Case: Building a trading platform that monitors real-time prices, market activity, and relevant events.
For Economic Analysis Applications
Recommended Categories:
- Economic Tools
- Calendar Tools
- Market Tools
Example Use Case: Creating an economic analysis tool that tracks indicators, events, and market responses.
Import Examples
Vercel AI SDK
Import All Tools
Import Specific Categories
Import Individual Tools
OpenAI Agents
Import All Tools
Import Specific Categories
Import Individual Tools
Tool Parameters Reference
Common Parameters
symbol
- Stock/ETF symbol (e.g., "AAPL", "SPY")period
- For financial statements: "annual" or "quarter"from
- Start date in YYYY-MM-DD formatto
- End date in YYYY-MM-DD formatname
- For economic indicators: specific indicator name
Category-Specific Parameters
Financial Tools:
period
- "annual" or "quarter" for statement periodslimit
- Number of periods to retrieve
Market Tools:
limit
- Number of results to returnexchange
- Specific exchange (e.g., "NASDAQ", "NYSE")
Calendar Tools:
from
- Start date for calendar eventsto
- End date for calendar events
Congressional Tools:
name
- Politician name for specific trading datalimit
- Number of transactions to retrieve
Next Steps
- Vercel AI SDK Integration - Learn how to use these tools with Vercel AI SDK
- OpenAI Provider - Learn about OpenAI Agents integration
- Examples - See practical implementations
- Best Practices - Learn best practices for building robust applications
- Error Handling - Learn about comprehensive error handling
- API Documentation - For direct API access (if you need more control)
- GitHub Repository - Source code and issues
Getting Started
Tool Reference
Advanced
Tool Categories
A comprehensive overview of all available FMP Tools organized by category for easy selection and integration.
Overview
FMP Tools are organized into logical categories based on the type of financial data they provide. Each category contains related tools that work together to provide comprehensive financial insights. You can import entire categories or individual tools based on your needs.
Available Categories
📊 Quote Tools
Real-time and historical price data for stocks and other securities.
Tools:
getStockQuote
- Get real-time stock quote for a company
Use Cases:
- Real-time price monitoring
- Portfolio tracking
- Price alerts and notifications
🏢 Company Tools
Company profiles, descriptions, and basic information.
Tools:
getCompanyProfile
- Get comprehensive company profile and informationgetCompanySharesFloat
- Get company shares float and liquidity datagetCompanyExecutiveCompensation
- Get executive compensation information
Use Cases:
- Company research and analysis
- Due diligence processes
- Investment screening
- Executive compensation analysis
- Share liquidity assessment
💰 Financial Tools
Financial statements, ratios, and detailed financial metrics.
Tools:
getBalanceSheet
- Get balance sheet statements (annual/quarterly)getIncomeStatement
- Get income statements (annual/quarterly)getCashFlowStatement
- Get cash flow statements (annual/quarterly)getKeyMetrics
- Get key financial metrics and KPIs (annual/quarterly)getFinancialRatios
- Get financial ratios and metrics (annual/quarterly)getEnterpriseValue
- Get enterprise value calculations (annual/quarterly)getCashflowGrowth
- Get cash flow growth analysis (annual/quarterly)getIncomeGrowth
- Get income growth analysis (annual/quarterly)
Use Cases:
- Financial analysis and modeling
- Investment research
- Credit analysis
- Valuation models
- Growth trend analysis
- Enterprise value calculations
📈 Market Tools
Market-wide data including indices, sectors, gainers, losers, and trading activity.
Tools:
getMarketPerformance
- Get overall market performance datagetSectorPerformance
- Get sector performance datagetGainers
- Get top gaining stocksgetLosers
- Get top losing stocksgetMostActive
- Get most actively traded stocks
Use Cases:
- Market analysis and trends
- Sector rotation strategies
- Trading opportunities identification
- Market sentiment analysis
🏛️ Economic Tools
Economic indicators, treasury rates, and macroeconomic data.
Tools:
getTreasuryRates
- Get treasury rates and yieldsgetEconomicIndicators
- Get economic indicators including GDP, CPI, unemployment, inflation, retail sales, consumer sentiment, durable goods, housing starts, vehicle sales, and more
Use Cases:
- Economic analysis and forecasting
- Interest rate monitoring
- Macroeconomic research
- Policy impact assessment
- Consumer behavior analysis
- Housing market analysis
📋 ETF Tools
ETF profiles, holdings, and composition data.
Tools:
getETFHoldings
- Get holdings for a specific ETFgetETFProfile
- Get ETF profile and information
Use Cases:
- ETF research and analysis
- Portfolio diversification
- Asset allocation strategies
- ETF comparison and selection
📅 Calendar Tools
Earnings calendars and economic event schedules.
Tools:
getEarningsCalendar
- Get upcoming earnings calendargetEconomicCalendar
- Get economic calendar events
Use Cases:
- Earnings season planning
- Event-driven trading strategies
- Economic event monitoring
- Corporate calendar tracking
🏛️ Congressional Tools
Congressional trading activity and disclosures.
Tools:
getSenateTrading
- Get recent Senate trading activity by symbolgetHouseTrading
- Get recent House trading activity by symbolgetSenateTradingByName
- Get Senate trading by politician namegetHouseTradingByName
- Get House trading by politician namegetSenateTradingRSSFeed
- Get Senate trading RSS feed with paginationgetHouseTradingRSSFeed
- Get House trading RSS feed with pagination
Use Cases:
- Political trading analysis
- Insider trading research
- Policy impact assessment
- Regulatory compliance monitoring
- Congressional activity tracking
🏢 Institutional Tools
Institutional ownership and holdings data.
Tools:
getInstitutionalHolders
- Get institutional holders for a company
Use Cases:
- Institutional ownership analysis
- Shareholder research
- Corporate governance analysis
- Investment flow tracking
👤 Insider Tools
Insider trading transactions and disclosures.
Tools:
getInsiderTrading
- Get insider trading data for a company
Use Cases:
- Insider trading analysis
- Corporate insider research
- Regulatory compliance
- Investment signal analysis
📊 Stock Tools
Stock-specific data like market cap, splits, and dividends.
Tools:
getMarketCap
- Get market capitalization for a companygetStockSplits
- Get historical stock splits for a companygetDividendHistory
- Get dividend history and payments for a company
Use Cases:
- Market capitalization analysis
- Stock split tracking
- Dividend analysis
- Historical stock data research
Tool Selection Guide
For Financial Analysis Applications
Recommended Categories:
- Company Tools
- Financial Tools
- Quote Tools
Example Use Case: Building a comprehensive financial analysis tool that provides company profiles, financial statements, and real-time quotes.
For Market Research Applications
Recommended Categories:
- Market Tools
- Economic Tools
- Calendar Tools
Example Use Case: Creating a market research platform that tracks market performance, economic indicators, and upcoming events.
For Investment Research Applications
Recommended Categories:
- Quote Tools
- Company Tools
- Financial Tools
- Market Tools
- ETF Tools
Example Use Case: Developing an investment research tool that provides comprehensive analysis across multiple asset classes.
For Trading Applications
Recommended Categories:
- Quote Tools
- Market Tools
- Calendar Tools
- Congressional Tools
Example Use Case: Building a trading platform that monitors real-time prices, market activity, and relevant events.
For Economic Analysis Applications
Recommended Categories:
- Economic Tools
- Calendar Tools
- Market Tools
Example Use Case: Creating an economic analysis tool that tracks indicators, events, and market responses.
Import Examples
Vercel AI SDK
Import All Tools
Import Specific Categories
Import Individual Tools
OpenAI Agents
Import All Tools
Import Specific Categories
Import Individual Tools
Tool Parameters Reference
Common Parameters
symbol
- Stock/ETF symbol (e.g., "AAPL", "SPY")period
- For financial statements: "annual" or "quarter"from
- Start date in YYYY-MM-DD formatto
- End date in YYYY-MM-DD formatname
- For economic indicators: specific indicator name
Category-Specific Parameters
Financial Tools:
period
- "annual" or "quarter" for statement periodslimit
- Number of periods to retrieve
Market Tools:
limit
- Number of results to returnexchange
- Specific exchange (e.g., "NASDAQ", "NYSE")
Calendar Tools:
from
- Start date for calendar eventsto
- End date for calendar events
Congressional Tools:
name
- Politician name for specific trading datalimit
- Number of transactions to retrieve
Next Steps
- Vercel AI SDK Integration - Learn how to use these tools with Vercel AI SDK
- OpenAI Provider - Learn about OpenAI Agents integration
- Examples - See practical implementations
- Best Practices - Learn best practices for building robust applications
- Error Handling - Learn about comprehensive error handling
- API Documentation - For direct API access (if you need more control)
- GitHub Repository - Source code and issues