fmp-node-api 0.0.6 → 0.0.8

package/dist/index.mjs

@@ -7,13 +7,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
     );
   }
@@ -29,37 +38,55 @@ 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,
+        error: null,
         status: response.status
       };
     } catch (error) {
       return {
         success: false,
+        data: null,
         error: error.message || "Unknown error occurred",
         status: error.response?.status || 500
       };
     }
   }
-  // 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,
+        error: null,
         status: response.status
       };
     } catch (error) {
       return {
         success: false,
+        data: null,
         error: error.message || "Unknown error occurred",
         status: error.response?.status || 500
       };
@@ -202,6 +229,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
@@ -742,6 +842,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
@@ -807,9 +920,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");
   }
   /**
@@ -830,9 +941,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);
   }
@@ -886,6 +995,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
@@ -961,6 +1082,15 @@ var SenateHouseEndpoints = class {
     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
@@ -980,6 +1110,298 @@ var SenateHouseEndpoints = class {
     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/endpoints/institutional.ts
+var InstitutionalEndpoints = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get Form 13F institutional stock ownership data
+   * https://site.financialmodelingprep.com/developer/docs#form-13f-13f---institutional-stock-ownership
+   * @param symbol - The stock symbol to get the Form 13F data for
+   * @param date - The date to get the Form 13F data for (optional)
+   * @returns Form 13F institutional stock ownership data
+   */
+  async getForm13F(params) {
+    const { cik, date } = params;
+    const queryParams = {};
+    if (date) queryParams.date = date;
+    return this.client.get(`/form-thirteen/${cik}`, "v3", queryParams);
+  }
+  /**
+   * Get Form 13F dates for institutional stock ownership
+   * https://site.financialmodelingprep.com/developer/docs#form-13f-dates-13f---institutional-stock-ownership
+   * @param symbol - The stock symbol to get the Form 13F dates for
+   * @returns Form 13F dates for institutional stock ownership
+   */
+  async getForm13FDates(params) {
+    const { cik } = params;
+    return this.client.get(`/form-thirteen-date/${cik}`, "v3");
+  }
+  /**
+   * Get institutional holders data
+   * https://site.financialmodelingprep.com/developer/docs#institutional-holder-13f---institutional-stock-ownership
+   * @param symbol - The stock symbol to get the institutional holders for
+   * @returns Institutional holders data
+   */
+  async getInstitutionalHolders(params) {
+    const { symbol } = params;
+    return this.client.get(`/institutional-holder/${symbol}`, "v3");
+  }
+};
+
+// src/endpoints/insider.ts
+var InsiderEndpoints = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get insider trading RSS feed
+   * https://site.financialmodelingprep.com/developer/docs#insider-trades-rss-insider-trading
+   * @param params - Parameters for the RSS feed request
+   * @returns An RSS feed of insider trades, updated in real time
+   */
+  async getInsiderTradingRSS({
+    page
+  }) {
+    return this.client.get(`/insider-trading-rss-feed`, "v4", { page });
+  }
+  /**
+   * Search for insider trades
+   * https://site.financialmodelingprep.com/developer/docs#insider-trades-search-insider-trading
+   * @param params - Parameters for the insider trading search
+   * @returns A list of insider trades filtered by the provided parameters
+   */
+  async searchInsiderTrading({
+    symbol,
+    reportingCik,
+    companyCik,
+    transactionType,
+    page
+  }) {
+    const params = { page };
+    if (symbol) params.symbol = symbol;
+    if (reportingCik) params.reportingCik = reportingCik;
+    if (companyCik) params.companyCik = companyCik;
+    if (transactionType) params.transactionType = transactionType;
+    return this.client.get(`/insider-trading`, "v4", params);
+  }
+  /**
+   * Get transaction types
+   * https://site.financialmodelingprep.com/developer/docs#transaction-types-insider-trading
+   * @returns A list of all insider transaction types
+   */
+  async getTransactionTypes() {
+    return this.client.get(`/insider-trading-transaction-type`, "v4");
+  }
+  /**
+   * Get insiders by symbol
+   * https://site.financialmodelingprep.com/developer/docs#insiders-by-symbol-insider-trading
+   * @param params - Parameters for the insiders request
+   * @returns A list of insiders for a specific company
+   */
+  async getInsidersBySymbol({
+    symbol
+  }) {
+    return this.client.get(`/insider-roaster`, "v4", { symbol });
+  }
+  /**
+   * Get insider trade statistics
+   * https://site.financialmodelingprep.com/developer/docs#insider-trade-statistics-insider-trading
+   * @param params - Parameters for the statistics request
+   * @returns Statistics on insider trading activity for a specific company
+   */
+  async getInsiderTradeStatistics({
+    symbol
+  }) {
+    return this.client.get(`/insider-roaster-statistic`, "v4", { symbol });
+  }
+  /**
+   * Get CIK mapper
+   * https://site.financialmodelingprep.com/developer/docs#cik-mapper-insider-trading
+   * @param params - Parameters for the CIK mapper request
+   * @returns A list of CIK numbers and corresponding company names
+   */
+  async getCikMapper({ page }) {
+    return this.client.get(`/mapper-cik-name`, "v4", { page });
+  }
+  /**
+   * Get CIK mapper by name
+   * https://site.financialmodelingprep.com/developer/docs#cik-mapper-by-name-insider-trading
+   * @param params - Parameters for the CIK mapper by name request
+   * @returns A list of CIK numbers and corresponding names matching the search term
+   */
+  async getCikMapperByName({
+    name,
+    page = 0
+  }) {
+    return this.client.get(`/mapper-cik-name`, "v4", { name, page });
+  }
+  /**
+   * Get CIK mapper by symbol
+   * https://site.financialmodelingprep.com/developer/docs#cik-mapper-company-insider-trading
+   * @param params - Parameters for the CIK mapper by symbol request
+   * @returns CIK number and corresponding company name for a specific symbol
+   */
+  async getCikMapperBySymbol({
+    symbol
+  }) {
+    return this.client.getSingle(`/mapper-cik-company/${symbol}`, "v4");
+  }
+  /**
+   * Get beneficial ownership acquisitions
+   * https://site.financialmodelingprep.com/developer/docs#acquisition-of-beneficial-ownership
+   * @param params - Parameters for the beneficial ownership request
+   * @returns A list of acquisitions of beneficial ownership for a specific company
+   */
+  async getBeneficialOwnership({
+    symbol
+  }) {
+    return this.client.get(`/insider/ownership/acquisition_of_beneficial_ownership`, "v4", {
+      symbol
+    });
+  }
+  /**
+   * Get fail to deliver data
+   * https://site.financialmodelingprep.com/developer/docs#fail-to-deliver
+   * @param params - Parameters for the fail to deliver request
+   * @returns A list of fail to deliver data for a specific company
+   */
+  async getFailToDeliver({
+    symbol,
+    page = 0
+  }) {
+    return this.client.get(`/fail_to_deliver`, "v4", { symbol, page });
+  }
+  /**
+   * Get all insider trades for a symbol (convenience method)
+   * @param symbol - The stock symbol to get insider trades for
+   * @param page - Page number for pagination (default: 0)
+   * @returns A list of insider trades for the specified symbol
+   */
+  async getInsiderTradesBySymbol(symbol, page = 0) {
+    return this.searchInsiderTrading({ symbol, page });
+  }
+  /**
+   * Get insider trades by transaction type (convenience method)
+   * @param transactionType - The transaction type to filter by
+   * @param page - Page number for pagination (default: 0)
+   * @returns A list of insider trades filtered by transaction type
+   */
+  async getInsiderTradesByType(transactionType, page = 0) {
+    return this.searchInsiderTrading({ transactionType, page });
+  }
+  /**
+   * Get insider trades by reporting CIK (convenience method)
+   * @param reportingCik - The reporting CIK to filter by
+   * @param page - Page number for pagination (default: 0)
+   * @returns A list of insider trades filtered by reporting CIK
+   */
+  async getInsiderTradesByReportingCik(reportingCik, page = 0) {
+    return this.searchInsiderTrading({ reportingCik, page });
+  }
+  /**
+   * Get insider trades by company CIK (convenience method)
+   * @param companyCik - The company CIK to filter by
+   * @param page - Page number for pagination (default: 0)
+   * @returns A list of insider trades filtered by company CIK
+   */
+  async getInsiderTradesByCompanyCik(companyCik, page = 0) {
+    return this.searchInsiderTrading({ companyCik, page });
+  }
+};
+
+// src/endpoints/sec.ts
+var SECEndpoints = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get RSS feed of SEC filings
+   * https://site.financialmodelingprep.com/developer/docs#rss-feed-securities-and-exchange-commission-(s.e.c)
+   * @param params - RSS feed parameters
+   * @returns A real-time feed of SEC filings from publicly traded companies, including the filing type, link to SEC page, and direct link to the filing. This endpoint can be used to stay up-to-date on the latest SEC filings for all companies or for a specific set of companies.
+   */
+  async getRSSFeed(params) {
+    return this.client.get("/rss_feed", "v4", params);
+  }
+  /**
+   * Get RSS feed of all SEC filings
+   * https://site.financialmodelingprep.com/developer/docs#rss-feed-all-securities-and-exchange-commission-(s.e.c)
+   * @param params - RSS feed all parameters
+   * @returns A real-time feed of all SEC filings from publicly traded companies in the latest RSS feed format. This endpoint provides a comprehensive overview of all SEC filings, including the filing type, link to SEC page, and direct link to the filing.
+   */
+  async getRSSFeedAll(params) {
+    return this.client.get("/rss_feed_all", "v4", params);
+  }
+  /**
+   * Get RSS feed V3 of SEC filings
+   * https://site.financialmodelingprep.com/developer/docs#rss-feed-v3-securities-and-exchange-commission-(s.e.c)
+   * @param params - RSS feed V3 parameters
+   * @returns A real-time feed of SEC filings from publicly traded companies in the latest RSS feed format (V3)
+   */
+  async getRSSFeedV3(params) {
+    return this.client.get("/rss_feed", "v3", params);
+  }
+  /**
+   * Get RSS feed of 8-K SEC filings
+   * https://site.financialmodelingprep.com/developer/docs#rss-feed-8-k-securities-and-exchange-commission-(s.e.c)
+   * @param params - RSS feed 8-K parameters
+   * @returns A real-time feed of 8-K SEC filings from publicly traded companies
+   */
+  async getRSSFeed8K(params) {
+    return this.client.get("/rss_feed_8k", "v4", params);
+  }
+  /**
+   * Get SEC filings for a specific company
+   * https://site.financialmodelingprep.com/developer/docs#sec-filings-securities-and-exchange-commission-(s.e.c)
+   * @param symbol - The stock symbol to get SEC filings for
+   * @param params - SEC filings parameters
+   * @returns Access direct links to SEC filings, including the filing type, link to the SEC page, and direct link to the specific filing
+   */
+  async getSECFilings({
+    symbol,
+    params
+  }) {
+    return this.client.get(`/sec_filings/${symbol}`, "v3", params);
+  }
+  /**
+   * Get individual industry classification
+   * https://site.financialmodelingprep.com/developer/docs#individual-industry-classification-standard-industrial-classification
+   * @param params - Industry classification parameters
+   * @returns Identify the industry in which a particular company operates, based on the Standard Industrial Classification (SIC) system
+   */
+  async getIndividualIndustryClassification(params) {
+    return this.client.getSingle("/standard_industrial_classification", "v4", params);
+  }
+  /**
+   * Get all industry classifications
+   * https://site.financialmodelingprep.com/developer/docs#all-industry-classification-standard-industrial-classification
+   * @returns Get a comprehensive overview of all industries, classified according to the SIC system
+   */
+  async getAllIndustryClassifications() {
+    return this.client.get("/standard_industrial_classification/all", "v4");
+  }
+  /**
+   * Get industry classification codes
+   * https://site.financialmodelingprep.com/developer/docs#industry-classification-codes-standard-industrial-classification
+   * @param params - Industry classification codes parameters
+   * @returns Learn more about the SIC system and identify the SIC code for a particular industry
+   */
+  async getIndustryClassificationCodes(params) {
+    return this.client.get("/standard_industrial_classification_list", "v4", params);
+  }
 };
 
 // src/fmp.ts
