fmp-node-api 0.0.4 → 0.0.6

package/dist/index.js

@@ -148,16 +148,19 @@ var StockEndpoints = class {
   }
   /**
    * Get real-time stock quote
-   * https://site.financialmodelingprep.com/developer/docs#full-quote-quote
+   * @deprecated Use `fmp.quote.getQuote()` instead. This method will be removed in version 0.1.0.
    * @param symbol - The stock symbol to get the quote for
    * @returns This endpoint gives you the latest bid and ask prices for a stock, as well as the volume and last trade price in real time.
    */
   async getQuote({ symbol }) {
+    console.warn(
+      "\u26A0\uFE0F  StockEndpoints.getQuote() is deprecated. Use fmp.quote.getQuote() instead. This method will be removed in version 0.1.0."
+    );
     return this.client.getSingle(`/quote/${symbol}`, "v3");
   }
   /**
    * Get historical stock prices
-   * https://site.financialmodelingprep.com/developer/docs#daily-chart-charts
+   * @deprecated Use `fmp.quote.getHistoricalPrice()` instead. This method will be removed in version 0.1.0.
    * @param symbol - The stock symbol to get the historical prices for
    * @param from - The start date to get the historical prices for
    * @param to - The end date to get the historical prices for
@@ -168,6 +171,9 @@ var StockEndpoints = class {
     from,
     to
   }) {
+    console.warn(
+      "\u26A0\uFE0F  StockEndpoints.getHistoricalPrice() is deprecated. Use fmp.quote.getHistoricalPrice() instead. This method will be removed in version 0.1.0."
+    );
     const params = {};
     if (from) params.from = from;
     if (to) params.to = to;
@@ -405,14 +411,19 @@ var ForexEndpoints = class {
   }
   /**
    * Get forex quote
+   * @deprecated Use `fmp.quote.getQuote()` instead. This method will be removed in version 0.1.0.
    * @param params - Parameters for the forex quote request
    * @returns Forex quote data
    */
   async getQuote(params) {
+    console.warn(
+      "\u26A0\uFE0F  ForexEndpoints.getQuote() is deprecated. Use fmp.quote.getQuote() instead. This method will be removed in version 0.1.0."
+    );
     return this.client.get("/quote", "v3", params);
   }
   /**
    * Get historical forex prices
+   * @deprecated Use `fmp.quote.getHistoricalPrice()` instead. This method will be removed in version 0.1.0.
    * @param symbol - The forex symbol to get the historical prices for
    * @param from - The start date to get the historical prices for
    * @param to - The end date to get the historical prices for
@@ -423,26 +434,14 @@ var ForexEndpoints = class {
     from,
     to
   }) {
+    console.warn(
+      "\u26A0\uFE0F  ForexEndpoints.getHistoricalPrice() is deprecated. Use fmp.quote.getHistoricalPrice() instead. This method will be removed in version 0.1.0."
+    );
     const params = {};
     if (from) params.from = from;
     if (to) params.to = to;
     return this.client.get(`/historical-price-full/${symbol}`, "v3", params);
   }
-  /**
-   * Get forex rates for a specific base currency
-   * @param baseCurrency - The base currency to get forex rates for
-   * @returns Forex rates data
-   */
-  async getForexRates(baseCurrency = "USD") {
-    return this.client.get(`/forex/${baseCurrency}`, "v3");
-  }
-  /**
-   * Get all forex rates
-   * @returns All forex rates data
-   */
-  async getAllForexRates() {
-    return this.client.get("/forex", "v3");
-  }
 };
 
 // src/endpoints/crypto.ts
@@ -452,16 +451,19 @@ var CryptoEndpoints = class {
   }
   /**
    * Get crypto quote
-   * https://site.financialmodelingprep.com/developer/docs#full-quote-crypto
+   * @deprecated Use `fmp.quote.getQuote()` instead. This method will be removed in version 0.1.0.
    * @param symbol - The crypto symbol to get the quote for
    * @returns Crypto quote data
    */
   async getQuote({ symbol }) {
+    console.warn(
+      "\u26A0\uFE0F  CryptoEndpoints.getQuote() is deprecated. Use fmp.quote.getQuote() instead. This method will be removed in version 0.1.0."
+    );
     return this.client.getSingle(`/quote/${symbol}`, "v3");
   }
   /**
    * Get historical crypto prices
-   * https://site.financialmodelingprep.com/developer/docs#cryptocurrency-daily-crypto
+   * @deprecated Use `fmp.quote.getHistoricalPrice()` instead. This method will be removed in version 0.1.0.
    * @param symbol - The crypto symbol to get the historical prices for
    * @param from - The start date to get the historical prices for
    * @param to - The end date to get the historical prices for
@@ -472,6 +474,9 @@ var CryptoEndpoints = class {
     from,
     to
   }) {
+    console.warn(
+      "\u26A0\uFE0F  CryptoEndpoints.getHistoricalPrice() is deprecated. Use fmp.quote.getHistoricalPrice() instead. This method will be removed in version 0.1.0."
+    );
     const params = {};
     if (from) params.from = from;
     if (to) params.to = to;
@@ -567,6 +572,7 @@ var MutualFundEndpoints = class {
   }
   /**
    * Get mutual fund quote
+   * @deprecated Use `fmp.quote.getQuote()` instead. This method will be removed in a future release.
    * @param params - Parameters for the mutual fund quote request
    * @returns Mutual fund quote data
    */
