fmp-node-api 0.0.5 → 0.0.6

package/README.md

@@ -408,7 +408,7 @@ pnpm test:watch         # Watch mode for development
 pnpm test:coverage      # Generate coverage report
 ```
 
-**Note**: Additional endpoint-specific test scripts (crypto, etf, mutual-fund, bond) are available in the package-level scripts but not exposed at the root level.
+**Note**: Additional endpoint-specific test scripts (crypto, etf, mutual-fund) are available in the package-level scripts but not exposed at the root level.
 
 ## Development
 
@@ -492,7 +492,6 @@ src/
 │   ├── crypto.ts          # Crypto types
 │   ├── etf.ts             # ETF types
 │   ├── mutual-fund.ts     # Mutual fund types
-│   ├── bond.ts            # Bond types
 │   ├── economic.ts        # Economic types
 │   ├── market.ts          # Market types
 │   ├── list.ts            # List types
@@ -506,7 +505,6 @@ src/
 │   ├── crypto.ts
 │   ├── etf.ts
 │   ├── mutual-fund.ts
-│   ├── bond.ts
 │   ├── economic.ts
 │   ├── market.ts
 │   ├── list.ts
@@ -530,7 +528,6 @@ src/
 │   │   ├── crypto.test.ts
 │   │   ├── etf.test.ts
 │   │   ├── mutual-fund.test.ts
-│   │   ├── bond.test.ts
 │   │   ├── list.test.ts
 │   │   ├── calendar.test.ts
 │   │   └── company.test.ts
@@ -577,7 +574,7 @@ pnpm test
 
 - **📖 [Contributing Guide](https://github.com/e-roy/fmp-node-wrapper/blob/main/CONTRIBUTING.md)**: Detailed guidelines and development setup
 - **🐛 [Issues](https://github.com/e-roy/fmp-node-wrapper/issues)**: Report bugs or request features
-- **📚 [Documentation](https://fmp-node-wrapper.vercel.app)**: Check the docs first
+- **📚 [Documentation](https://fmp-node-wrapper-docs.vercel.app)**: Check the docs first
 
 ### Before Contributing
 

package/dist/index.d.mts

@@ -577,13 +577,9 @@ interface EarningsSurprises {
     estimatedEarning: number;
 }
 
-interface ForexQuoteParams extends SymbolParams {
-}
 interface ForexHistoricalParams extends SymbolParams, DateRangeParams {
     timeseries?: number;
 }
-interface ForexListParams {
-}
 interface ForexQuote {
     symbol: string;
     price: number;
@@ -714,14 +710,6 @@ interface ETFStockExposure {
     marketValue: number;
 }
 
-interface MutualFundQuoteParams extends SymbolParams {
-}
-interface MutualFundProfileParams extends SymbolParams {
-}
-interface MutualFundHoldersParams extends SymbolParams, PaginationParams {
-}
-interface MutualFundListParams {
-}
 interface MutualFundQuote {
     symbol: string;
     price: number;
@@ -745,99 +733,17 @@ interface MutualFundQuote {
     sharesOutstanding: number;
     timestamp: number;
 }
-interface MutualFundProfile {
-    symbol: string;
-    price: number;
-    beta: number;
-    volAvg: number;
-    marketCap: number;
-    lastDiv: number;
-    range: string;
-    changes: number;
-    companyName: string;
-    currency: string;
-    cik: string;
-    isin: string;
-    cusip: string;
-    exchange: string;
-    exchangeShortName: string;
-    industry: string;
-    website: string;
-    description: string;
-    ceo: string;
-    sector: string;
-    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;
-}
 interface MutualFundHolding {
-    asset: string;
-    weightPercent: number;
+    holder: string;
     shares: number;
-    marketValue: number;
-}
-
-interface BondQuoteParams extends SymbolParams {
-}
-interface BondHistoricalParams extends SymbolParams, DateRangeParams {
-    timeseries?: number;
-}
-interface BondListParams {
-}
-interface BondQuote {
-    symbol: string;
-    price: number;
-    changesPercentage: number;
+    dateReported: string;
     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;
+    weightPercent: number;
 }
 
-interface EconomicIndicatorParams extends DateRangeParams {
-}
-interface TreasuryRateParams extends EconomicIndicatorParams {
-}
-interface FederalFundsRateParams extends EconomicIndicatorParams {
-}
-interface CPIParams extends EconomicIndicatorParams {
-}
-interface GDPParams extends EconomicIndicatorParams {
-}
-interface UnemploymentParams extends EconomicIndicatorParams {
-}
 interface EconomicIndicator {
     date: string;
     value: number;
-    change: number;
-    changePercent: number;
 }
 interface TreasuryRate {
     date: string;
@@ -854,27 +760,11 @@ interface TreasuryRate {
     year20: number;
     year30: number;
 }
-interface FederalFundsRate {
-    date: string;
-    value: number;
-}
-interface CPI {
-    date: string;
-    value: number;
-    change: number;
-    changePercent: number;
-}
-interface GDP {
-    date: string;
-    value: number;
-    change: number;
-    changePercent: number;
-}
-interface Unemployment {
-    date: string;
-    value: number;
-    change: number;
-    changePercent: number;
+type EconomicIndicatorName = 'GDP' | 'realGDP' | 'nominalPotentialGDP' | 'realGDPPerCapita' | 'federalFunds' | 'CPI' | 'inflationRate' | 'inflation' | 'retailSales' | 'consumerSentiment' | 'durableGoods' | 'unemploymentRate' | 'totalNonfarmPayroll' | 'initialClaims' | 'industrialProductionTotalIndex' | 'newPrivatelyOwnedHousingUnitsStartedTotalUnits' | 'totalVehicleSales' | 'retailMoneyFunds' | 'smoothedUSRecessionProbabilities' | '3MonthOr90DayRatesAndYieldsCertificatesOfDeposit' | 'commercialBankInterestRateOnCreditCardPlansAllAccounts' | '30YearFixedRateMortgageAverage' | '15YearFixedRateMortgageAverage';
+interface EconomicIndicatorParams {
+    name: EconomicIndicatorName;
+    from?: string;
+    to?: string;
 }
 
 interface MarketHours {
@@ -1122,6 +1012,42 @@ interface EarningsCallTranscript {
     content: string;
 }
 
+interface SenateHouseTradingParams {
+    symbol: string;
+}
+interface SenateHouseTradingRSSFeedParams {
+    page: number;
+}
+interface SenateTradingResponse {
+    firstName: string;
+    lastName: string;
+    office: string;
+    link: string;
+    dateRecieved: string;
+    transactionDate: string;
+    owner: string;
+    assetDescription: string;
+    assetType: string;
+    type: string;
+    amount: string;
+    comment: string;
+    symbol: string;
+}
+interface HouseTradingResponse {
+    disclosureYear: string;
+    disclosureDate: string;
+    transactionDate: string;
+    owner: string;
+    ticker: string;
+    assetDescription: string;
+    type: string;
+    amount: string;
+    representative: string;
+    district: string;
+    link: string;
+    capitalGainsOver200USD: string;
+}
+
 declare class FMPClient {
     private v3Client;
     private v4Client;
@@ -1308,7 +1234,7 @@ declare class ForexEndpoints {
      * @param params - Parameters for the forex quote request
      * @returns Forex quote data
      */
-    getQuote(params: ForexQuoteParams): Promise<APIResponse<ForexQuote[]>>;
+    getQuote(params: SymbolParams): Promise<APIResponse<ForexQuote[]>>;
     /**
      * Get historical forex prices
      * @deprecated Use `fmp.quote.getHistoricalPrice()` instead. This method will be removed in version 0.1.0.
@@ -1322,17 +1248,6 @@ declare class ForexEndpoints {
         from?: string;
         to?: string;
     }): 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<APIResponse<Record<string, number>>>;
-    /**
-     * Get all forex rates
-     * @returns All forex rates data
-     */
-    getAllForexRates(): Promise<APIResponse<Record<string, Record<string, number>>>>;
 }
 
 declare class CryptoEndpoints {
@@ -1429,40 +1344,14 @@ declare class MutualFundEndpoints {
      * @param params - Parameters for the mutual fund quote request
      * @returns Mutual fund quote data
      */
-    getQuote(params: MutualFundQuoteParams): Promise<APIResponse<MutualFundQuote[]>>;
-    /**
-     * Get mutual fund profile
-     */
-    getProfile(params: MutualFundProfileParams): Promise<APIResponse<MutualFundProfile[]>>;
+    getQuote(params: SymbolParams): Promise<APIResponse<MutualFundQuote[]>>;
     /**
-     * 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
      */
-    getHoldings(params: MutualFundHoldersParams): Promise<APIResponse<MutualFundHolding[]>>;
-}
-
-declare class BondEndpoints {
-    private client;
-    constructor(client: FMPClient);
-    /**
-     * 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
-     */
-    getQuote(params: BondQuoteParams): Promise<APIResponse<BondQuote[]>>;
-    /**
-     * 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
-     */
-    getHistoricalPrice({ symbol, from, to, }: {
-        symbol: string;
-        from?: string;
-        to?: string;
-    }): Promise<APIResponse<HistoricalPriceResponse>>;
+    getHolders({ symbol }: SymbolParams): Promise<APIResponse<MutualFundHolding[]>>;
 }
 
 declare class EconomicEndpoints {
@@ -1470,24 +1359,21 @@ declare class EconomicEndpoints {
     constructor(client: FMPClient);
     /**
      * 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
      */
-    getTreasuryRates(params?: TreasuryRateParams): Promise<APIResponse<TreasuryRate[]>>;
+    getTreasuryRates(params: DateRangeParams): Promise<APIResponse<TreasuryRate[]>>;
     /**
-     * Get federal funds rate
+     * 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.
      */
-    getFederalFundsRate(params?: FederalFundsRateParams): Promise<APIResponse<FederalFundsRate[]>>;
-    /**
-     * Get CPI data
-     */
-    getCPI(params?: CPIParams): Promise<APIResponse<CPI[]>>;
-    /**
-     * Get GDP data
-     */
-    getGDP(params?: GDPParams): Promise<APIResponse<GDP[]>>;
-    /**
-     * Get unemployment data
-     */
-    getUnemployment(params?: UnemploymentParams): Promise<APIResponse<Unemployment[]>>;
+    getEconomicIndicators(params: EconomicIndicatorParams): Promise<APIResponse<EconomicIndicator[]>>;
 }
 
 declare class MarketEndpoints {
@@ -1712,6 +1598,37 @@ declare class QuoteEndpoints {
     getIntraday(params: IntradayParams): Promise<APIResponse<HistoricalPriceData[]>>;
 }
 
+declare class SenateHouseEndpoints {
+    private client;
+    constructor(client: FMPClient);
+    /**
+     * 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
+     */
+    getSenateTrading(params: SenateHouseTradingParams): Promise<APIResponse<SenateTradingResponse[]>>;
+    /** 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
+     */
+    getSenateTradingRSSFeed(params: SenateHouseTradingRSSFeedParams): Promise<APIResponse<SenateTradingResponse[]>>;
+    /**
+     * 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
+     */
+    getHouseTrading(params: SenateHouseTradingParams): Promise<APIResponse<HouseTradingResponse[]>>;
+    /** 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
+     */
+    getHouseTradingRSSFeed(params: SenateHouseTradingRSSFeedParams): Promise<APIResponse<SenateTradingResponse[]>>;
+}
+
 /**
  * Main FMP API client that provides access to all endpoints
  *
@@ -1741,13 +1658,13 @@ declare class FMP {
     readonly crypto: CryptoEndpoints;
     readonly etf: ETFEndpoints;
     readonly mutualFund: MutualFundEndpoints;
-    readonly bond: BondEndpoints;
     readonly economic: EconomicEndpoints;
     readonly market: MarketEndpoints;
     readonly list: ListEndpoints;
     readonly calendar: CalendarEndpoints;
     readonly company: CompanyEndpoints;
     readonly quote: QuoteEndpoints;
+    readonly senateHouse: SenateHouseEndpoints;
     constructor(config: FMPConfig);
     /**
      * Get the underlying client instance for advanced usage
@@ -1879,4 +1796,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, 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 HistoricalPriceParams, type HistoricalPriceResponse, type HistoricalSharesFloat, type IPOCalendar, type IncomeGrowth, type IncomeStatement, type IntradayParams, 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, QuoteEndpoints, type QuoteParams, 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 };
+export { type APIResponse, type AvailableIndexesList, type BalanceSheet, type BalanceSheetGrowth, COUNTRIES, 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 EconomicIndicatorName, type EconomicIndicatorParams, type EconomicsCalendar, type EnterpriseValue, type ErrorResponse, Exchange, type ExecutiveCompensation, FMP, FMPClient, type FMPConfig, FinancialEndpoints, type FinancialGrowth, type FinancialRatios, type FinancialStatementBase, type FinancialStatementsParams, ForexEndpoints, type ForexHistoricalParams, type ForexList, type ForexQuote, type GrowthStatementBase, HTTP_STATUS, type HistoricalEmployeeCount, type HistoricalPriceData, type HistoricalPriceParams, type HistoricalPriceResponse, type HistoricalSharesFloat, type HouseTradingResponse, type IPOCalendar, type IncomeGrowth, type IncomeStatement, type IntradayParams, type KeyMetrics, ListEndpoints, MAX_LIMIT, type MarketCap, MarketEndpoints, type MarketHoliday, type MarketHours, type MarketIndex, type MarketPerformance, type MarketSectorPerformance, MutualFundEndpoints, type MutualFundHolding, type MutualFundQuote, PERIODS, type PaginationParams, Period, type PeriodParams, type QueryParams, type Quote, QuoteEndpoints, type QuoteParams, SECTORS, SenateHouseEndpoints, type SenateHouseTradingParams, type SenateHouseTradingRSSFeedParams, type SenateTradingResponse, type SharesFloat, type SplitsCalendar, type StockDividend, type StockDividendResponse, StockEndpoints, type StockList, type StockQuote, type StockSplit, type StockSplitResponse, type SuccessResponse, type SymbolParams, type TreasuryRate, formatCurrency, formatDate, formatLargeNumber, formatNumber, formatPercentage, formatReadableDate, formatTimestamp, formatVolume, validateApiKey, validateDate, validateLimit, validatePage, validatePeriod, validateSymbol };