@@ -997,6 +1419,9 @@ var FMP = class {
     this.company = new CompanyEndpoints(client);
     this.quote = new QuoteEndpoints(client);
     this.senateHouse = new SenateHouseEndpoints(client);
+    this.institutional = new InstitutionalEndpoints(client);
+    this.insider = new InsiderEndpoints(client);
+    this.sec = new SECEndpoints(client);
     this.forex = new ForexEndpoints(client);
     this.economic = new EconomicEndpoints(client);
     this.mutualFund = new MutualFundEndpoints(client);
@@ -1027,6 +1452,29 @@ var Exchange = /* @__PURE__ */ ((Exchange2) => {
   return Exchange2;
 })(Exchange || {});
 
+// src/types/insider.ts
+var TransactionType = /* @__PURE__ */ ((TransactionType2) => {
+  TransactionType2["AWARD"] = "A-Award";
+  TransactionType2["CONVERSION"] = "C-Conversion";
+  TransactionType2["RETURN"] = "D-Return";
+  TransactionType2["EXPIRE_SHORT"] = "E-ExpireShort";
+  TransactionType2["IN_KIND"] = "F-InKind";
+  TransactionType2["GIFT"] = "G-Gift";
+  TransactionType2["EXPIRE_LONG"] = "H-ExpireLong";
+  TransactionType2["DISCRETIONARY"] = "I-Discretionary";
+  TransactionType2["OTHER"] = "J-Other";
+  TransactionType2["SMALL"] = "L-Small";
+  TransactionType2["EXEMPT"] = "M-Exempt";
+  TransactionType2["OUT_OF_THE_MONEY"] = "O-OutOfTheMoney";
+  TransactionType2["PURCHASE"] = "P-Purchase";
+  TransactionType2["SALE"] = "S-Sale";
+  TransactionType2["TENDER"] = "U-Tender";
+  TransactionType2["WILL"] = "W-Will";
+  TransactionType2["IN_THE_MONEY"] = "X-InTheMoney";
+  TransactionType2["TRUST"] = "Z-Trust";
+  return TransactionType2;
+})(TransactionType || {});
+
 // src/utils/formatting.ts
 function formatCurrency(value, currency = "USD") {
   return new Intl.NumberFormat("en-US", {
@@ -1146,6 +1594,6 @@ var HTTP_STATUS = {
   INTERNAL_SERVER_ERROR: 500
 };
 
-export { COUNTRIES, CalendarEndpoints, CompanyEndpoints, CryptoEndpoints, DEFAULT_LIMIT, DEFAULT_TIMEOUT, ERROR_MESSAGES, ETFEndpoints, EXCHANGES, EconomicEndpoints, Exchange, FMP, FMPClient, FinancialEndpoints, ForexEndpoints, HTTP_STATUS, ListEndpoints, MAX_LIMIT, MarketEndpoints, MutualFundEndpoints, PERIODS, Period, QuoteEndpoints, SECTORS, SenateHouseEndpoints, StockEndpoints, formatCurrency, formatDate, formatLargeNumber, formatNumber, formatPercentage, formatReadableDate, formatTimestamp, formatVolume, validateApiKey, validateDate, validateLimit, validatePage, validatePeriod, validateSymbol };
+export { COUNTRIES, CalendarEndpoints, CompanyEndpoints, CryptoEndpoints, DEFAULT_LIMIT, DEFAULT_TIMEOUT, ERROR_MESSAGES, ETFEndpoints, EXCHANGES, EconomicEndpoints, Exchange, FMP, FMPClient, FinancialEndpoints, ForexEndpoints, HTTP_STATUS, InsiderEndpoints, InstitutionalEndpoints, ListEndpoints, MAX_LIMIT, MarketEndpoints, MutualFundEndpoints, PERIODS, Period, QuoteEndpoints, SECEndpoints, SECTORS, SenateHouseEndpoints, StockEndpoints, TransactionType, formatCurrency, formatDate, formatLargeNumber, formatNumber, formatPercentage, formatReadableDate, formatTimestamp, formatVolume, validateApiKey, validateDate, validateLimit, validatePage, validatePeriod, validateSymbol };
 //# sourceMappingURL=index.mjs.map
 //# sourceMappingURL=index.mjs.map