@@ -574,48 +580,13 @@ var MutualFundEndpoints = class {
     return this.client.get("/quote", "v3", params);
   }
   /**
-   * Get mutual fund profile
-   */
-  async getProfile(params) {
-    return this.client.get("/profile", "v3", params);
-  }
-  /**
-   * Get mutual fund holdings
+   * Get mutual fund holders
+   * https://site.financialmodelingprep.com/developer/docs#mutual-fund-holder-mutual-funds-holdings
+   * @param symbol - The symbol of the mutual fund to get the holders for
+   * @returns Mutual fund holders data
    */
-  async getHoldings(params) {
-    return this.client.get("/holdings", "v3", params);
-  }
-};
-
-// src/endpoints/bond.ts
-var BondEndpoints = class {
-  constructor(client) {
-    this.client = client;
-  }
-  /**
-   * Get bond quote
-   * @param params - Parameters for the bond quote request
-   * @returns Bond quote data
-   */
-  async getQuote(params) {
-    return this.client.get("/quote", "v3", params);
-  }
-  /**
-   * Get historical bond prices
-   * @param symbol - The bond symbol to get the historical prices for
-   * @param from - The start date to get the historical prices for
-   * @param to - The end date to get the historical prices for
-   * @returns Historical bond price data
-   */
-  async getHistoricalPrice({
-    symbol,
-    from,
-    to
-  }) {
-    const params = {};
-    if (from) params.from = from;
-    if (to) params.to = to;
-    return this.client.get(`/historical-price-full/${symbol}`, "v3", params);
+  async getHolders({ symbol }) {
+    return this.client.get(`/mutual-fund-holder/${symbol}`, "v3");
   }
 };
 
@@ -626,33 +597,32 @@ var EconomicEndpoints = class {
   }
   /**
    * Get treasury rates
-   */
-  async getTreasuryRates(params = {}) {
-    return this.client.get("/treasury-rates", "v3", params);
-  }
-  /**
-   * Get federal funds rate
-   */
-  async getFederalFundsRate(params = {}) {
-    return this.client.get("/federal-funds-rate", "v3", params);
-  }
-  /**
-   * Get CPI data
-   */
-  async getCPI(params = {}) {
-    return this.client.get("/economic/cpi", "v3", params);
-  }
-  /**
-   * Get GDP data
-   */
-  async getGDP(params = {}) {
-    return this.client.get("/economic/gdp", "v3", params);
-  }
-  /**
-   * Get unemployment data
-   */
-  async getUnemployment(params = {}) {
-    return this.client.get("/economic/unemployment", "v3", params);
+   * https://site.financialmodelingprep.com/developer/docs#treasury-rates-economics-data
+   * @param from - The start date to get the treasury rates for
+   * @param to - The end date to get the treasury rates for
+   * @returns Treasury rates data
+   */
+  async getTreasuryRates(params) {
+    const { from, to } = params;
+    const queryParams = {};
+    if (from) queryParams.from = from;
+    if (to) queryParams.to = to;
+    return this.client.get("/treasury", "v4", queryParams);
+  }
+  /**
+   * Get economic indicators
+   * https://site.financialmodelingprep.com/developer/docs#economic-indicators-economics-data
+   * @param name - GDP, realGDP, nominalPotentialGDP, realGDPPerCapita, federalFunds, CPI, inflationRate, inflation, retailSales, consumerSentiment, durableGoods, unemploymentRate, totalNonfarmPayroll, initialClaims, industrialProductionTotalIndex, newPrivatelyOwnedHousingUnitsStartedTotalUnits, totalVehicleSales, retailMoneyFunds, smoothedUSRecessionProbabilities, 3MonthOr90DayRatesAndYieldsCertificatesOfDeposit, commercialBankInterestRateOnCreditCardPlansAllAccounts, 30YearFixedRateMortgageAverage, 15YearFixedRateMortgageAverage
+   * @param from - The start date to get the economic indicators for
+   * @param to - The end date to get the economic indicators for
+   * @returns Provides real-time and historical economic data for a variety of economic indicators, such as GDP, unemployment, and inflation.
+   */
+  async getEconomicIndicators(params) {
+    const { name, from, to } = params;
+    const queryParams = { name };
+    if (from) queryParams.from = from;
+    if (to) queryParams.to = to;
+    return this.client.get(`/economic`, "v4", queryParams);
   }
 };
 
@@ -924,6 +894,100 @@ var CompanyEndpoints = class {
   }
 };
 
