@orbis-systems/orbis-api-clients 0.5.3 → 0.6.0

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.
@@ -7,6 +7,7 @@ interface BaseClientConfig<HandleError extends boolean = boolean> {
7
7
  defaultHeaders?: Record<string, string>;
8
8
  defaultSecure?: boolean;
9
9
  authDataStorageKey?: string;
10
+ withCredentials?: boolean;
10
11
  onAxiosError?: (error: AxiosError) => void;
11
12
  onError?: (error: unknown) => void;
12
13
  }
@@ -156,10 +157,10 @@ export interface InsightSymbolMomentum {
156
157
  result_ratio: number;
157
158
  }
158
159
  export interface InsightAddCountryCodesRequest {
159
- codes?: InsightCountryCode[];
160
+ codes: InsightCountryCode[];
160
161
  }
161
162
  export interface InsightAddGlobalIndexesRequest {
162
- countries?: InsightGlobalIndex[];
163
+ countries: InsightGlobalIndex[];
163
164
  }
164
165
  export interface InsightAgeDistribution {
165
166
  eldest: InsightAgeDistributionInfo;
@@ -262,15 +263,22 @@ export interface InsightArticleFeaturedImageInfo {
262
263
  width: number;
263
264
  }
264
265
  export interface InsightArticlesRequest {
265
- count?: number;
266
- /** (REQUIRE) */
267
- language?: string;
266
+ /** @example 10 */
267
+ count: number;
268
+ /** @example "eng" */
269
+ language: string;
270
+ /** @example 1609459200 */
268
271
  released_after?: number;
272
+ /** @example 1625097600 */
269
273
  released_before?: number;
274
+ /** @example "AAPL,GOOGL" */
270
275
  symbols?: string;
276
+ /** @example "technology" */
271
277
  tag?: string;
278
+ /** @example "group1" */
272
279
  tag_group?: string;
273
- type?: InsightArticlesRequestTypeEnum;
280
+ /** @example "education" */
281
+ type?: string;
274
282
  }
275
283
  export interface InsightAssetAllocationBreakdown {
276
284
  breakdown: string;
@@ -287,10 +295,10 @@ export interface InsightAuthorInfo {
287
295
  name: string;
288
296
  }
289
297
  export interface InsightAuthorProfileRequest {
290
- /** (REQUIRE) */
291
- id?: string;
292
- /** (REQUIRE) */
293
- language?: string;
298
+ /** @example "12345" */
299
+ id: string;
300
+ /** @example "eng" */
301
+ language: string;
294
302
  }
295
303
  export interface InsightAuthorProfileResponse {
296
304
  articles: InsightArticle[];
@@ -345,24 +353,34 @@ export interface InsightCalculateEstimatedReturnsResponse {
345
353
  total_value: number;
346
354
  }
347
355
  export interface InsightCalculateMatrixParamsRequest {
348
- expiry_date?: InsightDate;
349
- max_intervals?: number;
350
- option_type?: string;
351
- stock_price_max?: number;
352
- stock_price_min?: number;
353
- strike_value?: number;
354
- ticker?: string;
356
+ expiry_date: InsightDate;
357
+ /** @example 10 */
358
+ max_intervals: number;
359
+ /** @example "c" */
360
+ option_type?: InsightCalculateMatrixParamsRequestOptionTypeEnum;
361
+ /** @example 160 */
362
+ stock_price_max: number;
363
+ /** @example 140 */
364
+ stock_price_min: number;
365
+ /** @example 155 */
366
+ strike_value: number;
367
+ /** @example "AAPL" */
368
+ ticker: string;
355
369
  }
356
370
  export interface InsightCalculateMatrixResponse {
357
371
  matrix_data: InsightMatrixData[];
358
372
  ticker_data: InsightTickerData;
359
373
  }
360
374
  export interface InsightCalculateParamsRequest {
361
- expiry_date?: InsightDate;
362
- option_type?: string;
363
- stock_price?: number;
364
- strike_value?: number;
365
- ticker?: string;
375
+ expiry_date: InsightDate;
376
+ /** @example "c" */
377
+ option_type?: InsightCalculateParamsRequestOptionTypeEnum;
378
+ /** @example 150.25 */
379
+ stock_price: number;
380
+ /** @example 155 */
381
+ strike_value: number;
382
+ /** @example "AAPL" */
383
+ ticker: string;
366
384
  }
367
385
  export interface InsightCalculateParamsResponse {
368
386
  option_data: InsightOptionData;
@@ -378,41 +396,76 @@ export interface InsightClassificationResponse {
378
396
  name: string;
379
397
  }
380
398
  export interface InsightCombainedProfileResponse {
399
+ /** @example "One Apple Park Way" */
381
400
  address: string;
401
+ /** @example "Miscellaneous" */
382
402
  asset: string;
403
+ /** @example "Health" */
383
404
  category: string;
405
+ /** @example "Cupertino" */
384
406
  city: string;
407
+ /** @example "Apple Inc" */
385
408
  company_name: string;
409
+ /** @example "United States" */
386
410
  country: string;
411
+ /** @example "USA" */
387
412
  country_code: string;
388
413
  earning_release: InsightEarningRelease;
414
+ /** @example "tgala@apple.com" */
389
415
  email: string;
416
+ /** @example 164000 */
390
417
  employees_number: number;
391
- /** Index fields */
418
+ /**
419
+ * Index fields
420
+ * @example "0Ay"
421
+ */
392
422
  exchange: string;
423
+ /** @example "Nasdaq Index" */
393
424
  exchange_name: string;
394
- /** Fund fields */
425
+ /**
426
+ * Fund fields
427
+ * @example 0.68
428
+ */
395
429
  expense_ratio: number;
430
+ /** @example "+1 408 974-2483" */
396
431
  fax: string;
432
+ /** @example 36.403 */
397
433
  fund_ownership_percent: number;
434
+ /** @example "EQUITY" */
398
435
  fund_type: string;
436
+ /** @example 0.392 */
399
437
  insider_ownership_percent: number;
438
+ /** @example 39.768 */
400
439
  institutional_ownership_percent: number;
440
+ /** @example true */
401
441
  inverse: boolean;
442
+ /** @example "Apple Inc" */
402
443
  legal_company_name: string;
444
+ /** @example 1 */
403
445
  leverage: number;
404
446
  logo: InsightSymbolLogosResponse;
447
+ /** @example "Apple designs a wide variety of consumer electronic devices, including smartphones (iPhone), tablets (iPad), PCs (Mac), smartwatches (Apple Watch), and AirPods, among others. In addition, Apple offers its customers a variety of services such as Apple Music, iCloud, Apple Care, Apple TV+, Apple Arcade, Apple Fitness, Apple Card, and Apple Pay, among others. Apple's products include internally developed software and semiconductors, and the firm is well known for its integration of hardware, software, semiconductors, and services. Apple's products are distributed online as well as through company-owned stores and third-party retailers." */
405
448
  long_description: string;
449
+ /** @example 3068670 */
406
450
  market_cap: number;
451
+ /** @example "XNAS" */
407
452
  mic: string;
453
+ /** @example "+1 408 996-1010" */
408
454
  phone: string;
455
+ /** @example "95014" */
409
456
  postal_code: string;
457
+ /** @example "CA" */
410
458
  province: string;
411
459
  sector: InsightSymbolIndustries;
460
+ /** @example "Apple" */
412
461
  short_company_name: string;
462
+ /** @example "Manufactures mobile communication and media device" */
413
463
  short_description: string;
464
+ /** @example "Open Ended Investment Company" */
414
465
  structure: string;
466
+ /** @example "AAPL" */
415
467
  symbol: string;
468
+ /** @example "https://www.apple.com" */
416
469
  website: string;
417
470
  }
418
471
  export interface InsightCompaniesReview {
@@ -480,20 +533,59 @@ export interface InsightCouponBreakdown {
480
533
  percentage: number;
481
534
  }
482
535
  export interface InsightCreateContinentRequest {
483
- continents?: InsightContinent[];
536
+ continents: InsightContinent[];
484
537
  }
485
538
  export interface InsightCreateCustomIndexRequest {
539
+ /**
540
+ * @maxLength 1000
541
+ * @example "description"
542
+ */
486
543
  description?: string;
544
+ /** @maxItems 1000 */
487
545
  equities?: string[];
546
+ /** @maxItems 1000 */
488
547
  etfs?: string[];
489
- name?: string;
490
- private_name?: string;
548
+ /**
549
+ * @minLength 1
550
+ * @maxLength 1000
551
+ * @example "name"
552
+ */
553
+ name: string;
554
+ /**
555
+ * @minLength 1
556
+ * @maxLength 1000
557
+ * @example "private_name"
558
+ */
559
+ private_name: string;
560
+ }
561
+ export interface InsightCreateFeaturedArticlesRequest {
562
+ /** @example "https://example.com/image.jpg" */
563
+ image: string;
564
+ /** @example 1 */
565
+ source_id: number;
566
+ /** @example ["AAPL","GOOGL"] */
567
+ symbols: string[];
568
+ /** @example ["News","Update"] */
569
+ tags: string[];
570
+ /**
571
+ * @maxLength 1000
572
+ * @example "This is a teaser for the breaking news"
573
+ */
574
+ teaser: string;
575
+ /**
576
+ * @maxLength 1000
577
+ * @example "Breaking News"
578
+ */
579
+ title: string;
491
580
  }
492
581
  export interface InsightCreateHeatmapPresetRequest {
493
- heatmap_name?: string;
494
- symbols?: {
495
- symbol?: string;
496
- title?: string;
582
+ /** @example "Tech Stocks" */
583
+ heatmap_name: string;
584
+ symbols: {
585
+ /** @example "AAPL" */
586
+ symbol: string;
587
+ /** @example "Apple Inc." */
588
+ title: string;
497
589
  }[];
498
590
  }
499
591
  export interface InsightCreateOrUpdateFixedIncomePresetRequest {
@@ -511,11 +603,13 @@ export interface InsightCreateOrUpdateScreenerPresetRequest {
511
603
  preset_name?: string;
512
604
  }
513
605
  export interface InsightCreateRegionRequest {
514
- regions?: InsightRegion[];
606
+ regions: InsightRegion[];
515
607
  }
516
608
  export interface InsightCryptoLogoConvertedRequest {
517
- conversion?: InsightCryptoLogoConvertedRequestConversionEnum;
518
- symbol?: string;
609
+ /** @example "normal" */
610
+ conversion: InsightCryptoLogoConvertedRequestConversionEnum;
611
+ /** @example "BTC" */
612
+ symbol: string;
519
613
  }
520
614
  export interface InsightCryptoLogosResponse {
521
615
  logo: string;
@@ -547,54 +641,98 @@ export interface InsightDailyPriceHistoryResponse {
547
641
  symbol: string;
548
642
  }
549
643
  export interface InsightDate {
644
+ /**
645
+ * @min 1
646
+ * @max 31
647
+ * @example 31
648
+ */
550
649
  day: number;
650
+ /**
651
+ * @min 1
652
+ * @max 12
653
+ * @example 12
654
+ */
551
655
  month: number;
656
+ /**
657
+ * @min 2000
658
+ * @max 2100
659
+ * @example 2023
660
+ */
552
661
  year: number;
553
662
  }
554
663
  export interface InsightEarningRelease {
664
+ /** @example "08/02/2024 00:00:00" */
555
665
  date: string;
666
+ /** @example "NAS" */
556
667
  exchange: string;
668
+ /** @example "Q3" */
557
669
  quarter: string;
558
670
  quote: InsightQuote;
671
+ /** @example "2024-08-02T00:00:00Z" */
559
672
  start_time: string;
673
+ /** @example "Estimated" */
560
674
  status: string;
675
+ /** @example "AAPL" */
561
676
  symbol: string;
677
+ /** @example "After Market Close" */
562
678
  time: string;
563
679
  }
564
680
  export interface InsightEarningReleasesRequest {
681
+ /**
682
+ * @min 0
683
+ * @example 7
684
+ */
565
685
  days_from_now?: number;
686
+ /** @example ["NYSE"] */
566
687
  exchanges?: string[];
688
+ /** @example true */
567
689
  load_quotes?: boolean;
568
- paging?: InsightPaging;
569
- quote_access_type?: string;
690
+ paging: InsightPaging;
691
+ /** @example ["AAPL","GOOGL"] */
570
692
  symbols?: string[];
571
693
  }
572
694
  export interface InsightEarningReleasesResponse {
695
+ /** @example 10 */
573
696
  count: number;
574
697
  details: InsightEarningRelease[];
575
698
  }
576
699
  export interface InsightEditContinentRequest {
577
- id?: string;
578
- name?: string;
700
+ /** @example "1" */
701
+ id: string;
702
+ /** @example "Africa" */
703
+ name: string;
579
704
  }
580
705
  export interface InsightEditCountryCodeRequest {
581
- a2_code?: string;
582
- a3_code?: string;
583
- country_name?: string;
584
- morningstar_id?: string;
585
- num_code?: string;
706
+ /** @example "US" */
707
+ a2_code: string;
708
+ /** @example "USA" */
709
+ a3_code: string;
710
+ /** @example "United States" */
711
+ country_name: string;
712
+ /** @example "MSTAR123" */
713
+ morningstar_id: string;
714
+ /** @example "840" */
715
+ num_code: string;
586
716
  }
587
717
  export interface InsightEditGlobalIndexRequest {
588
- continent_id?: string;
589
- country?: string;
590
- gdp?: number;
591
- ppp?: number;
592
- region_id?: string;
593
- symbol?: string;
718
+ /** @example "019" */
719
+ continent_id: string;
720
+ /** @example "United States" */
721
+ country: string;
722
+ /** @example 21.43 */
723
+ gdp: number;
724
+ /** @example 65.12 */
725
+ ppp: number;
726
+ /** @example "01" */
727
+ region_id: string;
728
+ /** @example "AAPL" */
729
+ symbol: string;
594
730
  }
595
731
  export interface InsightEditRegionRequest {
596
- id?: string;
597
- name?: string;
732
+ /** @example "1" */
733
+ id: string;
734
+ /** @example "North America" */
735
+ name: string;
598
736
  }
599
737
  export interface InsightExchangeResponse {
600
738
  code: string;
@@ -649,6 +787,17 @@ export interface InsightExtremum {
649
787
  min_value: number;
650
788
  min_value_date: string;
651
789
  }
790
+ export interface InsightFeaturedArticle {
791
+ created: string;
792
+ id: string;
793
+ image: InsightNewsImage[];
794
+ source_id: number;
795
+ symbols: string[];
796
+ tags: string[];
797
+ teaser: string;
798
+ title: string;
799
+ updated: string;
800
+ }
652
801
  export interface InsightFilterCustomIndexesRequest {
653
802
  paging?: InsightPaging;
654
803
  symbols?: string[];
@@ -839,39 +988,118 @@ export interface InsightGetCustomIndexesResponse {
839
988
  count: number;
840
989
  data: InsightCustomIndex[];
841
990
  }
991
+ export interface InsightGetFeaturedArticlesResponse {
992
+ count: number;
993
+ featured_articles: InsightFeaturedArticle[];
994
+ }
842
995
  export interface InsightGetFixedIncomeEntriesRequest {
996
+ /** @example true */
843
997
  bank_qualified?: boolean;
998
+ /** @example true */
844
999
  callable?: boolean;
1000
+ /** @example true */
845
1001
  convertible?: boolean;
1002
+ /** @example ["USA"] */
846
1003
  country_codes?: string[];
847
1004
  coupon?: InsightLessAndMore;
1005
+ /** @example ["quarterly","zero"] */
848
1006
  coupon_frequencies?: string[];
1007
+ /** @example ["655664AH3","9128286R6"] */
849
1008
  cusip?: string[];
1009
+ /**
1010
+ * @maxLength 100
1011
+ * @example "Donald's"
1012
+ */
850
1013
  description?: string;
1014
+ /** @example true */
851
1015
  has_ticker?: boolean;
1016
+ /** @example true */
852
1017
  insured?: boolean;
1018
+ /** @example ["US655664AH33","US9128286R69"] */
853
1019
  isin?: string[];
854
1020
  issue_date?: InsightBeforeAndAfter;
1021
+ /**
1022
+ * @maxLength 100
1023
+ * @example "Donald's"
1024
+ */
855
1025
  issuer?: string;
856
1026
  maturity?: InsightBeforeAndAfter;
1027
+ /** @example ["NY"] */
857
1028
  municipal_states?: string[];
1029
+ /** @example true */
858
1030
  municipal_tax?: boolean;
1031
+ /** @example ["general_obligation"] */
859
1032
  municipal_types?: string[];
860
1033
  order?: InsightOrdering;
861
- pagination?: InsightPagination;
862
- paging?: InsightPaging;
1034
+ pagination: InsightPagination;
1035
+ paging: InsightPaging;
863
1036
  purposes?: string[];
1037
+ /** @example ["SOVEREIGN"] */
864
1038
  sectors?: string[];
865
1039
  sorts?: InsightOrdering[];
1040
+ /** @example ["AAA"] */
866
1041
  sp_ratings?: string[];
1042
+ /** @example ["called","outstanding"] */
867
1043
  statuses?: string[];
868
1044
  tickers?: string[];
1045
+ /** @example ["corporate"] */
869
1046
  types?: string[];
870
1047
  }
871
1048
  export interface InsightGetFixedIncomeEntriesResponse {
872
1049
  count: number;
873
1050
  data: InsightFixedIncome[];
874
1051
  }
1052
+ export interface InsightGetFixedIncomeEntriesV1Request {
1053
+ /** @example true */
1054
+ bank_qualified?: boolean;
1055
+ /** @example true */
1056
+ callable?: boolean;
1057
+ /** @example true */
1058
+ convertible?: boolean;
1059
+ /** @example ["USA"] */
1060
+ country_codes?: string[];
1061
+ coupon?: InsightLessAndMore;
1062
+ /** @example ["quarterly","zero"] */
1063
+ coupon_frequencies?: string[];
1064
+ /** @example ["655664AH3","9128286R6"] */
1065
+ cusip?: string[];
1066
+ /**
1067
+ * @maxLength 100
1068
+ * @example "Donald's"
1069
+ */
1070
+ description?: string;
1071
+ /** @example true */
1072
+ has_ticker?: boolean;
1073
+ /** @example true */
1074
+ insured?: boolean;
1075
+ /** @example ["US655664AH33","US9128286R69"] */
1076
+ isin?: string[];
1077
+ issue_date?: InsightBeforeAndAfter;
1078
+ /**
1079
+ * @maxLength 100
1080
+ * @example "Donald's"
1081
+ */
1082
+ issuer?: string;
1083
+ maturity?: InsightBeforeAndAfter;
1084
+ /** @example ["NY"] */
1085
+ municipal_states?: string[];
1086
+ /** @example true */
1087
+ municipal_tax?: boolean;
1088
+ /** @example ["general_obligation"] */
1089
+ municipal_types?: string[];
1090
+ order?: InsightOrdering;
1091
+ paging: InsightPaging;
1092
+ purposes?: string[];
1093
+ /** @example ["SOVEREIGN"] */
1094
+ sectors?: string[];
1095
+ /** @example ["AAA"] */
1096
+ sp_ratings?: string[];
1097
+ /** @example ["called","outstanding"] */
1098
+ statuses?: string[];
1099
+ tickers?: string[];
1100
+ /** @example ["corporate"] */
1101
+ types?: string[];
1102
+ }
875
1103
  export interface InsightGetFixedIncomeHistoricalData {
876
1104
  price: number;
877
1105
  timestamp: string;
@@ -927,12 +1155,12 @@ export interface InsightGetFundScreenerFiltersResponse {
927
1155
  sponsors?: InsightFundFilterSponsor[];
928
1156
  }
929
1157
  export interface InsightGetFundsForHoldingRequest {
930
- /** ANY|LEVERAGE_I|LEVERAGE_II|LEVERAGE_III */
931
- leverage?: string;
1158
+ /** @example "LEVERAGE_I" */
1159
+ leverage: InsightGetFundsForHoldingRequestLeverageEnum;
932
1160
  order?: InsightOrdering;
933
- paging?: InsightPaging;
934
- quote_access_type?: string;
935
- symbol?: string;
1161
+ paging: InsightPaging;
1162
+ /** @example "AAPL" */
1163
+ symbol: string;
936
1164
  }
937
1165
  export interface InsightGetFundsForHoldingResponse {
938
1166
  count: number;
@@ -959,10 +1187,13 @@ export interface InsightGetIndustriesPerformanceResponse {
959
1187
  worst_performing_quotes: InsightStockScreenerQuote[];
960
1188
  }
961
1189
  export interface InsightGetMarketDatesRequest {
962
- end_date?: string;
963
- markets?: string[];
964
- paging?: InsightPaging;
965
- start_date?: string;
1190
+ /** @example "2023-12-31" */
1191
+ end_date: string;
1192
+ /** @example ["NYSE","NASDAQ"] */
1193
+ markets: string[];
1194
+ paging: InsightPaging;
1195
+ /** @example "2023-01-01" */
1196
+ start_date: string;
966
1197
  }
967
1198
  export interface InsightGetMarketDatesResponse {
968
1199
  count: number;
@@ -977,7 +1208,8 @@ export interface InsightGetMarketHoursResponse {
977
1208
  time_zone: string;
978
1209
  }
979
1210
  export interface InsightGetOwnershipsByIDRequest {
980
- owner_id?: string;
1211
+ /** @example "123e4567-e89b-12d3-a456-426614174000" */
1212
+ owner_id: string;
981
1213
  paging?: InsightPaging;
982
1214
  }
983
1215
  export interface InsightGetOwnershipsBySymbolAsDashboardFieldsResponse {
@@ -986,10 +1218,13 @@ export interface InsightGetOwnershipsBySymbolAsDashboardFieldsResponse {
986
1218
  }
987
1219
  export interface InsightGetOwnershipsBySymbolRequest {
988
1220
  order?: InsightOrdering;
989
- owner_type?: string;
990
- paging?: InsightPaging;
1221
+ /** @example "institutional" */
1222
+ owner_type: InsightGetOwnershipsBySymbolRequestOwnerTypeEnum;
1223
+ paging: InsightPaging;
1224
+ /** @example "Apple Inc" */
991
1225
  search_query?: string;
992
- symbols?: string[];
1226
+ /** @example ["AAPL","GOOGL"] */
1227
+ symbols: string[];
993
1228
  }
994
1229
  export interface InsightGetOwnershipsBySymbolResponse {
995
1230
  count: number;
@@ -997,24 +1232,1158 @@ export interface InsightGetOwnershipsBySymbolResponse {
997
1232
  }
998
1233
  export interface InsightGetOwnershipsBySymbolWithoutSearchQueryRequest {
999
1234
  order?: InsightOrdering;
1000
- owner_type?: string;
1001
- paging?: InsightPaging;
1002
- symbols?: string[];
1235
+ /** @example "institutional" */
1236
+ owner_type: InsightGetOwnershipsBySymbolWithoutSearchQueryRequestOwnerTypeEnum;
1237
+ paging: InsightPaging;
1238
+ /** @example ["AAPL","GOOGL"] */
1239
+ symbols: string[];
1003
1240
  }
1004
1241
  export interface InsightGetScreenerPresetsResponse {
1005
1242
  count: number;
1006
1243
  default_presets: InsightScreenerPreset[];
1007
1244
  details: InsightScreenerPreset[];
1008
1245
  }
1009
- export interface InsightGetSliderArticlesResponse {
1010
- slider_articles: number[];
1011
- updated_at: string;
1246
+ export interface InsightGetSymbolFundamentalsAnnualResponse {
1247
+ balance_sheet: {
1248
+ '2021': {
1249
+ accounts_payable?: number;
1250
+ accounts_receivable?: number;
1251
+ accumulated_depreciation?: number;
1252
+ available_for_sale_securities?: number;
1253
+ capital_lease_obligations?: number;
1254
+ capital_stock?: number;
1255
+ cash?: number;
1256
+ cash_and_cash_equivalents?: number;
1257
+ cash_cash_equivalents_and_marketable_securities?: number;
1258
+ cash_equivalents?: number;
1259
+ commercial_paper?: number;
1260
+ common_stock?: number;
1261
+ common_stock_equity?: number;
1262
+ current_assets?: number;
1263
+ current_capital_lease_obligation?: number;
1264
+ current_debt?: number;
1265
+ current_debt_and_capital_lease_obligation?: number;
1266
+ current_deferred_liabilities?: number;
1267
+ current_deferred_revenue?: number;
1268
+ current_liabilities?: number;
1269
+ gains_losses_not_affecting_retained_earnings?: number;
1270
+ gross_ppe?: number;
1271
+ inventory?: number;
1272
+ invested_capital?: number;
1273
+ investmentin_financial_assets?: number;
1274
+ investments_and_advances?: number;
1275
+ land_and_improvements?: number;
1276
+ leases?: number;
1277
+ long_term_capital_lease_obligation?: number;
1278
+ long_term_debt?: number;
1279
+ long_term_debt_and_capital_lease_obligation?: number;
1280
+ machinery_furniture_equipment?: number;
1281
+ net_debt?: number;
1282
+ net_ppe?: number;
1283
+ net_tangible_assets?: number;
1284
+ ordinary_shares_number?: number;
1285
+ other_current_assets?: number;
1286
+ other_current_borrowings?: number;
1287
+ other_current_liabilities?: number;
1288
+ other_equity_adjustments?: number;
1289
+ other_investments?: number;
1290
+ other_non_current_assets?: number;
1291
+ other_non_current_liabilities?: number;
1292
+ other_properties?: number;
1293
+ other_receivables?: number;
1294
+ other_short_term_investments?: number;
1295
+ payables?: number;
1296
+ payables_and_accrued_expenses?: number;
1297
+ properties?: number;
1298
+ receivables?: number;
1299
+ retained_earnings?: number;
1300
+ share_issued?: number;
1301
+ stockholders_equity?: number;
1302
+ tangible_book_value?: number;
1303
+ total_assets?: number;
1304
+ total_capitalization?: number;
1305
+ total_debt?: number;
1306
+ total_equity?: number;
1307
+ total_equity_gross_minority_interest?: number;
1308
+ total_liabilities_net_minority_interest?: number;
1309
+ total_non_current_assets?: number;
1310
+ total_non_current_liabilities_net_minority_interest?: number;
1311
+ tradeand_other_payables_non_current?: number;
1312
+ working_capital?: number;
1313
+ };
1314
+ '2022': {
1315
+ accounts_payable?: number;
1316
+ accounts_receivable?: number;
1317
+ accumulated_depreciation?: number;
1318
+ available_for_sale_securities?: number;
1319
+ capital_lease_obligations?: number;
1320
+ capital_stock?: number;
1321
+ cash?: number;
1322
+ cash_and_cash_equivalents?: number;
1323
+ cash_cash_equivalents_and_marketable_securities?: number;
1324
+ cash_equivalents?: number;
1325
+ commercial_paper?: number;
1326
+ common_stock?: number;
1327
+ common_stock_equity?: number;
1328
+ current_assets?: number;
1329
+ current_capital_lease_obligation?: number;
1330
+ current_debt?: number;
1331
+ current_debt_and_capital_lease_obligation?: number;
1332
+ current_deferred_liabilities?: number;
1333
+ current_deferred_revenue?: number;
1334
+ current_liabilities?: number;
1335
+ gains_losses_not_affecting_retained_earnings?: number;
1336
+ gross_ppe?: number;
1337
+ income_tax_payable?: number;
1338
+ inventory?: number;
1339
+ invested_capital?: number;
1340
+ investmentin_financial_assets?: number;
1341
+ investments_and_advances?: number;
1342
+ land_and_improvements?: number;
1343
+ leases?: number;
1344
+ long_term_capital_lease_obligation?: number;
1345
+ long_term_debt?: number;
1346
+ long_term_debt_and_capital_lease_obligation?: number;
1347
+ machinery_furniture_equipment?: number;
1348
+ net_debt?: number;
1349
+ net_ppe?: number;
1350
+ net_tangible_assets?: number;
1351
+ non_current_deferred_assets?: number;
1352
+ non_current_deferred_taxes_assets?: number;
1353
+ ordinary_shares_number?: number;
1354
+ other_current_assets?: number;
1355
+ other_current_borrowings?: number;
1356
+ other_current_liabilities?: number;
1357
+ other_equity_adjustments?: number;
1358
+ other_investments?: number;
1359
+ other_non_current_assets?: number;
1360
+ other_non_current_liabilities?: number;
1361
+ other_properties?: number;
1362
+ other_receivables?: number;
1363
+ other_short_term_investments?: number;
1364
+ payables?: number;
1365
+ payables_and_accrued_expenses?: number;
1366
+ properties?: number;
1367
+ receivables?: number;
1368
+ retained_earnings?: number;
1369
+ share_issued?: number;
1370
+ stockholders_equity?: number;
1371
+ tangible_book_value?: number;
1372
+ total_assets?: number;
1373
+ total_capitalization?: number;
1374
+ total_debt?: number;
1375
+ total_equity?: number;
1376
+ total_equity_gross_minority_interest?: number;
1377
+ total_liabilities_net_minority_interest?: number;
1378
+ total_non_current_assets?: number;
1379
+ total_non_current_liabilities_net_minority_interest?: number;
1380
+ total_tax_payable?: number;
1381
+ tradeand_other_payables_non_current?: number;
1382
+ working_capital?: number;
1383
+ };
1384
+ '2023': {
1385
+ accounts_payable?: number;
1386
+ accounts_receivable?: number;
1387
+ accumulated_depreciation?: number;
1388
+ available_for_sale_securities?: number;
1389
+ capital_lease_obligations?: number;
1390
+ capital_stock?: number;
1391
+ cash?: number;
1392
+ cash_and_cash_equivalents?: number;
1393
+ cash_cash_equivalents_and_marketable_securities?: number;
1394
+ cash_equivalents?: number;
1395
+ com_tre_sha_num?: number;
1396
+ commercial_paper?: number;
1397
+ common_stock?: number;
1398
+ common_stock_equity?: number;
1399
+ current_assets?: number;
1400
+ current_capital_lease_obligation?: number;
1401
+ current_debt?: number;
1402
+ current_debt_and_capital_lease_obligation?: number;
1403
+ current_deferred_liabilities?: number;
1404
+ current_deferred_revenue?: number;
1405
+ current_liabilities?: number;
1406
+ gains_losses_not_affecting_retained_earnings?: number;
1407
+ gross_ppe?: number;
1408
+ income_tax_payable?: number;
1409
+ inventory?: number;
1410
+ invested_capital?: number;
1411
+ investmentin_financial_assets?: number;
1412
+ investments_and_advances?: number;
1413
+ land_and_improvements?: number;
1414
+ leases?: number;
1415
+ long_term_capital_lease_obligation?: number;
1416
+ long_term_debt?: number;
1417
+ long_term_debt_and_capital_lease_obligation?: number;
1418
+ machinery_furniture_equipment?: number;
1419
+ net_debt?: number;
1420
+ net_ppe?: number;
1421
+ net_tangible_assets?: number;
1422
+ non_current_deferred_assets?: number;
1423
+ non_current_deferred_taxes_assets?: number;
1424
+ ordinary_shares_number?: number;
1425
+ other_current_assets?: number;
1426
+ other_current_borrowings?: number;
1427
+ other_current_liabilities?: number;
1428
+ other_equity_adjustments?: number;
1429
+ other_non_current_assets?: number;
1430
+ other_non_current_liabilities?: number;
1431
+ other_properties?: number;
1432
+ other_receivables?: number;
1433
+ other_short_term_investments?: number;
1434
+ payables?: number;
1435
+ payables_and_accrued_expenses?: number;
1436
+ properties?: number;
1437
+ receivables?: number;
1438
+ retained_earnings?: number;
1439
+ share_issued?: number;
1440
+ stockholders_equity?: number;
1441
+ tangible_book_value?: number;
1442
+ total_assets?: number;
1443
+ total_capitalization?: number;
1444
+ total_debt?: number;
1445
+ total_equity?: number;
1446
+ total_equity_gross_minority_interest?: number;
1447
+ total_liabilities_net_minority_interest?: number;
1448
+ total_non_current_assets?: number;
1449
+ total_non_current_liabilities_net_minority_interest?: number;
1450
+ total_tax_payable?: number;
1451
+ tradeand_other_payables_non_current?: number;
1452
+ treasury_shares_number?: number;
1453
+ working_capital?: number;
1454
+ };
1455
+ '2024': {
1456
+ accounts_payable?: number;
1457
+ accounts_receivable?: number;
1458
+ accumulated_depreciation?: number;
1459
+ available_for_sale_securities?: number;
1460
+ capital_stock?: number;
1461
+ cash?: number;
1462
+ cash_and_cash_equivalents?: number;
1463
+ cash_cash_equivalents_and_marketable_securities?: number;
1464
+ cash_equivalents?: number;
1465
+ commercial_paper?: number;
1466
+ common_stock?: number;
1467
+ common_stock_equity?: number;
1468
+ current_assets?: number;
1469
+ current_debt?: number;
1470
+ current_debt_and_capital_lease_obligation?: number;
1471
+ current_deferred_liabilities?: number;
1472
+ current_deferred_revenue?: number;
1473
+ current_liabilities?: number;
1474
+ gains_losses_not_affecting_retained_earnings?: number;
1475
+ gross_ppe?: number;
1476
+ income_tax_payable?: number;
1477
+ inventory?: number;
1478
+ invested_capital?: number;
1479
+ investmentin_financial_assets?: number;
1480
+ investments_and_advances?: number;
1481
+ land_and_improvements?: number;
1482
+ leases?: number;
1483
+ long_term_debt?: number;
1484
+ long_term_debt_and_capital_lease_obligation?: number;
1485
+ machinery_furniture_equipment?: number;
1486
+ net_debt?: number;
1487
+ net_ppe?: number;
1488
+ net_tangible_assets?: number;
1489
+ non_current_deferred_assets?: number;
1490
+ non_current_deferred_taxes_assets?: number;
1491
+ ordinary_shares_number?: number;
1492
+ other_current_assets?: number;
1493
+ other_current_borrowings?: number;
1494
+ other_current_liabilities?: number;
1495
+ other_equity_adjustments?: number;
1496
+ other_non_current_assets?: number;
1497
+ other_non_current_liabilities?: number;
1498
+ other_receivables?: number;
1499
+ other_short_term_investments?: number;
1500
+ payables?: number;
1501
+ payables_and_accrued_expenses?: number;
1502
+ properties?: number;
1503
+ receivables?: number;
1504
+ retained_earnings?: number;
1505
+ share_issued?: number;
1506
+ stockholders_equity?: number;
1507
+ tangible_book_value?: number;
1508
+ total_assets?: number;
1509
+ total_capitalization?: number;
1510
+ total_debt?: number;
1511
+ total_equity?: number;
1512
+ total_equity_gross_minority_interest?: number;
1513
+ total_liabilities_net_minority_interest?: number;
1514
+ total_non_current_assets?: number;
1515
+ total_non_current_liabilities_net_minority_interest?: number;
1516
+ total_tax_payable?: number;
1517
+ tradeand_other_payables_non_current?: number;
1518
+ working_capital?: number;
1519
+ };
1520
+ currency: string;
1521
+ };
1522
+ cash_flow: {
1523
+ '2021': {
1524
+ beginning_cash_position?: number;
1525
+ capital_expenditure?: number;
1526
+ cash_dividends_paid?: number;
1527
+ cash_flow_from_continuing_financing_activities?: number;
1528
+ cash_flow_from_continuing_investing_activities?: number;
1529
+ cash_flow_from_continuing_operating_activities?: number;
1530
+ change_in_account_payable?: number;
1531
+ change_in_inventory?: number;
1532
+ change_in_other_current_assets?: number;
1533
+ change_in_other_current_liabilities?: number;
1534
+ change_in_other_working_capital?: number;
1535
+ change_in_payable?: number;
1536
+ change_in_payables_and_accrued_expense?: number;
1537
+ change_in_receivables?: number;
1538
+ change_in_working_capital?: number;
1539
+ changes_in_account_receivables?: number;
1540
+ changes_in_cash?: number;
1541
+ common_stock_dividend_paid?: number;
1542
+ common_stock_issuance?: number;
1543
+ common_stock_payments?: number;
1544
+ deferred_income_tax?: number;
1545
+ deferred_tax?: number;
1546
+ depreciation_amortization_depletion?: number;
1547
+ depreciation_and_amortization?: number;
1548
+ end_cash_position?: number;
1549
+ financing_cash_flow?: number;
1550
+ investing_cash_flow?: number;
1551
+ long_term_debt_issuance?: number;
1552
+ long_term_debt_payments?: number;
1553
+ net_business_purchase_and_sale?: number;
1554
+ net_common_stock_issuance?: number;
1555
+ net_income_from_continuing_operations?: number;
1556
+ net_investment_purchase_and_sale?: number;
1557
+ net_issuance_payments_of_debt?: number;
1558
+ net_long_term_debt_issuance?: number;
1559
+ net_other_financing_charges?: number;
1560
+ net_other_investing_changes?: number;
1561
+ net_ppe_purchase_and_sale?: number;
1562
+ net_short_term_debt_issuance?: number;
1563
+ operating_cash_flow?: number;
1564
+ other_non_cash_items?: number;
1565
+ purchase_of_business?: number;
1566
+ purchase_of_investment?: number;
1567
+ purchase_of_ppe?: number;
1568
+ sale_of_investment?: number;
1569
+ stock_based_compensation?: number;
1570
+ };
1571
+ '2022': {
1572
+ beginning_cash_position?: number;
1573
+ capital_expenditure?: number;
1574
+ cash_dividends_paid?: number;
1575
+ cash_flow_from_continuing_financing_activities?: number;
1576
+ cash_flow_from_continuing_investing_activities?: number;
1577
+ cash_flow_from_continuing_operating_activities?: number;
1578
+ change_in_account_payable?: number;
1579
+ change_in_inventory?: number;
1580
+ change_in_other_current_assets?: number;
1581
+ change_in_other_current_liabilities?: number;
1582
+ change_in_other_working_capital?: number;
1583
+ change_in_payable?: number;
1584
+ change_in_payables_and_accrued_expense?: number;
1585
+ change_in_receivables?: number;
1586
+ change_in_working_capital?: number;
1587
+ changes_in_account_receivables?: number;
1588
+ changes_in_cash?: number;
1589
+ common_stock_dividend_paid?: number;
1590
+ common_stock_payments?: number;
1591
+ deferred_income_tax?: number;
1592
+ deferred_tax?: number;
1593
+ depreciation_amortization_depletion?: number;
1594
+ depreciation_and_amortization?: number;
1595
+ end_cash_position?: number;
1596
+ financing_cash_flow?: number;
1597
+ investing_cash_flow?: number;
1598
+ long_term_debt_issuance?: number;
1599
+ long_term_debt_payments?: number;
1600
+ net_business_purchase_and_sale?: number;
1601
+ net_common_stock_issuance?: number;
1602
+ net_income_from_continuing_operations?: number;
1603
+ net_investment_purchase_and_sale?: number;
1604
+ net_issuance_payments_of_debt?: number;
1605
+ net_long_term_debt_issuance?: number;
1606
+ net_other_financing_charges?: number;
1607
+ net_other_investing_changes?: number;
1608
+ net_ppe_purchase_and_sale?: number;
1609
+ net_short_term_debt_issuance?: number;
1610
+ operating_cash_flow?: number;
1611
+ other_non_cash_items?: number;
1612
+ purchase_of_business?: number;
1613
+ purchase_of_investment?: number;
1614
+ purchase_of_ppe?: number;
1615
+ sale_of_investment?: number;
1616
+ short_term_debt_issuance?: number;
1617
+ stock_based_compensation?: number;
1618
+ };
1619
+ '2023': {
1620
+ beginning_cash_position?: number;
1621
+ capital_expenditure?: number;
1622
+ cash_dividends_paid?: number;
1623
+ cash_flow_from_continuing_financing_activities?: number;
1624
+ cash_flow_from_continuing_investing_activities?: number;
1625
+ cash_flow_from_continuing_operating_activities?: number;
1626
+ change_in_account_payable?: number;
1627
+ change_in_inventory?: number;
1628
+ change_in_other_current_assets?: number;
1629
+ change_in_other_current_liabilities?: number;
1630
+ change_in_payable?: number;
1631
+ change_in_payables_and_accrued_expense?: number;
1632
+ change_in_receivables?: number;
1633
+ change_in_working_capital?: number;
1634
+ changes_in_account_receivables?: number;
1635
+ changes_in_cash?: number;
1636
+ common_stock_dividend_paid?: number;
1637
+ common_stock_payments?: number;
1638
+ depreciation_amortization_depletion?: number;
1639
+ depreciation_and_amortization?: number;
1640
+ end_cash_position?: number;
1641
+ financing_cash_flow?: number;
1642
+ investing_cash_flow?: number;
1643
+ long_term_debt_issuance?: number;
1644
+ long_term_debt_payments?: number;
1645
+ net_common_stock_issuance?: number;
1646
+ net_income_from_continuing_operations?: number;
1647
+ net_investment_purchase_and_sale?: number;
1648
+ net_issuance_payments_of_debt?: number;
1649
+ net_long_term_debt_issuance?: number;
1650
+ net_other_financing_charges?: number;
1651
+ net_other_investing_changes?: number;
1652
+ net_ppe_purchase_and_sale?: number;
1653
+ net_short_term_debt_issuance?: number;
1654
+ operating_cash_flow?: number;
1655
+ other_non_cash_items?: number;
1656
+ purchase_of_investment?: number;
1657
+ purchase_of_ppe?: number;
1658
+ sale_of_investment?: number;
1659
+ stock_based_compensation?: number;
1660
+ };
1661
+ '2024': {
1662
+ beginning_cash_position?: number;
1663
+ capital_expenditure?: number;
1664
+ cash_dividends_paid?: number;
1665
+ cash_flow_from_continuing_financing_activities?: number;
1666
+ cash_flow_from_continuing_investing_activities?: number;
1667
+ cash_flow_from_continuing_operating_activities?: number;
1668
+ change_in_account_payable?: number;
1669
+ change_in_inventory?: number;
1670
+ change_in_other_current_assets?: number;
1671
+ change_in_other_current_liabilities?: number;
1672
+ change_in_payable?: number;
1673
+ change_in_payables_and_accrued_expense?: number;
1674
+ change_in_receivables?: number;
1675
+ change_in_working_capital?: number;
1676
+ changes_in_account_receivables?: number;
1677
+ changes_in_cash?: number;
1678
+ common_stock_dividend_paid?: number;
1679
+ common_stock_payments?: number;
1680
+ depreciation_amortization_depletion?: number;
1681
+ depreciation_and_amortization?: number;
1682
+ end_cash_position?: number;
1683
+ financing_cash_flow?: number;
1684
+ investing_cash_flow?: number;
1685
+ long_term_debt_issuance?: number;
1686
+ long_term_debt_payments?: number;
1687
+ net_common_stock_issuance?: number;
1688
+ net_income_from_continuing_operations?: number;
1689
+ net_investment_purchase_and_sale?: number;
1690
+ net_issuance_payments_of_debt?: number;
1691
+ net_long_term_debt_issuance?: number;
1692
+ net_other_financing_charges?: number;
1693
+ net_other_investing_changes?: number;
1694
+ net_ppe_purchase_and_sale?: number;
1695
+ net_short_term_debt_issuance?: number;
1696
+ operating_cash_flow?: number;
1697
+ other_non_cash_items?: number;
1698
+ purchase_of_investment?: number;
1699
+ purchase_of_ppe?: number;
1700
+ sale_of_investment?: number;
1701
+ stock_based_compensation?: number;
1702
+ };
1703
+ currency: string;
1704
+ };
1705
+ income_statement: {
1706
+ '2021': {
1707
+ cost_of_revenue?: number;
1708
+ diluted_ni_availto_com_stockholders?: number;
1709
+ ebit?: number;
1710
+ ebitda?: number;
1711
+ gross_profit?: number;
1712
+ interest_expense?: number;
1713
+ interest_expense_non_operating?: number;
1714
+ interest_income?: number;
1715
+ interest_income_non_operating?: number;
1716
+ net_income?: number;
1717
+ net_income_common_stockholders?: number;
1718
+ net_income_continuous_operations?: number;
1719
+ net_income_from_continuing_and_discontinued_operation?: number;
1720
+ net_income_from_continuing_operation_net_minority_interest?: number;
1721
+ net_income_including_noncontrolling_interests?: number;
1722
+ net_interest_income?: number;
1723
+ net_non_operating_interest_income_expense?: number;
1724
+ normalized_ebitda?: number;
1725
+ normalized_income?: number;
1726
+ operating_expense?: number;
1727
+ operating_income?: number;
1728
+ operating_revenue?: number;
1729
+ other_income_expense?: number;
1730
+ other_non_operating_income_expenses?: number;
1731
+ pretax_income?: number;
1732
+ reconciled_cost_of_revenue?: number;
1733
+ reconciled_depreciation?: number;
1734
+ research_and_development?: number;
1735
+ selling_general_and_administration?: number;
1736
+ tax_effect_of_unusual_items?: number;
1737
+ tax_provision?: number;
1738
+ tax_rate_for_calcs?: number;
1739
+ total_expenses?: number;
1740
+ total_revenue?: number;
1741
+ };
1742
+ '2022': {
1743
+ cost_of_revenue?: number;
1744
+ diluted_ni_availto_com_stockholders?: number;
1745
+ ebit?: number;
1746
+ ebitda?: number;
1747
+ gross_profit?: number;
1748
+ interest_expense?: number;
1749
+ interest_expense_non_operating?: number;
1750
+ interest_income?: number;
1751
+ interest_income_non_operating?: number;
1752
+ net_income?: number;
1753
+ net_income_common_stockholders?: number;
1754
+ net_income_continuous_operations?: number;
1755
+ net_income_from_continuing_and_discontinued_operation?: number;
1756
+ net_income_from_continuing_operation_net_minority_interest?: number;
1757
+ net_income_including_noncontrolling_interests?: number;
1758
+ net_interest_income?: number;
1759
+ net_non_operating_interest_income_expense?: number;
1760
+ normalized_ebitda?: number;
1761
+ normalized_income?: number;
1762
+ operating_expense?: number;
1763
+ operating_income?: number;
1764
+ operating_revenue?: number;
1765
+ other_income_expense?: number;
1766
+ other_non_operating_income_expenses?: number;
1767
+ pretax_income?: number;
1768
+ reconciled_cost_of_revenue?: number;
1769
+ reconciled_depreciation?: number;
1770
+ research_and_development?: number;
1771
+ selling_general_and_administration?: number;
1772
+ tax_effect_of_unusual_items?: number;
1773
+ tax_provision?: number;
1774
+ tax_rate_for_calcs?: number;
1775
+ total_expenses?: number;
1776
+ total_revenue?: number;
1777
+ };
1778
+ '2023': {
1779
+ cost_of_revenue?: number;
1780
+ diluted_ni_availto_com_stockholders?: number;
1781
+ ebit?: number;
1782
+ ebitda?: number;
1783
+ gross_profit?: number;
1784
+ interest_expense?: number;
1785
+ interest_expense_non_operating?: number;
1786
+ interest_income?: number;
1787
+ interest_income_non_operating?: number;
1788
+ net_income?: number;
1789
+ net_income_common_stockholders?: number;
1790
+ net_income_continuous_operations?: number;
1791
+ net_income_from_continuing_and_discontinued_operation?: number;
1792
+ net_income_from_continuing_operation_net_minority_interest?: number;
1793
+ net_income_including_noncontrolling_interests?: number;
1794
+ net_interest_income?: number;
1795
+ net_non_operating_interest_income_expense?: number;
1796
+ normalized_ebitda?: number;
1797
+ normalized_income?: number;
1798
+ operating_expense?: number;
1799
+ operating_income?: number;
1800
+ operating_revenue?: number;
1801
+ other_income_expense?: number;
1802
+ other_non_operating_income_expenses?: number;
1803
+ pretax_income?: number;
1804
+ reconciled_cost_of_revenue?: number;
1805
+ reconciled_depreciation?: number;
1806
+ research_and_development?: number;
1807
+ selling_general_and_administration?: number;
1808
+ tax_effect_of_unusual_items?: number;
1809
+ tax_provision?: number;
1810
+ tax_rate_for_calcs?: number;
1811
+ total_expenses?: number;
1812
+ total_revenue?: number;
1813
+ };
1814
+ '2024': {
1815
+ cost_of_revenue?: number;
1816
+ diluted_ni_availto_com_stockholders?: number;
1817
+ ebit?: number;
1818
+ ebitda?: number;
1819
+ gross_profit?: number;
1820
+ net_income?: number;
1821
+ net_income_common_stockholders?: number;
1822
+ net_income_continuous_operations?: number;
1823
+ net_income_from_continuing_and_discontinued_operation?: number;
1824
+ net_income_from_continuing_operation_net_minority_interest?: number;
1825
+ net_income_including_noncontrolling_interests?: number;
1826
+ normalized_ebitda?: number;
1827
+ normalized_income?: number;
1828
+ operating_expense?: number;
1829
+ operating_income?: number;
1830
+ operating_revenue?: number;
1831
+ other_income_expense?: number;
1832
+ other_non_operating_income_expenses?: number;
1833
+ pretax_income?: number;
1834
+ reconciled_cost_of_revenue?: number;
1835
+ reconciled_depreciation?: number;
1836
+ research_and_development?: number;
1837
+ selling_general_and_administration?: number;
1838
+ tax_effect_of_unusual_items?: number;
1839
+ tax_provision?: number;
1840
+ tax_rate_for_calcs?: number;
1841
+ total_expenses?: number;
1842
+ total_revenue?: number;
1843
+ };
1844
+ currency: string;
1845
+ };
1846
+ }
1847
+ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
1848
+ balance_sheet: {
1849
+ '2024Q1': {
1850
+ accounts_payable?: number;
1851
+ accounts_receivable?: number;
1852
+ accumulated_depreciation?: number;
1853
+ available_for_sale_securities?: number;
1854
+ capital_stock?: number;
1855
+ cash?: number;
1856
+ cash_and_cash_equivalents?: number;
1857
+ cash_cash_equivalents_and_marketable_securities?: number;
1858
+ cash_equivalents?: number;
1859
+ com_tre_sha_num?: number;
1860
+ commercial_paper?: number;
1861
+ common_stock?: number;
1862
+ common_stock_equity?: number;
1863
+ current_assets?: number;
1864
+ current_debt?: number;
1865
+ current_debt_and_capital_lease_obligation?: number;
1866
+ current_deferred_liabilities?: number;
1867
+ current_deferred_revenue?: number;
1868
+ current_liabilities?: number;
1869
+ gains_losses_not_affecting_retained_earnings?: number;
1870
+ gross_ppe?: number;
1871
+ inventory?: number;
1872
+ invested_capital?: number;
1873
+ investmentin_financial_assets?: number;
1874
+ investments_and_advances?: number;
1875
+ long_term_debt?: number;
1876
+ long_term_debt_and_capital_lease_obligation?: number;
1877
+ net_debt?: number;
1878
+ net_ppe?: number;
1879
+ net_tangible_assets?: number;
1880
+ ordinary_shares_number?: number;
1881
+ other_current_assets?: number;
1882
+ other_current_borrowings?: number;
1883
+ other_current_liabilities?: number;
1884
+ other_equity_adjustments?: number;
1885
+ other_non_current_assets?: number;
1886
+ other_non_current_liabilities?: number;
1887
+ other_receivables?: number;
1888
+ other_short_term_investments?: number;
1889
+ payables?: number;
1890
+ payables_and_accrued_expenses?: number;
1891
+ receivables?: number;
1892
+ retained_earnings?: number;
1893
+ share_issued?: number;
1894
+ stockholders_equity?: number;
1895
+ tangible_book_value?: number;
1896
+ total_assets?: number;
1897
+ total_capitalization?: number;
1898
+ total_debt?: number;
1899
+ total_equity?: number;
1900
+ total_equity_gross_minority_interest?: number;
1901
+ total_liabilities_net_minority_interest?: number;
1902
+ total_non_current_assets?: number;
1903
+ total_non_current_liabilities_net_minority_interest?: number;
1904
+ treasury_shares_number?: number;
1905
+ working_capital?: number;
1906
+ };
1907
+ '2024Q2': {
1908
+ accounts_payable?: number;
1909
+ accounts_receivable?: number;
1910
+ accumulated_depreciation?: number;
1911
+ available_for_sale_securities?: number;
1912
+ capital_stock?: number;
1913
+ cash?: number;
1914
+ cash_and_cash_equivalents?: number;
1915
+ cash_cash_equivalents_and_marketable_securities?: number;
1916
+ cash_equivalents?: number;
1917
+ commercial_paper?: number;
1918
+ common_stock?: number;
1919
+ common_stock_equity?: number;
1920
+ current_assets?: number;
1921
+ current_debt?: number;
1922
+ current_debt_and_capital_lease_obligation?: number;
1923
+ current_deferred_liabilities?: number;
1924
+ current_deferred_revenue?: number;
1925
+ current_liabilities?: number;
1926
+ gains_losses_not_affecting_retained_earnings?: number;
1927
+ gross_ppe?: number;
1928
+ inventory?: number;
1929
+ invested_capital?: number;
1930
+ investmentin_financial_assets?: number;
1931
+ investments_and_advances?: number;
1932
+ long_term_debt?: number;
1933
+ long_term_debt_and_capital_lease_obligation?: number;
1934
+ net_debt?: number;
1935
+ net_ppe?: number;
1936
+ net_tangible_assets?: number;
1937
+ ordinary_shares_number?: number;
1938
+ other_current_assets?: number;
1939
+ other_current_borrowings?: number;
1940
+ other_current_liabilities?: number;
1941
+ other_equity_adjustments?: number;
1942
+ other_non_current_assets?: number;
1943
+ other_non_current_liabilities?: number;
1944
+ other_receivables?: number;
1945
+ other_short_term_investments?: number;
1946
+ payables?: number;
1947
+ payables_and_accrued_expenses?: number;
1948
+ receivables?: number;
1949
+ retained_earnings?: number;
1950
+ share_issued?: number;
1951
+ stockholders_equity?: number;
1952
+ tangible_book_value?: number;
1953
+ total_assets?: number;
1954
+ total_capitalization?: number;
1955
+ total_debt?: number;
1956
+ total_equity?: number;
1957
+ total_equity_gross_minority_interest?: number;
1958
+ total_liabilities_net_minority_interest?: number;
1959
+ total_non_current_assets?: number;
1960
+ total_non_current_liabilities_net_minority_interest?: number;
1961
+ working_capital?: number;
1962
+ };
1963
+ '2024Q3': {
1964
+ accounts_payable?: number;
1965
+ accounts_receivable?: number;
1966
+ accumulated_depreciation?: number;
1967
+ available_for_sale_securities?: number;
1968
+ capital_stock?: number;
1969
+ cash?: number;
1970
+ cash_and_cash_equivalents?: number;
1971
+ cash_cash_equivalents_and_marketable_securities?: number;
1972
+ cash_equivalents?: number;
1973
+ commercial_paper?: number;
1974
+ common_stock?: number;
1975
+ common_stock_equity?: number;
1976
+ current_assets?: number;
1977
+ current_debt?: number;
1978
+ current_debt_and_capital_lease_obligation?: number;
1979
+ current_deferred_liabilities?: number;
1980
+ current_deferred_revenue?: number;
1981
+ current_liabilities?: number;
1982
+ gains_losses_not_affecting_retained_earnings?: number;
1983
+ gross_ppe?: number;
1984
+ inventory?: number;
1985
+ invested_capital?: number;
1986
+ investmentin_financial_assets?: number;
1987
+ investments_and_advances?: number;
1988
+ long_term_debt?: number;
1989
+ long_term_debt_and_capital_lease_obligation?: number;
1990
+ net_debt?: number;
1991
+ net_ppe?: number;
1992
+ net_tangible_assets?: number;
1993
+ ordinary_shares_number?: number;
1994
+ other_current_assets?: number;
1995
+ other_current_borrowings?: number;
1996
+ other_current_liabilities?: number;
1997
+ other_equity_adjustments?: number;
1998
+ other_non_current_assets?: number;
1999
+ other_non_current_liabilities?: number;
2000
+ other_receivables?: number;
2001
+ other_short_term_investments?: number;
2002
+ payables?: number;
2003
+ payables_and_accrued_expenses?: number;
2004
+ receivables?: number;
2005
+ retained_earnings?: number;
2006
+ share_issued?: number;
2007
+ stockholders_equity?: number;
2008
+ tangible_book_value?: number;
2009
+ total_assets?: number;
2010
+ total_capitalization?: number;
2011
+ total_debt?: number;
2012
+ total_equity?: number;
2013
+ total_equity_gross_minority_interest?: number;
2014
+ total_liabilities_net_minority_interest?: number;
2015
+ total_non_current_assets?: number;
2016
+ total_non_current_liabilities_net_minority_interest?: number;
2017
+ working_capital?: number;
2018
+ };
2019
+ '2024Q4': {
2020
+ accounts_payable?: number;
2021
+ accounts_receivable?: number;
2022
+ accumulated_depreciation?: number;
2023
+ available_for_sale_securities?: number;
2024
+ capital_stock?: number;
2025
+ cash?: number;
2026
+ cash_and_cash_equivalents?: number;
2027
+ cash_cash_equivalents_and_marketable_securities?: number;
2028
+ cash_equivalents?: number;
2029
+ commercial_paper?: number;
2030
+ common_stock?: number;
2031
+ common_stock_equity?: number;
2032
+ current_assets?: number;
2033
+ current_debt?: number;
2034
+ current_debt_and_capital_lease_obligation?: number;
2035
+ current_deferred_liabilities?: number;
2036
+ current_deferred_revenue?: number;
2037
+ current_liabilities?: number;
2038
+ gains_losses_not_affecting_retained_earnings?: number;
2039
+ gross_ppe?: number;
2040
+ income_tax_payable?: number;
2041
+ inventory?: number;
2042
+ invested_capital?: number;
2043
+ investmentin_financial_assets?: number;
2044
+ investments_and_advances?: number;
2045
+ land_and_improvements?: number;
2046
+ leases?: number;
2047
+ long_term_debt?: number;
2048
+ long_term_debt_and_capital_lease_obligation?: number;
2049
+ machinery_furniture_equipment?: number;
2050
+ net_debt?: number;
2051
+ net_ppe?: number;
2052
+ net_tangible_assets?: number;
2053
+ non_current_deferred_assets?: number;
2054
+ non_current_deferred_taxes_assets?: number;
2055
+ ordinary_shares_number?: number;
2056
+ other_current_assets?: number;
2057
+ other_current_borrowings?: number;
2058
+ other_current_liabilities?: number;
2059
+ other_equity_adjustments?: number;
2060
+ other_non_current_assets?: number;
2061
+ other_non_current_liabilities?: number;
2062
+ other_receivables?: number;
2063
+ other_short_term_investments?: number;
2064
+ payables?: number;
2065
+ payables_and_accrued_expenses?: number;
2066
+ properties?: number;
2067
+ receivables?: number;
2068
+ retained_earnings?: number;
2069
+ share_issued?: number;
2070
+ stockholders_equity?: number;
2071
+ tangible_book_value?: number;
2072
+ total_assets?: number;
2073
+ total_capitalization?: number;
2074
+ total_debt?: number;
2075
+ total_equity?: number;
2076
+ total_equity_gross_minority_interest?: number;
2077
+ total_liabilities_net_minority_interest?: number;
2078
+ total_non_current_assets?: number;
2079
+ total_non_current_liabilities_net_minority_interest?: number;
2080
+ total_tax_payable?: number;
2081
+ tradeand_other_payables_non_current?: number;
2082
+ working_capital?: number;
2083
+ };
2084
+ currency: string;
2085
+ };
2086
+ cash_flow: {
2087
+ '2024Q1': {
2088
+ beginning_cash_position?: number;
2089
+ capital_expenditure?: number;
2090
+ cash_dividends_paid?: number;
2091
+ cash_flow_from_continuing_financing_activities?: number;
2092
+ cash_flow_from_continuing_investing_activities?: number;
2093
+ cash_flow_from_continuing_operating_activities?: number;
2094
+ change_in_account_payable?: number;
2095
+ change_in_inventory?: number;
2096
+ change_in_other_current_assets?: number;
2097
+ change_in_other_current_liabilities?: number;
2098
+ change_in_payable?: number;
2099
+ change_in_payables_and_accrued_expense?: number;
2100
+ change_in_receivables?: number;
2101
+ change_in_working_capital?: number;
2102
+ changes_in_account_receivables?: number;
2103
+ changes_in_cash?: number;
2104
+ common_stock_dividend_paid?: number;
2105
+ common_stock_payments?: number;
2106
+ depreciation_amortization_depletion?: number;
2107
+ depreciation_and_amortization?: number;
2108
+ end_cash_position?: number;
2109
+ financing_cash_flow?: number;
2110
+ investing_cash_flow?: number;
2111
+ long_term_debt_payments?: number;
2112
+ net_common_stock_issuance?: number;
2113
+ net_income_from_continuing_operations?: number;
2114
+ net_investment_purchase_and_sale?: number;
2115
+ net_issuance_payments_of_debt?: number;
2116
+ net_long_term_debt_issuance?: number;
2117
+ net_other_financing_charges?: number;
2118
+ net_other_investing_changes?: number;
2119
+ net_ppe_purchase_and_sale?: number;
2120
+ net_short_term_debt_issuance?: number;
2121
+ operating_cash_flow?: number;
2122
+ other_non_cash_items?: number;
2123
+ purchase_of_investment?: number;
2124
+ purchase_of_ppe?: number;
2125
+ sale_of_investment?: number;
2126
+ short_term_debt_payments?: number;
2127
+ stock_based_compensation?: number;
2128
+ };
2129
+ '2024Q2': {
2130
+ beginning_cash_position?: number;
2131
+ capital_expenditure?: number;
2132
+ cash_dividends_paid?: number;
2133
+ cash_flow_from_continuing_financing_activities?: number;
2134
+ cash_flow_from_continuing_investing_activities?: number;
2135
+ cash_flow_from_continuing_operating_activities?: number;
2136
+ change_in_account_payable?: number;
2137
+ change_in_inventory?: number;
2138
+ change_in_other_current_assets?: number;
2139
+ change_in_other_current_liabilities?: number;
2140
+ change_in_payable?: number;
2141
+ change_in_payables_and_accrued_expense?: number;
2142
+ change_in_receivables?: number;
2143
+ change_in_working_capital?: number;
2144
+ changes_in_account_receivables?: number;
2145
+ changes_in_cash?: number;
2146
+ common_stock_dividend_paid?: number;
2147
+ common_stock_payments?: number;
2148
+ depreciation_amortization_depletion?: number;
2149
+ depreciation_and_amortization?: number;
2150
+ end_cash_position?: number;
2151
+ financing_cash_flow?: number;
2152
+ investing_cash_flow?: number;
2153
+ long_term_debt_payments?: number;
2154
+ net_common_stock_issuance?: number;
2155
+ net_income_from_continuing_operations?: number;
2156
+ net_investment_purchase_and_sale?: number;
2157
+ net_issuance_payments_of_debt?: number;
2158
+ net_long_term_debt_issuance?: number;
2159
+ net_other_financing_charges?: number;
2160
+ net_other_investing_changes?: number;
2161
+ net_ppe_purchase_and_sale?: number;
2162
+ net_short_term_debt_issuance?: number;
2163
+ operating_cash_flow?: number;
2164
+ other_non_cash_items?: number;
2165
+ purchase_of_investment?: number;
2166
+ purchase_of_ppe?: number;
2167
+ sale_of_investment?: number;
2168
+ short_term_debt_payments?: number;
2169
+ stock_based_compensation?: number;
2170
+ };
2171
+ '2024Q3': {
2172
+ beginning_cash_position?: number;
2173
+ capital_expenditure?: number;
2174
+ cash_dividends_paid?: number;
2175
+ cash_flow_from_continuing_financing_activities?: number;
2176
+ cash_flow_from_continuing_investing_activities?: number;
2177
+ cash_flow_from_continuing_operating_activities?: number;
2178
+ change_in_account_payable?: number;
2179
+ change_in_inventory?: number;
2180
+ change_in_other_current_assets?: number;
2181
+ change_in_other_current_liabilities?: number;
2182
+ change_in_payable?: number;
2183
+ change_in_payables_and_accrued_expense?: number;
2184
+ change_in_receivables?: number;
2185
+ change_in_working_capital?: number;
2186
+ changes_in_account_receivables?: number;
2187
+ changes_in_cash?: number;
2188
+ common_stock_dividend_paid?: number;
2189
+ common_stock_payments?: number;
2190
+ depreciation_amortization_depletion?: number;
2191
+ depreciation_and_amortization?: number;
2192
+ end_cash_position?: number;
2193
+ financing_cash_flow?: number;
2194
+ investing_cash_flow?: number;
2195
+ long_term_debt_payments?: number;
2196
+ net_common_stock_issuance?: number;
2197
+ net_income_from_continuing_operations?: number;
2198
+ net_investment_purchase_and_sale?: number;
2199
+ net_issuance_payments_of_debt?: number;
2200
+ net_long_term_debt_issuance?: number;
2201
+ net_other_financing_charges?: number;
2202
+ net_other_investing_changes?: number;
2203
+ net_ppe_purchase_and_sale?: number;
2204
+ net_short_term_debt_issuance?: number;
2205
+ operating_cash_flow?: number;
2206
+ other_non_cash_items?: number;
2207
+ purchase_of_investment?: number;
2208
+ purchase_of_ppe?: number;
2209
+ sale_of_investment?: number;
2210
+ short_term_debt_payments?: number;
2211
+ stock_based_compensation?: number;
2212
+ };
2213
+ '2024Q4': {
2214
+ beginning_cash_position?: number;
2215
+ capital_expenditure?: number;
2216
+ cash_dividends_paid?: number;
2217
+ cash_flow_from_continuing_financing_activities?: number;
2218
+ cash_flow_from_continuing_investing_activities?: number;
2219
+ cash_flow_from_continuing_operating_activities?: number;
2220
+ change_in_account_payable?: number;
2221
+ change_in_inventory?: number;
2222
+ change_in_other_current_assets?: number;
2223
+ change_in_other_current_liabilities?: number;
2224
+ change_in_payable?: number;
2225
+ change_in_payables_and_accrued_expense?: number;
2226
+ change_in_receivables?: number;
2227
+ change_in_working_capital?: number;
2228
+ changes_in_account_receivables?: number;
2229
+ changes_in_cash?: number;
2230
+ common_stock_dividend_paid?: number;
2231
+ common_stock_payments?: number;
2232
+ depreciation_amortization_depletion?: number;
2233
+ depreciation_and_amortization?: number;
2234
+ end_cash_position?: number;
2235
+ financing_cash_flow?: number;
2236
+ investing_cash_flow?: number;
2237
+ long_term_debt_issuance?: number;
2238
+ long_term_debt_payments?: number;
2239
+ net_common_stock_issuance?: number;
2240
+ net_income_from_continuing_operations?: number;
2241
+ net_investment_purchase_and_sale?: number;
2242
+ net_issuance_payments_of_debt?: number;
2243
+ net_long_term_debt_issuance?: number;
2244
+ net_other_financing_charges?: number;
2245
+ net_other_investing_changes?: number;
2246
+ net_ppe_purchase_and_sale?: number;
2247
+ net_short_term_debt_issuance?: number;
2248
+ operating_cash_flow?: number;
2249
+ other_non_cash_items?: number;
2250
+ purchase_of_investment?: number;
2251
+ purchase_of_ppe?: number;
2252
+ sale_of_investment?: number;
2253
+ stock_based_compensation?: number;
2254
+ };
2255
+ currency: string;
2256
+ };
2257
+ income_statement: {
2258
+ '2024Q1': {
2259
+ cost_of_revenue?: number;
2260
+ diluted_ni_availto_com_stockholders?: number;
2261
+ ebit?: number;
2262
+ ebitda?: number;
2263
+ gross_profit?: number;
2264
+ net_income?: number;
2265
+ net_income_common_stockholders?: number;
2266
+ net_income_continuous_operations?: number;
2267
+ net_income_from_continuing_and_discontinued_operation?: number;
2268
+ net_income_from_continuing_operation_net_minority_interest?: number;
2269
+ net_income_including_noncontrolling_interests?: number;
2270
+ normalized_ebitda?: number;
2271
+ normalized_income?: number;
2272
+ operating_expense?: number;
2273
+ operating_income?: number;
2274
+ operating_revenue?: number;
2275
+ other_income_expense?: number;
2276
+ other_non_operating_income_expenses?: number;
2277
+ pretax_income?: number;
2278
+ reconciled_cost_of_revenue?: number;
2279
+ reconciled_depreciation?: number;
2280
+ research_and_development?: number;
2281
+ selling_general_and_administration?: number;
2282
+ tax_effect_of_unusual_items?: number;
2283
+ tax_provision?: number;
2284
+ tax_rate_for_calcs?: number;
2285
+ total_expenses?: number;
2286
+ total_revenue?: number;
2287
+ };
2288
+ '2024Q2': {
2289
+ cost_of_revenue?: number;
2290
+ diluted_ni_availto_com_stockholders?: number;
2291
+ ebit?: number;
2292
+ ebitda?: number;
2293
+ gross_profit?: number;
2294
+ net_income?: number;
2295
+ net_income_common_stockholders?: number;
2296
+ net_income_continuous_operations?: number;
2297
+ net_income_from_continuing_and_discontinued_operation?: number;
2298
+ net_income_from_continuing_operation_net_minority_interest?: number;
2299
+ net_income_including_noncontrolling_interests?: number;
2300
+ normalized_ebitda?: number;
2301
+ normalized_income?: number;
2302
+ operating_expense?: number;
2303
+ operating_income?: number;
2304
+ operating_revenue?: number;
2305
+ other_income_expense?: number;
2306
+ other_non_operating_income_expenses?: number;
2307
+ pretax_income?: number;
2308
+ reconciled_cost_of_revenue?: number;
2309
+ reconciled_depreciation?: number;
2310
+ research_and_development?: number;
2311
+ selling_general_and_administration?: number;
2312
+ tax_effect_of_unusual_items?: number;
2313
+ tax_provision?: number;
2314
+ tax_rate_for_calcs?: number;
2315
+ total_expenses?: number;
2316
+ total_revenue?: number;
2317
+ };
2318
+ '2024Q3': {
2319
+ cost_of_revenue?: number;
2320
+ diluted_ni_availto_com_stockholders?: number;
2321
+ ebit?: number;
2322
+ ebitda?: number;
2323
+ gross_profit?: number;
2324
+ net_income?: number;
2325
+ net_income_common_stockholders?: number;
2326
+ net_income_continuous_operations?: number;
2327
+ net_income_from_continuing_and_discontinued_operation?: number;
2328
+ net_income_from_continuing_operation_net_minority_interest?: number;
2329
+ net_income_including_noncontrolling_interests?: number;
2330
+ normalized_ebitda?: number;
2331
+ normalized_income?: number;
2332
+ operating_expense?: number;
2333
+ operating_income?: number;
2334
+ operating_revenue?: number;
2335
+ other_income_expense?: number;
2336
+ other_non_operating_income_expenses?: number;
2337
+ pretax_income?: number;
2338
+ reconciled_cost_of_revenue?: number;
2339
+ reconciled_depreciation?: number;
2340
+ research_and_development?: number;
2341
+ selling_general_and_administration?: number;
2342
+ tax_effect_of_unusual_items?: number;
2343
+ tax_provision?: number;
2344
+ tax_rate_for_calcs?: number;
2345
+ total_expenses?: number;
2346
+ total_revenue?: number;
2347
+ };
2348
+ '2024Q4': {
2349
+ cost_of_revenue?: number;
2350
+ diluted_ni_availto_com_stockholders?: number;
2351
+ ebit?: number;
2352
+ ebitda?: number;
2353
+ gross_profit?: number;
2354
+ net_income?: number;
2355
+ net_income_common_stockholders?: number;
2356
+ net_income_continuous_operations?: number;
2357
+ net_income_from_continuing_and_discontinued_operation?: number;
2358
+ net_income_from_continuing_operation_net_minority_interest?: number;
2359
+ net_income_including_noncontrolling_interests?: number;
2360
+ normalized_ebitda?: number;
2361
+ normalized_income?: number;
2362
+ operating_expense?: number;
2363
+ operating_income?: number;
2364
+ operating_revenue?: number;
2365
+ other_income_expense?: number;
2366
+ other_non_operating_income_expenses?: number;
2367
+ pretax_income?: number;
2368
+ reconciled_cost_of_revenue?: number;
2369
+ reconciled_depreciation?: number;
2370
+ research_and_development?: number;
2371
+ selling_general_and_administration?: number;
2372
+ tax_effect_of_unusual_items?: number;
2373
+ tax_provision?: number;
2374
+ tax_rate_for_calcs?: number;
2375
+ total_expenses?: number;
2376
+ total_revenue?: number;
2377
+ };
2378
+ currency: string;
2379
+ };
1012
2380
  }
1013
2381
  export interface InsightGetSymbolFundamentalsRequest {
1014
- mode?: string;
1015
- symbol?: string;
2382
+ /** @example "annual" */
2383
+ mode: InsightGetSymbolFundamentalsRequestModeEnum;
2384
+ /** @example "AAPL" */
2385
+ symbol: string;
1016
2386
  }
1017
- export type InsightGetSymbolFundamentalsResponse = Record<string, any>;
1018
2387
  export interface InsightGetSymbolRelatedFieldsResponse {
1019
2388
  asset_allocations: InsightSymbolRelatedField[][];
1020
2389
  continents: InsightSymbolRelatedField[][];
@@ -1033,7 +2402,8 @@ export interface InsightGetSymbolRelatedFieldsResponse {
1033
2402
  symbol_type: string;
1034
2403
  }
1035
2404
  export interface InsightGetSymbolsPerTypeRequest {
1036
- symbols?: string[];
2405
+ /** @example ["AAPL","GOOGL","MSFT"] */
2406
+ symbols: string[];
1037
2407
  }
1038
2408
  export interface InsightGetSymbolsPerTypeResponse {
1039
2409
  EQUITY: string[];
@@ -1042,39 +2412,38 @@ export interface InsightGetSymbolsPerTypeResponse {
1042
2412
  MF: string[];
1043
2413
  }
1044
2414
  export interface InsightGetTopFundsRequest {
1045
- fund_type?: string;
1046
- inverse?: string;
1047
- leverage?: string;
2415
+ /** @example "ETF" */
2416
+ fund_type: InsightGetTopFundsRequestFundTypeEnum;
2417
+ /** @example "ANY" */
2418
+ inverse: InsightGetTopFundsRequestInverseEnum;
2419
+ /** @example "LEVERAGE_I" */
2420
+ leverage: InsightGetTopFundsRequestLeverageEnum;
1048
2421
  order?: InsightOrdering;
1049
- paging?: InsightPaging;
1050
- quote_access_type?: string;
1051
- /**
1052
- * Ordering takes priority over ReverseOrder, ReverseOrder left for backwards compatibility
1053
- * NOTE(@neghoda): Depricated feature - consider removing
1054
- */
1055
- reverse_order?: boolean;
2422
+ paging: InsightPaging;
1056
2423
  }
1057
2424
  export interface InsightGetTopFundsResponse {
1058
2425
  count: number;
1059
2426
  details: InsightExtendedFundData[];
1060
2427
  }
1061
- export interface InsightGetTopSymbolsRequest {
2428
+ export interface InsightGetTopSymbolsV1Request {
1062
2429
  exchange?: string[];
1063
2430
  market_cap?: InsightLessAndMore;
1064
2431
  order?: InsightOrdering;
1065
- pagination?: InsightPagination;
1066
2432
  paging?: InsightPaging;
1067
2433
  price?: InsightLessAndMore;
1068
- quote_access_type?: string;
1069
- sorts?: InsightOrdering[];
1070
2434
  volume?: InsightLessAndMore;
1071
2435
  }
1072
2436
  export interface InsightGetUsageDataRequest {
2437
+ /** @example ["NY","LA"] */
1073
2438
  branch_codes?: string[];
1074
- end_time?: string;
2439
+ /** @example "2023-01-31T23:59:59Z" */
2440
+ end_time: string;
2441
+ /** @example [123,456] */
1075
2442
  firm_ids?: number[];
1076
- source?: string;
1077
- start_time?: string;
2443
+ /** @example "MIDDLEWARE" */
2444
+ source: InsightGetUsageDataRequestSourceEnum;
2445
+ /** @example "2023-01-01T00:00:00Z" */
2446
+ start_time: string;
1078
2447
  }
1079
2448
  export interface InsightGlobalIndex {
1080
2449
  continent_id: string;
@@ -1337,17 +2706,17 @@ export interface InsightInstitutionalHolding {
1337
2706
  value: number;
1338
2707
  }
1339
2708
  export interface InsightIntradayRequest {
1340
- /** Format: YYYY-MM-DD (OPTIONAL) */
2709
+ /** @example "2023-01-01" */
1341
2710
  from?: string;
1342
- /** (OPTIONAL) */
2711
+ /** @example true */
1343
2712
  raw_volumes?: boolean;
1344
- /** (REQUIRE) */
1345
- rsi_span?: number;
1346
- /** (OPTIONAL) */
2713
+ /** @example 14 */
2714
+ rsi_span: number;
2715
+ /** @example 5 */
1347
2716
  smoothing?: number;
1348
- /** (REQUIRE) */
1349
- symbol?: string;
1350
- /** Format: YYYY-MM-DD (OPTIONAL) */
2717
+ /** @example "AAPL" */
2718
+ symbol: string;
2719
+ /** @example "2023-01-31" */
1351
2720
  to?: string;
1352
2721
  }
1353
2722
  export interface InsightIntradayResponse {
@@ -1500,23 +2869,34 @@ export interface InsightMaturityBreakdown {
1500
2869
  percentage: number;
1501
2870
  }
1502
2871
  export interface InsightMomentumRatioGraphRequest {
1503
- benchmark?: string;
1504
- mode?: string;
1505
- period?: number;
1506
- range?: string;
1507
- set_ema?: boolean;
1508
- symbols?: string[];
2872
+ /** @example "SPY" */
2873
+ benchmark: string;
2874
+ /** @example "daily" */
2875
+ mode: InsightMomentumRatioGraphRequestModeEnum;
2876
+ /**
2877
+ * @min 4
2878
+ * @max 10
2879
+ * @example 4
2880
+ */
2881
+ period: number;
2882
+ /** @example "1m" */
2883
+ range: string;
2884
+ /** @example true */
2885
+ set_ema: boolean;
2886
+ /** @example ["AAPL","CSCO"] */
2887
+ symbols: string[];
1509
2888
  }
1510
2889
  export interface InsightMomentumRatioGraphResponse {
1511
2890
  AAPL: InsightSymbolMomentum[];
1512
2891
  CSCO: InsightSymbolMomentum[];
1513
2892
  }
1514
2893
  export interface InsightMostPopularTagsRequest {
1515
- /** (REQUIRE) */
1516
- language?: string;
1517
- time?: InsightMostPopularTagsRequestTimeEnum;
1518
- /** (REQUIRE) */
1519
- type?: InsightMostPopularTagsRequestTypeEnum;
2894
+ /** @example "eng" */
2895
+ language: string;
2896
+ /** @example "week" */
2897
+ time: string;
2898
+ /** @example "symbol" */
2899
+ type: string;
1520
2900
  }
1521
2901
  export interface InsightMover {
1522
2902
  company_name: string;
@@ -1526,7 +2906,8 @@ export interface InsightMultipleCryptoLogosRequest {
1526
2906
  symbols?: string[];
1527
2907
  }
1528
2908
  export interface InsightMultipleSymbolLogosRequest {
1529
- symbols?: string[];
2909
+ /** @example ["AAPL","GOOGL","MSFT"] */
2910
+ symbols: string[];
1530
2911
  }
1531
2912
  export interface InsightNews {
1532
2913
  author: string;
@@ -1572,15 +2953,23 @@ export interface InsightNewsData {
1572
2953
  }
1573
2954
  export type InsightNewsExtraData = Record<string, InsightNewsData>;
1574
2955
  export interface InsightNewsFilterRequest {
2956
+ /** @example "John Doe" */
1575
2957
  author?: string;
1576
- channels?: string[];
2958
+ /** @example ["Finance","Technology"] */
2959
+ channels: string[];
2960
+ /** @example "2023-12-31" */
1577
2961
  end_date?: string;
2962
+ /** @example true */
1578
2963
  headline?: boolean;
1579
- paging?: InsightPaging;
2964
+ paging: InsightPaging;
2965
+ /** @example true */
1580
2966
  press_release?: boolean;
2967
+ /** @example "2023-01-01" */
1581
2968
  start_date?: string;
1582
- symbols?: string[];
1583
- tags?: string[];
2969
+ /** @example ["AAPL","GOOGL"] */
2970
+ symbols: string[];
2971
+ /** @example ["Earnings","Market"] */
2972
+ tags: string[];
1584
2973
  }
1585
2974
  export interface InsightNewsImage {
1586
2975
  size: string;
@@ -1597,7 +2986,8 @@ export interface InsightNewsPreview {
1597
2986
  updated: string;
1598
2987
  }
1599
2988
  export interface InsightNewsRequest {
1600
- id?: string;
2989
+ /** @example "123e4567-e89b-12d3-a456-426614174000" */
2990
+ id: string;
1601
2991
  }
1602
2992
  export interface InsightNewsResponse {
1603
2993
  count: number;
@@ -1649,14 +3039,21 @@ export interface InsightNewsfeed {
1649
3039
  user_id: number;
1650
3040
  }
1651
3041
  export interface InsightNewsfeedRequest {
1652
- count?: number;
1653
- /** (REQUIRE) */
1654
- language?: string;
3042
+ /** @example 10 */
3043
+ count: number;
3044
+ /** @example "eng" */
3045
+ language: string;
3046
+ /** @example 1609459200 */
1655
3047
  released_after?: number;
3048
+ /** @example 1625097600 */
1656
3049
  released_before?: number;
3050
+ /** @example "AAPL" */
1657
3051
  symbol?: string;
3052
+ /** @example "technology" */
1658
3053
  tag?: string;
1659
- type?: InsightNewsfeedRequestTypeEnum;
3054
+ /** @example "education" */
3055
+ type?: string;
3056
+ /** @example "group1" */
1660
3057
  with_tag_group?: string;
1661
3058
  }
1662
3059
  export interface InsightOptionData {
@@ -1680,12 +3077,16 @@ export interface InsightOptionValues {
1680
3077
  time_value: number;
1681
3078
  }
1682
3079
  export interface InsightOrdering {
1683
- /** @default "asc" */
3080
+ /**
3081
+ * @default "asc"
3082
+ * @example "asc"
3083
+ */
1684
3084
  direction: InsightOrderingDirectionEnum;
1685
3085
  /**
1686
3086
  * Sort direction:
1687
3087
  * * asc - Ascending, from A to Z.
1688
3088
  * * desc - Descending, from Z to A.
3089
+ * @example "name"
1689
3090
  */
1690
3091
  field: string;
1691
3092
  }
@@ -1699,11 +3100,29 @@ export interface InsightOwnershipDetails {
1699
3100
  symbol: string;
1700
3101
  }
1701
3102
  export interface InsightPagination {
3103
+ /**
3104
+ * @min 1
3105
+ * @example 1
3106
+ */
1702
3107
  page: number;
3108
+ /**
3109
+ * @min 1
3110
+ * @max 50
3111
+ * @example 10
3112
+ */
1703
3113
  size: number;
1704
3114
  }
1705
3115
  export interface InsightPaging {
3116
+ /**
3117
+ * @min 1
3118
+ * @max 100
3119
+ * @example 10
3120
+ */
1706
3121
  limit: number;
3122
+ /**
3123
+ * @min 0
3124
+ * @example 0
3125
+ */
1707
3126
  offset: number;
1708
3127
  }
1709
3128
  export interface InsightPerformanceHistory {
@@ -1724,8 +3143,13 @@ export interface InsightPerformingExpertsRatings {
1724
3143
  ticker: string;
1725
3144
  }
1726
3145
  export interface InsightPeriodFilter {
1727
- type?: InsightPeriodFilterTypeEnum;
1728
- value?: number;
3146
+ /** @example "day" */
3147
+ type: InsightPeriodFilterTypeEnum;
3148
+ /**
3149
+ * @min 1
3150
+ * @example 1
3151
+ */
3152
+ value: number;
1729
3153
  }
1730
3154
  export interface InsightPortfoliosRequest {
1731
3155
  /** (REQUIRED) */
@@ -1806,15 +3230,14 @@ export interface InsightQuoteFundamentalsSearchResponse {
1806
3230
  }
1807
3231
  export interface InsightQuoteHistoryRequest {
1808
3232
  /** Use ONLY one of the next filters: TimeRange OR Period */
1809
- filter?: InsightQuoteHistoryRequestFilter;
3233
+ filter: InsightQuoteHistoryRequestFilter;
1810
3234
  order?: InsightOrdering;
1811
3235
  paging?: InsightPaging;
1812
- /** Type of quote to load Enums(nbbo, delayed, cboe, bats, realtime, realtime_snapshot) (REQUIRED) */
1813
- quote_access_type?: string;
1814
3236
  }
1815
3237
  export interface InsightQuoteHistoryRequestFilter {
1816
3238
  period?: InsightPeriodFilter;
1817
- symbol?: string;
3239
+ /** @example "AAPL" */
3240
+ symbol: string;
1818
3241
  time_range?: InsightTimeRangeFilter;
1819
3242
  }
1820
3243
  export interface InsightQuoteHistoryResponse {
@@ -1835,11 +3258,13 @@ export interface InsightRatios {
1835
3258
  valuation: InsightValuation;
1836
3259
  }
1837
3260
  export interface InsightRecentIPOListRequest {
3261
+ /** @example true */
1838
3262
  load_quotes?: boolean;
1839
3263
  order?: InsightOrdering;
1840
- paging?: InsightPaging;
3264
+ paging: InsightPaging;
1841
3265
  quote_access_type?: string;
1842
- time?: string;
3266
+ /** @example "20y" */
3267
+ time: string;
1843
3268
  }
1844
3269
  export interface InsightRecentNewsPreviewsResponse {
1845
3270
  news: InsightNewsPreview[];
@@ -1852,20 +3277,28 @@ export interface InsightRemoveCustomIndexRequest {
1852
3277
  id?: string;
1853
3278
  }
1854
3279
  export interface InsightRemoveRewrittenFieldValueRequest {
3280
+ /** @example "Removed" */
1855
3281
  comment?: string;
1856
- field_id?: string;
1857
- internal_id?: string;
1858
- symbol?: string;
3282
+ /** @example "price" */
3283
+ field_id: string;
3284
+ /** @example "123e4567-e89b-12d3-a456-426614174000" */
3285
+ internal_id: string;
3286
+ /** @example "AAPL" */
3287
+ symbol: string;
1859
3288
  }
1860
3289
  export interface InsightRemoveScreenerPresetRequest {
1861
3290
  id?: string;
1862
3291
  }
1863
3292
  export interface InsightRewriteFieldValueRequest {
3293
+ /** @example "Updated" */
1864
3294
  comment?: string;
1865
- field_id?: string;
1866
- internal_id?: string;
1867
- new_value?: any;
1868
- symbol?: string;
3295
+ /** @example "price" */
3296
+ field_id: string;
3297
+ /** @example "123e4567-e89b-12d3-a456-426614174000" */
3298
+ internal_id: string;
3299
+ new_value: any;
3300
+ /** @example "AAPL" */
3301
+ symbol: string;
1869
3302
  }
1870
3303
  export interface InsightScreenerPreset {
1871
3304
  created_at: string;
@@ -1877,11 +3310,12 @@ export interface InsightScreenerPreset {
1877
3310
  updated_at: string;
1878
3311
  }
1879
3312
  export interface InsightSearchArticleRequest {
1880
- /** (REQUIRE) */
1881
- language?: string;
1882
- /** (REQUIRE) */
1883
- s?: string;
1884
- type?: InsightSearchArticleRequestTypeEnum;
3313
+ /** @example "eng" */
3314
+ language: string;
3315
+ /** @example "search term" */
3316
+ s: string;
3317
+ /** @example "all" */
3318
+ type: string;
1885
3319
  }
1886
3320
  export interface InsightSeasonalityEntry {
1887
3321
  april: InsightTickerSeasonality;
@@ -1899,10 +3333,20 @@ export interface InsightSeasonalityEntry {
1899
3333
  september: InsightTickerSeasonality;
1900
3334
  }
1901
3335
  export interface InsightSeasonalityRequest {
1902
- benchmark?: string;
1903
- lookahead?: number;
1904
- symbols?: string[];
1905
- years?: number;
3336
+ /** @example "A" */
3337
+ benchmark: string;
3338
+ /**
3339
+ * @min 1
3340
+ * @example 12
3341
+ */
3342
+ lookahead: number;
3343
+ /** @example ["AAPL","GOOGL"] */
3344
+ symbols: string[];
3345
+ /**
3346
+ * @min 1
3347
+ * @example 5
3348
+ */
3349
+ years: number;
1906
3350
  }
1907
3351
  export type InsightSeasonalityResponse = Record<string, InsightSeasonalityEntry>;
1908
3352
  export interface InsightSector {
@@ -1941,6 +3385,10 @@ export interface InsightSentiment {
1941
3385
  neutral: number;
1942
3386
  positive: number;
1943
3387
  }
3388
+ export interface InsightSetFeaturedArticlesRequest {
3389
+ /** @example ["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"] */
3390
+ ids: string[];
3391
+ }
1944
3392
  export interface InsightSignalData {
1945
3393
  based_on_num_hedge_funds: number;
1946
3394
  rating: string;
@@ -2022,8 +3470,8 @@ export interface InsightStockScreenerRequest {
2022
3470
  paging?: InsightPaging;
2023
3471
  pe_ratio?: InsightLessAndMore;
2024
3472
  price?: InsightLessAndMore;
2025
- quote_access_type?: string;
2026
3473
  sorts?: InsightOrdering[];
3474
+ /** @example "ADR" */
2027
3475
  stock_type?: string;
2028
3476
  volume?: InsightLessAndMore;
2029
3477
  }
@@ -2031,6 +3479,23 @@ export interface InsightStockScreenerResponse {
2031
3479
  count: number;
2032
3480
  details: InsightStockScreenerQuote[];
2033
3481
  }
3482
+ export interface InsightStockScreenerV2Request {
3483
+ average_volume_30d?: InsightLessAndMore;
3484
+ dividend_ex_date?: InsightBeforeAndAfter;
3485
+ dividend_pay_date?: InsightBeforeAndAfter;
3486
+ dividend_percent?: InsightLessAndMore;
3487
+ exchange?: InsightIncludeExclude;
3488
+ gap?: InsightLessAndMore;
3489
+ industry?: InsightIncludeExclude;
3490
+ market_cap?: InsightLessAndMore;
3491
+ pagination?: InsightPagination;
3492
+ pe_ratio?: InsightLessAndMore;
3493
+ price?: InsightLessAndMore;
3494
+ sorts?: InsightOrdering[];
3495
+ /** @example "ADR" */
3496
+ stock_type?: string;
3497
+ volume?: InsightLessAndMore;
3498
+ }
2034
3499
  export interface InsightStocksConsensusOverTimeRequest {
2035
3500
  /** "The intervals over which the consensus is given" */
2036
3501
  interval?: string;
@@ -2075,8 +3540,10 @@ export interface InsightSymbolIndustries {
2075
3540
  sub_industry: string;
2076
3541
  }
2077
3542
  export interface InsightSymbolLogoConvertedRequest {
2078
- conversion?: InsightSymbolLogoConvertedRequestConversionEnum;
2079
- symbol?: string;
3543
+ /** @example "normal" */
3544
+ conversion: InsightSymbolLogoConvertedRequestConversionEnum;
3545
+ /** @example "AAPL" */
3546
+ symbol: string;
2080
3547
  }
2081
3548
  export interface InsightSymbolLogosResponse {
2082
3549
  logo: string;
@@ -2135,10 +3602,16 @@ export interface InsightTickerSeasonality {
2135
3602
  yearly_data: InsightYearlyData[];
2136
3603
  }
2137
3604
  export interface InsightTimeRangeFilter {
2138
- /** Use unix timestamp in seconds */
2139
- end_time?: number;
2140
- /** Use unix timestamp in seconds */
2141
- start_time?: number;
3605
+ /**
3606
+ * Use unix timestamp in seconds
3607
+ * @example 1612137600
3608
+ */
3609
+ end_time: number;
3610
+ /**
3611
+ * Use unix timestamp in seconds
3612
+ * @example 1609459200
3613
+ */
3614
+ start_time: number;
2142
3615
  }
2143
3616
  export interface InsightTiprankQuote {
2144
3617
  ask_px: number;
@@ -2282,8 +3755,27 @@ export interface InsightUpdateCustomIndexRequest {
2282
3755
  name?: string;
2283
3756
  private_name?: string;
2284
3757
  }
2285
- export interface InsightUpsertSliderArticlesRequest {
2286
- slider_articles?: number[];
3758
+ export interface InsightUpdateFeaturedArticlesRequest {
3759
+ /** @example "123e4567-e89b-12d3-a456-426614174000" */
3760
+ id: string;
3761
+ /** @example "https://example.com/updated-image.jpg" */
3762
+ image: string;
3763
+ /** @example 1 */
3764
+ source_id: number;
3765
+ /** @example ["AAPL","GOOGL"] */
3766
+ symbols: string[];
3767
+ /** @example ["News","Update"] */
3768
+ tags: string[];
3769
+ /**
3770
+ * @maxLength 1000
3771
+ * @example "This is an updated teaser for the news"
3772
+ */
3773
+ teaser: string;
3774
+ /**
3775
+ * @maxLength 1000
3776
+ * @example "Updated News Title"
3777
+ */
3778
+ title: string;
2287
3779
  }
2288
3780
  export interface InsightUsageDataEntry {
2289
3781
  branch_code: string;
@@ -2370,10 +3862,17 @@ export interface InsightEquityDataResponse {
2370
3862
  volume: number;
2371
3863
  yest_close_px: number;
2372
3864
  }
2373
- export enum InsightArticlesRequestTypeEnum {
2374
- Education = "education",
2375
- NonEducation = "non-education"
3865
+ /** @example "c" */
3866
+ export enum InsightCalculateMatrixParamsRequestOptionTypeEnum {
3867
+ C = "c",
3868
+ P = "p"
2376
3869
  }
3870
+ /** @example "c" */
3871
+ export enum InsightCalculateParamsRequestOptionTypeEnum {
3872
+ C = "c",
3873
+ P = "p"
3874
+ }
3875
+ /** @example "normal" */
2377
3876
  export enum InsightCryptoLogoConvertedRequestConversionEnum {
2378
3877
  Original = "original",
2379
3878
  Default = "default",
@@ -2384,38 +3883,77 @@ export enum InsightCryptoLogoConvertedRequestConversionEnum {
2384
3883
  SquareStrictOrNormal = "square_strict_or_normal",
2385
3884
  BestMatch = "best_match"
2386
3885
  }
2387
- export enum InsightMostPopularTagsRequestTimeEnum {
2388
- Week = "week",
2389
- Month = "month",
2390
- Year = "year"
2391
- }
2392
- /** (REQUIRE) */
2393
- export enum InsightMostPopularTagsRequestTypeEnum {
2394
- Symbol = "symbol",
2395
- Primary = "primary",
2396
- Tags = "tags"
3886
+ /** @example "LEVERAGE_I" */
3887
+ export enum InsightGetFundsForHoldingRequestLeverageEnum {
3888
+ ANY = "ANY",
3889
+ LEVERAGE_I = "LEVERAGE_I",
3890
+ LEVERAGE_II = "LEVERAGE_II",
3891
+ LEVERAGE_III = "LEVERAGE_III"
2397
3892
  }
2398
- export enum InsightNewsfeedRequestTypeEnum {
2399
- Education = "education",
2400
- NonEducation = "non-education"
3893
+ /** @example "institutional" */
3894
+ export enum InsightGetOwnershipsBySymbolRequestOwnerTypeEnum {
3895
+ All = "all",
3896
+ Institutional = "institutional",
3897
+ Fund = "fund",
3898
+ Insider = "insider"
2401
3899
  }
2402
- /** @default "asc" */
3900
+ /** @example "institutional" */
3901
+ export enum InsightGetOwnershipsBySymbolWithoutSearchQueryRequestOwnerTypeEnum {
3902
+ All = "all",
3903
+ Institutional = "institutional",
3904
+ Fund = "fund",
3905
+ Insider = "insider"
3906
+ }
3907
+ /** @example "annual" */
3908
+ export enum InsightGetSymbolFundamentalsRequestModeEnum {
3909
+ Annual = "annual",
3910
+ Quarterly = "quarterly"
3911
+ }
3912
+ /** @example "ETF" */
3913
+ export enum InsightGetTopFundsRequestFundTypeEnum {
3914
+ ANY = "ANY",
3915
+ ETF = "ETF",
3916
+ MF = "MF"
3917
+ }
3918
+ /** @example "ANY" */
3919
+ export enum InsightGetTopFundsRequestInverseEnum {
3920
+ ANY = "ANY",
3921
+ SHORT = "SHORT",
3922
+ LONG = "LONG"
3923
+ }
3924
+ /** @example "LEVERAGE_I" */
3925
+ export enum InsightGetTopFundsRequestLeverageEnum {
3926
+ ANY = "ANY",
3927
+ LEVERAGE_I = "LEVERAGE_I",
3928
+ LEVERAGE_II = "LEVERAGE_II",
3929
+ LEVERAGE_III = "LEVERAGE_III"
3930
+ }
3931
+ /** @example "MIDDLEWARE" */
3932
+ export enum InsightGetUsageDataRequestSourceEnum {
3933
+ USER_MANAGEMENT = "USER_MANAGEMENT",
3934
+ MIDDLEWARE = "MIDDLEWARE"
3935
+ }
3936
+ /** @example "daily" */
3937
+ export enum InsightMomentumRatioGraphRequestModeEnum {
3938
+ Daily = "daily",
3939
+ Weekly = "weekly"
3940
+ }
3941
+ /**
3942
+ * @default "asc"
3943
+ * @example "asc"
3944
+ */
2403
3945
  export enum InsightOrderingDirectionEnum {
2404
3946
  Asc = "asc",
2405
3947
  Desc = "desc"
2406
3948
  }
3949
+ /** @example "day" */
2407
3950
  export enum InsightPeriodFilterTypeEnum {
2408
3951
  Day = "day",
2409
3952
  Week = "week",
2410
3953
  Month = "month",
2411
3954
  Year = "year"
2412
3955
  }
2413
- export enum InsightSearchArticleRequestTypeEnum {
2414
- All = "all",
2415
- Tag = "tag",
2416
- Primary = "primary",
2417
- Symbol = "symbol"
2418
- }
3956
+ /** @example "normal" */
2419
3957
  export enum InsightSymbolLogoConvertedRequestConversionEnum {
2420
3958
  Original = "original",
2421
3959
  Default = "default",
@@ -2564,6 +4102,15 @@ export class CustomLists<HandleError extends boolean = boolean> {
2564
4102
  /** how many equities records to skip */
2565
4103
  offset: number;
2566
4104
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
4105
+ /**
4106
+ * @description filter custom lists
4107
+ * @tags Custom Lists
4108
+ * @name FilterCustomLists
4109
+ * @summary filter custom lists
4110
+ * @request POST:/custom-lists/filter
4111
+ * @secure
4112
+ */
4113
+ filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
2567
4114
  }
2568
4115
  export class Dashboard<HandleError extends boolean = boolean> {
2569
4116
  protected readonly apiClient: JwtClient<HandleError>;
@@ -2664,7 +4211,7 @@ export class FixedIncome<HandleError extends boolean = boolean> {
2664
4211
  * @request POST:/fixed-income
2665
4212
  * @secure
2666
4213
  */
2667
- getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponse, HandleError>>;
4214
+ getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponse, HandleError>>;
2668
4215
  /**
2669
4216
  * @description Returns historical fixed income
2670
4217
  * @tags FixedIncome
@@ -2801,47 +4348,66 @@ export interface InsightFixedIncomeV2 {
2801
4348
  type: string;
2802
4349
  updated_at: string;
2803
4350
  }
4351
+ export interface InsightGetFixedIncomeEntriesResponseV2 {
4352
+ count: number;
4353
+ data: InsightFixedIncomeV2[];
4354
+ }
2804
4355
  export interface InsightGetFixedIncomeEntriesRequestV2 {
4356
+ /** @example true */
2805
4357
  bank_qualified?: boolean;
4358
+ /** @example true */
2806
4359
  callable?: boolean;
4360
+ /** @example true */
2807
4361
  convertible?: boolean;
4362
+ /** @example ["USA"] */
2808
4363
  country_codes?: string[];
2809
4364
  coupon?: InsightLessAndMoreV2;
4365
+ /** @example ["quarterly","zero"] */
2810
4366
  coupon_frequencies?: string[];
4367
+ /** @example ["655664AH3","9128286R6"] */
2811
4368
  cusip?: string[];
4369
+ /**
4370
+ * @maxLength 100
4371
+ * @example "Donald's"
4372
+ */
2812
4373
  description?: string;
4374
+ /** @example true */
2813
4375
  has_ticker?: boolean;
4376
+ /** @example true */
2814
4377
  insured?: boolean;
4378
+ /** @example ["US655664AH33","US9128286R69"] */
2815
4379
  isin?: string[];
2816
4380
  issue_date?: InsightBeforeAndAfterV2;
4381
+ /**
4382
+ * @maxLength 100
4383
+ * @example "Donald's"
4384
+ */
2817
4385
  issuer?: string;
2818
4386
  maturity?: InsightBeforeAndAfterV2;
4387
+ /** @example ["NY"] */
2819
4388
  municipal_states?: string[];
4389
+ /** @example true */
2820
4390
  municipal_tax?: boolean;
4391
+ /** @example ["general_obligation"] */
2821
4392
  municipal_types?: string[];
2822
- order?: InsightOrderingV2;
2823
- pagination?: InsightPaginationV2;
2824
- paging?: InsightPagingV2;
4393
+ pagination: InsightPaginationV2;
2825
4394
  purposes?: string[];
4395
+ /** @example ["SOVEREIGN"] */
2826
4396
  sectors?: string[];
2827
4397
  sorts?: InsightOrderingV2[];
4398
+ /** @example ["AAA"] */
2828
4399
  sp_ratings?: string[];
4400
+ /** @example ["called","outstanding"] */
2829
4401
  statuses?: string[];
2830
4402
  tickers?: string[];
4403
+ /** @example ["corporate"] */
2831
4404
  types?: string[];
2832
4405
  }
2833
- export interface InsightGetFixedIncomeEntriesResponseV2 {
2834
- count: number;
2835
- data: InsightFixedIncomeV2[];
2836
- }
2837
4406
  export interface InsightGetTopSymbolsRequestV2 {
2838
4407
  exchange?: string[];
2839
4408
  market_cap?: InsightLessAndMoreV2;
2840
- order?: InsightOrderingV2;
2841
4409
  pagination?: InsightPaginationV2;
2842
- paging?: InsightPagingV2;
2843
4410
  price?: InsightLessAndMoreV2;
2844
- quote_access_type?: string;
2845
4411
  sorts?: InsightOrderingV2[];
2846
4412
  volume?: InsightLessAndMoreV2;
2847
4413
  }
@@ -2854,23 +4420,32 @@ export interface InsightLessAndMoreV2 {
2854
4420
  more_than?: number;
2855
4421
  }
2856
4422
  export interface InsightOrderingV2 {
2857
- /** @default "asc" */
4423
+ /**
4424
+ * @default "asc"
4425
+ * @example "asc"
4426
+ */
2858
4427
  direction: InsightOrderingDirectionEnumV2;
2859
4428
  /**
2860
4429
  * Sort direction:
2861
4430
  * * asc - Ascending, from A to Z.
2862
4431
  * * desc - Descending, from Z to A.
4432
+ * @example "name"
2863
4433
  */
2864
4434
  field: string;
2865
4435
  }
2866
4436
  export interface InsightPaginationV2 {
4437
+ /**
4438
+ * @min 1
4439
+ * @example 1
4440
+ */
2867
4441
  page: number;
4442
+ /**
4443
+ * @min 1
4444
+ * @max 50
4445
+ * @example 10
4446
+ */
2868
4447
  size: number;
2869
4448
  }
2870
- export interface InsightPagingV2 {
2871
- limit: number;
2872
- offset: number;
2873
- }
2874
4449
  export interface InsightStockScreenerQuoteV2 {
2875
4450
  average_volume_30d: number;
2876
4451
  company_name: string;
@@ -2899,13 +4474,11 @@ export interface InsightStockScreenerRequestV2 {
2899
4474
  gap?: InsightLessAndMoreV2;
2900
4475
  industry?: InsightIncludeExcludeV2;
2901
4476
  market_cap?: InsightLessAndMoreV2;
2902
- order?: InsightOrderingV2;
2903
4477
  pagination?: InsightPaginationV2;
2904
- paging?: InsightPagingV2;
2905
4478
  pe_ratio?: InsightLessAndMoreV2;
2906
4479
  price?: InsightLessAndMoreV2;
2907
- quote_access_type?: string;
2908
4480
  sorts?: InsightOrderingV2[];
4481
+ /** @example "ADR" */
2909
4482
  stock_type?: string;
2910
4483
  volume?: InsightLessAndMoreV2;
2911
4484
  }
@@ -2916,7 +4489,10 @@ export interface InsightStockScreenerResponseV2 {
2916
4489
  status: number;
2917
4490
  total_records: number;
2918
4491
  }
2919
- /** @default "asc" */
4492
+ /**
4493
+ * @default "asc"
4494
+ * @example "asc"
4495
+ */
2920
4496
  export enum InsightOrderingDirectionEnumV2 {
2921
4497
  Asc = "asc",
2922
4498
  Desc = "desc"
@@ -2945,7 +4521,7 @@ export class Fundamentals<HandleError extends boolean = boolean> {
2945
4521
  * @request POST:/fundamentals
2946
4522
  * @secure
2947
4523
  */
2948
- getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsResponse, HandleError>>;
4524
+ getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
2949
4525
  }
2950
4526
  export class Funds<HandleError extends boolean = boolean> {
2951
4527
  protected readonly apiClient: JwtClient<HandleError>;
@@ -3060,19 +4636,6 @@ export class Ipos<HandleError extends boolean = boolean> {
3060
4636
  offset: number;
3061
4637
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
3062
4638
  }
3063
- export class Lists<HandleError extends boolean = boolean> {
3064
- protected readonly apiClient: JwtClient<HandleError>;
3065
- constructor(apiClient: JwtClient<HandleError>);
3066
- /**
3067
- * @description filter custom lists
3068
- * @tags lists
3069
- * @name FilterCustomLists
3070
- * @summary filter custom lists
3071
- * @request POST:/custom-lists/filter
3072
- * @secure
3073
- */
3074
- filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
3075
- }
3076
4639
  export class Logos<HandleError extends boolean = boolean> {
3077
4640
  protected readonly apiClient: JwtClient<HandleError>;
3078
4641
  constructor(apiClient: JwtClient<HandleError>);
@@ -3219,6 +4782,69 @@ export class News<HandleError extends boolean = boolean> {
3219
4782
  * @secure
3220
4783
  */
3221
4784
  newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
4785
+ /**
4786
+ * @description Get featured articles
4787
+ * @tags News
4788
+ * @name GetFeaturedArticles
4789
+ * @summary Get featured articles
4790
+ * @request GET:/news/featured-articles
4791
+ * @secure
4792
+ */
4793
+ getFeaturedArticles(query: {
4794
+ /** Limit */
4795
+ limit: number;
4796
+ /** Offset */
4797
+ offset: number;
4798
+ /** Start date */
4799
+ start_date?: string;
4800
+ /** End date */
4801
+ end_date?: string;
4802
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
4803
+ /**
4804
+ * @description Update featured articles
4805
+ * @tags News
4806
+ * @name UpdateFeaturedArticles
4807
+ * @summary Update featured articles
4808
+ * @request PUT:/news/featured-articles
4809
+ * @secure
4810
+ */
4811
+ updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4812
+ /**
4813
+ * @description Create featured articles
4814
+ * @tags News
4815
+ * @name CreateFeaturedArticles
4816
+ * @summary Create featured articles
4817
+ * @request POST:/news/featured-articles
4818
+ * @secure
4819
+ */
4820
+ createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4821
+ /**
4822
+ * @description Get active featured articles
4823
+ * @tags News
4824
+ * @name GetActiveFeaturedArticles
4825
+ * @summary Get active featured articles
4826
+ * @request GET:/news/featured-articles/active
4827
+ * @secure
4828
+ */
4829
+ getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
4830
+ /**
4831
+ * @description Set featured articles
4832
+ * @tags News
4833
+ * @name SetFeaturedArticles
4834
+ * @summary Set featured articles
4835
+ * @request POST:/news/featured-articles/set
4836
+ * @secure
4837
+ */
4838
+ setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4839
+ /**
4840
+ * @description Get featured article
4841
+ * @tags News
4842
+ * @name GetFeaturedArticle
4843
+ * @summary Get featured article
4844
+ * @request GET:/news/featured-articles/{id}
4845
+ * @secure
4846
+ */
4847
+ getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
3222
4848
  /**
3223
4849
  * @description Returns news by filters
3224
4850
  * @tags News
@@ -3377,22 +5003,6 @@ export class Passport<HandleError extends boolean = boolean> {
3377
5003
  * @secure
3378
5004
  */
3379
5005
  passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
3380
- /**
3381
- * @description Retrieve slider articles
3382
- * @tags Passport
3383
- * @name GetPassportSliderArticles
3384
- * @summary Get Slider Articles
3385
- * @request GET:/passport/slider-articles
3386
- */
3387
- getPassportSliderArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSliderArticlesResponse, HandleError>>;
3388
- /**
3389
- * @description Upsert slider articles
3390
- * @tags Passport
3391
- * @name UpsertPassportSliderArticles
3392
- * @summary Upsert slider articles
3393
- * @request POST:/passport/slider-articles
3394
- */
3395
- upsertPassportSliderArticles(request: InsightUpsertSliderArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSliderArticlesResponse, HandleError>>;
3396
5006
  }
3397
5007
  export class Public<HandleError extends boolean = boolean> {
3398
5008
  protected readonly apiClient: JwtClient<HandleError>;
@@ -3436,9 +5046,9 @@ export class Public<HandleError extends boolean = boolean> {
3436
5046
  * @secure
3437
5047
  */
3438
5048
  getPublicFundamentalsBySymbolData(symbol: string, query: {
3439
- /** Annual or year */
5049
+ /** Annual or quarterly */
3440
5050
  mode: string;
3441
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsResponse, HandleError>>;
5051
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
3442
5052
  /**
3443
5053
  * @description Daily price history
3444
5054
  * @tags Public
@@ -3557,8 +5167,6 @@ export class Quotes<HandleError extends boolean = boolean> {
3557
5167
  getQuotesEquityData(query: {
3558
5168
  /** Comma separated symbols */
3559
5169
  symbols: string;
3560
- /** NBBO || DELAYED || CBOE || CBOE1 || BATS || REALTIME || REALTIME_SNAPSHOT */
3561
- quote_access_type: string;
3562
5170
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
3563
5171
  }
3564
5172
  export class StockScreener<HandleError extends boolean = boolean> {
@@ -3572,14 +5180,9 @@ export class StockScreener<HandleError extends boolean = boolean> {
3572
5180
  * @request GET:/heatmaps
3573
5181
  * @secure
3574
5182
  */
3575
- stockMarketHeatmap(query: {
5183
+ stockMarketHeatmap(query?: {
3576
5184
  /** Name of symbol list to fetch details for. Empty is default */
3577
5185
  heatmap_name?: string;
3578
- /** NBBO || DELAYED || CBOE || CBOE1 || BATS || REALTIME || REALTIME_SNAPSHOT */
3579
- quote_access_type: string;
3580
- }, headers?: {
3581
- /** Authorization */
3582
- Authorization?: string;
3583
5186
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
3584
5187
  /**
3585
5188
  * @description create or update heat map preset
@@ -3607,7 +5210,7 @@ export class StockScreener<HandleError extends boolean = boolean> {
3607
5210
  * @request POST:/stock-screener
3608
5211
  * @secure
3609
5212
  */
3610
- stockScreener(filter: InsightStockScreenerRequest, headers?: {
5213
+ stockScreener(filter: InsightStockScreenerV2Request, headers?: {
3611
5214
  /** Authorization */
3612
5215
  Authorization?: string;
3613
5216
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
@@ -3660,7 +5263,7 @@ export class StockScreener<HandleError extends boolean = boolean> {
3660
5263
  * @request POST:/stock-screener/top
3661
5264
  * @secure
3662
5265
  */
3663
- getTopSymbols(input: InsightGetTopSymbolsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5266
+ getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
3664
5267
  }
3665
5268
  export class StockScreenerV2<HandleError extends boolean = boolean> {
3666
5269
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4169,8 +5772,6 @@ export class WorldMarkets<HandleError extends boolean = boolean> {
4169
5772
  offset: number;
4170
5773
  /** Continent code for filtering */
4171
5774
  continent?: string;
4172
- /** Quote type for price fetch */
4173
- quote_access_type?: string;
4174
5775
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
4175
5776
  /**
4176
5777
  * @description Edit global index
@@ -4258,7 +5859,6 @@ export class InsightApi<HandleError extends boolean = false> extends BaseApi<Han
4258
5859
  fund: Funds<HandleError>;
4259
5860
  intraday: Intraday<HandleError>;
4260
5861
  ipos: Ipos<HandleError>;
4261
- lists: Lists<HandleError>;
4262
5862
  logos: Logos<HandleError>;
4263
5863
  marketDates: MarketDates<HandleError>;
4264
5864
  news: News<HandleError>;