fmp-node-api 0.0.5 → 0.0.7

package/dist/index.js

@@ -13,13 +13,22 @@ function unwrapSingleObject(data) {
   }
   return data;
 }
+function normalizeArrayResponse(data) {
+  if (Array.isArray(data)) return data;
+  if (data == null) return [];
+  return data;
+}
+function normalizeObjectResponse(data) {
+  if (data == null) return {};
+  return data;
+}
 var FMPClient = class {
   constructor(config) {
     this.apiKey = config.apiKey;
     this.v3Client = this.createClient("https://financialmodelingprep.com/api/v3", config.timeout);
     this.v4Client = this.createClient("https://financialmodelingprep.com/api/v4", config.timeout);
     this.stableClient = this.createClient(
-      "https://financialmodelingprep.com/api/stable",
+      "https://financialmodelingprep.com/stable",
       config.timeout
     );
   }
@@ -35,14 +44,23 @@ var FMPClient = class {
     });
     return client;
   }
-  // Standard get method - returns raw API response
+  /**
+   * Standard get method - returns raw API response
+   *
+   * For endpoints that return arrays, this will always return an array (possibly empty) for `data` when success is true.
+   * For endpoints that return objects, data is returned as-is.
+   */
   async get(endpoint, version = "v3", params) {
     const client = this.getClientForVersion(version);
     try {
       const response = await client.get(endpoint, { params });
+      let data = response.data;
+      if (Array.isArray(data) || data == null) {
+        data = normalizeArrayResponse(data);
+      }
       return {
         success: true,
-        data: response.data,
+        data,
         status: response.status
       };
     } catch (error) {
@@ -53,14 +71,19 @@ var FMPClient = class {
       };
     }
   }
-  // Get method for single-object endpoints - unwraps single-item arrays
+  /**
+   * Get method for single-object endpoints - unwraps single-item arrays
+   *
+   * For endpoints that return single objects, this will always return an object (possibly empty) for `data` when success is true.
+   */
   async getSingle(endpoint, version = "v3", params) {
     const client = this.getClientForVersion(version);
     try {
       const response = await client.get(endpoint, { params });
+      const data = normalizeObjectResponse(unwrapSingleObject(response.data));
       return {
         success: true,
-        data: unwrapSingleObject(response.data),
+        data,
         status: response.status
       };
     } catch (error) {
@@ -208,6 +231,79 @@ var StockEndpoints = class {
   }) {
     return this.client.getSingle(`/historical-price-full/stock_dividend/${symbol}`, "v3");
   }
+  /**
+   * Get stock real time price
+   * @param symbol - The stock symbol to get the real time price for
+   * @returns The real time price for the stock
+   */
+  async getRealTimePrice({
+    symbols
+  }) {
+    const url = `stock/real-time-price/${symbols.join(",")}`;
+    const result = await this.client.get(url, "v3");
+    if (result.success && result.data && !Array.isArray(result.data)) {
+      const data = result.data;
+      if (typeof data === "object" && data !== null && "companiesPriceList" in data && Array.isArray(data.companiesPriceList)) {
+        const filteredData2 = data.companiesPriceList.filter((item) => item && item.symbol);
+        if (filteredData2.length > 0) {
+          return { ...result, data: filteredData2 };
+        }
+      }
+      if (typeof data === "object" && data !== null && "stockList" in data && Array.isArray(data.stockList)) {
+        const filteredData2 = data.stockList.filter((item) => item && item.symbol);
+        if (filteredData2.length > 0) {
+          return { ...result, data: filteredData2 };
+        }
+      }
+      if (data.symbol) {
+        return { ...result, data: [data] };
+      }
+      if (symbols.length === 1) {
+        console.warn(`No real-time price data found for symbol: ${symbols[0]}`);
+      }
+      return { ...result, data: [] };
+    }
+    const filteredData = result.data.filter((item) => item && item.symbol);
+    return { ...result, data: filteredData };
+  }
+  /**
+   * Get stock real time price full
+   * https://site.financialmodelingprep.com/developer/docs#real-time-full-price-quote
+   * @param symbols - The stock symbols to get the real time price for
+   * @returns The real time price for the stocks
+   */
+  async getRealTimePriceForMultipleStocks({
+    symbols
+  }) {
+    const url = `stock/full/real-time-price/${symbols.join(",")}`;
+    const result = await this.client.get(url, "v3");
+    if (result.success && result.data && !Array.isArray(result.data)) {
+      const data = result.data;
+      if (typeof data === "object" && data !== null && "companiesPriceList" in data && Array.isArray(data.companiesPriceList)) {
+        const filteredData2 = data.companiesPriceList.filter((item) => item && item.symbol);
+        if (filteredData2.length > 0) {
+          return { ...result, data: filteredData2 };
+        }
+      }
+      if (typeof data === "object" && data !== null && "stockList" in data && Array.isArray(data.stockList)) {
+        const filteredData2 = data.stockList.filter((item) => item && item.symbol);
+        if (filteredData2.length > 0) {
+          return { ...result, data: filteredData2 };
+        }
+      }
+      if (data.symbol) {
+        return { ...result, data: [data] };
+      }
+      if (symbols.length === 1) {
+        console.warn(`No full real-time price data found for symbol: ${symbols[0]}`);
+      }
+      return { ...result, data: [] };
+    }
+    const filteredData = result.data.filter(
+      (item) => item && item.symbol
+    );
+    return { ...result, data: filteredData };
+  }
 };
 
 // src/endpoints/financial.ts