+// src/endpoints/quote.ts
+var QuoteEndpoints = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get quote for any asset type (stock, crypto, forex, commodity, ETF)
+   * @param params - Parameters for the quote request
+   * @returns Quote data for the specified asset
+   */
+  async getQuote(params) {
+    const { symbol } = params;
+    return this.client.getSingle(`/quote/${symbol}`, "v3");
+  }
+  /**
+   * Get historical prices for any asset type
+   * @param params - Parameters for the historical price request
+   * @returns Historical price data for the specified asset
+   */
+  async getHistoricalPrice(params) {
+    const { symbol, from, to } = params;
+    const queryParams = {};
+    if (from) queryParams.from = from;
+    if (to) queryParams.to = to;
+    return this.client.getSingle(`/historical-price-full/${symbol}`, "v3", queryParams);
+  }
+  /**
+   * Get multiple quotes for any asset type
+   * @param symbols - Array of symbols to get quotes for
+   * @returns Array of quote data
+   */
+  async getQuotes(symbols) {
+    const symbolsParam = symbols.join(",");
+    return this.client.get(`/quote/${symbolsParam}`, "v3");
+  }
+  /**
+   * Get intraday data for any asset type
+   * @param params - Parameters for the intraday request
+   * @returns Intraday price data for the specified asset
+   */
+  async getIntraday(params) {
+    const { symbol, interval, from, to } = params;
+    const queryParams = {};
+    if (from) queryParams.from = from;
+    if (to) queryParams.to = to;
+    return this.client.get(`/historical-chart/${interval}/${symbol}`, "v3", queryParams);
+  }
+};
+
+// src/endpoints/senate-house.ts
+var SenateHouseEndpoints = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get senate trading data only
+   * https://site.financialmodelingprep.com/developer/docs#senate-trading
+   * @param symbol - The stock symbol to get the senate trading data for
+   * @returns Senate trading data only
+   */
+  async getSenateTrading(params) {
+    const { symbol } = params;
+    return this.client.get(`/senate-trading`, "v4", { symbol });
+  }
+  /** Get senate trading RSS feed
+   * https://site.financialmodelingprep.com/developer/docs#senate-trading-rss-feed-senate
+   * @param page - The page number to get
+   * @returns Senate trading RSS feed
+   */
+  async getSenateTradingRSSFeed(params) {
+    const { page } = params;
+    return this.client.get("/senate-trading-rss-feed", "v4", { page });
+  }
+  /**
+   * Get house trading data only
+   * https://site.financialmodelingprep.com/developer/docs#house-disclosure
+   * @param symbol - The stock symbol to get the house trading data for
+   * @returns House trading data only
+   */
+  async getHouseTrading(params) {
+    const { symbol } = params;
+    return this.client.get("/senate-disclosure", "v4", { symbol });
+  }
+  /** Get house trading RSS feed
+   * https://site.financialmodelingprep.com/developer/docs#house-disclosure-rss-feed-senate
+   * @param page - The page number to get
+   * @returns House trading RSS feed
+   */
+  async getHouseTradingRSSFeed(params) {
+    const { page } = params;
+    return this.client.get("/senate-disclosure-rss-feed", "v4", { page });
+  }
+};
+
 // src/fmp.ts
 var FMP = class {
   constructor(config) {
@@ -937,9 +1001,10 @@ var FMP = class {
     this.list = new ListEndpoints(client);
     this.calendar = new CalendarEndpoints(client);
     this.company = new CompanyEndpoints(client);
+    this.quote = new QuoteEndpoints(client);
+    this.senateHouse = new SenateHouseEndpoints(client);
     this.forex = new ForexEndpoints(client);
     this.economic = new EconomicEndpoints(client);
-    this.bond = new BondEndpoints(client);
     this.mutualFund = new MutualFundEndpoints(client);
   }
   /**
@@ -1087,7 +1152,6 @@ var HTTP_STATUS = {
   INTERNAL_SERVER_ERROR: 500
 };
 
-exports.BondEndpoints = BondEndpoints;
 exports.COUNTRIES = COUNTRIES;
 exports.CalendarEndpoints = CalendarEndpoints;
 exports.CompanyEndpoints = CompanyEndpoints;
@@ -1110,7 +1174,9 @@ exports.MarketEndpoints = MarketEndpoints;
 exports.MutualFundEndpoints = MutualFundEndpoints;
 exports.PERIODS = PERIODS;
 exports.Period = Period;
+exports.QuoteEndpoints = QuoteEndpoints;
 exports.SECTORS = SECTORS;
+exports.SenateHouseEndpoints = SenateHouseEndpoints;
 exports.StockEndpoints = StockEndpoints;
 exports.formatCurrency = formatCurrency;
 exports.formatDate = formatDate;