fmp-node-types 0.1.2 → 0.1.3

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.
Files changed (3) hide show
  1. package/dist/index.d.mts +610 -549
  2. package/dist/index.d.ts +610 -549
  3. package/package.json +1 -1
package/dist/index.d.mts CHANGED
@@ -1,3 +1,65 @@
1
+ interface EarningsCalendar {
2
+ date: string;
3
+ symbol: string;
4
+ eps: number | null;
5
+ epsEstimated: number | null;
6
+ time: string;
7
+ revenue: number | null;
8
+ revenueEstimated: number | null;
9
+ fiscalDateEnding: string;
10
+ updatedFromDate: string;
11
+ }
12
+ interface EarningsConfirmed {
13
+ symbol: string;
14
+ exchange: string;
15
+ time: string;
16
+ when: string;
17
+ date: string;
18
+ publicationDate: string;
19
+ title: string;
20
+ url: string;
21
+ }
22
+ interface DividendsCalendar {
23
+ date: string;
24
+ label: string;
25
+ adjDividend: number;
26
+ symbol: string;
27
+ dividend: number;
28
+ recordDate: string;
29
+ paymentDate: string;
30
+ declarationDate: string;
31
+ }
32
+ interface EconomicsCalendar {
33
+ date: string;
34
+ country: string;
35
+ event: string;
36
+ currency: string;
37
+ previous: number;
38
+ estimate: number | null;
39
+ actual: number | null;
40
+ change: number;
41
+ impact: string;
42
+ changePercentage: number;
43
+ unit: string | null;
44
+ }
45
+ interface IPOCalendar {
46
+ date: string;
47
+ company: string;
48
+ symbol: string;
49
+ exchange: string;
50
+ actions: string;
51
+ shares: number | null;
52
+ priceRange: string | null;
53
+ marketCap: number | null;
54
+ }
55
+ interface SplitsCalendar {
56
+ date: string;
57
+ label: string;
58
+ symbol: string;
59
+ numerator: number;
60
+ denominator: number;
61
+ }
62
+
1
63
  interface APIResponse<T = unknown> {
2
64
  success: boolean;
3
65
  data: T | null;
@@ -40,122 +102,223 @@ declare enum Exchange {
40
102
  BSE = "BSE"
41
103
  }
42
104
 
43
- interface Quote {
105
+ interface CompanyProfile {
44
106
  symbol: string;
45
- name: string;
46
107
  price: number;
47
- changesPercentage: number;
108
+ marketCap: number;
109
+ beta: number;
110
+ lastDividend: number;
111
+ range: string;
48
112
  change: number;
49
- dayLow: number;
50
- dayHigh: number;
51
- yearHigh: number;
52
- yearLow: number;
53
- marketCap: number | null;
54
- priceAvg50: number;
55
- priceAvg200: number;
56
- exchange: string;
57
- volume: number;
58
- avgVolume: number;
59
- open: number;
60
- previousClose: number;
61
- eps: number | null;
62
- pe: number | null;
63
- earningsAnnouncement: string | null;
64
- sharesOutstanding: number | null;
65
- timestamp: number;
66
- }
67
- interface HistoricalPriceData {
68
- date: string;
69
- open: number;
70
- high: number;
71
- low: number;
72
- close: number;
73
- adjClose: number;
113
+ changePercentage: number;
74
114
  volume: number;
75
- unadjustedVolume: number;
76
- change: number;
77
- changePercent: number;
78
- vwap: number;
79
- label: string;
80
- changeOverTime: number;
115
+ averageVolume: number;
116
+ companyName: string;
117
+ currency: string;
118
+ cik: string;
119
+ isin: string;
120
+ cusip: string;
121
+ exchangeFullName: string;
122
+ exchange: string;
123
+ industry: string;
124
+ website: string;
125
+ description: string;
126
+ ceo: string;
127
+ sector: string;
128
+ country: string;
129
+ fullTimeEmployees: string;
130
+ phone: string;
131
+ address: string;
132
+ city: string;
133
+ state: string;
134
+ zip: string;
135
+ image: string;
136
+ ipoDate: string;
137
+ defaultImage: boolean;
138
+ isEtf: boolean;
139
+ isActivelyTrading: boolean;
140
+ isAdr: boolean;
141
+ isFund: boolean;
81
142
  }
82
- interface HistoricalPriceResponse {
143
+ interface ExecutiveCompensation {
144
+ cik: string;
83
145
  symbol: string;
84
- historical: HistoricalPriceData[];
85
- }
86
-
87
- interface StockSplit {
88
- date: string;
89
- label: string;
90
- numerator: number;
91
- denominator: number;
146
+ companyName: string;
147
+ filingDate: string;
148
+ acceptedDate: string;
149
+ nameAndPosition: string;
150
+ year: number;
151
+ salary: number;
152
+ bonus: number;
153
+ stockAward: number;
154
+ optionAward: number;
155
+ incentivePlanCompensation: number;
156
+ allOtherCompensation: number;
157
+ total: number;
158
+ link: string;
92
159
  }
93
- interface StockSplitResponse {
160
+ interface CompanyNotes {
161
+ cik: string;
94
162
  symbol: string;
95
- historical: StockSplit[];
96
- }
97
- interface StockDividend {
98
- date: string;
99
- label: string;
100
- adjDividend: number;
101
- dividend: number;
102
- recordDate: string;
103
- paymentDate: string;
104
- declarationDate: string;
163
+ title: string;
164
+ exchange: string;
105
165
  }
106
- interface StockDividendResponse {
166
+ interface HistoricalEmployeeCount {
107
167
  symbol: string;
108
- historical: StockDividend[];
168
+ cik: string;
169
+ acceptanceTime: string;
170
+ periodOfReport: string;
171
+ companyName: string;
172
+ formType: string;
173
+ filingDate: string;
174
+ employeeCount: number;
175
+ source: string;
109
176
  }
110
- interface MarketCap {
177
+ interface SharesFloat {
111
178
  symbol: string;
179
+ freeFloat: number;
180
+ floatShares: number;
181
+ outstandingShares: number;
182
+ source: string;
112
183
  date: string;
113
- marketCap: number;
114
184
  }
115
- interface StockRealTimePrice {
185
+ interface HistoricalSharesFloat {
116
186
  symbol: string;
117
- price: number;
187
+ freeFloat: number;
188
+ floatShares: string;
189
+ outstandingShares: string;
190
+ source: string;
191
+ date: string;
118
192
  }
119
- interface StockRealTimePriceFull {
120
- bidSize: number;
121
- askPrice: number;
122
- volume: number;
123
- askSize: number;
124
- bidPrice: number;
125
- lastSalePrice: number;
126
- lastSaleSize: number;
127
- lastSaleTime: number;
128
- fmpLast: number;
129
- lastUpdated: number;
193
+ interface EarningsCallTranscript {
130
194
  symbol: string;
195
+ quarter: number;
196
+ year: number;
197
+ date: string;
198
+ content: string;
131
199
  }
132
- interface StockListResponse<T> {
133
- stockList: T[];
200
+ type CompanyTranscriptData = [number, number, string];
201
+
202
+ interface EconomicIndicator {
203
+ name: string;
204
+ date: string;
205
+ value: number;
134
206
  }
135
- interface CompaniesPriceListResponse<T> {
136
- companiesPriceList: T[];
207
+ interface TreasuryRate {
208
+ date: string;
209
+ month1: number;
210
+ month2: number;
211
+ month3: number;
212
+ month6: number;
213
+ year1: number;
214
+ year2: number;
215
+ year3: number;
216
+ year5: number;
217
+ year7: number;
218
+ year10: number;
219
+ year20: number;
220
+ year30: number;
137
221
  }
222
+ 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';
138
223
 
139
- interface IncomeStatement {
224
+ interface ETFHoldingDates {
140
225
  date: string;
141
- symbol: string;
142
- reportedCurrency: string;
226
+ }
227
+ interface ETFHolding {
143
228
  cik: string;
144
- filingDate: string;
145
- acceptedDate: string;
146
- fiscalYear: string;
147
- period: string;
148
- revenue: number;
149
- costOfRevenue: number;
150
- grossProfit: number;
151
- researchAndDevelopmentExpenses: number;
152
- generalAndAdministrativeExpenses: number;
153
- sellingAndMarketingExpenses: number;
154
- sellingGeneralAndAdministrativeExpenses: number;
155
- otherExpenses: number;
156
- operatingExpenses: number;
157
- costAndExpenses: number;
158
- netInterestIncome: number;
229
+ acceptanceTime: string;
230
+ date: string;
231
+ symbol: string;
232
+ name: string;
233
+ lei: string;
234
+ title: string;
235
+ cusip: string;
236
+ isin: string;
237
+ balance: number;
238
+ units: string;
239
+ cur_cd: string;
240
+ valUsd: number;
241
+ pctVal: number;
242
+ payoffProfile: string;
243
+ assetCat: string;
244
+ issuerCat: string;
245
+ invCountry: string;
246
+ isRestrictedSec: string;
247
+ fairValLevel: string;
248
+ isCashCollateral: string;
249
+ isNonCashCollateral: string;
250
+ isLoanByFund: string;
251
+ }
252
+ interface ETFHolder {
253
+ asset: string;
254
+ name: string;
255
+ isin: string;
256
+ cusip: string;
257
+ sharesNumber: number;
258
+ weightPercentage: number;
259
+ marketValue: number;
260
+ updated: string;
261
+ }
262
+ interface ETFProfile {
263
+ symbol: string;
264
+ name: string;
265
+ description: string;
266
+ isin: string;
267
+ assetClass: string;
268
+ securityCusip: string;
269
+ domicile: string;
270
+ website: string;
271
+ etfCompany: string;
272
+ expenseRatio: number;
273
+ assetsUnderManagement: number;
274
+ avgVolume: number;
275
+ inceptionDate: string;
276
+ nav: number;
277
+ navCurrency: string;
278
+ holdingsCount: number;
279
+ updatedAt: string;
280
+ sectorsList: {
281
+ exposure: string;
282
+ industry: string;
283
+ }[];
284
+ }
285
+ interface ETFWeighting {
286
+ symbol: string;
287
+ sector: string;
288
+ weightPercentage: string;
289
+ }
290
+ interface ETFCountryWeighting {
291
+ country: string;
292
+ weightPercentage: string;
293
+ }
294
+ interface ETFStockExposure {
295
+ etfSymbol: string;
296
+ assetExposure: string;
297
+ sharesNumber: number;
298
+ weightPercentage: number;
299
+ marketValue: number;
300
+ }
301
+
302
+ interface IncomeStatement {
303
+ date: string;
304
+ symbol: string;
305
+ reportedCurrency: string;
306
+ cik: string;
307
+ filingDate: string;
308
+ acceptedDate: string;
309
+ fiscalYear: string;
310
+ period: string;
311
+ revenue: number;
312
+ costOfRevenue: number;
313
+ grossProfit: number;
314
+ researchAndDevelopmentExpenses: number;
315
+ generalAndAdministrativeExpenses: number;
316
+ sellingAndMarketingExpenses: number;
317
+ sellingGeneralAndAdministrativeExpenses: number;
318
+ otherExpenses: number;
319
+ operatingExpenses: number;
320
+ costAndExpenses: number;
321
+ netInterestIncome: number;
159
322
  interestIncome: number;
160
323
  interestExpense: number;
161
324
  depreciationAndAmortization: number;
@@ -612,271 +775,127 @@ interface EarningsSurprises {
612
775
  estimatedEarning: number;
613
776
  }
614
777
 
615
- interface CompanyProfile {
778
+ interface InsiderTradingRSSResponse {
779
+ title: string;
780
+ fillingDate: string;
616
781
  symbol: string;
617
- price: number;
618
- marketCap: number;
619
- beta: number;
620
- lastDividend: number;
621
- range: string;
622
- change: number;
623
- changePercentage: number;
624
- volume: number;
625
- averageVolume: number;
626
- companyName: string;
627
- currency: string;
628
- cik: string;
629
- isin: string;
630
- cusip: string;
631
- exchangeFullName: string;
632
- exchange: string;
633
- industry: string;
634
- website: string;
635
- description: string;
636
- ceo: string;
637
- sector: string;
638
- country: string;
639
- fullTimeEmployees: string;
640
- phone: string;
641
- address: string;
642
- city: string;
643
- state: string;
644
- zip: string;
645
- image: string;
646
- ipoDate: string;
647
- defaultImage: boolean;
648
- isEtf: boolean;
649
- isActivelyTrading: boolean;
650
- isAdr: boolean;
651
- isFund: boolean;
782
+ link: string;
783
+ reportingCik: string;
784
+ issuerCik: string;
652
785
  }
653
- interface ExecutiveCompensation {
654
- cik: string;
786
+ interface InsiderTradingSearchResponse {
655
787
  symbol: string;
656
- companyName: string;
657
788
  filingDate: string;
658
- acceptedDate: string;
659
- nameAndPosition: string;
660
- year: number;
661
- salary: number;
662
- bonus: number;
663
- stockAward: number;
664
- optionAward: number;
665
- incentivePlanCompensation: number;
666
- allOtherCompensation: number;
667
- total: number;
789
+ transactionDate: string;
790
+ reportingCik: string;
791
+ transactionType: string;
792
+ securitiesOwned: number;
793
+ securitiesTransacted: number;
794
+ companyCik: string;
795
+ reportingName: string;
796
+ typeOfOwner: string;
668
797
  link: string;
798
+ securityName: string;
799
+ price: number;
800
+ formType: string;
801
+ acquistionOrDisposition: string;
669
802
  }
670
- interface CompanyNotes {
671
- cik: string;
672
- symbol: string;
673
- title: string;
674
- exchange: string;
803
+ type TransactionTypesResponse = string[];
804
+ interface InsidersBySymbolResponse {
805
+ typeOfOwner: string;
806
+ transactionDate: string;
807
+ owner: string;
675
808
  }
676
- interface HistoricalEmployeeCount {
809
+ interface InsiderTradeStatisticsResponse {
677
810
  symbol: string;
678
811
  cik: string;
679
- acceptanceTime: string;
680
- periodOfReport: string;
681
- companyName: string;
682
- formType: string;
683
- filingDate: string;
684
- employeeCount: number;
685
- source: string;
812
+ year: number;
813
+ quarter: number;
814
+ purchases: number;
815
+ sales: number;
816
+ buySellRatio: number;
817
+ totalBought: number;
818
+ totalSold: number;
819
+ averageBought: number;
820
+ averageSold: number;
821
+ pPurchases: number;
822
+ sSales: number;
686
823
  }
687
- interface SharesFloat {
824
+ interface CikMapperResponse {
825
+ reportingCik: string;
826
+ reportingName: string;
827
+ }
828
+ interface CikMapperBySymbolResponse {
688
829
  symbol: string;
689
- freeFloat: number;
690
- floatShares: number;
691
- outstandingShares: number;
692
- source: string;
693
- date: string;
830
+ companyCik: string;
694
831
  }
695
- interface HistoricalSharesFloat {
832
+ interface BeneficialOwnershipResponse {
833
+ cik: string;
696
834
  symbol: string;
697
- freeFloat: number;
698
- floatShares: string;
699
- outstandingShares: string;
700
- source: string;
701
- date: string;
835
+ filingDate: string;
836
+ acceptedDate: string;
837
+ cusip: string;
838
+ nameOfReportingPerson: string;
839
+ citizenshipOrPlaceOfOrganization: string;
840
+ soleVotingPower: string;
841
+ sharedVotingPower: string;
842
+ soleDispositivePower: string;
843
+ sharedDispositivePower: string;
844
+ amountBeneficiallyOwned: string;
845
+ percentOfClass: string;
846
+ typeOfReportingPerson: string;
847
+ url: string;
702
848
  }
703
- interface EarningsCallTranscript {
849
+ interface FailToDeliverResponse {
704
850
  symbol: string;
705
- quarter: number;
706
- year: number;
707
851
  date: string;
708
- content: string;
852
+ price: number;
853
+ quantity: number;
854
+ cusip: string;
855
+ name: string;
856
+ }
857
+ declare enum TransactionType {
858
+ AWARD = "A-Award",
859
+ CONVERSION = "C-Conversion",
860
+ RETURN = "D-Return",
861
+ EXPIRE_SHORT = "E-ExpireShort",
862
+ IN_KIND = "F-InKind",
863
+ GIFT = "G-Gift",
864
+ EXPIRE_LONG = "H-ExpireLong",
865
+ DISCRETIONARY = "I-Discretionary",
866
+ OTHER = "J-Other",
867
+ SMALL = "L-Small",
868
+ EXEMPT = "M-Exempt",
869
+ OUT_OF_THE_MONEY = "O-OutOfTheMoney",
870
+ PURCHASE = "P-Purchase",
871
+ SALE = "S-Sale",
872
+ TENDER = "U-Tender",
873
+ WILL = "W-Will",
874
+ IN_THE_MONEY = "X-InTheMoney",
875
+ TRUST = "Z-Trust"
709
876
  }
710
- type CompanyTranscriptData = [number, number, string];
711
877
 
712
- interface ETFHoldingDates {
878
+ interface Form13FResponse {
713
879
  date: string;
714
- }
715
- interface ETFHolding {
880
+ fillingDate: string;
881
+ acceptedDate: string;
716
882
  cik: string;
717
- acceptanceTime: string;
718
- date: string;
719
- symbol: string;
720
- name: string;
721
- lei: string;
722
- title: string;
723
883
  cusip: string;
724
- isin: string;
725
- balance: number;
726
- units: string;
727
- cur_cd: string;
728
- valUsd: number;
729
- pctVal: number;
730
- payoffProfile: string;
731
- assetCat: string;
732
- issuerCat: string;
733
- invCountry: string;
734
- isRestrictedSec: string;
735
- fairValLevel: string;
736
- isCashCollateral: string;
737
- isNonCashCollateral: string;
738
- isLoanByFund: string;
739
- }
740
- interface ETFHolder {
741
- asset: string;
742
- name: string;
743
- isin: string;
744
- cusip: string;
745
- sharesNumber: number;
746
- weightPercentage: number;
747
- marketValue: number;
748
- updated: string;
749
- }
750
- interface ETFProfile {
751
- symbol: string;
752
- name: string;
753
- description: string;
754
- isin: string;
755
- assetClass: string;
756
- securityCusip: string;
757
- domicile: string;
758
- website: string;
759
- etfCompany: string;
760
- expenseRatio: number;
761
- assetsUnderManagement: number;
762
- avgVolume: number;
763
- inceptionDate: string;
764
- nav: number;
765
- navCurrency: string;
766
- holdingsCount: number;
767
- updatedAt: string;
768
- sectorsList: {
769
- exposure: string;
770
- industry: string;
771
- }[];
772
- }
773
- interface ETFWeighting {
774
- symbol: string;
775
- sector: string;
776
- weightPercentage: string;
777
- }
778
- interface ETFCountryWeighting {
779
- country: string;
780
- weightPercentage: string;
781
- }
782
- interface ETFStockExposure {
783
- etfSymbol: string;
784
- assetExposure: string;
785
- sharesNumber: number;
786
- weightPercentage: number;
787
- marketValue: number;
884
+ tickercusip: string;
885
+ nameOfIssuer: string;
886
+ shares: number;
887
+ titleOfClass: string;
888
+ value: number;
889
+ link: string;
890
+ finalLink: string;
788
891
  }
789
-
790
- interface MutualFundHolding {
892
+ interface InstitutionalHolderResponse {
791
893
  holder: string;
792
894
  shares: number;
793
895
  dateReported: string;
794
896
  change: number;
795
- weightPercent: number;
796
897
  }
797
898
 
798
- interface MarketHours {
799
- stockExchangeName: string;
800
- stockMarketHours: {
801
- openingHour: string;
802
- closingHour: string;
803
- };
804
- stockMarketHolidays: MarketHoliday[];
805
- isTheStockMarketOpen: boolean;
806
- isTheEuronextMarketOpen: boolean;
807
- isTheForexMarketOpen: boolean;
808
- isTheCryptoMarketOpen: boolean;
809
- }
810
- interface MarketHoliday {
811
- year: number;
812
- 'Martin Luther King, Jr. Day': string;
813
- "Presidents' Day": string;
814
- 'Good Friday': string;
815
- 'Memorial Day': string;
816
- Juneteenth: string;
817
- 'Independence Day': string;
818
- 'Labor Day': string;
819
- 'Thanksgiving Day': string;
820
- Christmas: string;
821
- }
822
- interface MarketPerformance {
823
- symbol: string;
824
- name: string;
825
- change: number;
826
- price: number;
827
- changesPercentage: number;
828
- }
829
- interface MarketSectorPerformance {
830
- sector: string;
831
- changesPercentage: number;
832
- }
833
- interface MarketIndex {
834
- symbol: string;
835
- price: number;
836
- extendedPrice: number | null;
837
- change: number;
838
- dayHigh: number;
839
- dayLow: number;
840
- previousClose: number;
841
- volume: number | null;
842
- open: number;
843
- close: number | null;
844
- lastTradeTime: string;
845
- lastExtendedTradeTime: string | null;
846
- updatedAt: string;
847
- createdAt: string;
848
- type: string;
849
- name: string;
850
- range: string;
851
- yearHigh: number;
852
- yearLow: number;
853
- priceAvg50: number | null;
854
- priceAvg200: number | null;
855
- changesPercentage: number;
856
- }
857
-
858
- interface EconomicIndicator {
859
- name: string;
860
- date: string;
861
- value: number;
862
- }
863
- interface TreasuryRate {
864
- date: string;
865
- month1: number;
866
- month2: number;
867
- month3: number;
868
- month6: number;
869
- year1: number;
870
- year2: number;
871
- year3: number;
872
- year5: number;
873
- year7: number;
874
- year10: number;
875
- year20: number;
876
- year30: number;
877
- }
878
- 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';
879
-
880
899
  interface StockList {
881
900
  symbol: string;
882
901
  exchange: string;
@@ -914,234 +933,116 @@ interface AvailableIndexesList {
914
933
  exchangeShortName: string;
915
934
  }
916
935
 
917
- interface EarningsCalendar {
918
- date: string;
919
- symbol: string;
920
- eps: number | null;
921
- epsEstimated: number | null;
922
- time: string;
923
- revenue: number | null;
924
- revenueEstimated: number | null;
925
- fiscalDateEnding: string;
926
- updatedFromDate: string;
927
- }
928
- interface EarningsConfirmed {
929
- symbol: string;
930
- exchange: string;
931
- time: string;
932
- when: string;
933
- date: string;
934
- publicationDate: string;
935
- title: string;
936
- url: string;
937
- }
938
- interface DividendsCalendar {
939
- date: string;
940
- label: string;
941
- adjDividend: number;
942
- symbol: string;
943
- dividend: number;
944
- recordDate: string;
945
- paymentDate: string;
946
- declarationDate: string;
947
- }
948
- interface EconomicsCalendar {
949
- date: string;
950
- country: string;
951
- event: string;
952
- currency: string;
953
- previous: number;
954
- estimate: number | null;
955
- actual: number | null;
956
- change: number;
957
- impact: string;
958
- changePercentage: number;
959
- unit: string | null;
960
- }
961
- interface IPOCalendar {
962
- date: string;
963
- company: string;
964
- symbol: string;
965
- exchange: string;
966
- actions: string;
967
- shares: number | null;
968
- priceRange: string | null;
969
- marketCap: number | null;
970
- }
971
- interface SplitsCalendar {
972
- date: string;
973
- label: string;
974
- symbol: string;
975
- numerator: number;
976
- denominator: number;
977
- }
978
-
979
- interface SenateTradingResponse {
980
- firstName: string;
981
- lastName: string;
982
- office: string;
983
- link: string;
984
- dateRecieved: string;
985
- transactionDate: string;
986
- owner: string;
987
- assetDescription: string;
988
- assetType: string;
989
- type: string;
990
- amount: string;
991
- comment: string;
992
- symbol: string;
993
- }
994
- interface HouseTradingResponse {
995
- disclosureYear: string;
996
- disclosureDate: string;
997
- transactionDate: string;
998
- owner: string;
999
- ticker: string;
1000
- assetDescription: string;
1001
- type: string;
1002
- amount: string;
1003
- representative: string;
1004
- district: string;
1005
- link: string;
1006
- capitalGainsOver200USD: string;
1007
- }
1008
- interface SenateHouseTradingByNameResponse {
1009
- symbol: string;
1010
- disclosureDate: string;
1011
- transactionDate: string;
1012
- firstName: string;
1013
- lastName: string;
1014
- office: string;
1015
- district: string;
1016
- owner: string;
1017
- assetDescription: string;
1018
- assetType: string;
1019
- type: string;
1020
- amount: string;
1021
- capitalGainsOver200USD: string;
1022
- comment: string;
1023
- link: string;
1024
- }
1025
-
1026
- interface Form13FResponse {
1027
- date: string;
1028
- fillingDate: string;
1029
- acceptedDate: string;
1030
- cik: string;
1031
- cusip: string;
1032
- tickercusip: string;
1033
- nameOfIssuer: string;
1034
- shares: number;
1035
- titleOfClass: string;
1036
- value: number;
1037
- link: string;
1038
- finalLink: string;
1039
- }
1040
- interface InstitutionalHolderResponse {
1041
- holder: string;
1042
- shares: number;
1043
- dateReported: string;
1044
- change: number;
1045
- }
1046
-
1047
- interface InsiderTradingRSSResponse {
1048
- title: string;
1049
- fillingDate: string;
1050
- symbol: string;
1051
- link: string;
1052
- reportingCik: string;
1053
- issuerCik: string;
1054
- }
1055
- interface InsiderTradingSearchResponse {
1056
- symbol: string;
1057
- filingDate: string;
1058
- transactionDate: string;
1059
- reportingCik: string;
1060
- transactionType: string;
1061
- securitiesOwned: number;
1062
- securitiesTransacted: number;
1063
- companyCik: string;
1064
- reportingName: string;
1065
- typeOfOwner: string;
1066
- link: string;
1067
- securityName: string;
1068
- price: number;
1069
- formType: string;
1070
- acquistionOrDisposition: string;
1071
- }
1072
- type TransactionTypesResponse = string[];
1073
- interface InsidersBySymbolResponse {
1074
- typeOfOwner: string;
1075
- transactionDate: string;
1076
- owner: string;
936
+ interface MarketHours {
937
+ stockExchangeName: string;
938
+ stockMarketHours: {
939
+ openingHour: string;
940
+ closingHour: string;
941
+ };
942
+ stockMarketHolidays: MarketHoliday[];
943
+ isTheStockMarketOpen: boolean;
944
+ isTheEuronextMarketOpen: boolean;
945
+ isTheForexMarketOpen: boolean;
946
+ isTheCryptoMarketOpen: boolean;
1077
947
  }
1078
- interface InsiderTradeStatisticsResponse {
1079
- symbol: string;
1080
- cik: string;
948
+ interface MarketHoliday {
1081
949
  year: number;
1082
- quarter: number;
1083
- purchases: number;
1084
- sales: number;
1085
- buySellRatio: number;
1086
- totalBought: number;
1087
- totalSold: number;
1088
- averageBought: number;
1089
- averageSold: number;
1090
- pPurchases: number;
1091
- sSales: number;
1092
- }
1093
- interface CikMapperResponse {
1094
- reportingCik: string;
1095
- reportingName: string;
950
+ 'Martin Luther King, Jr. Day': string;
951
+ "Presidents' Day": string;
952
+ 'Good Friday': string;
953
+ 'Memorial Day': string;
954
+ Juneteenth: string;
955
+ 'Independence Day': string;
956
+ 'Labor Day': string;
957
+ 'Thanksgiving Day': string;
958
+ Christmas: string;
1096
959
  }
1097
- interface CikMapperBySymbolResponse {
960
+ interface MarketPerformance {
1098
961
  symbol: string;
1099
- companyCik: string;
962
+ name: string;
963
+ change: number;
964
+ price: number;
965
+ changesPercentage: number;
1100
966
  }
1101
- interface BeneficialOwnershipResponse {
1102
- cik: string;
1103
- symbol: string;
1104
- filingDate: string;
1105
- acceptedDate: string;
1106
- cusip: string;
1107
- nameOfReportingPerson: string;
1108
- citizenshipOrPlaceOfOrganization: string;
1109
- soleVotingPower: string;
1110
- sharedVotingPower: string;
1111
- soleDispositivePower: string;
1112
- sharedDispositivePower: string;
1113
- amountBeneficiallyOwned: string;
1114
- percentOfClass: string;
1115
- typeOfReportingPerson: string;
1116
- url: string;
967
+ interface MarketSectorPerformance {
968
+ sector: string;
969
+ changesPercentage: number;
1117
970
  }
1118
- interface FailToDeliverResponse {
971
+ interface MarketIndex {
1119
972
  symbol: string;
1120
- date: string;
1121
973
  price: number;
1122
- quantity: number;
1123
- cusip: string;
974
+ extendedPrice: number | null;
975
+ change: number;
976
+ dayHigh: number;
977
+ dayLow: number;
978
+ previousClose: number;
979
+ volume: number | null;
980
+ open: number;
981
+ close: number | null;
982
+ lastTradeTime: string;
983
+ lastExtendedTradeTime: string | null;
984
+ updatedAt: string;
985
+ createdAt: string;
986
+ type: string;
1124
987
  name: string;
988
+ range: string;
989
+ yearHigh: number;
990
+ yearLow: number;
991
+ priceAvg50: number | null;
992
+ priceAvg200: number | null;
993
+ changesPercentage: number;
1125
994
  }
1126
- declare enum TransactionType {
1127
- AWARD = "A-Award",
1128
- CONVERSION = "C-Conversion",
1129
- RETURN = "D-Return",
1130
- EXPIRE_SHORT = "E-ExpireShort",
1131
- IN_KIND = "F-InKind",
1132
- GIFT = "G-Gift",
1133
- EXPIRE_LONG = "H-ExpireLong",
1134
- DISCRETIONARY = "I-Discretionary",
1135
- OTHER = "J-Other",
1136
- SMALL = "L-Small",
1137
- EXEMPT = "M-Exempt",
1138
- OUT_OF_THE_MONEY = "O-OutOfTheMoney",
1139
- PURCHASE = "P-Purchase",
1140
- SALE = "S-Sale",
1141
- TENDER = "U-Tender",
1142
- WILL = "W-Will",
1143
- IN_THE_MONEY = "X-InTheMoney",
1144
- TRUST = "Z-Trust"
995
+
996
+ interface MutualFundHolding {
997
+ holder: string;
998
+ shares: number;
999
+ dateReported: string;
1000
+ change: number;
1001
+ weightPercent: number;
1002
+ }
1003
+
1004
+ interface Quote {
1005
+ symbol: string;
1006
+ name: string;
1007
+ price: number;
1008
+ changesPercentage: number;
1009
+ change: number;
1010
+ dayLow: number;
1011
+ dayHigh: number;
1012
+ yearHigh: number;
1013
+ yearLow: number;
1014
+ marketCap: number | null;
1015
+ priceAvg50: number;
1016
+ priceAvg200: number;
1017
+ exchange: string;
1018
+ volume: number;
1019
+ avgVolume: number;
1020
+ open: number;
1021
+ previousClose: number;
1022
+ eps: number | null;
1023
+ pe: number | null;
1024
+ earningsAnnouncement: string | null;
1025
+ sharesOutstanding: number | null;
1026
+ timestamp: number;
1027
+ }
1028
+ interface HistoricalPriceData {
1029
+ date: string;
1030
+ open: number;
1031
+ high: number;
1032
+ low: number;
1033
+ close: number;
1034
+ adjClose: number;
1035
+ volume: number;
1036
+ unadjustedVolume: number;
1037
+ change: number;
1038
+ changePercent: number;
1039
+ vwap: number;
1040
+ label: string;
1041
+ changeOverTime: number;
1042
+ }
1043
+ interface HistoricalPriceResponse {
1044
+ symbol: string;
1045
+ historical: HistoricalPriceData[];
1145
1046
  }
1146
1047
 
1147
1048
  interface RSSFeedItem {
@@ -1236,4 +1137,164 @@ interface IndustryClassificationCodesParams {
1236
1137
  sicCode?: number;
1237
1138
  }
1238
1139
 
1239
- export { type APIResponse, type AvailableIndexesList, type BalanceSheet, type BalanceSheetGrowth, type BeneficialOwnershipResponse, type CashFlowStatement, type CashflowGrowth, type CikMapperBySymbolResponse, type CikMapperResponse, type CompaniesPriceListResponse, type CompanyNotes, type CompanyProfile, type CompanyTranscriptData, type CryptoList, type DateRangeParams, type DividendsCalendar, type ETFCountryWeighting, type ETFHolder, type ETFHolding, type ETFHoldingDates, type ETFList, type ETFProfile, type ETFStockExposure, type ETFWeighting, type EarningsCalendar, type EarningsCallTranscript, type EarningsConfirmed, type EarningsHistorical, type EarningsSurprises, type EconomicIndicator, type EconomicIndicatorName, type EconomicsCalendar, type EnterpriseValue, Exchange, type ExecutiveCompensation, type FMPConfig, type FailToDeliverResponse, type FinancialGrowth, type FinancialRatios, type ForexList, type Form13FResponse, type HistoricalEmployeeCount, type HistoricalPriceData, type HistoricalPriceResponse, type HistoricalSharesFloat, type HouseTradingResponse, type IPOCalendar, type IncomeGrowth, type IncomeStatement, type IndividualIndustryClassificationParams, type IndustryClassification, type IndustryClassificationCode, type IndustryClassificationCodesParams, type InsiderTradeStatisticsResponse, type InsiderTradingRSSResponse, type InsiderTradingSearchResponse, type InsidersBySymbolResponse, type InstitutionalHolderResponse, type KeyMetrics, type MarketCap, type MarketHoliday, type MarketHours, type MarketIndex, type MarketPerformance, type MarketSectorPerformance, type MutualFundHolding, type PaginationParams, Period, type PeriodParams, type QueryParams, type Quote, type RSSFeed8KItem, type RSSFeed8KParams, type RSSFeedAllItem, type RSSFeedItem, type RSSFeedParams, type RSSFeedV3Item, type RSSFeedV3Params, type SECFiling, type SECFilingsParams, type SenateHouseTradingByNameResponse, type SenateTradingResponse, type SharesFloat, type SplitsCalendar, type StockDividend, type StockDividendResponse, type StockList, type StockListResponse, type StockRealTimePrice, type StockRealTimePriceFull, type StockSplit, type StockSplitResponse, type SymbolParams, TransactionType, type TransactionTypesResponse, type TreasuryRate };
1140
+ interface ScreenerParams {
1141
+ marketCapMoreThan?: number;
1142
+ marketCapLowerThan?: number;
1143
+ sector?: string;
1144
+ industry?: string;
1145
+ betaMoreThan?: number;
1146
+ betaLowerThan?: number;
1147
+ priceMoreThan?: number;
1148
+ priceLowerThan?: number;
1149
+ dividendMoreThan?: number;
1150
+ dividendLowerThan?: number;
1151
+ volumeMoreThan?: number;
1152
+ volumeLowerThan?: number;
1153
+ exchange?: string;
1154
+ country?: string;
1155
+ isEtf?: boolean;
1156
+ isFund?: boolean;
1157
+ isActivelyTrading?: boolean;
1158
+ limit?: number;
1159
+ includeAllShareClasses?: boolean;
1160
+ }
1161
+ interface Screener {
1162
+ symbol: string;
1163
+ companyName: string;
1164
+ marketCap: number;
1165
+ sector: string;
1166
+ industry: string;
1167
+ beta: number;
1168
+ price: number;
1169
+ lastAnnualDividend: number;
1170
+ volume: number;
1171
+ exchange: string;
1172
+ exchangeShortName: string;
1173
+ country: string;
1174
+ isEtf: boolean;
1175
+ isFund: boolean;
1176
+ isActivelyTrading: boolean;
1177
+ }
1178
+ interface AvailableExchanges {
1179
+ exchange: string;
1180
+ name: string;
1181
+ countryName: string;
1182
+ countryCode: string;
1183
+ symbolSuffix: string;
1184
+ delay: string;
1185
+ }
1186
+ interface AvailableSectors {
1187
+ sector: string;
1188
+ }
1189
+ interface AvailableIndustries {
1190
+ industry: string;
1191
+ }
1192
+ interface AvailableCountries {
1193
+ country: string;
1194
+ }
1195
+
1196
+ interface SenateTradingResponse {
1197
+ symbol: string;
1198
+ disclosureDate: string;
1199
+ transactionDate: string;
1200
+ firstName: string;
1201
+ lastName: string;
1202
+ office: string;
1203
+ district: string;
1204
+ owner: string;
1205
+ assetDescription: string;
1206
+ assetType: string;
1207
+ type: string;
1208
+ amount: string;
1209
+ capitalGainsOver200USD: string;
1210
+ comment: string;
1211
+ link: string;
1212
+ }
1213
+ interface HouseTradingResponse {
1214
+ symbol: string;
1215
+ disclosureDate: string;
1216
+ transactionDate: string;
1217
+ firstName: string;
1218
+ lastName: string;
1219
+ office: string;
1220
+ district: string;
1221
+ owner: string;
1222
+ assetDescription: string;
1223
+ assetType: string;
1224
+ type: string;
1225
+ amount: string;
1226
+ capitalGainsOver200USD: string;
1227
+ comment: string;
1228
+ link: string;
1229
+ }
1230
+ interface SenateHouseTradingByNameResponse {
1231
+ symbol: string;
1232
+ disclosureDate: string;
1233
+ transactionDate: string;
1234
+ firstName: string;
1235
+ lastName: string;
1236
+ office: string;
1237
+ district: string;
1238
+ owner: string;
1239
+ assetDescription: string;
1240
+ assetType: string;
1241
+ type: string;
1242
+ amount: string;
1243
+ capitalGainsOver200USD: string;
1244
+ comment: string;
1245
+ link: string;
1246
+ }
1247
+
1248
+ interface StockSplit {
1249
+ date: string;
1250
+ label: string;
1251
+ numerator: number;
1252
+ denominator: number;
1253
+ }
1254
+ interface StockSplitResponse {
1255
+ symbol: string;
1256
+ historical: StockSplit[];
1257
+ }
1258
+ interface StockDividend {
1259
+ date: string;
1260
+ label: string;
1261
+ adjDividend: number;
1262
+ dividend: number;
1263
+ recordDate: string;
1264
+ paymentDate: string;
1265
+ declarationDate: string;
1266
+ }
1267
+ interface StockDividendResponse {
1268
+ symbol: string;
1269
+ historical: StockDividend[];
1270
+ }
1271
+ interface MarketCap {
1272
+ symbol: string;
1273
+ date: string;
1274
+ marketCap: number;
1275
+ }
1276
+ interface StockRealTimePrice {
1277
+ symbol: string;
1278
+ price: number;
1279
+ }
1280
+ interface StockRealTimePriceFull {
1281
+ bidSize: number;
1282
+ askPrice: number;
1283
+ volume: number;
1284
+ askSize: number;
1285
+ bidPrice: number;
1286
+ lastSalePrice: number;
1287
+ lastSaleSize: number;
1288
+ lastSaleTime: number;
1289
+ fmpLast: number;
1290
+ lastUpdated: number;
1291
+ symbol: string;
1292
+ }
1293
+ interface StockListResponse<T> {
1294
+ stockList: T[];
1295
+ }
1296
+ interface CompaniesPriceListResponse<T> {
1297
+ companiesPriceList: T[];
1298
+ }
1299
+
1300
+ export { type APIResponse, type AvailableCountries, type AvailableExchanges, type AvailableIndexesList, type AvailableIndustries, type AvailableSectors, type BalanceSheet, type BalanceSheetGrowth, type BeneficialOwnershipResponse, type CashFlowStatement, type CashflowGrowth, type CikMapperBySymbolResponse, type CikMapperResponse, type CompaniesPriceListResponse, type CompanyNotes, type CompanyProfile, type CompanyTranscriptData, type CryptoList, type DateRangeParams, type DividendsCalendar, type ETFCountryWeighting, type ETFHolder, type ETFHolding, type ETFHoldingDates, type ETFList, type ETFProfile, type ETFStockExposure, type ETFWeighting, type EarningsCalendar, type EarningsCallTranscript, type EarningsConfirmed, type EarningsHistorical, type EarningsSurprises, type EconomicIndicator, type EconomicIndicatorName, type EconomicsCalendar, type EnterpriseValue, Exchange, type ExecutiveCompensation, type FMPConfig, type FailToDeliverResponse, type FinancialGrowth, type FinancialRatios, type ForexList, type Form13FResponse, type HistoricalEmployeeCount, type HistoricalPriceData, type HistoricalPriceResponse, type HistoricalSharesFloat, type HouseTradingResponse, type IPOCalendar, type IncomeGrowth, type IncomeStatement, type IndividualIndustryClassificationParams, type IndustryClassification, type IndustryClassificationCode, type IndustryClassificationCodesParams, type InsiderTradeStatisticsResponse, type InsiderTradingRSSResponse, type InsiderTradingSearchResponse, type InsidersBySymbolResponse, type InstitutionalHolderResponse, type KeyMetrics, type MarketCap, type MarketHoliday, type MarketHours, type MarketIndex, type MarketPerformance, type MarketSectorPerformance, type MutualFundHolding, type PaginationParams, Period, type PeriodParams, type QueryParams, type Quote, type RSSFeed8KItem, type RSSFeed8KParams, type RSSFeedAllItem, type RSSFeedItem, type RSSFeedParams, type RSSFeedV3Item, type RSSFeedV3Params, type SECFiling, type SECFilingsParams, type Screener, type ScreenerParams, type SenateHouseTradingByNameResponse, type SenateTradingResponse, type SharesFloat, type SplitsCalendar, type StockDividend, type StockDividendResponse, type StockList, type StockListResponse, type StockRealTimePrice, type StockRealTimePriceFull, type StockSplit, type StockSplitResponse, type SymbolParams, TransactionType, type TransactionTypesResponse, type TreasuryRate };