@@ -442,21 +538,6 @@ var ForexEndpoints = class {
     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
@@ -595,50 +676,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
-   */
-  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
-   * @deprecated Use `fmp.quote.getQuote()` instead. This method will be removed in a future release.
-   * @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
-   * @deprecated Use `fmp.quote.getHistoricalPrice()` instead. This method will be removed in a future release.
-   * @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
+   * 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 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");
   }
 };
 
@@ -649,33 +693,32 @@ var EconomicEndpoints = class {
   }
   /**
    * Get treasury rates
+   * 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 = {}) {
-    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);
+  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 unemployment data
+   * 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 getUnemployment(params = {}) {
-    return this.client.get("/economic/unemployment", "v3", params);
+  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);
   }
 };
 
@@ -801,6 +844,19 @@ var CalendarEndpoints = class {
     if (to) params.to = to;
     return this.client.get("/earning_calendar", "v3", params);
   }
+  /**
+   * Get earnings confirmed
+   * https://site.financialmodelingprep.com/developer/docs#earnings-confirmed-earnings
+   * @param from - The start date to get the earnings confirmed for
+   * @param to - The end date to get the earnings confirmed for
+   * @returns The earnings confirmed
+   */
+  async getEarningsConfirmed({ from, to } = {}) {
+    const params = {};
+    if (from) params.from = from;
+    if (to) params.to = to;
+    return this.client.get("/earning-calendar-confirmed", "v4", params);
+  }
   /**
    * Get dividends calendar
    * https://site.financialmodelingprep.com/developer/docs#dividends-calendar-dividends
@@ -866,9 +922,7 @@ var CompanyEndpoints = class {
    * @param symbol - The stock symbol to get the profile for
    * @returns Get a comprehensive overview of a company with our Company Profile endpoint. This endpoint provides key information such as price, beta, market capitalization, description, headquarters, and more.
    */
-  async getCompanyProfile({
-    symbol
-  }) {
+  async getCompanyProfile({ symbol }) {
     return this.client.getSingle(`/profile/${symbol}`, "v3");
   }
   /**
@@ -889,9 +943,7 @@ var CompanyEndpoints = class {
    * @param symbol - The stock symbol to get the notes for
    * @returns Stay up-to-date on a company's financial condition, operations, and risks with our Company Notes endpoint. This endpoint provides information about notes reported by a company in their financial statements.
    */
-  async getCompanyNotes({
-    symbol
-  }) {
+  async getCompanyNotes({ symbol }) {
     const params = { symbol };
     return this.client.get(`/company-notes`, "v4", params);
   }
@@ -945,6 +997,18 @@ var CompanyEndpoints = class {
     const params = { year, quarter };
     return this.client.getSingle(`/earning_call_transcript/${symbol}`, "v3", params);
   }
+  /**
+   * Get company transcript dates
+   * https://site.financialmodelingprep.com/developer/docs#transcript-dates-earnings-transcripts
+   * @param symbol - The stock symbol to get the transcript data for
+   * @returns The FMP Company Transcript Data endpoint provides the transcript data for a company's earnings call.
+   */
+  async getCompanyTranscriptData({
+    symbol
+  }) {
+    const params = { symbol };
+    return this.client.getSingle(`/earning_call_transcript`, "v4", params);
+  }
 };
 
 // src/endpoints/quote.ts
@@ -996,6 +1060,69 @@ var QuoteEndpoints = class {
   }
 };
 
+// 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 Senate trades by name
+   * https://site.financialmodelingprep.com/developer/docs/stable#senate-trading-by-name
+   * @param name - The name of the senator to get the trades for
+   * @returns Senate trades by name
+   */
+  async getSenateTradingByName(params) {
+    const { name } = params;
+    return this.client.get("/senate-trades-by-name", "stable", { name });
+  }
+  /**
+   * 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 });
+  }
+  /** Get house trading by name
+   * https://site.financialmodelingprep.com/developer/docs/stable#house-trading-by-name
+   * @param name - The name of the representative to get the trades for
+   * @returns House trading by name
+   */
+  async getHouseTradingByName(params) {
+    const { name } = params;
+    return this.client.get("/house-trades-by-name", "stable", { name });
+  }
+};
+
 // src/fmp.ts
 var FMP = class {
   constructor(config) {
@@ -1010,9 +1137,9 @@ var FMP = class {
     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);
   }
   /**
@@ -1160,7 +1287,6 @@ var HTTP_STATUS = {
   INTERNAL_SERVER_ERROR: 500
 };
 
-exports.BondEndpoints = BondEndpoints;
 exports.COUNTRIES = COUNTRIES;
 exports.CalendarEndpoints = CalendarEndpoints;
 exports.CompanyEndpoints = CompanyEndpoints;
@@ -1185,6 +1311,7 @@ exports.PERIODS = PERIODS;
 exports.Period = Period;
 exports.QuoteEndpoints = QuoteEndpoints;
 exports.SECTORS = SECTORS;
+exports.SenateHouseEndpoints = SenateHouseEndpoints;
 exports.StockEndpoints = StockEndpoints;
 exports.formatCurrency = formatCurrency;
 exports.formatDate = formatDate;