fmp-node-api 0.0.3 → 0.0.4

package/dist/index.d.ts

@@ -14,13 +14,6 @@ interface ErrorResponse extends APIResponse<never> {
     error: string;
     status: number;
 }
-type UnwrapSingle<T> = T extends [infer U] ? U : T extends (infer U)[] ? U | U[] : T;
-interface UnwrappedAPIResponse<T = unknown> {
-    success: boolean;
-    data?: UnwrapSingle<T>;
-    error?: string;
-    status?: number;
-}
 interface FMPConfig {
     apiKey: string;
     baseURL?: string;
@@ -130,6 +123,10 @@ interface StockSplit {
     numerator: number;
     denominator: number;
 }
+interface StockSplitResponse {
+    symbol: string;
+    historical: StockSplit[];
+}
 interface StockDividend {
     date: string;
     label: string;
@@ -139,16 +136,15 @@ interface StockDividend {
     paymentDate: string;
     declarationDate: string;
 }
+interface StockDividendResponse {
+    symbol: string;
+    historical: StockDividend[];
+}
 interface MarketCap {
     symbol: string;
     date: string;
     marketCap: number;
 }
-interface StockHistoricalPriceData extends HistoricalPriceData {
-}
-interface StockHistoricalPriceResponse extends HistoricalPriceResponse {
-    historical: StockHistoricalPriceData[];
-}
 
 interface FinancialStatementsParams extends SymbolParams, PeriodParams {
     limit?: number;
@@ -547,6 +543,23 @@ interface FinancialGrowth extends GrowthStatementBase {
     rdexpenseGrowth: number;
     sgaexpensesGrowth: number;
 }
+interface EarningsHistorical {
+    date: string;
+    symbol: string;
+    eps: number;
+    epsEstimated: number;
+    time: string;
+    revenue: number;
+    revenueEstimated: number;
+    updatedFromDate: string;
+    fiscalDateEnding: string;
+}
+interface EarningsSurprises {
+    date: string;
+    symbol: string;
+    actualEarningResult: number;
+    estimatedEarning: number;
+}
 
 interface ForexQuoteParams extends SymbolParams {
 }
@@ -579,8 +592,6 @@ interface ForexQuote {
     timestamp: number;
 }
 
-interface CryptoQuoteParams extends SymbolParams {
-}
 interface CryptoHistoricalParams extends SymbolParams, DateRangeParams {
     timeseries?: number;
 }
@@ -588,13 +599,14 @@ interface CryptoListParams {
 }
 interface CryptoQuote {
     symbol: string;
+    name: string;
     price: number;
     changesPercentage: number;
     change: number;
     dayLow: number;
     dayHigh: number;
-    yearLow: number;
     yearHigh: number;
+    yearLow: number;
     marketCap: number;
     priceAvg50: number;
     priceAvg200: number;
@@ -603,86 +615,86 @@ interface CryptoQuote {
     exchange: string;
     open: number;
     previousClose: number;
-    eps: number;
-    pe: number;
-    earningsAnnouncement: string;
+    eps: number | null;
+    pe: number | null;
+    earningsAnnouncement: string | null;
     sharesOutstanding: number;
     timestamp: number;
 }
 
-interface ETFQuoteParams extends SymbolParams {
-}
-interface ETFProfileParams extends SymbolParams {
-}
-interface ETFHoldersParams extends SymbolParams, PaginationParams {
-}
-interface ETFListParams {
+interface ETFHoldingDates {
+    date: string;
 }
-interface ETFQuote {
+interface ETFHolding {
+    cik: string;
+    acceptanceTime: string;
+    date: string;
     symbol: string;
-    price: number;
-    changesPercentage: number;
-    change: number;
-    dayLow: number;
-    dayHigh: number;
-    yearLow: number;
-    yearHigh: number;
-    marketCap: number;
-    priceAvg50: number;
-    priceAvg200: number;
-    volume: number;
-    avgVolume: number;
-    exchange: string;
-    open: number;
-    previousClose: number;
-    eps: number;
-    pe: number;
-    earningsAnnouncement: string;
-    sharesOutstanding: number;
-    timestamp: number;
+    name: string;
+    lei: string;
+    title: string;
+    cusip: string;
+    isin: string;
+    balance: number;
+    units: string;
+    cur_cd: string;
+    valUsd: number;
+    pctVal: number;
+    payoffProfile: string;
+    assetCat: string;
+    issuerCat: string;
+    invCountry: string;
+    isRestrictedSec: string;
+    fairValLevel: string;
+    isCashCollateral: string;
+    isNonCashCollateral: string;
+    isLoanByFund: string;
+}
+interface ETFHolder {
+    asset: string;
+    name: string;
+    isin: string;
+    cusip: string;
+    sharesNumber: number;
+    weightPercentage: number;
+    marketValue: number;
+    updated: string;
 }
 interface ETFProfile {
     symbol: string;
-    price: number;
-    beta: number;
-    volAvg: number;
-    marketCap: number;
-    lastDiv: number;
-    range: string;
-    changes: number;
-    companyName: string;
-    currency: string;
-    cik: string;
-    isin: string;
+    assetClass: string;
+    aum: number;
+    avgVolume: number;
     cusip: string;
-    exchange: string;
-    exchangeShortName: string;
-    industry: string;
-    website: string;
     description: string;
-    ceo: string;
+    domicile: string;
+    etfCompany: string;
+    expenseRatio: number;
+    inceptionDate: string;
+    isin: string;
+    name: string;
+    nav: number;
+    navCurrency: string;
+    sectorsList: {
+        exposure: string;
+        industry: string;
+    }[];
+    website: string;
+    holdingsCount: number;
+}
+interface ETFWeighting {
     sector: string;
+    weightPercentage: string;
+}
+interface ETFCountryWeighting {
     country: string;
-    fullTimeEmployees: string;
-    phone: string;
-    address: string;
-    city: string;
-    state: string;
-    zip: string;
-    dcfDiff: number;
-    dcf: number;
-    image: string;
-    ipoDate: string;
-    defaultImage: boolean;
-    isEtf: boolean;
-    isActivelyTrading: boolean;
-    isAdr: boolean;
-    isFund: boolean;
+    weightPercentage: string;
 }
-interface ETFHolding {
-    asset: string;
-    weightPercent: number;
-    shares: number;
+interface ETFStockExposure {
+    etfSymbol: string;
+    assetExposure: string;
+    sharesNumber: number;
+    weightPercentage: number;
     marketValue: number;
 }
 
@@ -849,56 +861,36 @@ interface Unemployment {
     changePercent: number;
 }
 
-interface MarketHoursParams {
-}
-interface MarketPerformanceParams {
-}
-interface MarketGainersParams {
-}
-interface MarketLosersParams {
-}
-interface MarketMostActiveParams {
-}
-interface MarketSectorPerformanceParams {
-}
-interface MarketIndexParams extends DateRangeParams {
-}
 interface MarketHours {
     stockExchangeName: string;
     stockMarketHours: {
         openingHour: string;
         closingHour: string;
-        gmtOffset: number;
     };
-    holidays: string[];
+    stockMarketHolidays: MarketHoliday[];
     isTheStockMarketOpen: boolean;
     isTheEuronextMarketOpen: boolean;
     isTheForexMarketOpen: boolean;
     isTheCryptoMarketOpen: boolean;
 }
+interface MarketHoliday {
+    year: number;
+    'Martin Luther King, Jr. Day': string;
+    "Presidents' Day": string;
+    'Good Friday': string;
+    'Memorial Day': string;
+    Juneteenth: string;
+    'Independence Day': string;
+    'Labor Day': string;
+    'Thanksgiving Day': string;
+    Christmas: string;
+}
 interface MarketPerformance {
-    ticker: string;
-    companyName: string;
+    symbol: string;
+    name: string;
+    change: number;
     price: number;
     changesPercentage: number;
-    changes: number;
-    dayLow: number;
-    dayHigh: number;
-    yearLow: number;
-    yearHigh: number;
-    marketCap: number;
-    priceAvg50: number;
-    priceAvg200: number;
-    volume: number;
-    avgVolume: number;
-    exchange: string;
-    open: number;
-    previousClose: number;
-    eps: number;
-    pe: number;
-    earningsAnnouncement: string;
-    sharesOutstanding: number;
-    timestamp: number;
 }
 interface MarketSectorPerformance {
     sector: string;
@@ -906,27 +898,27 @@ interface MarketSectorPerformance {
 }
 interface MarketIndex {
     symbol: string;
-    name: string;
     price: number;
-    changesPercentage: number;
+    extendedPrice: number | null;
     change: number;
-    dayLow: number;
     dayHigh: number;
-    yearLow: number;
-    yearHigh: number;
-    marketCap: number;
-    priceAvg50: number;
-    priceAvg200: number;
-    volume: number;
-    avgVolume: number;
-    exchange: string;
-    open: number;
+    dayLow: number;
     previousClose: number;
-    eps: number;
-    pe: number;
-    earningsAnnouncement: string;
-    sharesOutstanding: number;
-    timestamp: number;
+    volume: number | null;
+    open: number;
+    close: number | null;
+    lastTradeTime: string;
+    lastExtendedTradeTime: string | null;
+    updatedAt: string;
+    createdAt: string;
+    type: string;
+    name: string;
+    range: string;
+    yearHigh: number;
+    yearLow: number;
+    priceAvg50: number | null;
+    priceAvg200: number | null;
+    changesPercentage: number;
 }
 
 interface EarningsCalendar {
@@ -985,8 +977,9 @@ interface StockList {
     symbol: string;
     exchange: string;
     exchangeShortName: string;
-    price: string;
+    price: number;
     name: string;
+    type: string;
 }
 interface ETFList {
     symbol: string;
@@ -1120,7 +1113,8 @@ declare class FMPClient {
     private apiKey;
     constructor(config: FMPConfig);
     private createClient;
-    get<T>(endpoint: string, version?: 'v3' | 'v4' | 'stable', params?: Record<string, any>): Promise<UnwrappedAPIResponse<T>>;
+    get<T>(endpoint: string, version?: 'v3' | 'v4' | 'stable', params?: Record<string, any>): Promise<APIResponse<T>>;
+    getSingle<T>(endpoint: string, version?: 'v3' | 'v4' | 'stable', params?: Record<string, any>): Promise<APIResponse<T>>;
     private getClientForVersion;
 }
 
@@ -1135,7 +1129,7 @@ declare class StockEndpoints {
      */
     getQuote({ symbol }: {
         symbol: string;
-    }): Promise<UnwrappedAPIResponse<StockQuote | null>>;
+    }): Promise<APIResponse<StockQuote | null>>;
     /**
      * Get historical stock prices
      * https://site.financialmodelingprep.com/developer/docs#daily-chart-charts
@@ -1148,25 +1142,25 @@ declare class StockEndpoints {
         symbol: string;
         from?: string;
         to?: string;
-    }): Promise<UnwrappedAPIResponse<StockHistoricalPriceResponse>>;
+    }): Promise<APIResponse<HistoricalPriceResponse>>;
     /**
      * Get market cap
      * https://site.financialmodelingprep.com/developer/docs#market-cap-company-information
      * @param symbol - The stock symbol to get the market cap for
      * @returns The FMP Market Cap endpoint provides the current market capitalization of a company. Market cap is a measure of the size and relative importance of a company in the stock market. It is calculated by multiplying the current share price by the number of outstanding shares.
      */
-    getMarketCap({ symbol, }: {
+    getMarketCap({ symbol }: {
         symbol: string;
-    }): Promise<UnwrappedAPIResponse<MarketCap | null>>;
+    }): Promise<APIResponse<MarketCap | null>>;
     /**
      * Get stock splits
      * https://site.financialmodelingprep.com/developer/docs#splits-historical-splits
      * @param symbol - The stock symbol to get the splits for
      * @returns A list of historical stock splits for publicly traded companies, including the date of the stock split, the split ratio, and the type of stock split.
      */
-    getStockSplits({ symbol, }: {
+    getStockSplits({ symbol }: {
         symbol: string;
-    }): Promise<UnwrappedAPIResponse<StockSplit[]>>;
+    }): Promise<APIResponse<StockSplitResponse>>;
     /**
      * Get dividend history
      * https://site.financialmodelingprep.com/developer/docs#dividends-historical-dividends
@@ -1175,7 +1169,7 @@ declare class StockEndpoints {
      */
     getDividendHistory({ symbol, }: {
         symbol: string;
-    }): Promise<UnwrappedAPIResponse<StockDividend[]>>;
+    }): Promise<APIResponse<StockDividendResponse>>;
 }
 
 declare class FinancialEndpoints {
@@ -1189,25 +1183,25 @@ declare class FinancialEndpoints {
      * @param limit - The number of periods to get
      * @returns FMP's Income Statement API provides access to real-time income statement data for a wide range of companies, including public companies, private companies, and ETFs. This data can be used to track a company's profitability over time, to compare a company to its competitors, and to identify trends in a company's business.
      */
-    getIncomeStatement({ symbol, period, limit, }: FinancialStatementsParams): Promise<UnwrappedAPIResponse<IncomeStatement[]>>;
+    getIncomeStatement({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<IncomeStatement[]>>;
     /**
      * Get balance sheet
      * https://site.financialmodelingprep.com/developer/docs#balance-sheet-statements-financial-statements
      * @param symbol - The stock symbol to get the balance sheet for
      * @param period - The period to get the balance sheet for (annual or quarter)
      * @param limit - The number of periods to get
-     * @returns The balance sheet is a financial statement that displays a company’s total assets, liabilities, and shareholder equity over a specific timeframe (quarterly or yearly). Investors can use this statement to determine if the company can fund its operations, meet its debt obligations, and pay a dividend.
+     * @returns The balance sheet is a financial statement that displays a company's total assets, liabilities, and shareholder equity over a specific timeframe (quarterly or yearly). Investors can use this statement to determine if the company can fund its operations, meet its debt obligations, and pay a dividend.
      */
-    getBalanceSheet({ symbol, period, limit, }: FinancialStatementsParams): Promise<UnwrappedAPIResponse<BalanceSheet[]>>;
+    getBalanceSheet({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<BalanceSheet[]>>;
     /**
      * Get cash flow statement
      * https://site.financialmodelingprep.com/developer/docs#cashflow-statements-financial-statements
      * @param symbol - The stock symbol to get the cash flow statement for
      * @param period - The period to get the cash flow statement for (annual or quarter)
      * @param limit - The number of periods to get
-     * @returns The cash flow statement is a financial statement that highlights how cash moves through the company, including both cash inflows and outflows. This statement shows the cash flows in 3 main categories “Operating Cash Flows”, “Investing Cash Flows”, and “Financing Cash Flows”, which help investors to understand if the company is making money or losing money by conducting business.
+     * @returns The cash flow statement is a financial statement that highlights how cash moves through the company, including both cash inflows and outflows. This statement shows the cash flows in 3 main categories "Operating Cash Flows", "Investing Cash Flows", and "Financing Cash Flows", which help investors to understand if the company is making money or losing money by conducting business.
      */
-    getCashFlowStatement({ symbol, period, limit, }: FinancialStatementsParams): Promise<UnwrappedAPIResponse<CashFlowStatement[]>>;
+    getCashFlowStatement({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<CashFlowStatement[]>>;
     /**
      * Get key metrics
      * https://site.financialmodelingprep.com/developer/docs#key-metrics-statement-analysis
@@ -1216,7 +1210,7 @@ declare class FinancialEndpoints {
      * @param limit - The number of periods to get
      * @returns Get key financial metrics for a company, including revenue, net income, and price-to-earnings ratio (P/E ratio). Assess a company's financial performance and compare it to its competitors.
      */
-    getKeyMetrics({ symbol, period, limit, }: FinancialStatementsParams): Promise<UnwrappedAPIResponse<KeyMetrics[]>>;
+    getKeyMetrics({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<KeyMetrics[]>>;
     /**
      * Get financial ratios
      * https://site.financialmodelingprep.com/developer/docs#ratios-statement-analysis
@@ -1225,7 +1219,7 @@ declare class FinancialEndpoints {
      * @param limit - The number of periods to get
      * @returns Get financial ratios for a company, such as the P/B ratio and the ROE. Assess a company's financial health and compare it to its competitors.
      */
-    getFinancialRatios({ symbol, period, limit, }: FinancialStatementsParams): Promise<UnwrappedAPIResponse<FinancialRatios[]>>;
+    getFinancialRatios({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<FinancialRatios[]>>;
     /**
      * Get enterprise value
      * https://site.financialmodelingprep.com/developer/docs#enterprise-values-statement-analysis
@@ -1234,7 +1228,7 @@ declare class FinancialEndpoints {
      * @param limit - The number of periods to get
      * @returns Get the enterprise value of a company, which is the total value of a company, including its equity and debt. Assess a company's overall value and compare it to its peers.
      */
-    getEnterpriseValue({ symbol, period, limit, }: FinancialStatementsParams): Promise<UnwrappedAPIResponse<EnterpriseValue[]>>;
+    getEnterpriseValue({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<EnterpriseValue[]>>;
     /**
      * Get cashflow growth
      * https://site.financialmodelingprep.com/developer/docs#cashflow-growth-statement-analysis
@@ -1243,7 +1237,7 @@ declare class FinancialEndpoints {
      * @param limit - The number of periods to get
      * @returns Get the cash flow growth rate for a company. Measure how quickly a company's cash flow is growing.
      */
-    getCashflowGrowth({ symbol, period, limit, }: FinancialStatementsParams): Promise<UnwrappedAPIResponse<CashflowGrowth[]>>;
+    getCashflowGrowth({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<CashflowGrowth[]>>;
     /**
      *  Get income growth
      * https://site.financialmodelingprep.com/developer/docs#income-growth-statement-analysis
@@ -1252,7 +1246,7 @@ declare class FinancialEndpoints {
      * @param limit - The number of periods to get
      * @returns Get the income growth rate for a company. Measure how quickly a company's income is growing.
      */
-    getIncomeGrowth({ symbol, period, limit, }: FinancialStatementsParams): Promise<UnwrappedAPIResponse<IncomeGrowth[]>>;
+    getIncomeGrowth({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<IncomeGrowth[]>>;
     /**
      * Get balance sheet growth
      * https://site.financialmodelingprep.com/developer/docs#balance-sheet-growth-statement-analysis
@@ -1261,7 +1255,7 @@ declare class FinancialEndpoints {
      * @param limit - The number of periods to get
      * @returns Get the balance sheet growth rate for a company. Measure how quickly a company's assets and liabilities are growing.
      */
-    getBalanceSheetGrowth({ symbol, period, limit, }: FinancialStatementsParams): Promise<UnwrappedAPIResponse<BalanceSheetGrowth[]>>;
+    getBalanceSheetGrowth({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<BalanceSheetGrowth[]>>;
     /**
      * Get financial growth
      * https://site.financialmodelingprep.com/developer/docs#financial-growth-statement-analysis
@@ -1270,7 +1264,23 @@ declare class FinancialEndpoints {
      * @param limit - The number of periods to get
      * @returns Financial Growth Get the financial growth rate for a company. Measure how quickly a company's overall financial performance is improving.
      */
-    getFinancialGrowth({ symbol, period, limit, }: FinancialStatementsParams): Promise<UnwrappedAPIResponse<FinancialGrowth[]>>;
+    getFinancialGrowth({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<FinancialGrowth[]>>;
+    /**
+     * Get earnings historical
+     * https://site.financialmodelingprep.com/developer/docs#earnings-historical-earnings
+     * @param symbol - The stock symbol to get the earnings historical for
+     * @param limit - The number of periods to get
+     * @returns A list of historical & upcoming earnings announcements for a specific company, including the date, estimated EPS, and actual EPS.
+     */
+    getEarningsHistorical({ symbol, limit, }: FinancialStatementsParams): Promise<APIResponse<EarningsHistorical[]>>;
+    /**
+     * Get earnings surprises
+     * https://site.financialmodelingprep.com/developer/docs#earnings-surprises-earnings
+     * @param symbol - The stock symbol to get the earnings surprises for
+     * @param limit - The number of periods to get
+     * @returns A list of earnings announcements for publicly traded companies that were either positive or negative surprises. This endpoint includes the date of the earnings announcement, the estimated EPS, the actual EPS, and the earnings surprise.
+     */
+    getEarningsSurprises({ symbol, }: FinancialStatementsParams): Promise<APIResponse<EarningsSurprises[]>>;
 }
 
 declare class ForexEndpoints {
@@ -1278,24 +1288,33 @@ declare class ForexEndpoints {
     constructor(client: FMPClient);
     /**
      * Get forex quote
+     * @param params - Parameters for the forex quote request
+     * @returns Forex quote data
      */
-    getQuote(params: ForexQuoteParams): Promise<UnwrappedAPIResponse<ForexQuote[]>>;
+    getQuote(params: ForexQuoteParams): Promise<APIResponse<ForexQuote[]>>;
     /**
      * Get historical forex prices
+     * @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
+     * @returns Historical forex price data
      */
     getHistoricalPrice({ symbol, from, to, }: {
         symbol: string;
         from?: string;
         to?: string;
-    }): Promise<UnwrappedAPIResponse<HistoricalPriceResponse>>;
+    }): Promise<APIResponse<HistoricalPriceResponse>>;
     /**
      * Get forex rates for a specific base currency
+     * @param baseCurrency - The base currency to get forex rates for
+     * @returns Forex rates data
      */
-    getForexRates(baseCurrency?: string): Promise<UnwrappedAPIResponse<Record<string, number>>>;
+    getForexRates(baseCurrency?: string): Promise<APIResponse<Record<string, number>>>;
     /**
      * Get all forex rates
+     * @returns All forex rates data
      */
-    getAllForexRates(): Promise<UnwrappedAPIResponse<Record<string, Record<string, number>>>>;
+    getAllForexRates(): Promise<APIResponse<Record<string, Record<string, number>>>>;
 }
 
 declare class CryptoEndpoints {
@@ -1303,33 +1322,84 @@ declare class CryptoEndpoints {
     constructor(client: FMPClient);
     /**
      * Get crypto quote
+     * https://site.financialmodelingprep.com/developer/docs#full-quote-crypto
+     * @param symbol - The crypto symbol to get the quote for
+     * @returns Crypto quote data
      */
-    getQuote(params: CryptoQuoteParams): Promise<UnwrappedAPIResponse<CryptoQuote[]>>;
+    getQuote({ symbol }: {
+        symbol: string;
+    }): Promise<APIResponse<CryptoQuote | null>>;
     /**
      * Get historical crypto prices
+     * https://site.financialmodelingprep.com/developer/docs#cryptocurrency-daily-crypto
+     * @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
+     * @returns Provides daily price data for all cryptocurrencies that are traded on exchanges around the world.
      */
     getHistoricalPrice({ symbol, from, to, }: {
         symbol: string;
         from?: string;
         to?: string;
-    }): Promise<UnwrappedAPIResponse<HistoricalPriceResponse>>;
+    }): Promise<APIResponse<HistoricalPriceResponse>>;
 }
 
 declare class ETFEndpoints {
     private client;
     constructor(client: FMPClient);
     /**
-     * Get ETF quote
+     * Get ETF holding dates
+     * https://site.financialmodelingprep.com/developer/docs#etf-holding-dates-etf-holdings
+     * @param symbol - The symbol of the ETF to get the holding dates for
+     * @returns The FMP ETF Holding Dates endpoint provides a list of the dates on which ETF holdings are updated. For example, an investor may want to know when an ETF's holdings are updated in order to make sure that they are still aligned with their investment goals.
      */
-    getQuote(params: ETFQuoteParams): Promise<UnwrappedAPIResponse<ETFQuote[]>>;
+    getHoldingDates({ symbol }: SymbolParams): Promise<APIResponse<ETFHoldingDates[]>>;
+    /**
+     * Get ETF holdings
+     * https://site.financialmodelingprep.com/developer/docs#etf-holdings-etf-holdings
+     * @param symbol - The symbol of the ETF to get the holdings for
+     * @param date - The date to get the holdings for
+     * @returns The FMP ETF Holdings endpoint provides a list of all the institutional investors that own shares of an ETF. For example, an investor may want to know which ETF has the highest exposure to a particular industry or sector.
+     */
+    getHoldings({ symbol, date, }: {
+        symbol: string;
+        date: string;
+    }): Promise<APIResponse<ETFHolding[]>>;
+    /**
+     * Get ETF holder
+     * https://site.financialmodelingprep.com/developer/docs#etf-holder-etf-holdings
+     * @param symbol - The symbol of the ETF to get the holder for
+     * @returns This endpoint returns all stocks held by a specific ETF. Assets, share number, and weight are among the fields returned. For example you can get components of SPY, VOO and more.
+     */
+    getHolder({ symbol }: SymbolParams): Promise<APIResponse<ETFHolder[]>>;
     /**
      * Get ETF profile
+     * https://site.financialmodelingprep.com/developer/docs#etf-information-etf-holdings
+     * @param symbol - The symbol of the ETF to get the profile for
+     * @returns The FMP ETF Information endpoint provides basic information about an ETF, such as its ticker symbol, name, expense ratio, and asset under management. For example, an investor may want to compare the expense ratios of different ETFs to find the one that is most cost-effective.
      */
-    getProfile(params: ETFProfileParams): Promise<UnwrappedAPIResponse<ETFProfile[]>>;
+    getProfile({ symbol }: SymbolParams): Promise<APIResponse<ETFProfile | null>>;
     /**
-     * Get ETF holdings
+     * Get ETF sector weighting
+     * https://site.financialmodelingprep.com/developer/docs#etf-sector-weighting-etf-holdings
+     * @param symbol - The symbol of the ETF to get the sector exposure for
+     * @returns The FMP ETF Sector Weighting endpoint provides a breakdown of the percentage of an ETF's assets that are invested in each sector. For example, an investor may want to invest in an ETF that has a high exposure to the technology sector if they believe that the technology sector is poised for growth.
      */
-    getHoldings(params: ETFHoldersParams): Promise<UnwrappedAPIResponse<ETFHolding[]>>;
+    getSectorWeighting({ symbol }: SymbolParams): Promise<APIResponse<ETFWeighting[]>>;
+    /**
+     * Get ETF country weighting
+     * https://site.financialmodelingprep.com/developer/docs#etf-country-weighting-etf-holdings
+     * @param symbol - The symbol of the ETF to get the country weighting for
+     * @returns The FMP ETF Country Weighting endpoint provides a breakdown of the percentage of an ETF's assets that are invested in each country. For example, an investor may want to invest in an ETF that has a high exposure to China if they believe that the Chinese economy is poised for growth.
+     */
+    getCountryWeighting({ symbol }: SymbolParams): Promise<APIResponse<ETFCountryWeighting[]>>;
+    /**
+     * Get ETF Stock exposure
+     * https://site.financialmodelingprep.com/developer/docs#etf-sector-exposure-etf-holdings
+     * @param symbol - The symbol of the ETF to get the stock exposure for
+     * @returns This endpoint returns asset exposure from all ETFs that have it in their holdings. It has properties like market value, share number or weight percentage. It can be useful for looking up stock you like to check what ETF has it on their portfolio.
+     */
+    getStockExposure({ symbol }: SymbolParams): Promise<APIResponse<ETFStockExposure[]>>;
 }
 
 declare class MutualFundEndpoints {
@@ -1337,16 +1407,18 @@ declare class MutualFundEndpoints {
     constructor(client: FMPClient);
     /**
      * Get mutual fund quote
+     * @param params - Parameters for the mutual fund quote request
+     * @returns Mutual fund quote data
      */
-    getQuote(params: MutualFundQuoteParams): Promise<UnwrappedAPIResponse<MutualFundQuote[]>>;
+    getQuote(params: MutualFundQuoteParams): Promise<APIResponse<MutualFundQuote[]>>;
     /**
      * Get mutual fund profile
      */
-    getProfile(params: MutualFundProfileParams): Promise<UnwrappedAPIResponse<MutualFundProfile[]>>;
+    getProfile(params: MutualFundProfileParams): Promise<APIResponse<MutualFundProfile[]>>;
     /**
      * Get mutual fund holdings
      */
-    getHoldings(params: MutualFundHoldersParams): Promise<UnwrappedAPIResponse<MutualFundHolding[]>>;
+    getHoldings(params: MutualFundHoldersParams): Promise<APIResponse<MutualFundHolding[]>>;
 }
 
 declare class BondEndpoints {
@@ -1354,16 +1426,22 @@ declare class BondEndpoints {
     constructor(client: FMPClient);
     /**
      * Get bond quote
+     * @param params - Parameters for the bond quote request
+     * @returns Bond quote data
      */
-    getQuote(params: BondQuoteParams): Promise<UnwrappedAPIResponse<BondQuote[]>>;
+    getQuote(params: BondQuoteParams): Promise<APIResponse<BondQuote[]>>;
     /**
      * 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
      */
     getHistoricalPrice({ symbol, from, to, }: {
         symbol: string;
         from?: string;
         to?: string;
-    }): Promise<UnwrappedAPIResponse<HistoricalPriceResponse>>;
+    }): Promise<APIResponse<HistoricalPriceResponse>>;
 }
 
 declare class EconomicEndpoints {
@@ -1372,23 +1450,23 @@ declare class EconomicEndpoints {
     /**
      * Get treasury rates
      */
-    getTreasuryRates(params?: TreasuryRateParams): Promise<UnwrappedAPIResponse<TreasuryRate[]>>;
+    getTreasuryRates(params?: TreasuryRateParams): Promise<APIResponse<TreasuryRate[]>>;
     /**
      * Get federal funds rate
      */
-    getFederalFundsRate(params?: FederalFundsRateParams): Promise<UnwrappedAPIResponse<FederalFundsRate[]>>;
+    getFederalFundsRate(params?: FederalFundsRateParams): Promise<APIResponse<FederalFundsRate[]>>;
     /**
      * Get CPI data
      */
-    getCPI(params?: CPIParams): Promise<UnwrappedAPIResponse<CPI[]>>;
+    getCPI(params?: CPIParams): Promise<APIResponse<CPI[]>>;
     /**
      * Get GDP data
      */
-    getGDP(params?: GDPParams): Promise<UnwrappedAPIResponse<GDP[]>>;
+    getGDP(params?: GDPParams): Promise<APIResponse<GDP[]>>;
     /**
      * Get unemployment data
      */
-    getUnemployment(params?: UnemploymentParams): Promise<UnwrappedAPIResponse<Unemployment[]>>;
+    getUnemployment(params?: UnemploymentParams): Promise<APIResponse<Unemployment[]>>;
 }
 
 declare class MarketEndpoints {
@@ -1397,31 +1475,39 @@ declare class MarketEndpoints {
     /**
      * Get market hours
      */
-    getMarketHours(): Promise<UnwrappedAPIResponse<MarketHours>>;
+    getMarketHours(): Promise<APIResponse<MarketHours>>;
     /**
      * Get market performance
      */
-    getMarketPerformance(): Promise<UnwrappedAPIResponse<MarketPerformance[]>>;
+    getMarketPerformance(): Promise<APIResponse<MarketPerformance[]>>;
     /**
      * Get top gainers
+     * https://site.financialmodelingprep.com/developer/docs#market-biggest-gainers-market-overview
+     * @returns The FMP Market Biggest Gainers endpoint provides a list of the stocks that have gained the most value on a given day. This information can be used by investors to identify stocks that are momentum and to potential investment opportunities.
      */
-    getGainers(): Promise<UnwrappedAPIResponse<MarketPerformance[]>>;
+    getGainers(): Promise<APIResponse<MarketPerformance[]>>;
     /**
      * Get top losers
+     * https://site.financialmodelingprep.com/developer/docs#market-biggest-losers-market-overview
+     * @returns The FMP Market Biggest Losers endpoint provides a list of the stocks that have lost the most value on a given day. This information can be used by investors to identify stocks that are underperforming and to potential trading opportunities.
      */
-    getLosers(): Promise<UnwrappedAPIResponse<MarketPerformance[]>>;
+    getLosers(): Promise<APIResponse<MarketPerformance[]>>;
     /**
      * Get most active stocks
      */
-    getMostActive(): Promise<UnwrappedAPIResponse<MarketPerformance[]>>;
+    getMostActive(): Promise<APIResponse<MarketPerformance[]>>;
     /**
      * Get sector performance
+     * https://site.financialmodelingprep.com/developer/docs#sector-performance-market-overview
+     * @returns The FMP Sector Performance endpoint provides the performance of each sector of the stock market over a specified period of time. This information can be used by investors to identify sectors that are outperforming or underperforming the market.
      */
-    getSectorPerformance(): Promise<UnwrappedAPIResponse<MarketSectorPerformance[]>>;
+    getSectorPerformance(): Promise<APIResponse<MarketSectorPerformance[]>>;
     /**
      * Get market indices
+     * https://site.financialmodelingprep.com/developer/docs#market-index-market-overview
+     * @returns The FMP Market Index endpoint provides a list of all the major stock market indices, such as the S&P 500, the Dow Jones Industrial Average, and the Nasdaq Composite Index. This information can be used by investors to track the performance of the overall stock market and to identify sectors and industries that are outperforming or underperforming the market.
      */
-    getMarketIndex(params?: MarketIndexParams): Promise<UnwrappedAPIResponse<MarketIndex[]>>;
+    getMarketIndex(): Promise<APIResponse<MarketIndex[]>>;
 }
 
 declare class ListEndpoints {
@@ -1432,31 +1518,31 @@ declare class ListEndpoints {
      * https://site.financialmodelingprep.com/developer/docs#symbol-list-stock-list
      * @returns The stock list
      */
-    getStockList(): Promise<UnwrappedAPIResponse<StockList[]>>;
+    getStockList(): Promise<APIResponse<StockList[]>>;
     /**
      * Get ETF list
      * https://site.financialmodelingprep.com/developer/docs#exchange-traded-fund-search-stock-list
      * @returns The ETF list
      */
-    getETFList(): Promise<UnwrappedAPIResponse<ETFList[]>>;
+    getETFList(): Promise<APIResponse<ETFList[]>>;
     /**
      * Get crypto list
      * https://site.financialmodelingprep.com/developer/docs#cryptocurrencies-list-crypto
      * @returns The crypto list
      */
-    getCryptoList(): Promise<UnwrappedAPIResponse<CryptoList[]>>;
+    getCryptoList(): Promise<APIResponse<CryptoList[]>>;
     /**
      * Get forex list
      * https://site.financialmodelingprep.com/developer/docs#forex-list-forex
      * @returns The forex list
      */
-    getForexList(): Promise<UnwrappedAPIResponse<ForexList[]>>;
+    getForexList(): Promise<APIResponse<ForexList[]>>;
     /**
      * Get available indexes list
      * https://site.financialmodelingprep.com/developer/docs#available-indexes
      * @returns The available indexes list
      */
-    getAvailableIndexes(): Promise<UnwrappedAPIResponse<AvailableIndexesList[]>>;
+    getAvailableIndexes(): Promise<APIResponse<AvailableIndexesList[]>>;
 }
 
 declare class CalendarEndpoints {
@@ -1469,7 +1555,7 @@ declare class CalendarEndpoints {
      * @param to - The end date to get the earnings calendar for
      * @returns The earnings calendar
      */
-    getEarningsCalendar({ from, to }?: DateRangeParams): Promise<UnwrappedAPIResponse<EarningsCalendar[]>>;
+    getEarningsCalendar({ from, to }?: DateRangeParams): Promise<APIResponse<EarningsCalendar[]>>;
     /**
      * Get dividends calendar
      * https://site.financialmodelingprep.com/developer/docs#dividends-calendar-dividends
@@ -1477,7 +1563,7 @@ declare class CalendarEndpoints {
      * @param to - The end date to get the dividends calendar for
      * @returns The dividends calendar
      */
-    getDividendsCalendar({ from, to }?: DateRangeParams): Promise<UnwrappedAPIResponse<DividendsCalendar[]>>;
+    getDividendsCalendar({ from, to }?: DateRangeParams): Promise<APIResponse<DividendsCalendar[]>>;
     /**
      * Get economics calendar
      * https://site.financialmodelingprep.com/developer/docs#economics-calendar-economics-data
@@ -1485,7 +1571,7 @@ declare class CalendarEndpoints {
      * @param to - The end date to get the economics calendar for
      * @returns The economics calendar
      */
-    getEconomicsCalendar({ from, to }?: DateRangeParams): Promise<UnwrappedAPIResponse<EconomicsCalendar[]>>;
+    getEconomicsCalendar({ from, to }?: DateRangeParams): Promise<APIResponse<EconomicsCalendar[]>>;
     /**
      * Get IPO calendar
      * https://site.financialmodelingprep.com/developer/docs#ipo-calender-by-ipo-calendar
@@ -1493,7 +1579,7 @@ declare class CalendarEndpoints {
      * @param to - The end date to get the IPO calendar for
      * @returns The IPO calendar
      */
-    getIPOCalendar({ from, to }?: DateRangeParams): Promise<UnwrappedAPIResponse<IPOCalendar[]>>;
+    getIPOCalendar({ from, to }?: DateRangeParams): Promise<APIResponse<IPOCalendar[]>>;
     /**
      * Get stock splits calendar
      * https://site.financialmodelingprep.com/developer/docs#splits-calendar-splits
@@ -1501,7 +1587,7 @@ declare class CalendarEndpoints {
      * @param to - The end date to get the stock splits calendar for
      * @returns The stock splits calendar
      */
-    getSplitsCalendar({ from, to }?: DateRangeParams): Promise<UnwrappedAPIResponse<SplitsCalendar[]>>;
+    getSplitsCalendar({ from, to }?: DateRangeParams): Promise<APIResponse<SplitsCalendar[]>>;
 }
 
 declare class CompanyEndpoints {
@@ -1515,7 +1601,7 @@ declare class CompanyEndpoints {
      */
     getCompanyProfile({ symbol, }: {
         symbol: string;
-    }): Promise<UnwrappedAPIResponse<CompanyProfile | null>>;
+    }): Promise<APIResponse<CompanyProfile | null>>;
     /**
      * Get executive compensation
      * https://site.financialmodelingprep.com/developer/docs#executive-compensation-company-information
@@ -1524,7 +1610,7 @@ declare class CompanyEndpoints {
      */
     getExecutiveCompensation({ symbol, }: {
         symbol: string;
-    }): Promise<UnwrappedAPIResponse<ExecutiveCompensation[] | null>>;
+    }): Promise<APIResponse<ExecutiveCompensation[] | null>>;
     /**
      * Get company notes
      * https://site.financialmodelingprep.com/developer/docs#company-notes-company-information
@@ -1533,7 +1619,7 @@ declare class CompanyEndpoints {
      */
     getCompanyNotes({ symbol, }: {
         symbol: string;
-    }): Promise<UnwrappedAPIResponse<CompanyNotes[] | null>>;
+    }): Promise<APIResponse<CompanyNotes[] | null>>;
     /**
      * Get historical employee count
      * https://site.financialmodelingprep.com/developer/docs#historical-employee-company-information
@@ -1542,16 +1628,16 @@ declare class CompanyEndpoints {
      */
     getHistoricalEmployeeCount({ symbol, }: {
         symbol: string;
-    }): Promise<UnwrappedAPIResponse<HistoricalEmployeeCount[] | null>>;
+    }): Promise<APIResponse<HistoricalEmployeeCount[] | null>>;
     /**
      * Get shares float
      * https://site.financialmodelingprep.com/developer/docs#company-share-float-share-float
      * @param symbol - The stock symbol to get the shares float for
      * @returns The FMP Company Share Float endpoint provides the total number of shares that are publicly traded for a given company. This is also known as the company's float. The float is calculated by subtracting the number of restricted shares from the total number of outstanding shares.
      */
-    getSharesFloat({ symbol, }: {
+    getSharesFloat({ symbol }: {
         symbol: string;
-    }): Promise<UnwrappedAPIResponse<SharesFloat | null>>;
+    }): Promise<APIResponse<SharesFloat | null>>;
     /**
      * Get historical shares float
      * https://site.financialmodelingprep.com/developer/docs#company-historical-share-float
@@ -1560,7 +1646,7 @@ declare class CompanyEndpoints {
      */
     getHistoricalSharesFloat({ symbol, }: {
         symbol: string;
-    }): Promise<UnwrappedAPIResponse<HistoricalSharesFloat[] | null>>;
+    }): Promise<APIResponse<HistoricalSharesFloat[] | null>>;
     /**
      * Get earnings call transcript
      * https://site.financialmodelingprep.com/developer/docs#earnings-transcript-earnings-transcripts
@@ -1573,7 +1659,7 @@ declare class CompanyEndpoints {
         symbol: string;
         year: number;
         quarter: number;
-    }): Promise<UnwrappedAPIResponse<EarningsCallTranscript[] | null>>;
+    }): Promise<APIResponse<EarningsCallTranscript[] | null>>;
 }
 
 /**
@@ -1742,4 +1828,4 @@ declare const HTTP_STATUS: {
     readonly INTERNAL_SERVER_ERROR: 500;
 };
 
-export { type APIResponse, type AvailableIndexesList, type BalanceSheet, type BalanceSheetGrowth, BondEndpoints, type BondHistoricalParams, type BondListParams, type BondQuote, type BondQuoteParams, COUNTRIES, type CPI, type CPIParams, CalendarEndpoints, type CashFlowStatement, type CashflowGrowth, CompanyEndpoints, type CompanyNotes, type CompanyProfile, CryptoEndpoints, type CryptoHistoricalParams, type CryptoList, type CryptoListParams, type CryptoQuote, type CryptoQuoteParams, DEFAULT_LIMIT, DEFAULT_TIMEOUT, type DateRangeParams, type DividendsCalendar, ERROR_MESSAGES, ETFEndpoints, type ETFHoldersParams, type ETFHolding, type ETFList, type ETFListParams, type ETFProfile, type ETFProfileParams, type ETFQuote, type ETFQuoteParams, EXCHANGES, type EarningsCalendar, type EarningsCallTranscript, EconomicEndpoints, type EconomicIndicator, type EconomicIndicatorParams, type EconomicsCalendar, type EnterpriseValue, type ErrorResponse, Exchange, type ExecutiveCompensation, FMP, FMPClient, type FMPConfig, type FederalFundsRate, type FederalFundsRateParams, FinancialEndpoints, type FinancialGrowth, type FinancialRatios, type FinancialStatementBase, type FinancialStatementsParams, ForexEndpoints, type ForexHistoricalParams, type ForexList, type ForexListParams, type ForexQuote, type ForexQuoteParams, type GDP, type GDPParams, type GrowthStatementBase, HTTP_STATUS, type HistoricalEmployeeCount, type HistoricalPriceData, type HistoricalPriceResponse, type HistoricalSharesFloat, type IPOCalendar, type IncomeGrowth, type IncomeStatement, type KeyMetrics, ListEndpoints, MAX_LIMIT, type MarketCap, MarketEndpoints, type MarketGainersParams, type MarketHours, type MarketHoursParams, type MarketIndex, type MarketIndexParams, type MarketLosersParams, type MarketMostActiveParams, type MarketPerformance, type MarketPerformanceParams, type MarketSectorPerformance, type MarketSectorPerformanceParams, MutualFundEndpoints, type MutualFundHoldersParams, type MutualFundHolding, type MutualFundListParams, type MutualFundProfile, type MutualFundProfileParams, type MutualFundQuote, type MutualFundQuoteParams, PERIODS, type PaginationParams, Period, type PeriodParams, type QueryParams, type Quote, SECTORS, type SharesFloat, type SplitsCalendar, type StockDividend, StockEndpoints, type StockHistoricalPriceData, type StockHistoricalPriceResponse, type StockList, type StockQuote, type StockSplit, type SuccessResponse, type SymbolParams, type TreasuryRate, type TreasuryRateParams, type Unemployment, type UnemploymentParams, type UnwrapSingle, type UnwrappedAPIResponse, formatCurrency, formatDate, formatLargeNumber, formatNumber, formatPercentage, formatReadableDate, formatTimestamp, formatVolume, validateApiKey, validateDate, validateLimit, validatePage, validatePeriod, validateSymbol };
+export { type APIResponse, type AvailableIndexesList, type BalanceSheet, type BalanceSheetGrowth, BondEndpoints, type BondHistoricalParams, type BondListParams, type BondQuote, type BondQuoteParams, COUNTRIES, type CPI, type CPIParams, CalendarEndpoints, type CashFlowStatement, type CashflowGrowth, CompanyEndpoints, type CompanyNotes, type CompanyProfile, CryptoEndpoints, type CryptoHistoricalParams, type CryptoList, type CryptoListParams, type CryptoQuote, DEFAULT_LIMIT, DEFAULT_TIMEOUT, type DateRangeParams, type DividendsCalendar, ERROR_MESSAGES, type ETFCountryWeighting, ETFEndpoints, type ETFHolder, type ETFHolding, type ETFHoldingDates, type ETFList, type ETFProfile, type ETFStockExposure, type ETFWeighting, EXCHANGES, type EarningsCalendar, type EarningsCallTranscript, type EarningsHistorical, type EarningsSurprises, EconomicEndpoints, type EconomicIndicator, type EconomicIndicatorParams, type EconomicsCalendar, type EnterpriseValue, type ErrorResponse, Exchange, type ExecutiveCompensation, FMP, FMPClient, type FMPConfig, type FederalFundsRate, type FederalFundsRateParams, FinancialEndpoints, type FinancialGrowth, type FinancialRatios, type FinancialStatementBase, type FinancialStatementsParams, ForexEndpoints, type ForexHistoricalParams, type ForexList, type ForexListParams, type ForexQuote, type ForexQuoteParams, type GDP, type GDPParams, type GrowthStatementBase, HTTP_STATUS, type HistoricalEmployeeCount, type HistoricalPriceData, type HistoricalPriceResponse, type HistoricalSharesFloat, type IPOCalendar, type IncomeGrowth, type IncomeStatement, type KeyMetrics, ListEndpoints, MAX_LIMIT, type MarketCap, MarketEndpoints, type MarketHoliday, type MarketHours, type MarketIndex, type MarketPerformance, type MarketSectorPerformance, MutualFundEndpoints, type MutualFundHoldersParams, type MutualFundHolding, type MutualFundListParams, type MutualFundProfile, type MutualFundProfileParams, type MutualFundQuote, type MutualFundQuoteParams, PERIODS, type PaginationParams, Period, type PeriodParams, type QueryParams, type Quote, SECTORS, type SharesFloat, type SplitsCalendar, type StockDividend, type StockDividendResponse, StockEndpoints, type StockList, type StockQuote, type StockSplit, type StockSplitResponse, type SuccessResponse, type SymbolParams, type TreasuryRate, type TreasuryRateParams, type Unemployment, type UnemploymentParams, formatCurrency, formatDate, formatLargeNumber, formatNumber, formatPercentage, formatReadableDate, formatTimestamp, formatVolume, validateApiKey, validateDate, validateLimit, validatePage, validatePeriod, validateSymbol };