fmp-ai-tools 0.2.0-beta.8 → 0.2.0-beta.9

package/dist/providers/openai/index.d.mts

@@ -8,6 +8,7 @@ declare const getIntraday: Tool<unknown>;
 declare const getCompanyProfile: Tool<unknown>;
 declare const getCompanySharesFloat: Tool<unknown>;
 declare const getCompanyExecutiveCompensation: Tool<unknown>;
+declare const getStockPeers: Tool<unknown>;
 declare const getEarningsCalendar: Tool<unknown>;
 declare const getEconomicCalendar: Tool<unknown>;
 declare const getTreasuryRates: Tool<unknown>;
@@ -25,6 +26,11 @@ declare const getIncomeGrowth: Tool<unknown>;
 declare const getBalanceSheetGrowth: Tool<unknown>;
 declare const getFinancialGrowth: Tool<unknown>;
 declare const getEarningsHistorical: Tool<unknown>;
+declare const getFinancialScores: Tool<unknown>;
+declare const getKeyMetricsTTM: Tool<unknown>;
+declare const getFinancialRatiosTTM: Tool<unknown>;
+declare const getRevenueProductSegmentation: Tool<unknown>;
+declare const getRevenueGeographicSegmentation: Tool<unknown>;
 declare const getInsiderTrading: Tool<unknown>;
 declare const getInstitutionalHolders: Tool<unknown>;
 declare const getMarketPerformance: Tool<unknown>;
@@ -45,6 +51,7 @@ declare const searchSymbol: Tool<unknown>;
 declare const getAnalystEstimates: Tool<unknown>;
 declare const getPriceTargetConsensus: Tool<unknown>;
 declare const getStockGrades: Tool<unknown>;
+declare const getGradesConsensus: Tool<unknown>;
 declare const getDiscountedCashFlow: Tool<unknown>;
 declare const getCompanyRating: Tool<unknown>;
 declare const getTechnicalIndicator: Tool<unknown>;
@@ -70,4 +77,4 @@ declare const senateHouseTools: Tool<unknown>[];
 declare const stockTools: Tool<unknown>[];
 declare const fmpTools: Tool<unknown>[];
 
-export { analystTools, calendarTools, companyTools, economicTools, etfTools, financialTools, fmpTools, getAnalystEstimates, getBalanceSheet, getBalanceSheetGrowth, getCashFlowStatement, getCashflowGrowth, getCompanyExecutiveCompensation, getCompanyProfile, getCompanyRating, getCompanySharesFloat, getDiscountedCashFlow, getDividendHistory, getETFHoldings, getETFProfile, getEarningsCalendar, getEarningsHistorical, getEconomicCalendar, getEconomicIndicators, getEnterpriseValue, getFinancialGrowth, getFinancialRatios, getGainers, getHistoricalPrice, getHouseTrading, getHouseTradingByName, getHouseTradingRSSFeed, getIncomeGrowth, getIncomeStatement, getInsiderTrading, getInstitutionalHolders, getIntraday, getKeyMetrics, getLosers, getMarketCap, getMarketPerformance, getMostActive, getPriceTargetConsensus, getSectorPerformance, getSenateTrading, getSenateTradingByName, getSenateTradingRSSFeed, getStockGrades, getStockNews, getStockNewsBySymbol, getStockQuote, getStockSplits, getTechnicalIndicator, getTreasuryRates, insiderTools, institutionalTools, marketTools, newsTools, quoteTools, screenStocks, screenerTools, searchSymbol, searchTools, senateHouseTools, stockTools, technicalTools, valuationTools };
+export { analystTools, calendarTools, companyTools, economicTools, etfTools, financialTools, fmpTools, getAnalystEstimates, getBalanceSheet, getBalanceSheetGrowth, getCashFlowStatement, getCashflowGrowth, getCompanyExecutiveCompensation, getCompanyProfile, getCompanyRating, getCompanySharesFloat, getDiscountedCashFlow, getDividendHistory, getETFHoldings, getETFProfile, getEarningsCalendar, getEarningsHistorical, getEconomicCalendar, getEconomicIndicators, getEnterpriseValue, getFinancialGrowth, getFinancialRatios, getFinancialRatiosTTM, getFinancialScores, getGainers, getGradesConsensus, getHistoricalPrice, getHouseTrading, getHouseTradingByName, getHouseTradingRSSFeed, getIncomeGrowth, getIncomeStatement, getInsiderTrading, getInstitutionalHolders, getIntraday, getKeyMetrics, getKeyMetricsTTM, getLosers, getMarketCap, getMarketPerformance, getMostActive, getPriceTargetConsensus, getRevenueGeographicSegmentation, getRevenueProductSegmentation, getSectorPerformance, getSenateTrading, getSenateTradingByName, getSenateTradingRSSFeed, getStockGrades, getStockNews, getStockNewsBySymbol, getStockPeers, getStockQuote, getStockSplits, getTechnicalIndicator, getTreasuryRates, insiderTools, institutionalTools, marketTools, newsTools, quoteTools, screenStocks, screenerTools, searchSymbol, searchTools, senateHouseTools, stockTools, technicalTools, valuationTools };

