fmp-node-api 0.0.4 → 0.0.6
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/README.md +3 -7
- package/dist/index.d.mts +187 -219
- package/dist/index.d.ts +187 -219
- package/dist/index.js +155 -89
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +154 -89
- package/dist/index.mjs.map +1 -1
- package/package.json +9 -1
package/README.md
CHANGED
|
@@ -64,13 +64,12 @@ const fmp = new FMP({
|
|
|
64
64
|
|
|
65
65
|
### Available Modules
|
|
66
66
|
|
|
67
|
+
- **`fmp.quote`** - Quote data for stocks, forex, crypto, commodities, and ETFs
|
|
67
68
|
- **`fmp.stock`** - Stock market data (quotes, profiles, historical prices, etc.)
|
|
68
69
|
- **`fmp.financial`** - Financial statements (income, balance sheet, cash flow)
|
|
69
|
-
- **`fmp.forex`** - Foreign exchange data
|
|
70
70
|
- **`fmp.crypto`** - Cryptocurrency data
|
|
71
71
|
- **`fmp.etf`** - ETF data and holdings
|
|
72
72
|
- **`fmp.mutualFund`** - Mutual fund data
|
|
73
|
-
- **`fmp.bond`** - Bond market data
|
|
74
73
|
- **`fmp.economic`** - Economic indicators
|
|
75
74
|
- **`fmp.market`** - Market-wide data and performance
|
|
76
75
|
- **`fmp.list`** - Stock lists and indices
|
|
@@ -409,7 +408,7 @@ pnpm test:watch # Watch mode for development
|
|
|
409
408
|
pnpm test:coverage # Generate coverage report
|
|
410
409
|
```
|
|
411
410
|
|
|
412
|
-
**Note**: Additional endpoint-specific test scripts (crypto, etf, mutual-fund
|
|
411
|
+
**Note**: Additional endpoint-specific test scripts (crypto, etf, mutual-fund) are available in the package-level scripts but not exposed at the root level.
|
|
413
412
|
|
|
414
413
|
## Development
|
|
415
414
|
|
|
@@ -493,7 +492,6 @@ src/
|
|
|
493
492
|
│ ├── crypto.ts # Crypto types
|
|
494
493
|
│ ├── etf.ts # ETF types
|
|
495
494
|
│ ├── mutual-fund.ts # Mutual fund types
|
|
496
|
-
│ ├── bond.ts # Bond types
|
|
497
495
|
│ ├── economic.ts # Economic types
|
|
498
496
|
│ ├── market.ts # Market types
|
|
499
497
|
│ ├── list.ts # List types
|
|
@@ -507,7 +505,6 @@ src/
|
|
|
507
505
|
│ ├── crypto.ts
|
|
508
506
|
│ ├── etf.ts
|
|
509
507
|
│ ├── mutual-fund.ts
|
|
510
|
-
│ ├── bond.ts
|
|
511
508
|
│ ├── economic.ts
|
|
512
509
|
│ ├── market.ts
|
|
513
510
|
│ ├── list.ts
|
|
@@ -531,7 +528,6 @@ src/
|
|
|
531
528
|
│ │ ├── crypto.test.ts
|
|
532
529
|
│ │ ├── etf.test.ts
|
|
533
530
|
│ │ ├── mutual-fund.test.ts
|
|
534
|
-
│ │ ├── bond.test.ts
|
|
535
531
|
│ │ ├── list.test.ts
|
|
536
532
|
│ │ ├── calendar.test.ts
|
|
537
533
|
│ │ └── company.test.ts
|
|
@@ -578,7 +574,7 @@ pnpm test
|
|
|
578
574
|
|
|
579
575
|
- **📖 [Contributing Guide](https://github.com/e-roy/fmp-node-wrapper/blob/main/CONTRIBUTING.md)**: Detailed guidelines and development setup
|
|
580
576
|
- **🐛 [Issues](https://github.com/e-roy/fmp-node-wrapper/issues)**: Report bugs or request features
|
|
581
|
-
- **📚 [Documentation](https://fmp-node-wrapper.vercel.app)**: Check the docs first
|
|
577
|
+
- **📚 [Documentation](https://fmp-node-wrapper-docs.vercel.app)**: Check the docs first
|
|
582
578
|
|
|
583
579
|
### Before Contributing
|
|
584
580
|
|
package/dist/index.d.mts
CHANGED
|
@@ -33,64 +33,80 @@ interface PaginationParams {
|
|
|
33
33
|
interface PeriodParams {
|
|
34
34
|
period?: 'annual' | 'quarter';
|
|
35
35
|
}
|
|
36
|
-
interface
|
|
37
|
-
|
|
38
|
-
open: number;
|
|
39
|
-
high: number;
|
|
40
|
-
low: number;
|
|
41
|
-
close: number;
|
|
42
|
-
adjClose: number;
|
|
43
|
-
volume: number;
|
|
44
|
-
unadjustedVolume: number;
|
|
45
|
-
change: number;
|
|
46
|
-
changePercent: number;
|
|
47
|
-
vwap: number;
|
|
48
|
-
label: string;
|
|
49
|
-
changeOverTime: number;
|
|
36
|
+
interface QueryParams {
|
|
37
|
+
[key: string]: string | number | boolean | undefined;
|
|
50
38
|
}
|
|
51
|
-
|
|
39
|
+
declare enum Period {
|
|
40
|
+
ANNUAL = "annual",
|
|
41
|
+
QUARTER = "quarter"
|
|
42
|
+
}
|
|
43
|
+
declare enum Exchange {
|
|
44
|
+
NYSE = "NYSE",
|
|
45
|
+
NASDAQ = "NASDAQ",
|
|
46
|
+
AMEX = "AMEX",
|
|
47
|
+
TSX = "TSX",
|
|
48
|
+
LSE = "LSE",
|
|
49
|
+
ASX = "ASX",
|
|
50
|
+
NSE = "NSE",
|
|
51
|
+
BSE = "BSE"
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
interface QuoteParams {
|
|
52
55
|
symbol: string;
|
|
53
|
-
historical: HistoricalPriceData[];
|
|
54
56
|
}
|
|
55
|
-
interface
|
|
56
|
-
|
|
57
|
+
interface HistoricalPriceParams {
|
|
58
|
+
symbol: string;
|
|
59
|
+
from?: string;
|
|
60
|
+
to?: string;
|
|
61
|
+
}
|
|
62
|
+
interface IntradayParams {
|
|
63
|
+
symbol: string;
|
|
64
|
+
interval: '1min' | '5min' | '15min' | '30min' | '1hour' | '4hour';
|
|
65
|
+
from?: string;
|
|
66
|
+
to?: string;
|
|
57
67
|
}
|
|
58
68
|
interface Quote {
|
|
59
69
|
symbol: string;
|
|
70
|
+
name: string;
|
|
60
71
|
price: number;
|
|
72
|
+
changesPercentage: number;
|
|
61
73
|
change: number;
|
|
62
|
-
changePercent: number;
|
|
63
74
|
dayLow: number;
|
|
64
75
|
dayHigh: number;
|
|
65
|
-
yearLow: number;
|
|
66
76
|
yearHigh: number;
|
|
67
|
-
|
|
77
|
+
yearLow: number;
|
|
78
|
+
marketCap: number | null;
|
|
68
79
|
priceAvg50: number;
|
|
69
80
|
priceAvg200: number;
|
|
81
|
+
exchange: string;
|
|
70
82
|
volume: number;
|
|
71
83
|
avgVolume: number;
|
|
72
|
-
exchange: string;
|
|
73
84
|
open: number;
|
|
74
85
|
previousClose: number;
|
|
75
|
-
eps: number;
|
|
76
|
-
pe: number;
|
|
77
|
-
earningsAnnouncement: string;
|
|
78
|
-
sharesOutstanding: number;
|
|
86
|
+
eps: number | null;
|
|
87
|
+
pe: number | null;
|
|
88
|
+
earningsAnnouncement: string | null;
|
|
89
|
+
sharesOutstanding: number | null;
|
|
79
90
|
timestamp: number;
|
|
80
91
|
}
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
92
|
+
interface HistoricalPriceData {
|
|
93
|
+
date: string;
|
|
94
|
+
open: number;
|
|
95
|
+
high: number;
|
|
96
|
+
low: number;
|
|
97
|
+
close: number;
|
|
98
|
+
adjClose: number;
|
|
99
|
+
volume: number;
|
|
100
|
+
unadjustedVolume: number;
|
|
101
|
+
change: number;
|
|
102
|
+
changePercent: number;
|
|
103
|
+
vwap: number;
|
|
104
|
+
label: string;
|
|
105
|
+
changeOverTime: number;
|
|
84
106
|
}
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
AMEX = "AMEX",
|
|
89
|
-
TSX = "TSX",
|
|
90
|
-
LSE = "LSE",
|
|
91
|
-
ASX = "ASX",
|
|
92
|
-
NSE = "NSE",
|
|
93
|
-
BSE = "BSE"
|
|
107
|
+
interface HistoricalPriceResponse {
|
|
108
|
+
symbol: string;
|
|
109
|
+
historical: HistoricalPriceData[];
|
|
94
110
|
}
|
|
95
111
|
|
|
96
112
|
interface StockQuote {
|
|
@@ -561,13 +577,9 @@ interface EarningsSurprises {
|
|
|
561
577
|
estimatedEarning: number;
|
|
562
578
|
}
|
|
563
579
|
|
|
564
|
-
interface ForexQuoteParams extends SymbolParams {
|
|
565
|
-
}
|
|
566
580
|
interface ForexHistoricalParams extends SymbolParams, DateRangeParams {
|
|
567
581
|
timeseries?: number;
|
|
568
582
|
}
|
|
569
|
-
interface ForexListParams {
|
|
570
|
-
}
|
|
571
583
|
interface ForexQuote {
|
|
572
584
|
symbol: string;
|
|
573
585
|
price: number;
|
|
@@ -698,14 +710,6 @@ interface ETFStockExposure {
|
|
|
698
710
|
marketValue: number;
|
|
699
711
|
}
|
|
700
712
|
|
|
701
|
-
interface MutualFundQuoteParams extends SymbolParams {
|
|
702
|
-
}
|
|
703
|
-
interface MutualFundProfileParams extends SymbolParams {
|
|
704
|
-
}
|
|
705
|
-
interface MutualFundHoldersParams extends SymbolParams, PaginationParams {
|
|
706
|
-
}
|
|
707
|
-
interface MutualFundListParams {
|
|
708
|
-
}
|
|
709
713
|
interface MutualFundQuote {
|
|
710
714
|
symbol: string;
|
|
711
715
|
price: number;
|
|
@@ -729,99 +733,17 @@ interface MutualFundQuote {
|
|
|
729
733
|
sharesOutstanding: number;
|
|
730
734
|
timestamp: number;
|
|
731
735
|
}
|
|
732
|
-
interface MutualFundProfile {
|
|
733
|
-
symbol: string;
|
|
734
|
-
price: number;
|
|
735
|
-
beta: number;
|
|
736
|
-
volAvg: number;
|
|
737
|
-
marketCap: number;
|
|
738
|
-
lastDiv: number;
|
|
739
|
-
range: string;
|
|
740
|
-
changes: number;
|
|
741
|
-
companyName: string;
|
|
742
|
-
currency: string;
|
|
743
|
-
cik: string;
|
|
744
|
-
isin: string;
|
|
745
|
-
cusip: string;
|
|
746
|
-
exchange: string;
|
|
747
|
-
exchangeShortName: string;
|
|
748
|
-
industry: string;
|
|
749
|
-
website: string;
|
|
750
|
-
description: string;
|
|
751
|
-
ceo: string;
|
|
752
|
-
sector: string;
|
|
753
|
-
country: string;
|
|
754
|
-
fullTimeEmployees: string;
|
|
755
|
-
phone: string;
|
|
756
|
-
address: string;
|
|
757
|
-
city: string;
|
|
758
|
-
state: string;
|
|
759
|
-
zip: string;
|
|
760
|
-
dcfDiff: number;
|
|
761
|
-
dcf: number;
|
|
762
|
-
image: string;
|
|
763
|
-
ipoDate: string;
|
|
764
|
-
defaultImage: boolean;
|
|
765
|
-
isEtf: boolean;
|
|
766
|
-
isActivelyTrading: boolean;
|
|
767
|
-
isAdr: boolean;
|
|
768
|
-
isFund: boolean;
|
|
769
|
-
}
|
|
770
736
|
interface MutualFundHolding {
|
|
771
|
-
|
|
772
|
-
weightPercent: number;
|
|
737
|
+
holder: string;
|
|
773
738
|
shares: number;
|
|
774
|
-
|
|
775
|
-
}
|
|
776
|
-
|
|
777
|
-
interface BondQuoteParams extends SymbolParams {
|
|
778
|
-
}
|
|
779
|
-
interface BondHistoricalParams extends SymbolParams, DateRangeParams {
|
|
780
|
-
timeseries?: number;
|
|
781
|
-
}
|
|
782
|
-
interface BondListParams {
|
|
783
|
-
}
|
|
784
|
-
interface BondQuote {
|
|
785
|
-
symbol: string;
|
|
786
|
-
price: number;
|
|
787
|
-
changesPercentage: number;
|
|
739
|
+
dateReported: string;
|
|
788
740
|
change: number;
|
|
789
|
-
|
|
790
|
-
dayHigh: number;
|
|
791
|
-
yearLow: number;
|
|
792
|
-
yearHigh: number;
|
|
793
|
-
marketCap: number;
|
|
794
|
-
priceAvg50: number;
|
|
795
|
-
priceAvg200: number;
|
|
796
|
-
volume: number;
|
|
797
|
-
avgVolume: number;
|
|
798
|
-
exchange: string;
|
|
799
|
-
open: number;
|
|
800
|
-
previousClose: number;
|
|
801
|
-
eps: number;
|
|
802
|
-
pe: number;
|
|
803
|
-
earningsAnnouncement: string;
|
|
804
|
-
sharesOutstanding: number;
|
|
805
|
-
timestamp: number;
|
|
741
|
+
weightPercent: number;
|
|
806
742
|
}
|
|
807
743
|
|
|
808
|
-
interface EconomicIndicatorParams extends DateRangeParams {
|
|
809
|
-
}
|
|
810
|
-
interface TreasuryRateParams extends EconomicIndicatorParams {
|
|
811
|
-
}
|
|
812
|
-
interface FederalFundsRateParams extends EconomicIndicatorParams {
|
|
813
|
-
}
|
|
814
|
-
interface CPIParams extends EconomicIndicatorParams {
|
|
815
|
-
}
|
|
816
|
-
interface GDPParams extends EconomicIndicatorParams {
|
|
817
|
-
}
|
|
818
|
-
interface UnemploymentParams extends EconomicIndicatorParams {
|
|
819
|
-
}
|
|
820
744
|
interface EconomicIndicator {
|
|
821
745
|
date: string;
|
|
822
746
|
value: number;
|
|
823
|
-
change: number;
|
|
824
|
-
changePercent: number;
|
|
825
747
|
}
|
|
826
748
|
interface TreasuryRate {
|
|
827
749
|
date: string;
|
|
@@ -838,27 +760,11 @@ interface TreasuryRate {
|
|
|
838
760
|
year20: number;
|
|
839
761
|
year30: number;
|
|
840
762
|
}
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
date: string;
|
|
847
|
-
value: number;
|
|
848
|
-
change: number;
|
|
849
|
-
changePercent: number;
|
|
850
|
-
}
|
|
851
|
-
interface GDP {
|
|
852
|
-
date: string;
|
|
853
|
-
value: number;
|
|
854
|
-
change: number;
|
|
855
|
-
changePercent: number;
|
|
856
|
-
}
|
|
857
|
-
interface Unemployment {
|
|
858
|
-
date: string;
|
|
859
|
-
value: number;
|
|
860
|
-
change: number;
|
|
861
|
-
changePercent: number;
|
|
763
|
+
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';
|
|
764
|
+
interface EconomicIndicatorParams {
|
|
765
|
+
name: EconomicIndicatorName;
|
|
766
|
+
from?: string;
|
|
767
|
+
to?: string;
|
|
862
768
|
}
|
|
863
769
|
|
|
864
770
|
interface MarketHours {
|
|
@@ -1106,6 +1012,42 @@ interface EarningsCallTranscript {
|
|
|
1106
1012
|
content: string;
|
|
1107
1013
|
}
|
|
1108
1014
|
|
|
1015
|
+
interface SenateHouseTradingParams {
|
|
1016
|
+
symbol: string;
|
|
1017
|
+
}
|
|
1018
|
+
interface SenateHouseTradingRSSFeedParams {
|
|
1019
|
+
page: number;
|
|
1020
|
+
}
|
|
1021
|
+
interface SenateTradingResponse {
|
|
1022
|
+
firstName: string;
|
|
1023
|
+
lastName: string;
|
|
1024
|
+
office: string;
|
|
1025
|
+
link: string;
|
|
1026
|
+
dateRecieved: string;
|
|
1027
|
+
transactionDate: string;
|
|
1028
|
+
owner: string;
|
|
1029
|
+
assetDescription: string;
|
|
1030
|
+
assetType: string;
|
|
1031
|
+
type: string;
|
|
1032
|
+
amount: string;
|
|
1033
|
+
comment: string;
|
|
1034
|
+
symbol: string;
|
|
1035
|
+
}
|
|
1036
|
+
interface HouseTradingResponse {
|
|
1037
|
+
disclosureYear: string;
|
|
1038
|
+
disclosureDate: string;
|
|
1039
|
+
transactionDate: string;
|
|
1040
|
+
owner: string;
|
|
1041
|
+
ticker: string;
|
|
1042
|
+
assetDescription: string;
|
|
1043
|
+
type: string;
|
|
1044
|
+
amount: string;
|
|
1045
|
+
representative: string;
|
|
1046
|
+
district: string;
|
|
1047
|
+
link: string;
|
|
1048
|
+
capitalGainsOver200USD: string;
|
|
1049
|
+
}
|
|
1050
|
+
|
|
1109
1051
|
declare class FMPClient {
|
|
1110
1052
|
private v3Client;
|
|
1111
1053
|
private v4Client;
|
|
@@ -1123,7 +1065,7 @@ declare class StockEndpoints {
|
|
|
1123
1065
|
constructor(client: FMPClient);
|
|
1124
1066
|
/**
|
|
1125
1067
|
* Get real-time stock quote
|
|
1126
|
-
*
|
|
1068
|
+
* @deprecated Use `fmp.quote.getQuote()` instead. This method will be removed in version 0.1.0.
|
|
1127
1069
|
* @param symbol - The stock symbol to get the quote for
|
|
1128
1070
|
* @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.
|
|
1129
1071
|
*/
|
|
@@ -1132,7 +1074,7 @@ declare class StockEndpoints {
|
|
|
1132
1074
|
}): Promise<APIResponse<StockQuote | null>>;
|
|
1133
1075
|
/**
|
|
1134
1076
|
* Get historical stock prices
|
|
1135
|
-
*
|
|
1077
|
+
* @deprecated Use `fmp.quote.getHistoricalPrice()` instead. This method will be removed in version 0.1.0.
|
|
1136
1078
|
* @param symbol - The stock symbol to get the historical prices for
|
|
1137
1079
|
* @param from - The start date to get the historical prices for
|
|
1138
1080
|
* @param to - The end date to get the historical prices for
|
|
@@ -1288,12 +1230,14 @@ declare class ForexEndpoints {
|
|
|
1288
1230
|
constructor(client: FMPClient);
|
|
1289
1231
|
/**
|
|
1290
1232
|
* Get forex quote
|
|
1233
|
+
* @deprecated Use `fmp.quote.getQuote()` instead. This method will be removed in version 0.1.0.
|
|
1291
1234
|
* @param params - Parameters for the forex quote request
|
|
1292
1235
|
* @returns Forex quote data
|
|
1293
1236
|
*/
|
|
1294
|
-
getQuote(params:
|
|
1237
|
+
getQuote(params: SymbolParams): Promise<APIResponse<ForexQuote[]>>;
|
|
1295
1238
|
/**
|
|
1296
1239
|
* Get historical forex prices
|
|
1240
|
+
* @deprecated Use `fmp.quote.getHistoricalPrice()` instead. This method will be removed in version 0.1.0.
|
|
1297
1241
|
* @param symbol - The forex symbol to get the historical prices for
|
|
1298
1242
|
* @param from - The start date to get the historical prices for
|
|
1299
1243
|
* @param to - The end date to get the historical prices for
|
|
@@ -1304,17 +1248,6 @@ declare class ForexEndpoints {
|
|
|
1304
1248
|
from?: string;
|
|
1305
1249
|
to?: string;
|
|
1306
1250
|
}): Promise<APIResponse<HistoricalPriceResponse>>;
|
|
1307
|
-
/**
|
|
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
|
|
1311
|
-
*/
|
|
1312
|
-
getForexRates(baseCurrency?: string): Promise<APIResponse<Record<string, number>>>;
|
|
1313
|
-
/**
|
|
1314
|
-
* Get all forex rates
|
|
1315
|
-
* @returns All forex rates data
|
|
1316
|
-
*/
|
|
1317
|
-
getAllForexRates(): Promise<APIResponse<Record<string, Record<string, number>>>>;
|
|
1318
1251
|
}
|
|
1319
1252
|
|
|
1320
1253
|
declare class CryptoEndpoints {
|
|
@@ -1322,7 +1255,7 @@ declare class CryptoEndpoints {
|
|
|
1322
1255
|
constructor(client: FMPClient);
|
|
1323
1256
|
/**
|
|
1324
1257
|
* Get crypto quote
|
|
1325
|
-
*
|
|
1258
|
+
* @deprecated Use `fmp.quote.getQuote()` instead. This method will be removed in version 0.1.0.
|
|
1326
1259
|
* @param symbol - The crypto symbol to get the quote for
|
|
1327
1260
|
* @returns Crypto quote data
|
|
1328
1261
|
*/
|
|
@@ -1331,7 +1264,7 @@ declare class CryptoEndpoints {
|
|
|
1331
1264
|
}): Promise<APIResponse<CryptoQuote | null>>;
|
|
1332
1265
|
/**
|
|
1333
1266
|
* Get historical crypto prices
|
|
1334
|
-
*
|
|
1267
|
+
* @deprecated Use `fmp.quote.getHistoricalPrice()` instead. This method will be removed in version 0.1.0.
|
|
1335
1268
|
* @param symbol - The crypto symbol to get the historical prices for
|
|
1336
1269
|
* @param from - The start date to get the historical prices for
|
|
1337
1270
|
* @param to - The end date to get the historical prices for
|
|
@@ -1407,41 +1340,18 @@ declare class MutualFundEndpoints {
|
|
|
1407
1340
|
constructor(client: FMPClient);
|
|
1408
1341
|
/**
|
|
1409
1342
|
* Get mutual fund quote
|
|
1343
|
+
* @deprecated Use `fmp.quote.getQuote()` instead. This method will be removed in a future release.
|
|
1410
1344
|
* @param params - Parameters for the mutual fund quote request
|
|
1411
1345
|
* @returns Mutual fund quote data
|
|
1412
1346
|
*/
|
|
1413
|
-
getQuote(params:
|
|
1347
|
+
getQuote(params: SymbolParams): Promise<APIResponse<MutualFundQuote[]>>;
|
|
1414
1348
|
/**
|
|
1415
|
-
* Get mutual fund
|
|
1349
|
+
* Get mutual fund holders
|
|
1350
|
+
* https://site.financialmodelingprep.com/developer/docs#mutual-fund-holder-mutual-funds-holdings
|
|
1351
|
+
* @param symbol - The symbol of the mutual fund to get the holders for
|
|
1352
|
+
* @returns Mutual fund holders data
|
|
1416
1353
|
*/
|
|
1417
|
-
|
|
1418
|
-
/**
|
|
1419
|
-
* Get mutual fund holdings
|
|
1420
|
-
*/
|
|
1421
|
-
getHoldings(params: MutualFundHoldersParams): Promise<APIResponse<MutualFundHolding[]>>;
|
|
1422
|
-
}
|
|
1423
|
-
|
|
1424
|
-
declare class BondEndpoints {
|
|
1425
|
-
private client;
|
|
1426
|
-
constructor(client: FMPClient);
|
|
1427
|
-
/**
|
|
1428
|
-
* Get bond quote
|
|
1429
|
-
* @param params - Parameters for the bond quote request
|
|
1430
|
-
* @returns Bond quote data
|
|
1431
|
-
*/
|
|
1432
|
-
getQuote(params: BondQuoteParams): Promise<APIResponse<BondQuote[]>>;
|
|
1433
|
-
/**
|
|
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
|
|
1439
|
-
*/
|
|
1440
|
-
getHistoricalPrice({ symbol, from, to, }: {
|
|
1441
|
-
symbol: string;
|
|
1442
|
-
from?: string;
|
|
1443
|
-
to?: string;
|
|
1444
|
-
}): Promise<APIResponse<HistoricalPriceResponse>>;
|
|
1354
|
+
getHolders({ symbol }: SymbolParams): Promise<APIResponse<MutualFundHolding[]>>;
|
|
1445
1355
|
}
|
|
1446
1356
|
|
|
1447
1357
|
declare class EconomicEndpoints {
|
|
@@ -1449,24 +1359,21 @@ declare class EconomicEndpoints {
|
|
|
1449
1359
|
constructor(client: FMPClient);
|
|
1450
1360
|
/**
|
|
1451
1361
|
* Get treasury rates
|
|
1362
|
+
* https://site.financialmodelingprep.com/developer/docs#treasury-rates-economics-data
|
|
1363
|
+
* @param from - The start date to get the treasury rates for
|
|
1364
|
+
* @param to - The end date to get the treasury rates for
|
|
1365
|
+
* @returns Treasury rates data
|
|
1452
1366
|
*/
|
|
1453
|
-
getTreasuryRates(params
|
|
1454
|
-
/**
|
|
1455
|
-
* Get federal funds rate
|
|
1456
|
-
*/
|
|
1457
|
-
getFederalFundsRate(params?: FederalFundsRateParams): Promise<APIResponse<FederalFundsRate[]>>;
|
|
1458
|
-
/**
|
|
1459
|
-
* Get CPI data
|
|
1460
|
-
*/
|
|
1461
|
-
getCPI(params?: CPIParams): Promise<APIResponse<CPI[]>>;
|
|
1462
|
-
/**
|
|
1463
|
-
* Get GDP data
|
|
1464
|
-
*/
|
|
1465
|
-
getGDP(params?: GDPParams): Promise<APIResponse<GDP[]>>;
|
|
1367
|
+
getTreasuryRates(params: DateRangeParams): Promise<APIResponse<TreasuryRate[]>>;
|
|
1466
1368
|
/**
|
|
1467
|
-
* Get
|
|
1369
|
+
* Get economic indicators
|
|
1370
|
+
* https://site.financialmodelingprep.com/developer/docs#economic-indicators-economics-data
|
|
1371
|
+
* @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
|
|
1372
|
+
* @param from - The start date to get the economic indicators for
|
|
1373
|
+
* @param to - The end date to get the economic indicators for
|
|
1374
|
+
* @returns Provides real-time and historical economic data for a variety of economic indicators, such as GDP, unemployment, and inflation.
|
|
1468
1375
|
*/
|
|
1469
|
-
|
|
1376
|
+
getEconomicIndicators(params: EconomicIndicatorParams): Promise<APIResponse<EconomicIndicator[]>>;
|
|
1470
1377
|
}
|
|
1471
1378
|
|
|
1472
1379
|
declare class MarketEndpoints {
|
|
@@ -1662,6 +1569,66 @@ declare class CompanyEndpoints {
|
|
|
1662
1569
|
}): Promise<APIResponse<EarningsCallTranscript[] | null>>;
|
|
1663
1570
|
}
|
|
1664
1571
|
|
|
1572
|
+
declare class QuoteEndpoints {
|
|
1573
|
+
private client;
|
|
1574
|
+
constructor(client: FMPClient);
|
|
1575
|
+
/**
|
|
1576
|
+
* Get quote for any asset type (stock, crypto, forex, commodity, ETF)
|
|
1577
|
+
* @param params - Parameters for the quote request
|
|
1578
|
+
* @returns Quote data for the specified asset
|
|
1579
|
+
*/
|
|
1580
|
+
getQuote(params: QuoteParams): Promise<APIResponse<Quote | null>>;
|
|
1581
|
+
/**
|
|
1582
|
+
* Get historical prices for any asset type
|
|
1583
|
+
* @param params - Parameters for the historical price request
|
|
1584
|
+
* @returns Historical price data for the specified asset
|
|
1585
|
+
*/
|
|
1586
|
+
getHistoricalPrice(params: HistoricalPriceParams): Promise<APIResponse<HistoricalPriceResponse>>;
|
|
1587
|
+
/**
|
|
1588
|
+
* Get multiple quotes for any asset type
|
|
1589
|
+
* @param symbols - Array of symbols to get quotes for
|
|
1590
|
+
* @returns Array of quote data
|
|
1591
|
+
*/
|
|
1592
|
+
getQuotes(symbols: string[]): Promise<APIResponse<Quote[]>>;
|
|
1593
|
+
/**
|
|
1594
|
+
* Get intraday data for any asset type
|
|
1595
|
+
* @param params - Parameters for the intraday request
|
|
1596
|
+
* @returns Intraday price data for the specified asset
|
|
1597
|
+
*/
|
|
1598
|
+
getIntraday(params: IntradayParams): Promise<APIResponse<HistoricalPriceData[]>>;
|
|
1599
|
+
}
|
|
1600
|
+
|
|
1601
|
+
declare class SenateHouseEndpoints {
|
|
1602
|
+
private client;
|
|
1603
|
+
constructor(client: FMPClient);
|
|
1604
|
+
/**
|
|
1605
|
+
* Get senate trading data only
|
|
1606
|
+
* https://site.financialmodelingprep.com/developer/docs#senate-trading
|
|
1607
|
+
* @param symbol - The stock symbol to get the senate trading data for
|
|
1608
|
+
* @returns Senate trading data only
|
|
1609
|
+
*/
|
|
1610
|
+
getSenateTrading(params: SenateHouseTradingParams): Promise<APIResponse<SenateTradingResponse[]>>;
|
|
1611
|
+
/** Get senate trading RSS feed
|
|
1612
|
+
* https://site.financialmodelingprep.com/developer/docs#senate-trading-rss-feed-senate
|
|
1613
|
+
* @param page - The page number to get
|
|
1614
|
+
* @returns Senate trading RSS feed
|
|
1615
|
+
*/
|
|
1616
|
+
getSenateTradingRSSFeed(params: SenateHouseTradingRSSFeedParams): Promise<APIResponse<SenateTradingResponse[]>>;
|
|
1617
|
+
/**
|
|
1618
|
+
* Get house trading data only
|
|
1619
|
+
* https://site.financialmodelingprep.com/developer/docs#house-disclosure
|
|
1620
|
+
* @param symbol - The stock symbol to get the house trading data for
|
|
1621
|
+
* @returns House trading data only
|
|
1622
|
+
*/
|
|
1623
|
+
getHouseTrading(params: SenateHouseTradingParams): Promise<APIResponse<HouseTradingResponse[]>>;
|
|
1624
|
+
/** Get house trading RSS feed
|
|
1625
|
+
* https://site.financialmodelingprep.com/developer/docs#house-disclosure-rss-feed-senate
|
|
1626
|
+
* @param page - The page number to get
|
|
1627
|
+
* @returns House trading RSS feed
|
|
1628
|
+
*/
|
|
1629
|
+
getHouseTradingRSSFeed(params: SenateHouseTradingRSSFeedParams): Promise<APIResponse<SenateTradingResponse[]>>;
|
|
1630
|
+
}
|
|
1631
|
+
|
|
1665
1632
|
/**
|
|
1666
1633
|
* Main FMP API client that provides access to all endpoints
|
|
1667
1634
|
*
|
|
@@ -1691,12 +1658,13 @@ declare class FMP {
|
|
|
1691
1658
|
readonly crypto: CryptoEndpoints;
|
|
1692
1659
|
readonly etf: ETFEndpoints;
|
|
1693
1660
|
readonly mutualFund: MutualFundEndpoints;
|
|
1694
|
-
readonly bond: BondEndpoints;
|
|
1695
1661
|
readonly economic: EconomicEndpoints;
|
|
1696
1662
|
readonly market: MarketEndpoints;
|
|
1697
1663
|
readonly list: ListEndpoints;
|
|
1698
1664
|
readonly calendar: CalendarEndpoints;
|
|
1699
1665
|
readonly company: CompanyEndpoints;
|
|
1666
|
+
readonly quote: QuoteEndpoints;
|
|
1667
|
+
readonly senateHouse: SenateHouseEndpoints;
|
|
1700
1668
|
constructor(config: FMPConfig);
|
|
1701
1669
|
/**
|
|
1702
1670
|
* Get the underlying client instance for advanced usage
|
|
@@ -1828,4 +1796,4 @@ declare const HTTP_STATUS: {
|
|
|
1828
1796
|
readonly INTERNAL_SERVER_ERROR: 500;
|
|
1829
1797
|
};
|
|
1830
1798
|
|
|
1831
|
-
export { type APIResponse, type AvailableIndexesList, type BalanceSheet, type BalanceSheetGrowth,
|
|
1799
|
+
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 };
|