fmp-node-api 0.0.2 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,5 +1,3 @@
1
- import { AxiosRequestConfig, AxiosInstance } from 'axios';
2
-
3
1
  interface APIResponse<T = unknown> {
4
2
  success: boolean;
5
3
  data?: T;
@@ -80,87 +78,44 @@ interface Quote {
80
78
  sharesOutstanding: number;
81
79
  timestamp: number;
82
80
  }
83
- interface CompanyProfile {
81
+ declare enum Period {
82
+ ANNUAL = "annual",
83
+ QUARTER = "quarter"
84
+ }
85
+ declare enum Exchange {
86
+ NYSE = "NYSE",
87
+ NASDAQ = "NASDAQ",
88
+ AMEX = "AMEX",
89
+ TSX = "TSX",
90
+ LSE = "LSE",
91
+ ASX = "ASX",
92
+ NSE = "NSE",
93
+ BSE = "BSE"
94
+ }
95
+
96
+ interface StockQuote {
84
97
  symbol: string;
98
+ name: string;
85
99
  price: number;
86
- beta: number;
87
- volAvg: number;
100
+ changesPercentage: number;
101
+ change: number;
102
+ dayLow: number;
103
+ dayHigh: number;
104
+ yearHigh: number;
105
+ yearLow: number;
88
106
  marketCap: number;
89
- lastDiv: number;
90
- range: string;
91
- changes: number;
92
- companyName: string;
93
- currency: string;
94
- cik: string;
95
- isin: string;
96
- cusip: string;
107
+ priceAvg50: number;
108
+ priceAvg200: number;
97
109
  exchange: string;
98
- exchangeShortName: string;
99
- industry: string;
100
- website: string;
101
- description: string;
102
- ceo: string;
103
- sector: string;
104
- country: string;
105
- fullTimeEmployees: string;
106
- phone: string;
107
- address: string;
108
- city: string;
109
- state: string;
110
- zip: string;
111
- dcfDiff: number;
112
- dcf: number;
113
- image: string;
114
- ipoDate: string;
115
- defaultImage: boolean;
116
- isEtf: boolean;
117
- isActivelyTrading: boolean;
118
- isAdr: boolean;
119
- isFund: boolean;
120
- }
121
- declare const FMP_STABLE_URL = "https://financialmodelingprep.com/stable";
122
-
123
- type StockQuote = Quote;
124
- interface StockQuoteParams extends SymbolParams {
125
- }
126
- interface StockProfileParams extends SymbolParams {
127
- }
128
- interface StockHistoricalPriceParams extends SymbolParams, DateRangeParams {
129
- timeseries?: number;
130
- }
131
- interface StockMarketCapParams extends SymbolParams {
132
- }
133
- interface StockEarningsCalendarParams {
134
- from?: string;
135
- to?: string;
136
- }
137
- interface StockSplitsParams extends SymbolParams {
138
- }
139
- interface StockDividendParams extends SymbolParams {
140
- }
141
- interface StockInsiderTradingParams extends SymbolParams, PaginationParams {
142
- }
143
- interface StockInstitutionalHoldersParams extends SymbolParams {
144
- }
145
- interface StockMutualFundHoldersParams extends SymbolParams {
146
- }
147
- interface StockMajorHoldersParams extends SymbolParams {
148
- }
149
- interface StockAnalystEstimatesParams extends SymbolParams, PaginationParams {
150
- }
151
- interface StockPriceTargetParams extends SymbolParams {
152
- }
153
- interface StockRatingParams extends SymbolParams {
154
- }
155
- interface StockGradeParams extends SymbolParams {
156
- }
157
- interface StockSectorPerformanceParams {
158
- }
159
- interface StockLosersParams {
160
- }
161
- interface StockGainersParams {
162
- }
163
- interface StockMostActiveParams {
110
+ volume: number;
111
+ avgVolume: number;
112
+ open: number;
113
+ previousClose: number;
114
+ eps: number;
115
+ pe: number;
116
+ earningsAnnouncement: string;
117
+ sharesOutstanding: number;
118
+ timestamp: number;
164
119
  }
165
120
  interface StockSplit {
166
121
  date: string;
@@ -168,6 +123,10 @@ interface StockSplit {
168
123
  numerator: number;
169
124
  denominator: number;
170
125
  }
126
+ interface StockSplitResponse {
127
+ symbol: string;
128
+ historical: StockSplit[];
129
+ }
171
130
  interface StockDividend {
172
131
  date: string;
173
132
  label: string;
@@ -177,154 +136,20 @@ interface StockDividend {
177
136
  paymentDate: string;
178
137
  declarationDate: string;
179
138
  }
180
- interface InsiderTrading {
181
- symbol: string;
182
- companyName: string;
183
- cik: string;
184
- ownerName: string;
185
- ownerCik: string;
186
- ownerTitle: string;
187
- transactionDate: string;
188
- transactionCode: string;
189
- transactionAmount: number;
190
- transactionPrice: number;
191
- transactionAcquiredDisposed: string;
192
- postTransactionAmount: number;
193
- secLink: string;
194
- }
195
- interface InstitutionalHolder {
196
- holder: string;
197
- shares: number;
198
- dateReported: string;
199
- change: number;
200
- weightPercent: number;
201
- }
202
- interface MutualFundHolder {
203
- holder: string;
204
- shares: number;
205
- dateReported: string;
206
- change: number;
207
- weightPercent: number;
208
- }
209
- interface MajorHolder {
210
- holder: string;
211
- shares: number;
212
- dateReported: string;
213
- change: number;
214
- weightPercent: number;
215
- }
216
- interface AnalystEstimate {
217
- symbol: string;
218
- date: string;
219
- estimatedRevenueLow: number;
220
- estimatedRevenueHigh: number;
221
- estimatedRevenueAvg: number;
222
- estimatedEbitdaLow: number;
223
- estimatedEbitdaHigh: number;
224
- estimatedEbitdaAvg: number;
225
- estimatedEbitLow: number;
226
- estimatedEbitHigh: number;
227
- estimatedEbitAvg: number;
228
- estimatedNetIncomeLow: number;
229
- estimatedNetIncomeHigh: number;
230
- estimatedNetIncomeAvg: number;
231
- estimatedSgaExpenseLow: number;
232
- estimatedSgaExpenseHigh: number;
233
- estimatedSgaExpenseAvg: number;
234
- estimatedEpsAvg: number;
235
- estimatedEpsHigh: number;
236
- estimatedEpsLow: number;
237
- numberAnalystEstimatedRevenue: number;
238
- numberAnalystsEstimatedEps: number;
239
- }
240
- interface PriceTarget {
241
- symbol: string;
242
- targetMean: number;
243
- targetMedian: number;
244
- targetHigh: number;
245
- targetLow: number;
246
- targetCount: number;
247
- }
248
- interface StockRating {
249
- symbol: string;
250
- date: string;
251
- rating: string;
252
- ratingScore: number;
253
- ratingRecommendation: string;
254
- ratingDetailsDCFScore: number;
255
- ratingDetailsDCFRecommendation: string;
256
- ratingDetailsROEScore: number;
257
- ratingDetailsROERecommendation: string;
258
- ratingDetailsROAScore: number;
259
- ratingDetailsROARecommendation: string;
260
- ratingDetailsDEScore: number;
261
- ratingDetailsDERecommendation: string;
262
- ratingDetailsPEScore: number;
263
- ratingDetailsPERecommendation: string;
264
- ratingDetailsPBScore: number;
265
- ratingDetailsPBRecommendation: string;
266
- }
267
- interface StockGrade {
268
- symbol: string;
269
- date: string;
270
- gradingCompany: string;
271
- previousGrade: string;
272
- newGrade: string;
273
- grade: string;
274
- }
275
- interface SectorPerformance {
276
- sector: string;
277
- changesPercentage: number;
278
- }
279
- interface StockList {
139
+ interface StockDividendResponse {
280
140
  symbol: string;
281
- name: string;
282
- currency: string;
283
- stockExchange: string;
284
- exchangeShortName: string;
141
+ historical: StockDividend[];
285
142
  }
286
143
  interface MarketCap {
287
144
  symbol: string;
288
145
  date: string;
289
146
  marketCap: number;
290
147
  }
291
- interface EarningsCalendar {
292
- date: string;
293
- symbol: string;
294
- eps: number;
295
- estimatedEps: number;
296
- time: string;
297
- revenue: number;
298
- estimatedRevenue: number;
299
- fiscalDateEnding: string;
300
- updatedFromDate: string;
301
- }
302
- interface StockHistoricalPriceData extends HistoricalPriceData {
303
- }
304
- interface StockHistoricalPriceResponse extends HistoricalPriceResponse {
305
- historical: StockHistoricalPriceData[];
306
- }
307
148
 
308
149
  interface FinancialStatementsParams extends SymbolParams, PeriodParams {
309
150
  limit?: number;
310
151
  }
311
- interface IncomeStatementParams extends FinancialStatementsParams {
312
- }
313
- interface BalanceSheetParams extends FinancialStatementsParams {
314
- }
315
- interface CashFlowParams extends FinancialStatementsParams {
316
- }
317
- interface FinancialGrowthParams extends FinancialStatementsParams {
318
- }
319
- interface KeyMetricsParams extends FinancialStatementsParams {
320
- }
321
- interface FinancialRatiosParams extends FinancialStatementsParams {
322
- }
323
- interface EnterpriseValueParams extends FinancialStatementsParams {
324
- }
325
- interface CompanyValuationParams extends FinancialStatementsParams {
326
- }
327
- interface FinancialStatement {
152
+ interface FinancialStatementBase {
328
153
  date: string;
329
154
  symbol: string;
330
155
  reportedCurrency: string;
@@ -335,9 +160,14 @@ interface FinancialStatement {
335
160
  period: string;
336
161
  link: string;
337
162
  finalLink: string;
338
- [key: string]: string | number | boolean;
339
163
  }
340
- interface IncomeStatement extends FinancialStatement {
164
+ interface GrowthStatementBase {
165
+ date: string;
166
+ symbol: string;
167
+ calendarYear: string;
168
+ period: string;
169
+ }
170
+ interface IncomeStatement extends FinancialStatementBase {
341
171
  revenue: number;
342
172
  costOfRevenue: number;
343
173
  grossProfit: number;
@@ -349,6 +179,7 @@ interface IncomeStatement extends FinancialStatement {
349
179
  otherExpenses: number;
350
180
  operatingExpenses: number;
351
181
  costAndExpenses: number;
182
+ interestIncome: number;
352
183
  interestExpense: number;
353
184
  depreciationAndAmortization: number;
354
185
  ebitda: number;
@@ -362,16 +193,17 @@ interface IncomeStatement extends FinancialStatement {
362
193
  netIncome: number;
363
194
  netIncomeRatio: number;
364
195
  eps: number;
365
- epsDiluted: number;
366
- ebit: number;
367
- ebitRatio: number;
196
+ epsdiluted: number;
197
+ weightedAverageShsOut: number;
198
+ weightedAverageShsOutDil: number;
368
199
  }
369
- interface BalanceSheet extends FinancialStatement {
200
+ interface BalanceSheet extends FinancialStatementBase {
370
201
  cashAndCashEquivalents: number;
371
202
  shortTermInvestments: number;
372
203
  cashAndShortTermInvestments: number;
373
204
  netReceivables: number;
374
205
  inventory: number;
206
+ otherCurrentAssets: number;
375
207
  totalCurrentAssets: number;
376
208
  propertyPlantEquipmentNet: number;
377
209
  goodwill: number;
@@ -411,10 +243,11 @@ interface BalanceSheet extends FinancialStatement {
411
243
  totalDebt: number;
412
244
  netDebt: number;
413
245
  }
414
- interface CashFlowStatement extends FinancialStatement {
246
+ interface CashFlowStatement extends FinancialStatementBase {
415
247
  netIncome: number;
416
248
  depreciationAndAmortization: number;
417
249
  deferredIncomeTax: number;
250
+ stockBasedCompensation: number;
418
251
  changeInWorkingCapital: number;
419
252
  accountsReceivables: number;
420
253
  inventory: number;
@@ -573,6 +406,160 @@ interface EnterpriseValue {
573
406
  addTotalDebt: number;
574
407
  enterpriseValue: number;
575
408
  }
409
+ interface CashflowGrowth extends GrowthStatementBase {
410
+ growthNetIncome: number;
411
+ growthDepreciationAndAmortization: number;
412
+ growthDeferredIncomeTax: number;
413
+ growthStockBasedCompensation: number;
414
+ growthChangeInWorkingCapital: number;
415
+ growthAccountsReceivables: number;
416
+ growthInventory: number;
417
+ growthAccountsPayables: number;
418
+ growthOtherWorkingCapital: number;
419
+ growthOtherNonCashItems: number;
420
+ growthNetCashProvidedByOperatingActivites: number;
421
+ growthInvestmentsInPropertyPlantAndEquipment: number;
422
+ growthAcquisitionsNet: number;
423
+ growthPurchasesOfInvestments: number;
424
+ growthSalesMaturitiesOfInvestments: number;
425
+ growthOtherInvestingActivites: number;
426
+ growthNetCashUsedForInvestingActivites: number;
427
+ growthDebtRepayment: number;
428
+ growthCommonStockIssued: number;
429
+ growthCommonStockRepurchased: number;
430
+ growthDividendsPaid: number;
431
+ growthOtherFinancingActivites: number;
432
+ growthNetCashUsedProvidedByFinancingActivities: number;
433
+ growthEffectOfForexChangesOnCash: number;
434
+ growthNetChangeInCash: number;
435
+ growthCashAtEndOfPeriod: number;
436
+ growthCashAtBeginningOfPeriod: number;
437
+ growthOperatingCashFlow: number;
438
+ growthCapitalExpenditure: number;
439
+ growthFreeCashFlow: number;
440
+ }
441
+ interface IncomeGrowth extends GrowthStatementBase {
442
+ growthRevenue: number;
443
+ growthCostOfRevenue: number;
444
+ growthGrossProfit: number;
445
+ growthGrossProfitRatio: number;
446
+ growthResearchAndDevelopmentExpenses: number;
447
+ growthGeneralAndAdministrativeExpenses: number;
448
+ growthSellingAndMarketingExpenses: number;
449
+ growthOtherExpenses: number;
450
+ growthOperatingExpenses: number;
451
+ growthCostAndExpenses: number;
452
+ growthInterestExpense: number;
453
+ growthDepreciationAndAmortization: number;
454
+ growthEBITDA: number;
455
+ growthEBITDARatio: number;
456
+ growthOperatingIncome: number;
457
+ growthOperatingIncomeRatio: number;
458
+ growthTotalOtherIncomeExpensesNet: number;
459
+ growthIncomeBeforeTax: number;
460
+ growthIncomeBeforeTaxRatio: number;
461
+ growthIncomeTaxExpense: number;
462
+ growthNetIncome: number;
463
+ growthNetIncomeRatio: number;
464
+ growthEPS: number;
465
+ growthEPSDiluted: number;
466
+ growthWeightedAverageShsOut: number;
467
+ growthWeightedAverageShsOutDil: number;
468
+ }
469
+ interface BalanceSheetGrowth extends GrowthStatementBase {
470
+ growthCashAndCashEquivalents: number;
471
+ growthShortTermInvestments: number;
472
+ growthCashAndShortTermInvestments: number;
473
+ growthNetReceivables: number;
474
+ growthInventory: number;
475
+ growthOtherCurrentAssets: number;
476
+ growthTotalCurrentAssets: number;
477
+ growthPropertyPlantEquipmentNet: number;
478
+ growthGoodwill: number;
479
+ growthIntangibleAssets: number;
480
+ growthGoodwillAndIntangibleAssets: number;
481
+ growthLongTermInvestments: number;
482
+ growthTaxAssets: number;
483
+ growthOtherNonCurrentAssets: number;
484
+ growthTotalNonCurrentAssets: number;
485
+ growthOtherAssets: number;
486
+ growthTotalAssets: number;
487
+ growthAccountPayables: number;
488
+ growthShortTermDebt: number;
489
+ growthTaxPayables: number;
490
+ growthDeferredRevenue: number;
491
+ growthOtherCurrentLiabilities: number;
492
+ growthTotalCurrentLiabilities: number;
493
+ growthLongTermDebt: number;
494
+ growthDeferredRevenueNonCurrent: number;
495
+ growthDeferrredTaxLiabilitiesNonCurrent: number;
496
+ growthOtherNonCurrentLiabilities: number;
497
+ growthTotalNonCurrentLiabilities: number;
498
+ growthOtherLiabilities: number;
499
+ growthTotalLiabilities: number;
500
+ growthCommonStock: number;
501
+ growthRetainedEarnings: number;
502
+ growthAccumulatedOtherComprehensiveIncomeLoss: number;
503
+ growthOthertotalStockholdersEquity: number;
504
+ growthTotalStockholdersEquity: number;
505
+ growthTotalLiabilitiesAndStockholdersEquity: number;
506
+ growthTotalInvestments: number;
507
+ growthTotalDebt: number;
508
+ growthNetDebt: number;
509
+ }
510
+ interface FinancialGrowth extends GrowthStatementBase {
511
+ revenueGrowth: number;
512
+ grossProfitGrowth: number;
513
+ ebitgrowth: number;
514
+ operatingIncomeGrowth: number;
515
+ netIncomeGrowth: number;
516
+ epsgrowth: number;
517
+ epsdilutedGrowth: number;
518
+ weightedAverageSharesGrowth: number;
519
+ weightedAverageSharesDilutedGrowth: number;
520
+ dividendsperShareGrowth: number;
521
+ operatingCashFlowGrowth: number;
522
+ freeCashFlowGrowth: number;
523
+ tenYRevenueGrowthPerShare: number;
524
+ fiveYRevenueGrowthPerShare: number;
525
+ threeYRevenueGrowthPerShare: number;
526
+ tenYOperatingCFGrowthPerShare: number;
527
+ fiveYOperatingCFGrowthPerShare: number;
528
+ threeYOperatingCFGrowthPerShare: number;
529
+ tenYNetIncomeGrowthPerShare: number;
530
+ fiveYNetIncomeGrowthPerShare: number;
531
+ threeYNetIncomeGrowthPerShare: number;
532
+ tenYShareholdersEquityGrowthPerShare: number;
533
+ fiveYShareholdersEquityGrowthPerShare: number;
534
+ threeYShareholdersEquityGrowthPerShare: number;
535
+ tenYDividendperShareGrowthPerShare: number;
536
+ fiveYDividendperShareGrowthPerShare: number;
537
+ threeYDividendperShareGrowthPerShare: number;
538
+ receivablesGrowth: number;
539
+ inventoryGrowth: number;
540
+ assetGrowth: number;
541
+ bookValueperShareGrowth: number;
542
+ debtGrowth: number;
543
+ rdexpenseGrowth: number;
544
+ sgaexpensesGrowth: number;
545
+ }
546
+ interface EarningsHistorical {
547
+ date: string;
548
+ symbol: string;
549
+ eps: number;
550
+ epsEstimated: number;
551
+ time: string;
552
+ revenue: number;
553
+ revenueEstimated: number;
554
+ updatedFromDate: string;
555
+ fiscalDateEnding: string;
556
+ }
557
+ interface EarningsSurprises {
558
+ date: string;
559
+ symbol: string;
560
+ actualEarningResult: number;
561
+ estimatedEarning: number;
562
+ }
576
563
 
577
564
  interface ForexQuoteParams extends SymbolParams {
578
565
  }
@@ -604,16 +591,7 @@ interface ForexQuote {
604
591
  sharesOutstanding: number;
605
592
  timestamp: number;
606
593
  }
607
- interface ForexPair {
608
- symbol: string;
609
- name: string;
610
- currency: string;
611
- stockExchange: string;
612
- exchangeShortName: string;
613
- }
614
594
 
615
- interface CryptoQuoteParams extends SymbolParams {
616
- }
617
595
  interface CryptoHistoricalParams extends SymbolParams, DateRangeParams {
618
596
  timeseries?: number;
619
597
  }
@@ -621,13 +599,14 @@ interface CryptoListParams {
621
599
  }
622
600
  interface CryptoQuote {
623
601
  symbol: string;
602
+ name: string;
624
603
  price: number;
625
604
  changesPercentage: number;
626
605
  change: number;
627
606
  dayLow: number;
628
607
  dayHigh: number;
629
- yearLow: number;
630
608
  yearHigh: number;
609
+ yearLow: number;
631
610
  marketCap: number;
632
611
  priceAvg50: number;
633
612
  priceAvg200: number;
@@ -636,29 +615,98 @@ interface CryptoQuote {
636
615
  exchange: string;
637
616
  open: number;
638
617
  previousClose: number;
639
- eps: number;
640
- pe: number;
641
- earningsAnnouncement: string;
618
+ eps: number | null;
619
+ pe: number | null;
620
+ earningsAnnouncement: string | null;
642
621
  sharesOutstanding: number;
643
622
  timestamp: number;
644
623
  }
645
- interface CryptoCurrency {
624
+
625
+ interface ETFHoldingDates {
626
+ date: string;
627
+ }
628
+ interface ETFHolding {
629
+ cik: string;
630
+ acceptanceTime: string;
631
+ date: string;
646
632
  symbol: string;
647
633
  name: string;
648
- currency: string;
649
- stockExchange: string;
650
- exchangeShortName: string;
634
+ lei: string;
635
+ title: string;
636
+ cusip: string;
637
+ isin: string;
638
+ balance: number;
639
+ units: string;
640
+ cur_cd: string;
641
+ valUsd: number;
642
+ pctVal: number;
643
+ payoffProfile: string;
644
+ assetCat: string;
645
+ issuerCat: string;
646
+ invCountry: string;
647
+ isRestrictedSec: string;
648
+ fairValLevel: string;
649
+ isCashCollateral: string;
650
+ isNonCashCollateral: string;
651
+ isLoanByFund: string;
652
+ }
653
+ interface ETFHolder {
654
+ asset: string;
655
+ name: string;
656
+ isin: string;
657
+ cusip: string;
658
+ sharesNumber: number;
659
+ weightPercentage: number;
660
+ marketValue: number;
661
+ updated: string;
662
+ }
663
+ interface ETFProfile {
664
+ symbol: string;
665
+ assetClass: string;
666
+ aum: number;
667
+ avgVolume: number;
668
+ cusip: string;
669
+ description: string;
670
+ domicile: string;
671
+ etfCompany: string;
672
+ expenseRatio: number;
673
+ inceptionDate: string;
674
+ isin: string;
675
+ name: string;
676
+ nav: number;
677
+ navCurrency: string;
678
+ sectorsList: {
679
+ exposure: string;
680
+ industry: string;
681
+ }[];
682
+ website: string;
683
+ holdingsCount: number;
684
+ }
685
+ interface ETFWeighting {
686
+ sector: string;
687
+ weightPercentage: string;
688
+ }
689
+ interface ETFCountryWeighting {
690
+ country: string;
691
+ weightPercentage: string;
692
+ }
693
+ interface ETFStockExposure {
694
+ etfSymbol: string;
695
+ assetExposure: string;
696
+ sharesNumber: number;
697
+ weightPercentage: number;
698
+ marketValue: number;
651
699
  }
652
700
 
653
- interface ETFQuoteParams extends SymbolParams {
701
+ interface MutualFundQuoteParams extends SymbolParams {
654
702
  }
655
- interface ETFProfileParams extends SymbolParams {
703
+ interface MutualFundProfileParams extends SymbolParams {
656
704
  }
657
- interface ETFHoldersParams extends SymbolParams, PaginationParams {
705
+ interface MutualFundHoldersParams extends SymbolParams, PaginationParams {
658
706
  }
659
- interface ETFListParams {
707
+ interface MutualFundListParams {
660
708
  }
661
- interface ETFQuote {
709
+ interface MutualFundQuote {
662
710
  symbol: string;
663
711
  price: number;
664
712
  changesPercentage: number;
@@ -681,7 +729,7 @@ interface ETFQuote {
681
729
  sharesOutstanding: number;
682
730
  timestamp: number;
683
731
  }
684
- interface ETFProfile {
732
+ interface MutualFundProfile {
685
733
  symbol: string;
686
734
  price: number;
687
735
  beta: number;
@@ -719,29 +767,21 @@ interface ETFProfile {
719
767
  isAdr: boolean;
720
768
  isFund: boolean;
721
769
  }
722
- interface ETFHolding {
770
+ interface MutualFundHolding {
723
771
  asset: string;
724
772
  weightPercent: number;
725
773
  shares: number;
726
774
  marketValue: number;
727
775
  }
728
- interface ETFList {
729
- symbol: string;
730
- name: string;
731
- currency: string;
732
- stockExchange: string;
733
- exchangeShortName: string;
734
- }
735
776
 
736
- interface MutualFundQuoteParams extends SymbolParams {
737
- }
738
- interface MutualFundProfileParams extends SymbolParams {
777
+ interface BondQuoteParams extends SymbolParams {
739
778
  }
740
- interface MutualFundHoldersParams extends SymbolParams, PaginationParams {
779
+ interface BondHistoricalParams extends SymbolParams, DateRangeParams {
780
+ timeseries?: number;
741
781
  }
742
- interface MutualFundListParams {
782
+ interface BondListParams {
743
783
  }
744
- interface MutualFundQuote {
784
+ interface BondQuote {
745
785
  symbol: string;
746
786
  price: number;
747
787
  changesPercentage: number;
@@ -764,95 +804,6 @@ interface MutualFundQuote {
764
804
  sharesOutstanding: number;
765
805
  timestamp: number;
766
806
  }
767
- interface MutualFundProfile {
768
- symbol: string;
769
- price: number;
770
- beta: number;
771
- volAvg: number;
772
- marketCap: number;
773
- lastDiv: number;
774
- range: string;
775
- changes: number;
776
- companyName: string;
777
- currency: string;
778
- cik: string;
779
- isin: string;
780
- cusip: string;
781
- exchange: string;
782
- exchangeShortName: string;
783
- industry: string;
784
- website: string;
785
- description: string;
786
- ceo: string;
787
- sector: string;
788
- country: string;
789
- fullTimeEmployees: string;
790
- phone: string;
791
- address: string;
792
- city: string;
793
- state: string;
794
- zip: string;
795
- dcfDiff: number;
796
- dcf: number;
797
- image: string;
798
- ipoDate: string;
799
- defaultImage: boolean;
800
- isEtf: boolean;
801
- isActivelyTrading: boolean;
802
- isAdr: boolean;
803
- isFund: boolean;
804
- }
805
- interface MutualFundHolding {
806
- asset: string;
807
- weightPercent: number;
808
- shares: number;
809
- marketValue: number;
810
- }
811
- interface MutualFundList {
812
- symbol: string;
813
- name: string;
814
- currency: string;
815
- stockExchange: string;
816
- exchangeShortName: string;
817
- }
818
-
819
- interface BondQuoteParams extends SymbolParams {
820
- }
821
- interface BondHistoricalParams extends SymbolParams, DateRangeParams {
822
- timeseries?: number;
823
- }
824
- interface BondListParams {
825
- }
826
- interface BondQuote {
827
- symbol: string;
828
- price: number;
829
- changesPercentage: number;
830
- change: number;
831
- dayLow: number;
832
- dayHigh: number;
833
- yearLow: number;
834
- yearHigh: number;
835
- marketCap: number;
836
- priceAvg50: number;
837
- priceAvg200: number;
838
- volume: number;
839
- avgVolume: number;
840
- exchange: string;
841
- open: number;
842
- previousClose: number;
843
- eps: number;
844
- pe: number;
845
- earningsAnnouncement: string;
846
- sharesOutstanding: number;
847
- timestamp: number;
848
- }
849
- interface BondList {
850
- symbol: string;
851
- name: string;
852
- currency: string;
853
- stockExchange: string;
854
- exchangeShortName: string;
855
- }
856
807
 
857
808
  interface EconomicIndicatorParams extends DateRangeParams {
858
809
  }
@@ -910,56 +861,36 @@ interface Unemployment {
910
861
  changePercent: number;
911
862
  }
912
863
 
913
- interface MarketHoursParams {
914
- }
915
- interface MarketPerformanceParams {
916
- }
917
- interface MarketGainersParams {
918
- }
919
- interface MarketLosersParams {
920
- }
921
- interface MarketMostActiveParams {
922
- }
923
- interface MarketSectorPerformanceParams {
924
- }
925
- interface MarketIndexParams extends DateRangeParams {
926
- }
927
864
  interface MarketHours {
928
865
  stockExchangeName: string;
929
866
  stockMarketHours: {
930
867
  openingHour: string;
931
868
  closingHour: string;
932
- gmtOffset: number;
933
869
  };
934
- holidays: string[];
870
+ stockMarketHolidays: MarketHoliday[];
935
871
  isTheStockMarketOpen: boolean;
936
872
  isTheEuronextMarketOpen: boolean;
937
873
  isTheForexMarketOpen: boolean;
938
874
  isTheCryptoMarketOpen: boolean;
939
875
  }
876
+ interface MarketHoliday {
877
+ year: number;
878
+ 'Martin Luther King, Jr. Day': string;
879
+ "Presidents' Day": string;
880
+ 'Good Friday': string;
881
+ 'Memorial Day': string;
882
+ Juneteenth: string;
883
+ 'Independence Day': string;
884
+ 'Labor Day': string;
885
+ 'Thanksgiving Day': string;
886
+ Christmas: string;
887
+ }
940
888
  interface MarketPerformance {
941
- ticker: string;
942
- companyName: string;
889
+ symbol: string;
890
+ name: string;
891
+ change: number;
943
892
  price: number;
944
893
  changesPercentage: number;
945
- changes: number;
946
- dayLow: number;
947
- dayHigh: number;
948
- yearLow: number;
949
- yearHigh: number;
950
- marketCap: number;
951
- priceAvg50: number;
952
- priceAvg200: number;
953
- volume: number;
954
- avgVolume: number;
955
- exchange: string;
956
- open: number;
957
- previousClose: number;
958
- eps: number;
959
- pe: number;
960
- earningsAnnouncement: string;
961
- sharesOutstanding: number;
962
- timestamp: number;
963
894
  }
964
895
  interface MarketSectorPerformance {
965
896
  sector: string;
@@ -967,46 +898,224 @@ interface MarketSectorPerformance {
967
898
  }
968
899
  interface MarketIndex {
969
900
  symbol: string;
970
- name: string;
971
901
  price: number;
972
- changesPercentage: number;
902
+ extendedPrice: number | null;
973
903
  change: number;
974
- dayLow: number;
975
904
  dayHigh: number;
976
- yearLow: number;
977
- yearHigh: number;
978
- marketCap: number;
979
- priceAvg50: number;
980
- priceAvg200: number;
981
- volume: number;
982
- avgVolume: number;
983
- exchange: string;
984
- open: number;
905
+ dayLow: number;
985
906
  previousClose: number;
907
+ volume: number | null;
908
+ open: number;
909
+ close: number | null;
910
+ lastTradeTime: string;
911
+ lastExtendedTradeTime: string | null;
912
+ updatedAt: string;
913
+ createdAt: string;
914
+ type: string;
915
+ name: string;
916
+ range: string;
917
+ yearHigh: number;
918
+ yearLow: number;
919
+ priceAvg50: number | null;
920
+ priceAvg200: number | null;
921
+ changesPercentage: number;
922
+ }
923
+
924
+ interface EarningsCalendar {
925
+ date: string;
926
+ symbol: string;
986
927
  eps: number;
987
- pe: number;
988
- earningsAnnouncement: string;
989
- sharesOutstanding: number;
990
- timestamp: number;
928
+ epsEstimated: number | null;
929
+ time: string;
930
+ revenue: number | null;
931
+ revenueEstimated: number | null;
932
+ fiscalDateEnding: string;
933
+ updatedFromDate: string;
934
+ }
935
+ interface DividendsCalendar {
936
+ date: string;
937
+ label: string;
938
+ adjDividend: number;
939
+ symbol: string;
940
+ dividend: number;
941
+ recordDate: string;
942
+ paymentDate: string;
943
+ declarationDate: string;
944
+ }
945
+ interface EconomicsCalendar {
946
+ date: string;
947
+ country: string;
948
+ event: string;
949
+ currency: string;
950
+ previous: number;
951
+ estimate: number | null;
952
+ actual: number | null;
953
+ change: number;
954
+ impact: string;
955
+ changePercentage: number;
956
+ unit: string | null;
957
+ }
958
+ interface IPOCalendar {
959
+ date: string;
960
+ company: string;
961
+ symbol: string;
962
+ exchange: string;
963
+ actions: string;
964
+ shares: number | null;
965
+ priceRange: string | null;
966
+ marketCap: number | null;
967
+ }
968
+ interface SplitsCalendar {
969
+ date: string;
970
+ label: string;
971
+ symbol: string;
972
+ numerator: number;
973
+ denominator: number;
974
+ }
975
+
976
+ interface StockList {
977
+ symbol: string;
978
+ exchange: string;
979
+ exchangeShortName: string;
980
+ price: number;
981
+ name: string;
982
+ type: string;
983
+ }
984
+ interface ETFList {
985
+ symbol: string;
986
+ exchange: string;
987
+ exchangeShortName: string;
988
+ price: number;
989
+ name: string;
990
+ }
991
+ interface CryptoList {
992
+ symbol: string;
993
+ name: string;
994
+ currency: string;
995
+ stockExchange: string;
996
+ exchangeShortName: string;
997
+ }
998
+ interface ForexList {
999
+ symbol: string;
1000
+ name: string;
1001
+ currency: string;
1002
+ stockExchange: string;
1003
+ exchangeShortName: string;
1004
+ }
1005
+ interface AvailableIndexesList {
1006
+ symbol: string;
1007
+ name: string;
1008
+ currency: string;
1009
+ stockExchange: string;
1010
+ exchangeShortName: string;
1011
+ }
1012
+
1013
+ interface CompanyProfile {
1014
+ symbol: string;
1015
+ price: number;
1016
+ beta: number;
1017
+ volAvg: number;
1018
+ mktCap: number;
1019
+ lastDiv: number;
1020
+ range: string;
1021
+ changes: number;
1022
+ companyName: string;
1023
+ currency: string;
1024
+ cik: string;
1025
+ isin: string;
1026
+ cusip: string;
1027
+ exchange: string;
1028
+ exchangeShortName: string;
1029
+ industry: string;
1030
+ website: string;
1031
+ description: string;
1032
+ ceo: string;
1033
+ sector: string;
1034
+ country: string;
1035
+ fullTimeEmployees: string;
1036
+ phone: string;
1037
+ address: string;
1038
+ city: string;
1039
+ state: string;
1040
+ zip: string;
1041
+ dcfDiff: number;
1042
+ dcf: number;
1043
+ image: string;
1044
+ ipoDate: string;
1045
+ defaultImage: boolean;
1046
+ isEtf: boolean;
1047
+ isActivelyTrading: boolean;
1048
+ isAdr: boolean;
1049
+ isFund: boolean;
1050
+ }
1051
+ interface ExecutiveCompensation {
1052
+ cik: string;
1053
+ symbol: string;
1054
+ companyName: string;
1055
+ industryTitle: string;
1056
+ acceptedDate: string;
1057
+ filingDate: string;
1058
+ nameAndPosition: string;
1059
+ year: number;
1060
+ salary: number;
1061
+ bonus: number;
1062
+ stock_award: number;
1063
+ incentive_plan_compensation: number;
1064
+ all_other_compensation: number;
1065
+ total: number;
1066
+ url: string;
1067
+ }
1068
+ interface CompanyNotes {
1069
+ cik: string;
1070
+ symbol: string;
1071
+ title: string;
1072
+ exchange: string;
1073
+ }
1074
+ interface HistoricalEmployeeCount {
1075
+ symbol: string;
1076
+ cik: string;
1077
+ acceptanceTime: string;
1078
+ periodOfReport: string;
1079
+ companyName: string;
1080
+ formType: string;
1081
+ filingDate: string;
1082
+ employeeCount: number;
1083
+ source: string;
1084
+ }
1085
+ interface SharesFloat {
1086
+ symbol: string;
1087
+ freeFloat: number;
1088
+ floatShares: number;
1089
+ outstandingShares: number;
1090
+ source: string;
1091
+ date: string;
1092
+ }
1093
+ interface HistoricalSharesFloat {
1094
+ symbol: string;
1095
+ freeFloat: number;
1096
+ floatShares: string;
1097
+ outstandingShares: string;
1098
+ source: string;
1099
+ date: string;
1100
+ }
1101
+ interface EarningsCallTranscript {
1102
+ symbol: string;
1103
+ quarter: number;
1104
+ year: number;
1105
+ date: string;
1106
+ content: string;
991
1107
  }
992
1108
 
993
1109
  declare class FMPClient {
994
- private client;
1110
+ private v3Client;
1111
+ private v4Client;
1112
+ private stableClient;
995
1113
  private apiKey;
996
- private baseURL;
997
1114
  constructor(config: FMPConfig);
998
- /**
999
- * Make a GET request to the API
1000
- */
1001
- get<T = any>(endpoint: string, params?: Record<string, any>): Promise<APIResponse<T>>;
1002
- /**
1003
- * Make a POST request to the API
1004
- */
1005
- post<T = any>(endpoint: string, data?: any, config?: AxiosRequestConfig): Promise<APIResponse<T>>;
1006
- /**
1007
- * Get the underlying axios instance for advanced usage
1008
- */
1009
- getAxiosInstance(): AxiosInstance;
1115
+ private createClient;
1116
+ get<T>(endpoint: string, version?: 'v3' | 'v4' | 'stable', params?: Record<string, any>): Promise<APIResponse<T>>;
1117
+ getSingle<T>(endpoint: string, version?: 'v3' | 'v4' | 'stable', params?: Record<string, any>): Promise<APIResponse<T>>;
1118
+ private getClientForVersion;
1010
1119
  }
1011
1120
 
1012
1121
  declare class StockEndpoints {
@@ -1014,53 +1123,53 @@ declare class StockEndpoints {
1014
1123
  constructor(client: FMPClient);
1015
1124
  /**
1016
1125
  * Get real-time stock quote
1126
+ * https://site.financialmodelingprep.com/developer/docs#full-quote-quote
1127
+ * @param symbol - The stock symbol to get the quote for
1128
+ * @returns This endpoint gives you the latest bid and ask prices for a stock, as well as the volume and last trade price in real time.
1017
1129
  */
1018
1130
  getQuote({ symbol }: {
1019
1131
  symbol: string;
1020
- }): Promise<APIResponse<StockQuote[]>>;
1021
- /**
1022
- * Get company profile
1023
- */
1024
- getCompanyProfile({ symbol }: {
1025
- symbol: string;
1026
- }): Promise<APIResponse<CompanyProfile[]>>;
1132
+ }): Promise<APIResponse<StockQuote | null>>;
1027
1133
  /**
1028
1134
  * Get historical stock prices
1135
+ * https://site.financialmodelingprep.com/developer/docs#daily-chart-charts
1136
+ * @param symbol - The stock symbol to get the historical prices for
1137
+ * @param from - The start date to get the historical prices for
1138
+ * @param to - The end date to get the historical prices for
1139
+ * @returns The FMP Daily Chart endpoint provides daily stock data for a specified company, including opening, high, low, and closing prices, with a default limit of 5 years of historical data. To access data beyond this limit, use the from and to parameters for custom date ranges, each with a 5-year limit
1029
1140
  */
1030
1141
  getHistoricalPrice({ symbol, from, to, }: {
1031
1142
  symbol: string;
1032
1143
  from?: string;
1033
1144
  to?: string;
1034
- }): Promise<APIResponse<StockHistoricalPriceResponse>>;
1035
- /**
1036
- * Get list of all stocks
1037
- */
1038
- getStockList(): Promise<APIResponse<StockList[]>>;
1145
+ }): Promise<APIResponse<HistoricalPriceResponse>>;
1039
1146
  /**
1040
- * Get market capitalization
1147
+ * Get market cap
1148
+ * https://site.financialmodelingprep.com/developer/docs#market-cap-company-information
1149
+ * @param symbol - The stock symbol to get the market cap for
1150
+ * @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.
1041
1151
  */
1042
1152
  getMarketCap({ symbol }: {
1043
1153
  symbol: string;
1044
- }): Promise<APIResponse<MarketCap[]>>;
1045
- /**
1046
- * Get earnings calendar
1047
- */
1048
- getEarningsCalendar(params: {
1049
- from?: string;
1050
- to?: string;
1051
- }): Promise<APIResponse<EarningsCalendar[]>>;
1154
+ }): Promise<APIResponse<MarketCap | null>>;
1052
1155
  /**
1053
1156
  * Get stock splits
1157
+ * https://site.financialmodelingprep.com/developer/docs#splits-historical-splits
1158
+ * @param symbol - The stock symbol to get the splits for
1159
+ * @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.
1054
1160
  */
1055
1161
  getStockSplits({ symbol }: {
1056
1162
  symbol: string;
1057
- }): Promise<APIResponse<StockSplit[]>>;
1163
+ }): Promise<APIResponse<StockSplitResponse>>;
1058
1164
  /**
1059
1165
  * Get dividend history
1166
+ * https://site.financialmodelingprep.com/developer/docs#dividends-historical-dividends
1167
+ * @param symbol - The stock symbol to get the dividend history for
1168
+ * @returns A list of historical dividend payments for publicly traded companies, including the date of the dividend payment, the ex-dividend date, and the dividend per share.
1060
1169
  */
1061
- getDividendHistory({ symbol }: {
1170
+ getDividendHistory({ symbol, }: {
1062
1171
  symbol: string;
1063
- }): Promise<APIResponse<StockDividend[]>>;
1172
+ }): Promise<APIResponse<StockDividendResponse>>;
1064
1173
  }
1065
1174
 
1066
1175
  declare class FinancialEndpoints {
@@ -1068,52 +1177,142 @@ declare class FinancialEndpoints {
1068
1177
  constructor(client: FMPClient);
1069
1178
  /**
1070
1179
  * Get income statement
1180
+ * https://site.financialmodelingprep.com/developer/docs#income-statements-financial-statements
1181
+ * @param symbol - The stock symbol to get the income statement for
1182
+ * @param period - The period to get the income statement for (annual or quarter)
1183
+ * @param limit - The number of periods to get
1184
+ * @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.
1071
1185
  */
1072
- getIncomeStatement({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<FinancialStatement[]>>;
1186
+ getIncomeStatement({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<IncomeStatement[]>>;
1073
1187
  /**
1074
1188
  * Get balance sheet
1189
+ * https://site.financialmodelingprep.com/developer/docs#balance-sheet-statements-financial-statements
1190
+ * @param symbol - The stock symbol to get the balance sheet for
1191
+ * @param period - The period to get the balance sheet for (annual or quarter)
1192
+ * @param limit - The number of periods to get
1193
+ * @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.
1075
1194
  */
1076
- getBalanceSheet({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<FinancialStatement[]>>;
1195
+ getBalanceSheet({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<BalanceSheet[]>>;
1077
1196
  /**
1078
1197
  * Get cash flow statement
1198
+ * https://site.financialmodelingprep.com/developer/docs#cashflow-statements-financial-statements
1199
+ * @param symbol - The stock symbol to get the cash flow statement for
1200
+ * @param period - The period to get the cash flow statement for (annual or quarter)
1201
+ * @param limit - The number of periods to get
1202
+ * @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.
1079
1203
  */
1080
- getCashFlowStatement({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<FinancialStatement[]>>;
1204
+ getCashFlowStatement({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<CashFlowStatement[]>>;
1081
1205
  /**
1082
1206
  * Get key metrics
1207
+ * https://site.financialmodelingprep.com/developer/docs#key-metrics-statement-analysis
1208
+ * @param symbol - The stock symbol to get the key metrics for
1209
+ * @param period - The period to get the key metrics for (annual or quarter)
1210
+ * @param limit - The number of periods to get
1211
+ * @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.
1083
1212
  */
1084
- getKeyMetrics({ symbol, period, limit, }: KeyMetricsParams): Promise<APIResponse<KeyMetrics[]>>;
1213
+ getKeyMetrics({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<KeyMetrics[]>>;
1085
1214
  /**
1086
1215
  * Get financial ratios
1216
+ * https://site.financialmodelingprep.com/developer/docs#ratios-statement-analysis
1217
+ * @param symbol - The stock symbol to get the financial ratios for
1218
+ * @param period - The period to get the financial ratios for (annual or quarter)
1219
+ * @param limit - The number of periods to get
1220
+ * @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.
1087
1221
  */
1088
- getFinancialRatios({ symbol, period, limit, }: FinancialRatiosParams): Promise<APIResponse<FinancialRatios[]>>;
1222
+ getFinancialRatios({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<FinancialRatios[]>>;
1089
1223
  /**
1090
1224
  * Get enterprise value
1225
+ * https://site.financialmodelingprep.com/developer/docs#enterprise-values-statement-analysis
1226
+ * @param symbol - The stock symbol to get the enterprise value for
1227
+ * @param period - The period to get the enterprise value for (annual or quarter)
1228
+ * @param limit - The number of periods to get
1229
+ * @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.
1230
+ */
1231
+ getEnterpriseValue({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<EnterpriseValue[]>>;
1232
+ /**
1233
+ * Get cashflow growth
1234
+ * https://site.financialmodelingprep.com/developer/docs#cashflow-growth-statement-analysis
1235
+ * @param symbol - The stock symbol to get the cashflow growth for
1236
+ * @param period - The period to get the cashflow growth for (annual or quarter)
1237
+ * @param limit - The number of periods to get
1238
+ * @returns Get the cash flow growth rate for a company. Measure how quickly a company's cash flow is growing.
1091
1239
  */
1092
- getEnterpriseValue({ symbol, period, limit, }: EnterpriseValueParams): Promise<APIResponse<EnterpriseValue[]>>;
1240
+ getCashflowGrowth({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<CashflowGrowth[]>>;
1241
+ /**
1242
+ * Get income growth
1243
+ * https://site.financialmodelingprep.com/developer/docs#income-growth-statement-analysis
1244
+ * @param symbol - The stock symbol to get the income growth for
1245
+ * @param period - The period to get the income growth for (annual or quarter)
1246
+ * @param limit - The number of periods to get
1247
+ * @returns Get the income growth rate for a company. Measure how quickly a company's income is growing.
1248
+ */
1249
+ getIncomeGrowth({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<IncomeGrowth[]>>;
1250
+ /**
1251
+ * Get balance sheet growth
1252
+ * https://site.financialmodelingprep.com/developer/docs#balance-sheet-growth-statement-analysis
1253
+ * @param symbol - The stock symbol to get the balance sheet growth for
1254
+ * @param period - The period to get the balance sheet growth for (annual or quarter)
1255
+ * @param limit - The number of periods to get
1256
+ * @returns Get the balance sheet growth rate for a company. Measure how quickly a company's assets and liabilities are growing.
1257
+ */
1258
+ getBalanceSheetGrowth({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<BalanceSheetGrowth[]>>;
1259
+ /**
1260
+ * Get financial growth
1261
+ * https://site.financialmodelingprep.com/developer/docs#financial-growth-statement-analysis
1262
+ * @param symbol - The stock symbol to get the financial growth for
1263
+ * @param period - The period to get the financial growth for (annual or quarter)
1264
+ * @param limit - The number of periods to get
1265
+ * @returns Financial Growth Get the financial growth rate for a company. Measure how quickly a company's overall financial performance is improving.
1266
+ */
1267
+ getFinancialGrowth({ symbol, period, limit, }: FinancialStatementsParams): Promise<APIResponse<FinancialGrowth[]>>;
1268
+ /**
1269
+ * Get earnings historical
1270
+ * https://site.financialmodelingprep.com/developer/docs#earnings-historical-earnings
1271
+ * @param symbol - The stock symbol to get the earnings historical for
1272
+ * @param limit - The number of periods to get
1273
+ * @returns A list of historical & upcoming earnings announcements for a specific company, including the date, estimated EPS, and actual EPS.
1274
+ */
1275
+ getEarningsHistorical({ symbol, limit, }: FinancialStatementsParams): Promise<APIResponse<EarningsHistorical[]>>;
1276
+ /**
1277
+ * Get earnings surprises
1278
+ * https://site.financialmodelingprep.com/developer/docs#earnings-surprises-earnings
1279
+ * @param symbol - The stock symbol to get the earnings surprises for
1280
+ * @param limit - The number of periods to get
1281
+ * @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.
1282
+ */
1283
+ getEarningsSurprises({ symbol, }: FinancialStatementsParams): Promise<APIResponse<EarningsSurprises[]>>;
1093
1284
  }
1094
1285
 
1095
1286
  declare class ForexEndpoints {
1096
1287
  private client;
1097
1288
  constructor(client: FMPClient);
1098
1289
  /**
1099
- * Get real-time forex quote
1290
+ * Get forex quote
1291
+ * @param params - Parameters for the forex quote request
1292
+ * @returns Forex quote data
1100
1293
  */
1101
1294
  getQuote(params: ForexQuoteParams): Promise<APIResponse<ForexQuote[]>>;
1102
1295
  /**
1103
- * Get historical forex data
1104
- */
1105
- getHistoricalPrice(params: ForexHistoricalParams): Promise<APIResponse<HistoricalPriceResponse>>;
1106
- /**
1107
- * Get list of all forex pairs
1108
- * Using the forex-specific endpoint
1296
+ * Get historical forex prices
1297
+ * @param symbol - The forex symbol to get the historical prices for
1298
+ * @param from - The start date to get the historical prices for
1299
+ * @param to - The end date to get the historical prices for
1300
+ * @returns Historical forex price data
1109
1301
  */
1110
- getForexList(): Promise<APIResponse<ForexPair[]>>;
1302
+ getHistoricalPrice({ symbol, from, to, }: {
1303
+ symbol: string;
1304
+ from?: string;
1305
+ to?: string;
1306
+ }): Promise<APIResponse<HistoricalPriceResponse>>;
1111
1307
  /**
1112
- * Get forex rates for a specific currency
1308
+ * Get forex rates for a specific base currency
1309
+ * @param baseCurrency - The base currency to get forex rates for
1310
+ * @returns Forex rates data
1113
1311
  */
1114
1312
  getForexRates(baseCurrency?: string): Promise<APIResponse<Record<string, number>>>;
1115
1313
  /**
1116
- * Get forex rates for all currencies
1314
+ * Get all forex rates
1315
+ * @returns All forex rates data
1117
1316
  */
1118
1317
  getAllForexRates(): Promise<APIResponse<Record<string, Record<string, number>>>>;
1119
1318
  }
@@ -1122,45 +1321,94 @@ declare class CryptoEndpoints {
1122
1321
  private client;
1123
1322
  constructor(client: FMPClient);
1124
1323
  /**
1125
- * Get real-time crypto quote
1126
- */
1127
- getQuote(params: CryptoQuoteParams): Promise<APIResponse<CryptoQuote[]>>;
1128
- /**
1129
- * Get historical crypto data
1324
+ * Get crypto quote
1325
+ * https://site.financialmodelingprep.com/developer/docs#full-quote-crypto
1326
+ * @param symbol - The crypto symbol to get the quote for
1327
+ * @returns Crypto quote data
1130
1328
  */
1131
- getHistoricalPrice(params: CryptoHistoricalParams): Promise<APIResponse<HistoricalPriceResponse>>;
1329
+ getQuote({ symbol }: {
1330
+ symbol: string;
1331
+ }): Promise<APIResponse<CryptoQuote | null>>;
1132
1332
  /**
1133
- * Get list of all cryptocurrencies
1333
+ * Get historical crypto prices
1334
+ * https://site.financialmodelingprep.com/developer/docs#cryptocurrency-daily-crypto
1335
+ * @param symbol - The crypto symbol to get the historical prices for
1336
+ * @param from - The start date to get the historical prices for
1337
+ * @param to - The end date to get the historical prices for
1338
+ * @returns Provides daily price data for all cryptocurrencies that are traded on exchanges around the world.
1134
1339
  */
1135
- getCryptoList(): Promise<APIResponse<CryptoCurrency[]>>;
1340
+ getHistoricalPrice({ symbol, from, to, }: {
1341
+ symbol: string;
1342
+ from?: string;
1343
+ to?: string;
1344
+ }): Promise<APIResponse<HistoricalPriceResponse>>;
1136
1345
  }
1137
1346
 
1138
1347
  declare class ETFEndpoints {
1139
1348
  private client;
1140
1349
  constructor(client: FMPClient);
1141
1350
  /**
1142
- * Get real-time ETF quote
1351
+ * Get ETF holding dates
1352
+ * https://site.financialmodelingprep.com/developer/docs#etf-holding-dates-etf-holdings
1353
+ * @param symbol - The symbol of the ETF to get the holding dates for
1354
+ * @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.
1143
1355
  */
1144
- getQuote(params: ETFQuoteParams): Promise<APIResponse<ETFQuote[]>>;
1356
+ getHoldingDates({ symbol }: SymbolParams): Promise<APIResponse<ETFHoldingDates[]>>;
1357
+ /**
1358
+ * Get ETF holdings
1359
+ * https://site.financialmodelingprep.com/developer/docs#etf-holdings-etf-holdings
1360
+ * @param symbol - The symbol of the ETF to get the holdings for
1361
+ * @param date - The date to get the holdings for
1362
+ * @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.
1363
+ */
1364
+ getHoldings({ symbol, date, }: {
1365
+ symbol: string;
1366
+ date: string;
1367
+ }): Promise<APIResponse<ETFHolding[]>>;
1368
+ /**
1369
+ * Get ETF holder
1370
+ * https://site.financialmodelingprep.com/developer/docs#etf-holder-etf-holdings
1371
+ * @param symbol - The symbol of the ETF to get the holder for
1372
+ * @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.
1373
+ */
1374
+ getHolder({ symbol }: SymbolParams): Promise<APIResponse<ETFHolder[]>>;
1145
1375
  /**
1146
1376
  * Get ETF profile
1377
+ * https://site.financialmodelingprep.com/developer/docs#etf-information-etf-holdings
1378
+ * @param symbol - The symbol of the ETF to get the profile for
1379
+ * @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.
1147
1380
  */
1148
- getProfile(params: ETFProfileParams): Promise<APIResponse<ETFProfile[]>>;
1381
+ getProfile({ symbol }: SymbolParams): Promise<APIResponse<ETFProfile | null>>;
1149
1382
  /**
1150
- * Get ETF holdings
1383
+ * Get ETF sector weighting
1384
+ * https://site.financialmodelingprep.com/developer/docs#etf-sector-weighting-etf-holdings
1385
+ * @param symbol - The symbol of the ETF to get the sector exposure for
1386
+ * @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.
1151
1387
  */
1152
- getHoldings(params: ETFHoldersParams): Promise<APIResponse<ETFHolding[]>>;
1388
+ getSectorWeighting({ symbol }: SymbolParams): Promise<APIResponse<ETFWeighting[]>>;
1153
1389
  /**
1154
- * Get list of all ETFs
1390
+ * Get ETF country weighting
1391
+ * https://site.financialmodelingprep.com/developer/docs#etf-country-weighting-etf-holdings
1392
+ * @param symbol - The symbol of the ETF to get the country weighting for
1393
+ * @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.
1155
1394
  */
1156
- getETFList(): Promise<APIResponse<ETFList[]>>;
1395
+ getCountryWeighting({ symbol }: SymbolParams): Promise<APIResponse<ETFCountryWeighting[]>>;
1396
+ /**
1397
+ * Get ETF Stock exposure
1398
+ * https://site.financialmodelingprep.com/developer/docs#etf-sector-exposure-etf-holdings
1399
+ * @param symbol - The symbol of the ETF to get the stock exposure for
1400
+ * @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.
1401
+ */
1402
+ getStockExposure({ symbol }: SymbolParams): Promise<APIResponse<ETFStockExposure[]>>;
1157
1403
  }
1158
1404
 
1159
1405
  declare class MutualFundEndpoints {
1160
1406
  private client;
1161
1407
  constructor(client: FMPClient);
1162
1408
  /**
1163
- * Get real-time mutual fund quote
1409
+ * Get mutual fund quote
1410
+ * @param params - Parameters for the mutual fund quote request
1411
+ * @returns Mutual fund quote data
1164
1412
  */
1165
1413
  getQuote(params: MutualFundQuoteParams): Promise<APIResponse<MutualFundQuote[]>>;
1166
1414
  /**
@@ -1171,27 +1419,29 @@ declare class MutualFundEndpoints {
1171
1419
  * Get mutual fund holdings
1172
1420
  */
1173
1421
  getHoldings(params: MutualFundHoldersParams): Promise<APIResponse<MutualFundHolding[]>>;
1174
- /**
1175
- * Get list of all mutual funds
1176
- */
1177
- getMutualFundList(): Promise<APIResponse<MutualFundList[]>>;
1178
1422
  }
1179
1423
 
1180
1424
  declare class BondEndpoints {
1181
1425
  private client;
1182
1426
  constructor(client: FMPClient);
1183
1427
  /**
1184
- * Get real-time bond quote
1428
+ * Get bond quote
1429
+ * @param params - Parameters for the bond quote request
1430
+ * @returns Bond quote data
1185
1431
  */
1186
1432
  getQuote(params: BondQuoteParams): Promise<APIResponse<BondQuote[]>>;
1187
1433
  /**
1188
- * Get historical bond data
1189
- */
1190
- getHistoricalPrice(params: BondHistoricalParams): Promise<APIResponse<HistoricalPriceResponse>>;
1191
- /**
1192
- * Get list of all bonds
1434
+ * Get historical bond prices
1435
+ * @param symbol - The bond symbol to get the historical prices for
1436
+ * @param from - The start date to get the historical prices for
1437
+ * @param to - The end date to get the historical prices for
1438
+ * @returns Historical bond price data
1193
1439
  */
1194
- getBondList(): Promise<APIResponse<BondList[]>>;
1440
+ getHistoricalPrice({ symbol, from, to, }: {
1441
+ symbol: string;
1442
+ from?: string;
1443
+ to?: string;
1444
+ }): Promise<APIResponse<HistoricalPriceResponse>>;
1195
1445
  }
1196
1446
 
1197
1447
  declare class EconomicEndpoints {
@@ -1231,11 +1481,15 @@ declare class MarketEndpoints {
1231
1481
  */
1232
1482
  getMarketPerformance(): Promise<APIResponse<MarketPerformance[]>>;
1233
1483
  /**
1234
- * Get market gainers
1484
+ * Get top gainers
1485
+ * https://site.financialmodelingprep.com/developer/docs#market-biggest-gainers-market-overview
1486
+ * @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.
1235
1487
  */
1236
1488
  getGainers(): Promise<APIResponse<MarketPerformance[]>>;
1237
1489
  /**
1238
- * Get market losers
1490
+ * Get top losers
1491
+ * https://site.financialmodelingprep.com/developer/docs#market-biggest-losers-market-overview
1492
+ * @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.
1239
1493
  */
1240
1494
  getLosers(): Promise<APIResponse<MarketPerformance[]>>;
1241
1495
  /**
@@ -1244,12 +1498,168 @@ declare class MarketEndpoints {
1244
1498
  getMostActive(): Promise<APIResponse<MarketPerformance[]>>;
1245
1499
  /**
1246
1500
  * Get sector performance
1501
+ * https://site.financialmodelingprep.com/developer/docs#sector-performance-market-overview
1502
+ * @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.
1247
1503
  */
1248
1504
  getSectorPerformance(): Promise<APIResponse<MarketSectorPerformance[]>>;
1249
1505
  /**
1250
- * Get market index data
1506
+ * Get market indices
1507
+ * https://site.financialmodelingprep.com/developer/docs#market-index-market-overview
1508
+ * @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.
1509
+ */
1510
+ getMarketIndex(): Promise<APIResponse<MarketIndex[]>>;
1511
+ }
1512
+
1513
+ declare class ListEndpoints {
1514
+ private client;
1515
+ constructor(client: FMPClient);
1516
+ /**
1517
+ * Get stock list
1518
+ * https://site.financialmodelingprep.com/developer/docs#symbol-list-stock-list
1519
+ * @returns The stock list
1520
+ */
1521
+ getStockList(): Promise<APIResponse<StockList[]>>;
1522
+ /**
1523
+ * Get ETF list
1524
+ * https://site.financialmodelingprep.com/developer/docs#exchange-traded-fund-search-stock-list
1525
+ * @returns The ETF list
1526
+ */
1527
+ getETFList(): Promise<APIResponse<ETFList[]>>;
1528
+ /**
1529
+ * Get crypto list
1530
+ * https://site.financialmodelingprep.com/developer/docs#cryptocurrencies-list-crypto
1531
+ * @returns The crypto list
1532
+ */
1533
+ getCryptoList(): Promise<APIResponse<CryptoList[]>>;
1534
+ /**
1535
+ * Get forex list
1536
+ * https://site.financialmodelingprep.com/developer/docs#forex-list-forex
1537
+ * @returns The forex list
1538
+ */
1539
+ getForexList(): Promise<APIResponse<ForexList[]>>;
1540
+ /**
1541
+ * Get available indexes list
1542
+ * https://site.financialmodelingprep.com/developer/docs#available-indexes
1543
+ * @returns The available indexes list
1544
+ */
1545
+ getAvailableIndexes(): Promise<APIResponse<AvailableIndexesList[]>>;
1546
+ }
1547
+
1548
+ declare class CalendarEndpoints {
1549
+ private client;
1550
+ constructor(client: FMPClient);
1551
+ /**
1552
+ * Get earnings calendar
1553
+ * https://site.financialmodelingprep.com/developer/docs#earnings-calendar-earnings
1554
+ * @param from - The start date to get the earnings calendar for
1555
+ * @param to - The end date to get the earnings calendar for
1556
+ * @returns The earnings calendar
1557
+ */
1558
+ getEarningsCalendar({ from, to }?: DateRangeParams): Promise<APIResponse<EarningsCalendar[]>>;
1559
+ /**
1560
+ * Get dividends calendar
1561
+ * https://site.financialmodelingprep.com/developer/docs#dividends-calendar-dividends
1562
+ * @param from - The start date to get the dividends calendar for
1563
+ * @param to - The end date to get the dividends calendar for
1564
+ * @returns The dividends calendar
1565
+ */
1566
+ getDividendsCalendar({ from, to }?: DateRangeParams): Promise<APIResponse<DividendsCalendar[]>>;
1567
+ /**
1568
+ * Get economics calendar
1569
+ * https://site.financialmodelingprep.com/developer/docs#economics-calendar-economics-data
1570
+ * @param from - The start date to get the economics calendar for
1571
+ * @param to - The end date to get the economics calendar for
1572
+ * @returns The economics calendar
1573
+ */
1574
+ getEconomicsCalendar({ from, to }?: DateRangeParams): Promise<APIResponse<EconomicsCalendar[]>>;
1575
+ /**
1576
+ * Get IPO calendar
1577
+ * https://site.financialmodelingprep.com/developer/docs#ipo-calender-by-ipo-calendar
1578
+ * @param from - The start date to get the IPO calendar for
1579
+ * @param to - The end date to get the IPO calendar for
1580
+ * @returns The IPO calendar
1581
+ */
1582
+ getIPOCalendar({ from, to }?: DateRangeParams): Promise<APIResponse<IPOCalendar[]>>;
1583
+ /**
1584
+ * Get stock splits calendar
1585
+ * https://site.financialmodelingprep.com/developer/docs#splits-calendar-splits
1586
+ * @param from - The start date to get the stock splits calendar for
1587
+ * @param to - The end date to get the stock splits calendar for
1588
+ * @returns The stock splits calendar
1251
1589
  */
1252
- getMarketIndex(params?: MarketIndexParams): Promise<APIResponse<MarketIndex[]>>;
1590
+ getSplitsCalendar({ from, to }?: DateRangeParams): Promise<APIResponse<SplitsCalendar[]>>;
1591
+ }
1592
+
1593
+ declare class CompanyEndpoints {
1594
+ private client;
1595
+ constructor(client: FMPClient);
1596
+ /**
1597
+ * Get company profile
1598
+ * https://site.financialmodelingprep.com/developer/docs#company-profile-company-information
1599
+ * @param symbol - The stock symbol to get the profile for
1600
+ * @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.
1601
+ */
1602
+ getCompanyProfile({ symbol, }: {
1603
+ symbol: string;
1604
+ }): Promise<APIResponse<CompanyProfile | null>>;
1605
+ /**
1606
+ * Get executive compensation
1607
+ * https://site.financialmodelingprep.com/developer/docs#executive-compensation-company-information
1608
+ * @param symbol - The stock symbol to get the executive compensation for
1609
+ * @returns Understand how a company compensates its executives with our Executive Compensation endpoint. This endpoint provides information such as salary, bonus, and stock options for each executive.
1610
+ */
1611
+ getExecutiveCompensation({ symbol, }: {
1612
+ symbol: string;
1613
+ }): Promise<APIResponse<ExecutiveCompensation[] | null>>;
1614
+ /**
1615
+ * Get company notes
1616
+ * https://site.financialmodelingprep.com/developer/docs#company-notes-company-information
1617
+ * @param symbol - The stock symbol to get the notes for
1618
+ * @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.
1619
+ */
1620
+ getCompanyNotes({ symbol, }: {
1621
+ symbol: string;
1622
+ }): Promise<APIResponse<CompanyNotes[] | null>>;
1623
+ /**
1624
+ * Get historical employee count
1625
+ * https://site.financialmodelingprep.com/developer/docs#historical-employee-company-information
1626
+ * @param symbol - The stock symbol to get the historical employee count for
1627
+ * @returns Track a company's employee count over time with our Historical Employee Count endpoint. This endpoint provides information about the number of employees a company has had each year.
1628
+ */
1629
+ getHistoricalEmployeeCount({ symbol, }: {
1630
+ symbol: string;
1631
+ }): Promise<APIResponse<HistoricalEmployeeCount[] | null>>;
1632
+ /**
1633
+ * Get shares float
1634
+ * https://site.financialmodelingprep.com/developer/docs#company-share-float-share-float
1635
+ * @param symbol - The stock symbol to get the shares float for
1636
+ * @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.
1637
+ */
1638
+ getSharesFloat({ symbol }: {
1639
+ symbol: string;
1640
+ }): Promise<APIResponse<SharesFloat | null>>;
1641
+ /**
1642
+ * Get historical shares float
1643
+ * https://site.financialmodelingprep.com/developer/docs#company-historical-share-float
1644
+ * @param symbol - The stock symbol to get the historical shares float for
1645
+ * @returns The FMP Historical Share Float endpoint provides historical data on the 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.
1646
+ */
1647
+ getHistoricalSharesFloat({ symbol, }: {
1648
+ symbol: string;
1649
+ }): Promise<APIResponse<HistoricalSharesFloat[] | null>>;
1650
+ /**
1651
+ * Get earnings call transcript
1652
+ * https://site.financialmodelingprep.com/developer/docs#earnings-transcript-earnings-transcripts
1653
+ * @param symbol - The stock symbol to get the earnings call transcript for
1654
+ * @param year - The year of the earnings call
1655
+ * @param quarter - The quarter of the earnings call
1656
+ * @returns The FMP Earnings Call Transcript endpoint provides the transcript of a company's earnings call.
1657
+ */
1658
+ getEarningsCallTranscript({ symbol, year, quarter, }: {
1659
+ symbol: string;
1660
+ year: number;
1661
+ quarter: number;
1662
+ }): Promise<APIResponse<EarningsCallTranscript[] | null>>;
1253
1663
  }
1254
1664
 
1255
1665
  /**
@@ -1284,6 +1694,9 @@ declare class FMP {
1284
1694
  readonly bond: BondEndpoints;
1285
1695
  readonly economic: EconomicEndpoints;
1286
1696
  readonly market: MarketEndpoints;
1697
+ readonly list: ListEndpoints;
1698
+ readonly calendar: CalendarEndpoints;
1699
+ readonly company: CompanyEndpoints;
1287
1700
  constructor(config: FMPConfig);
1288
1701
  /**
1289
1702
  * Get the underlying client instance for advanced usage
@@ -1291,6 +1704,14 @@ declare class FMP {
1291
1704
  getClient(): FMPClient;
1292
1705
  }
1293
1706
 
1707
+ /**
1708
+ * Validate API key
1709
+ */
1710
+ declare function validateApiKey(apiKey: string): void;
1711
+ /**
1712
+ * Validate stock symbol
1713
+ */
1714
+ declare function validateSymbol(symbol: string): void;
1294
1715
  /**
1295
1716
  * Validate date format (YYYY-MM-DD)
1296
1717
  */
@@ -1407,25 +1828,4 @@ declare const HTTP_STATUS: {
1407
1828
  readonly INTERNAL_SERVER_ERROR: 500;
1408
1829
  };
1409
1830
 
1410
- declare class FMPError extends Error {
1411
- status?: number | undefined;
1412
- code?: string | undefined;
1413
- constructor(message: string, status?: number | undefined, code?: string | undefined);
1414
- }
1415
- declare function validateApiKey(apiKey: string): void;
1416
- declare function validateSymbol(symbol: string): void;
1417
- declare const FMP_BASE_URL = "https://financialmodelingprep.com/api/v3";
1418
- declare const FMP_BASE_URL_V4 = "https://financialmodelingprep.com/api/v4";
1419
- declare enum Period {
1420
- ANNUAL = "annual",
1421
- QUARTER = "quarter"
1422
- }
1423
- declare enum Exchange {
1424
- NYSE = "NYSE",
1425
- NASDAQ = "NASDAQ",
1426
- AMEX = "AMEX",
1427
- TSX = "TSX",
1428
- LSE = "LSE"
1429
- }
1430
-
1431
- export { type APIResponse, type AnalystEstimate, type BalanceSheet, type BalanceSheetParams, BondEndpoints, type BondHistoricalParams, type BondList, type BondListParams, type BondQuote, type BondQuoteParams, COUNTRIES, type CPI, type CPIParams, type CashFlowParams, type CashFlowStatement, type CompanyProfile, type CompanyValuationParams, type CryptoCurrency, CryptoEndpoints, type CryptoHistoricalParams, type CryptoListParams, type CryptoQuote, type CryptoQuoteParams, DEFAULT_LIMIT, DEFAULT_TIMEOUT, type DateRangeParams, ERROR_MESSAGES, ETFEndpoints, type ETFHoldersParams, type ETFHolding, type ETFList, type ETFListParams, type ETFProfile, type ETFProfileParams, type ETFQuote, type ETFQuoteParams, EXCHANGES, type EarningsCalendar, EconomicEndpoints, type EconomicIndicator, type EconomicIndicatorParams, type EnterpriseValue, type EnterpriseValueParams, type ErrorResponse, Exchange, FMP, FMPClient, type FMPConfig, FMPError, FMP_BASE_URL, FMP_BASE_URL_V4, FMP_STABLE_URL, type FederalFundsRate, type FederalFundsRateParams, FinancialEndpoints, type FinancialGrowthParams, type FinancialRatios, type FinancialRatiosParams, type FinancialStatement, type FinancialStatementsParams, ForexEndpoints, type ForexHistoricalParams, type ForexListParams, type ForexPair, type ForexQuote, type ForexQuoteParams, type GDP, type GDPParams, HTTP_STATUS, type HistoricalPriceData, type HistoricalPriceResponse, type IncomeStatement, type IncomeStatementParams, type InsiderTrading, type InstitutionalHolder, type KeyMetrics, type KeyMetricsParams, MAX_LIMIT, type MajorHolder, 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 MutualFundHolder, type MutualFundHoldersParams, type MutualFundHolding, type MutualFundList, type MutualFundListParams, type MutualFundProfile, type MutualFundProfileParams, type MutualFundQuote, type MutualFundQuoteParams, PERIODS, type PaginationParams, Period, type PeriodParams, type PriceTarget, type QueryParams, type Quote, SECTORS, type SectorPerformance, type StockAnalystEstimatesParams, type StockDividend, type StockDividendParams, type StockEarningsCalendarParams, StockEndpoints, type StockGainersParams, type StockGrade, type StockGradeParams, type StockHistoricalPriceData, type StockHistoricalPriceParams, type StockHistoricalPriceResponse, type StockInsiderTradingParams, type StockInstitutionalHoldersParams, type StockList, type StockLosersParams, type StockMajorHoldersParams, type StockMarketCapParams, type StockMostActiveParams, type StockMutualFundHoldersParams, type StockPriceTargetParams, type StockProfileParams, type StockQuote, type StockQuoteParams, type StockRating, type StockRatingParams, type StockSectorPerformanceParams, type StockSplit, type StockSplitsParams, 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 };
1831
+ 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 };