package/dist/providers/openai/index.d.ts

@@ -8,6 +8,7 @@ declare const getIntraday: Tool<unknown>;
 declare const getCompanyProfile: Tool<unknown>;
 declare const getCompanySharesFloat: Tool<unknown>;
 declare const getCompanyExecutiveCompensation: Tool<unknown>;
+declare const getStockPeers: Tool<unknown>;
 declare const getEarningsCalendar: Tool<unknown>;
 declare const getEconomicCalendar: Tool<unknown>;
 declare const getTreasuryRates: Tool<unknown>;
@@ -25,6 +26,11 @@ declare const getIncomeGrowth: Tool<unknown>;
 declare const getBalanceSheetGrowth: Tool<unknown>;
 declare const getFinancialGrowth: Tool<unknown>;
 declare const getEarningsHistorical: Tool<unknown>;
+declare const getFinancialScores: Tool<unknown>;
+declare const getKeyMetricsTTM: Tool<unknown>;
+declare const getFinancialRatiosTTM: Tool<unknown>;
+declare const getRevenueProductSegmentation: Tool<unknown>;
+declare const getRevenueGeographicSegmentation: Tool<unknown>;
 declare const getInsiderTrading: Tool<unknown>;
 declare const getInstitutionalHolders: Tool<unknown>;
 declare const getMarketPerformance: Tool<unknown>;
@@ -45,6 +51,7 @@ declare const searchSymbol: Tool<unknown>;
 declare const getAnalystEstimates: Tool<unknown>;
 declare const getPriceTargetConsensus: Tool<unknown>;
 declare const getStockGrades: Tool<unknown>;
+declare const getGradesConsensus: Tool<unknown>;
 declare const getDiscountedCashFlow: Tool<unknown>;
 declare const getCompanyRating: Tool<unknown>;
 declare const getTechnicalIndicator: Tool<unknown>;
@@ -70,4 +77,4 @@ declare const senateHouseTools: Tool<unknown>[];
 declare const stockTools: Tool<unknown>[];
 declare const fmpTools: Tool<unknown>[];
 
-export { analystTools, calendarTools, companyTools, economicTools, etfTools, financialTools, fmpTools, getAnalystEstimates, getBalanceSheet, getBalanceSheetGrowth, getCashFlowStatement, getCashflowGrowth, getCompanyExecutiveCompensation, getCompanyProfile, getCompanyRating, getCompanySharesFloat, getDiscountedCashFlow, getDividendHistory, getETFHoldings, getETFProfile, getEarningsCalendar, getEarningsHistorical, getEconomicCalendar, getEconomicIndicators, getEnterpriseValue, getFinancialGrowth, getFinancialRatios, getGainers, getHistoricalPrice, getHouseTrading, getHouseTradingByName, getHouseTradingRSSFeed, getIncomeGrowth, getIncomeStatement, getInsiderTrading, getInstitutionalHolders, getIntraday, getKeyMetrics, getLosers, getMarketCap, getMarketPerformance, getMostActive, getPriceTargetConsensus, getSectorPerformance, getSenateTrading, getSenateTradingByName, getSenateTradingRSSFeed, getStockGrades, getStockNews, getStockNewsBySymbol, getStockQuote, getStockSplits, getTechnicalIndicator, getTreasuryRates, insiderTools, institutionalTools, marketTools, newsTools, quoteTools, screenStocks, screenerTools, searchSymbol, searchTools, senateHouseTools, stockTools, technicalTools, valuationTools };
+export { analystTools, calendarTools, companyTools, economicTools, etfTools, financialTools, fmpTools, getAnalystEstimates, getBalanceSheet, getBalanceSheetGrowth, getCashFlowStatement, getCashflowGrowth, getCompanyExecutiveCompensation, getCompanyProfile, getCompanyRating, getCompanySharesFloat, getDiscountedCashFlow, getDividendHistory, getETFHoldings, getETFProfile, getEarningsCalendar, getEarningsHistorical, getEconomicCalendar, getEconomicIndicators, getEnterpriseValue, getFinancialGrowth, getFinancialRatios, getFinancialRatiosTTM, getFinancialScores, getGainers, getGradesConsensus, getHistoricalPrice, getHouseTrading, getHouseTradingByName, getHouseTradingRSSFeed, getIncomeGrowth, getIncomeStatement, getInsiderTrading, getInstitutionalHolders, getIntraday, getKeyMetrics, getKeyMetricsTTM, getLosers, getMarketCap, getMarketPerformance, getMostActive, getPriceTargetConsensus, getRevenueGeographicSegmentation, getRevenueProductSegmentation, getSectorPerformance, getSenateTrading, getSenateTradingByName, getSenateTradingRSSFeed, getStockGrades, getStockNews, getStockNewsBySymbol, getStockPeers, getStockQuote, getStockSplits, getTechnicalIndicator, getTreasuryRates, insiderTools, institutionalTools, marketTools, newsTools, quoteTools, screenStocks, screenerTools, searchSymbol, searchTools, senateHouseTools, stockTools, technicalTools, valuationTools };

