fmp-node-types 0.1.2 → 0.1.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,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,100 +102,201 @@ 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;
113
+ changePercentage: number;
57
114
  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;
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;
66
142
  }
67
- interface HistoricalPriceData {
143
+ interface ExecutiveCompensation {
144
+ cik: string;
145
+ symbol: string;
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;
159
+ }
160
+ interface CompanyNotes {
161
+ cik: string;
162
+ symbol: string;
163
+ title: string;
164
+ exchange: string;
165
+ }
166
+ interface HistoricalEmployeeCount {
167
+ symbol: string;
168
+ cik: string;
169
+ acceptanceTime: string;
170
+ periodOfReport: string;
171
+ companyName: string;
172
+ formType: string;
173
+ filingDate: string;
174
+ employeeCount: number;
175
+ source: string;
176
+ }
177
+ interface SharesFloat {
178
+ symbol: string;
179
+ freeFloat: number;
180
+ floatShares: number;
181
+ outstandingShares: number;
182
+ source: string;
68
183
  date: string;
69
- open: number;
70
- high: number;
71
- low: number;
72
- close: number;
73
- adjClose: number;
74
- volume: number;
75
- unadjustedVolume: number;
76
- change: number;
77
- changePercent: number;
78
- vwap: number;
79
- label: string;
80
- changeOverTime: number;
81
184
  }
82
- interface HistoricalPriceResponse {
185
+ interface HistoricalSharesFloat {
83
186
  symbol: string;
84
- historical: HistoricalPriceData[];
187
+ freeFloat: number;
188
+ floatShares: string;
189
+ outstandingShares: string;
190
+ source: string;
191
+ date: string;
85
192
  }
193
+ interface EarningsCallTranscript {
194
+ symbol: string;
195
+ quarter: number;
196
+ year: number;
197
+ date: string;
198
+ content: string;
199
+ }
200
+ type CompanyTranscriptData = [number, number, string];
86
201
 
87
- interface StockSplit {
202
+ interface EconomicIndicator {
203
+ name: string;
88
204
  date: string;
89
- label: string;
90
- numerator: number;
91
- denominator: number;
205
+ value: number;
92
206
  }
93
- interface StockSplitResponse {
94
- symbol: string;
95
- historical: StockSplit[];
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;
96
221
  }
97
- interface StockDividend {
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';
223
+
224
+ interface ETFHoldingDates {
98
225
  date: string;
99
- label: string;
100
- adjDividend: number;
101
- dividend: number;
102
- recordDate: string;
103
- paymentDate: string;
104
- declarationDate: string;
105
226
  }
106
- interface StockDividendResponse {
227
+ interface ETFHolding {
228
+ cik: string;
229
+ acceptanceTime: string;
230
+ date: string;
107
231
  symbol: string;
108
- historical: StockDividend[];
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;
109
251
  }
110
- interface MarketCap {
111
- symbol: string;
112
- date: string;
113
- marketCap: number;
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;
114
261
  }
115
- interface StockRealTimePrice {
262
+ interface ETFProfile {
116
263
  symbol: string;
117
- price: number;
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
+ }[];
118
284
  }
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;
285
+ interface ETFWeighting {
130
286
  symbol: string;
287
+ sector: string;
288
+ weightPercentage: string;
131
289
  }
132
- interface StockListResponse<T> {
133
- stockList: T[];
290
+ interface ETFCountryWeighting {
291
+ country: string;
292
+ weightPercentage: string;
134
293
  }
135
- interface CompaniesPriceListResponse<T> {
136
- companiesPriceList: T[];
294
+ interface ETFStockExposure {
295
+ etfSymbol: string;
296
+ assetExposure: string;
297
+ sharesNumber: number;
298
+ weightPercentage: number;
299
+ marketValue: number;
137
300
  }
138
301
 
139
302
  interface IncomeStatement {
@@ -612,187 +775,175 @@ interface EarningsSurprises {
612
775
  estimatedEarning: number;
613
776
  }
614
777
 
615
- interface CompanyProfile {
778
+ interface InsiderTradingRSSResponse {
616
779
  symbol: string;
780
+ filingDate: string;
781
+ transactionDate: string;
782
+ reportingCik: string;
783
+ companyCik: string;
784
+ transactionType: string;
785
+ securitiesOwned: number;
786
+ reportingName: string;
787
+ typeOfOwner: string;
788
+ acquisitionOrDisposition: string;
789
+ directOrIndirect: string;
790
+ formType: string;
791
+ securitiesTransacted: number;
617
792
  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;
793
+ securityName: string;
794
+ url: string;
652
795
  }
653
- interface ExecutiveCompensation {
654
- cik: string;
796
+ interface InsiderTradingSearchResponse {
655
797
  symbol: string;
656
- companyName: string;
657
798
  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;
668
- link: string;
799
+ transactionDate: string;
800
+ reportingCik: string;
801
+ companyCik: string;
802
+ transactionType: string;
803
+ securitiesOwned: number;
804
+ reportingName: string;
805
+ typeOfOwner: string;
806
+ acquisitionOrDisposition: string;
807
+ directOrIndirect: string;
808
+ formType: string;
809
+ securitiesTransacted: number;
810
+ price: number;
811
+ securityName: string;
812
+ url: string;
669
813
  }
670
- interface CompanyNotes {
671
- cik: string;
672
- symbol: string;
673
- title: string;
674
- exchange: string;
814
+ type TransactionTypesResponse = {
815
+ transactionType: string;
816
+ }[];
817
+ interface InsidersBySymbolResponse {
818
+ typeOfOwner: string;
819
+ transactionDate: string;
820
+ owner: string;
675
821
  }
676
- interface HistoricalEmployeeCount {
822
+ interface InsiderTradeStatisticsResponse {
677
823
  symbol: string;
678
824
  cik: string;
679
- acceptanceTime: string;
680
- periodOfReport: string;
681
- companyName: string;
682
- formType: string;
683
- filingDate: string;
684
- employeeCount: number;
685
- source: string;
825
+ year: number;
826
+ quarter: number;
827
+ acquiredTransactions: number;
828
+ disposedTransactions: number;
829
+ acquiredDisposedRatio: number;
830
+ totalAcquired: number;
831
+ totalDisposed: number;
832
+ averageAcquired: number;
833
+ averageDisposed: number;
834
+ totalPurchases: number;
835
+ totalSales: number;
686
836
  }
687
- interface SharesFloat {
837
+ interface CikMapperResponse {
838
+ reportingCik: string;
839
+ reportingName: string;
840
+ }
841
+ interface CikMapperBySymbolResponse {
688
842
  symbol: string;
689
- freeFloat: number;
690
- floatShares: number;
691
- outstandingShares: number;
692
- source: string;
693
- date: string;
843
+ companyCik: string;
694
844
  }
695
- interface HistoricalSharesFloat {
845
+ interface BeneficialOwnershipResponse {
846
+ cik: string;
696
847
  symbol: string;
697
- freeFloat: number;
698
- floatShares: string;
699
- outstandingShares: string;
700
- source: string;
701
- date: string;
848
+ filingDate: string;
849
+ acceptedDate: string;
850
+ cusip: string;
851
+ nameOfReportingPerson: string;
852
+ citizenshipOrPlaceOfOrganization: string;
853
+ soleVotingPower: string;
854
+ sharedVotingPower: string;
855
+ soleDispositivePower: string;
856
+ sharedDispositivePower: string;
857
+ amountBeneficiallyOwned: string;
858
+ percentOfClass: string;
859
+ typeOfReportingPerson: string;
860
+ url: string;
702
861
  }
703
- interface EarningsCallTranscript {
862
+ interface FailToDeliverResponse {
704
863
  symbol: string;
705
- quarter: number;
706
- year: number;
707
864
  date: string;
708
- content: string;
865
+ price: number;
866
+ quantity: number;
867
+ cusip: string;
868
+ name: string;
869
+ }
870
+ declare enum TransactionType {
871
+ AWARD = "A-Award",
872
+ CONVERSION = "C-Conversion",
873
+ RETURN = "D-Return",
874
+ EXPIRE_SHORT = "E-ExpireShort",
875
+ IN_KIND = "F-InKind",
876
+ GIFT = "G-Gift",
877
+ EXPIRE_LONG = "H-ExpireLong",
878
+ DISCRETIONARY = "I-Discretionary",
879
+ OTHER = "J-Other",
880
+ SMALL = "L-Small",
881
+ EXEMPT = "M-Exempt",
882
+ OUT_OF_THE_MONEY = "O-OutOfTheMoney",
883
+ PURCHASE = "P-Purchase",
884
+ SALE = "S-Sale",
885
+ TENDER = "U-Tender",
886
+ WILL = "W-Will",
887
+ IN_THE_MONEY = "X-InTheMoney",
888
+ TRUST = "Z-Trust"
709
889
  }
710
- type CompanyTranscriptData = [number, number, string];
711
890
 
712
- interface ETFHoldingDates {
891
+ interface Form13FResponse {
713
892
  date: string;
714
- }
715
- interface ETFHolding {
893
+ fillingDate: string;
894
+ acceptedDate: string;
716
895
  cik: string;
717
- acceptanceTime: string;
718
- date: string;
719
- symbol: string;
720
- name: string;
721
- lei: string;
722
- title: string;
723
896
  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;
897
+ tickercusip: string;
898
+ nameOfIssuer: string;
899
+ shares: number;
900
+ titleOfClass: string;
901
+ value: number;
902
+ link: string;
903
+ finalLink: string;
749
904
  }
750
- interface ETFProfile {
905
+ interface InstitutionalHolderResponse {
906
+ holder: string;
907
+ shares: number;
908
+ dateReported: string;
909
+ change: number;
910
+ }
911
+
912
+ interface StockList {
751
913
  symbol: string;
914
+ exchange: string;
915
+ exchangeShortName: string;
916
+ price: number;
752
917
  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
- }[];
918
+ type: string;
772
919
  }
773
- interface ETFWeighting {
920
+ interface ETFList {
774
921
  symbol: string;
775
- sector: string;
776
- weightPercentage: string;
922
+ exchange: string;
923
+ exchangeShortName: string;
924
+ price: number;
925
+ name: string;
777
926
  }
778
- interface ETFCountryWeighting {
779
- country: string;
780
- weightPercentage: string;
927
+ interface CryptoList {
928
+ symbol: string;
929
+ name: string;
930
+ currency: string;
931
+ stockExchange: string;
932
+ exchangeShortName: string;
781
933
  }
782
- interface ETFStockExposure {
783
- etfSymbol: string;
784
- assetExposure: string;
785
- sharesNumber: number;
786
- weightPercentage: number;
787
- marketValue: number;
934
+ interface ForexList {
935
+ symbol: string;
936
+ name: string;
937
+ currency: string;
938
+ stockExchange: string;
939
+ exchangeShortName: string;
788
940
  }
789
-
790
- interface MutualFundHolding {
791
- holder: string;
792
- shares: number;
793
- dateReported: string;
794
- change: number;
795
- weightPercent: number;
941
+ interface AvailableIndexesList {
942
+ symbol: string;
943
+ name: string;
944
+ currency: string;
945
+ stockExchange: string;
946
+ exchangeShortName: string;
796
947
  }
797
948
 
798
949
  interface MarketHours {
@@ -855,293 +1006,77 @@ interface MarketIndex {
855
1006
  changesPercentage: number;
856
1007
  }
857
1008
 
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
- interface StockList {
881
- symbol: string;
882
- exchange: string;
883
- exchangeShortName: string;
884
- price: number;
885
- name: string;
886
- type: string;
887
- }
888
- interface ETFList {
889
- symbol: string;
890
- exchange: string;
891
- exchangeShortName: string;
892
- price: number;
893
- name: string;
894
- }
895
- interface CryptoList {
896
- symbol: string;
897
- name: string;
898
- currency: string;
899
- stockExchange: string;
900
- exchangeShortName: string;
901
- }
902
- interface ForexList {
903
- symbol: string;
904
- name: string;
905
- currency: string;
906
- stockExchange: string;
907
- exchangeShortName: string;
908
- }
909
- interface AvailableIndexesList {
910
- symbol: string;
911
- name: string;
912
- currency: string;
913
- stockExchange: string;
914
- exchangeShortName: string;
915
- }
916
-
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 {
1009
+ interface MutualFundHolding {
1041
1010
  holder: string;
1042
1011
  shares: number;
1043
1012
  dateReported: string;
1044
1013
  change: number;
1014
+ weightPercent: number;
1045
1015
  }
1046
1016
 
1047
- interface InsiderTradingRSSResponse {
1048
- title: string;
1049
- fillingDate: string;
1017
+ interface News {
1050
1018
  symbol: string;
1051
- link: string;
1052
- reportingCik: string;
1053
- issuerCik: string;
1019
+ publishedDate: string;
1020
+ publisher: string;
1021
+ title: string;
1022
+ image: string;
1023
+ site: string;
1024
+ text: string;
1025
+ url: string;
1054
1026
  }
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;
1027
+ interface Article {
1028
+ title: string;
1029
+ date: string;
1030
+ content: string;
1031
+ tickers: string;
1032
+ image: string;
1066
1033
  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;
1034
+ author: string;
1035
+ site: string;
1077
1036
  }
1078
- interface InsiderTradeStatisticsResponse {
1079
- symbol: string;
1080
- cik: string;
1081
- 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;
1096
- }
1097
- interface CikMapperBySymbolResponse {
1098
- symbol: string;
1099
- companyCik: string;
1100
- }
1101
- interface BeneficialOwnershipResponse {
1102
- cik: string;
1037
+
1038
+ interface Quote {
1103
1039
  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;
1040
+ name: string;
1041
+ price: number;
1042
+ changesPercentage: number;
1043
+ change: number;
1044
+ dayLow: number;
1045
+ dayHigh: number;
1046
+ yearHigh: number;
1047
+ yearLow: number;
1048
+ marketCap: number | null;
1049
+ priceAvg50: number;
1050
+ priceAvg200: number;
1051
+ exchange: string;
1052
+ volume: number;
1053
+ avgVolume: number;
1054
+ open: number;
1055
+ previousClose: number;
1056
+ eps: number | null;
1057
+ pe: number | null;
1058
+ earningsAnnouncement: string | null;
1059
+ sharesOutstanding: number | null;
1060
+ timestamp: number;
1117
1061
  }
1118
- interface FailToDeliverResponse {
1119
- symbol: string;
1062
+ interface HistoricalPriceData {
1120
1063
  date: string;
1121
- price: number;
1122
- quantity: number;
1123
- cusip: string;
1124
- name: string;
1064
+ open: number;
1065
+ high: number;
1066
+ low: number;
1067
+ close: number;
1068
+ adjClose: number;
1069
+ volume: number;
1070
+ unadjustedVolume: number;
1071
+ change: number;
1072
+ changePercent: number;
1073
+ vwap: number;
1074
+ label: string;
1075
+ changeOverTime: number;
1125
1076
  }
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"
1077
+ interface HistoricalPriceResponse {
1078
+ symbol: string;
1079
+ historical: HistoricalPriceData[];
1145
1080
  }
1146
1081
 
1147
1082
  interface RSSFeedItem {
@@ -1236,4 +1171,164 @@ interface IndustryClassificationCodesParams {
1236
1171
  sicCode?: number;
1237
1172
  }
1238
1173
 
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 };
1174
+ interface ScreenerParams {
1175
+ marketCapMoreThan?: number;
1176
+ marketCapLowerThan?: number;
1177
+ sector?: string;
1178
+ industry?: string;
1179
+ betaMoreThan?: number;
1180
+ betaLowerThan?: number;
1181
+ priceMoreThan?: number;
1182
+ priceLowerThan?: number;
1183
+ dividendMoreThan?: number;
1184
+ dividendLowerThan?: number;
1185
+ volumeMoreThan?: number;
1186
+ volumeLowerThan?: number;
1187
+ exchange?: string;
1188
+ country?: string;
1189
+ isEtf?: boolean;
1190
+ isFund?: boolean;
1191
+ isActivelyTrading?: boolean;
1192
+ limit?: number;
1193
+ includeAllShareClasses?: boolean;
1194
+ }
1195
+ interface Screener {
1196
+ symbol: string;
1197
+ companyName: string;
1198
+ marketCap: number;
1199
+ sector: string;
1200
+ industry: string;
1201
+ beta: number;
1202
+ price: number;
1203
+ lastAnnualDividend: number;
1204
+ volume: number;
1205
+ exchange: string;
1206
+ exchangeShortName: string;
1207
+ country: string;
1208
+ isEtf: boolean;
1209
+ isFund: boolean;
1210
+ isActivelyTrading: boolean;
1211
+ }
1212
+ interface AvailableExchanges {
1213
+ exchange: string;
1214
+ name: string;
1215
+ countryName: string;
1216
+ countryCode: string;
1217
+ symbolSuffix: string;
1218
+ delay: string;
1219
+ }
1220
+ interface AvailableSectors {
1221
+ sector: string;
1222
+ }
1223
+ interface AvailableIndustries {
1224
+ industry: string;
1225
+ }
1226
+ interface AvailableCountries {
1227
+ country: string;
1228
+ }
1229
+
1230
+ interface SenateTradingResponse {
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
+ interface HouseTradingResponse {
1248
+ symbol: string;
1249
+ disclosureDate: string;
1250
+ transactionDate: string;
1251
+ firstName: string;
1252
+ lastName: string;
1253
+ office: string;
1254
+ district: string;
1255
+ owner: string;
1256
+ assetDescription: string;
1257
+ assetType: string;
1258
+ type: string;
1259
+ amount: string;
1260
+ capitalGainsOver200USD: string;
1261
+ comment: string;
1262
+ link: string;
1263
+ }
1264
+ interface SenateHouseTradingByNameResponse {
1265
+ symbol: string;
1266
+ disclosureDate: string;
1267
+ transactionDate: string;
1268
+ firstName: string;
1269
+ lastName: string;
1270
+ office: string;
1271
+ district: string;
1272
+ owner: string;
1273
+ assetDescription: string;
1274
+ assetType: string;
1275
+ type: string;
1276
+ amount: string;
1277
+ capitalGainsOver200USD: string;
1278
+ comment: string;
1279
+ link: string;
1280
+ }
1281
+
1282
+ interface StockSplit {
1283
+ date: string;
1284
+ label: string;
1285
+ numerator: number;
1286
+ denominator: number;
1287
+ }
1288
+ interface StockSplitResponse {
1289
+ symbol: string;
1290
+ historical: StockSplit[];
1291
+ }
1292
+ interface StockDividend {
1293
+ date: string;
1294
+ label: string;
1295
+ adjDividend: number;
1296
+ dividend: number;
1297
+ recordDate: string;
1298
+ paymentDate: string;
1299
+ declarationDate: string;
1300
+ }
1301
+ interface StockDividendResponse {
1302
+ symbol: string;
1303
+ historical: StockDividend[];
1304
+ }
1305
+ interface MarketCap {
1306
+ symbol: string;
1307
+ date: string;
1308
+ marketCap: number;
1309
+ }
1310
+ interface StockRealTimePrice {
1311
+ symbol: string;
1312
+ price: number;
1313
+ }
1314
+ interface StockRealTimePriceFull {
1315
+ bidSize: number;
1316
+ askPrice: number;
1317
+ volume: number;
1318
+ askSize: number;
1319
+ bidPrice: number;
1320
+ lastSalePrice: number;
1321
+ lastSaleSize: number;
1322
+ lastSaleTime: number;
1323
+ fmpLast: number;
1324
+ lastUpdated: number;
1325
+ symbol: string;
1326
+ }
1327
+ interface StockListResponse<T> {
1328
+ stockList: T[];
1329
+ }
1330
+ interface CompaniesPriceListResponse<T> {
1331
+ companiesPriceList: T[];
1332
+ }
1333
+
1334
+ export { type APIResponse, type Article, 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 News, 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 };