package/dist/providers/openai/index.js

@@ -326,6 +326,12 @@ var companyDefinitions = [
     description: "Get the company executive compensation",
     inputSchema: symbolSchema,
     execute: async ({ symbol: symbol2 }) => toToolResponse(await getFMPClient().company.getExecutiveCompensation(symbol2))
+  }),
+  defineTool({
+    name: "getStockPeers",
+    description: "Get a list of peer companies (with price and market cap) for a company",
+    inputSchema: symbolSchema,
+    execute: async ({ symbol: symbol2 }) => toToolResponse(await getFMPClient().company.getStockPeers(symbol2))
   })
 ];
 var period = zod.z.enum(["annual", "quarter"]).default("annual").describe("The period type (annual or quarter)");
@@ -406,6 +412,40 @@ var financialDefinitions = [
       limit: zod.z.number().default(10).describe("The number of periods to retrieve")
     }),
     execute: async ({ symbol: symbol2, limit: limit2 }) => toToolResponse(await getFMPClient().financial.getEarningsHistorical({ symbol: symbol2, limit: limit2 }))
+  }),
+  defineTool({
+    name: "getFinancialScores",
+    description: "Get financial health scores for a company (Altman Z-Score bankruptcy risk + Piotroski fundamental-strength score)",
+    inputSchema: zod.z.object({ symbol: symbol("financial scores") }),
+    execute: async ({ symbol: symbol2 }) => toToolResponse(await getFMPClient().financial.getFinancialScores({ symbol: symbol2 }))
+  }),
+  defineTool({
+    name: "getKeyMetricsTTM",
+    description: "Get current trailing-twelve-month (TTM) key metrics for a company (one snapshot row)",
+    inputSchema: zod.z.object({ symbol: symbol("TTM key metrics") }),
+    execute: async ({ symbol: symbol2 }) => toToolResponse(await getFMPClient().financial.getKeyMetricsTTM({ symbol: symbol2 }))
+  }),
+  defineTool({
+    name: "getFinancialRatiosTTM",
+    description: "Get current trailing-twelve-month (TTM) financial ratios for a company (margins, returns, liquidity)",
+    inputSchema: zod.z.object({ symbol: symbol("TTM financial ratios") }),
+    execute: async ({ symbol: symbol2 }) => toToolResponse(await getFMPClient().financial.getFinancialRatiosTTM({ symbol: symbol2 }))
+  }),
+  defineTool({
+    name: "getRevenueProductSegmentation",
+    description: "Get revenue broken down by product line for a company",
+    inputSchema: zod.z.object({ symbol: symbol("product revenue segmentation"), period }),
+    execute: async ({ symbol: symbol2, period: period2 }) => toToolResponse(
+      await getFMPClient().financial.getRevenueProductSegmentation({ symbol: symbol2, period: period2 })
+    )
+  }),
+  defineTool({
+    name: "getRevenueGeographicSegmentation",
+    description: "Get revenue broken down by geographic region for a company",
+    inputSchema: zod.z.object({ symbol: symbol("geographic revenue segmentation"), period }),
+    execute: async ({ symbol: symbol2, period: period2 }) => toToolResponse(
+      await getFMPClient().financial.getRevenueGeographicSegmentation({ symbol: symbol2, period: period2 })
+    )
   })
 ];
 var dateRangeSchema = zod.z.object({
@@ -681,6 +721,14 @@ var analystDefinitions = [
       }
       return toToolResponse(res);
     }
+  }),
+  defineTool({
+    name: "getGradesConsensus",
+    description: "Get the analyst rating consensus for a company (counts of strongBuy/buy/hold/sell/strongSell + overall consensus)",
+    inputSchema: zod.z.object({
+      symbol: zod.z.string().min(1).describe("The stock symbol (e.g., AAPL)")
+    }),
+    execute: async ({ symbol: symbol2 }) => toToolResponse(await getFMPClient().analyst.getGradesConsensus({ symbol: symbol2 }))
   })
 ];
 var symbolSchema2 = zod.z.object({
@@ -833,6 +881,7 @@ var getIntraday = byName.getIntraday;
 var getCompanyProfile = byName.getCompanyProfile;
 var getCompanySharesFloat = byName.getCompanySharesFloat;
 var getCompanyExecutiveCompensation = byName.getCompanyExecutiveCompensation;
+var getStockPeers = byName.getStockPeers;
 var getEarningsCalendar = byName.getEarningsCalendar;
 var getEconomicCalendar = byName.getEconomicCalendar;
 var getTreasuryRates = byName.getTreasuryRates;
@@ -850,6 +899,11 @@ var getIncomeGrowth = byName.getIncomeGrowth;
 var getBalanceSheetGrowth = byName.getBalanceSheetGrowth;
 var getFinancialGrowth = byName.getFinancialGrowth;
 var getEarningsHistorical = byName.getEarningsHistorical;
+var getFinancialScores = byName.getFinancialScores;
+var getKeyMetricsTTM = byName.getKeyMetricsTTM;
+var getFinancialRatiosTTM = byName.getFinancialRatiosTTM;
+var getRevenueProductSegmentation = byName.getRevenueProductSegmentation;
+var getRevenueGeographicSegmentation = byName.getRevenueGeographicSegmentation;
 var getInsiderTrading = byName.getInsiderTrading;
 var getInstitutionalHolders = byName.getInstitutionalHolders;
 var getMarketPerformance = byName.getMarketPerformance;
@@ -870,6 +924,7 @@ var searchSymbol = byName.searchSymbol;
 var getAnalystEstimates = byName.getAnalystEstimates;
 var getPriceTargetConsensus = byName.getPriceTargetConsensus;
 var getStockGrades = byName.getStockGrades;
+var getGradesConsensus = byName.getGradesConsensus;
 var getDiscountedCashFlow = byName.getDiscountedCashFlow;
 var getCompanyRating = byName.getCompanyRating;
 var getTechnicalIndicator = byName.getTechnicalIndicator;
@@ -923,7 +978,10 @@ exports.getEconomicIndicators = getEconomicIndicators;
 exports.getEnterpriseValue = getEnterpriseValue;
 exports.getFinancialGrowth = getFinancialGrowth;
 exports.getFinancialRatios = getFinancialRatios;
+exports.getFinancialRatiosTTM = getFinancialRatiosTTM;
+exports.getFinancialScores = getFinancialScores;
 exports.getGainers = getGainers;
+exports.getGradesConsensus = getGradesConsensus;
 exports.getHistoricalPrice = getHistoricalPrice;
 exports.getHouseTrading = getHouseTrading;
 exports.getHouseTradingByName = getHouseTradingByName;
@@ -934,11 +992,14 @@ exports.getInsiderTrading = getInsiderTrading;
 exports.getInstitutionalHolders = getInstitutionalHolders;
 exports.getIntraday = getIntraday;
 exports.getKeyMetrics = getKeyMetrics;
+exports.getKeyMetricsTTM = getKeyMetricsTTM;
 exports.getLosers = getLosers;
 exports.getMarketCap = getMarketCap;
 exports.getMarketPerformance = getMarketPerformance;
 exports.getMostActive = getMostActive;
 exports.getPriceTargetConsensus = getPriceTargetConsensus;
+exports.getRevenueGeographicSegmentation = getRevenueGeographicSegmentation;
+exports.getRevenueProductSegmentation = getRevenueProductSegmentation;
 exports.getSectorPerformance = getSectorPerformance;
 exports.getSenateTrading = getSenateTrading;
 exports.getSenateTradingByName = getSenateTradingByName;
@@ -946,6 +1007,7 @@ exports.getSenateTradingRSSFeed = getSenateTradingRSSFeed;
 exports.getStockGrades = getStockGrades;
 exports.getStockNews = getStockNews;
 exports.getStockNewsBySymbol = getStockNewsBySymbol;
+exports.getStockPeers = getStockPeers;
 exports.getStockQuote = getStockQuote;
 exports.getStockSplits = getStockSplits;
 exports.getTechnicalIndicator = getTechnicalIndicator;