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

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,10 +787,33 @@ 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[];
655
804
  }
805
+ export interface InsightFilteredCustomIndexResponse {
806
+ created_at?: string;
807
+ description?: string;
808
+ equities?: string[];
809
+ etfs?: string[];
810
+ excluded_symbols?: string[];
811
+ id?: string;
812
+ included_symbols?: string[];
813
+ name?: string;
814
+ symbols?: string[];
815
+ updated_at?: string;
816
+ }
656
817
  export interface InsightFixedIncome {
657
818
  a144: boolean;
658
819
  accrued_interest: number;
@@ -839,39 +1000,118 @@ export interface InsightGetCustomIndexesResponse {
839
1000
  count: number;
840
1001
  data: InsightCustomIndex[];
841
1002
  }
1003
+ export interface InsightGetFeaturedArticlesResponse {
1004
+ count: number;
1005
+ featured_articles: InsightFeaturedArticle[];
1006
+ }
842
1007
  export interface InsightGetFixedIncomeEntriesRequest {
1008
+ /** @example true */
843
1009
  bank_qualified?: boolean;
1010
+ /** @example true */
844
1011
  callable?: boolean;
1012
+ /** @example true */
845
1013
  convertible?: boolean;
1014
+ /** @example ["USA"] */
846
1015
  country_codes?: string[];
847
1016
  coupon?: InsightLessAndMore;
1017
+ /** @example ["quarterly","zero"] */
848
1018
  coupon_frequencies?: string[];
1019
+ /** @example ["655664AH3","9128286R6"] */
849
1020
  cusip?: string[];
1021
+ /**
1022
+ * @maxLength 100
1023
+ * @example "Donald's"
1024
+ */
850
1025
  description?: string;
1026
+ /** @example true */
851
1027
  has_ticker?: boolean;
1028
+ /** @example true */
852
1029
  insured?: boolean;
1030
+ /** @example ["US655664AH33","US9128286R69"] */
853
1031
  isin?: string[];
854
1032
  issue_date?: InsightBeforeAndAfter;
1033
+ /**
1034
+ * @maxLength 100
1035
+ * @example "Donald's"
1036
+ */
855
1037
  issuer?: string;
856
1038
  maturity?: InsightBeforeAndAfter;
1039
+ /** @example ["NY"] */
857
1040
  municipal_states?: string[];
1041
+ /** @example true */
858
1042
  municipal_tax?: boolean;
1043
+ /** @example ["general_obligation"] */
859
1044
  municipal_types?: string[];
860
1045
  order?: InsightOrdering;
861
- pagination?: InsightPagination;
862
- paging?: InsightPaging;
1046
+ pagination: InsightPagination;
1047
+ paging: InsightPaging;
863
1048
  purposes?: string[];
1049
+ /** @example ["SOVEREIGN"] */
864
1050
  sectors?: string[];
865
1051
  sorts?: InsightOrdering[];
1052
+ /** @example ["AAA"] */
866
1053
  sp_ratings?: string[];
1054
+ /** @example ["called","outstanding"] */
867
1055
  statuses?: string[];
868
1056
  tickers?: string[];
1057
+ /** @example ["corporate"] */
869
1058
  types?: string[];
870
1059
  }
871
1060
  export interface InsightGetFixedIncomeEntriesResponse {
872
1061
  count: number;
873
1062
  data: InsightFixedIncome[];
874
1063
  }
1064
+ export interface InsightGetFixedIncomeEntriesV1Request {
1065
+ /** @example true */
1066
+ bank_qualified?: boolean;
1067
+ /** @example true */
1068
+ callable?: boolean;
1069
+ /** @example true */
1070
+ convertible?: boolean;
1071
+ /** @example ["USA"] */
1072
+ country_codes?: string[];
1073
+ coupon?: InsightLessAndMore;
1074
+ /** @example ["quarterly","zero"] */
1075
+ coupon_frequencies?: string[];
1076
+ /** @example ["655664AH3","9128286R6"] */
1077
+ cusip?: string[];
1078
+ /**
1079
+ * @maxLength 100
1080
+ * @example "Donald's"
1081
+ */
1082
+ description?: string;
1083
+ /** @example true */
1084
+ has_ticker?: boolean;
1085
+ /** @example true */
1086
+ insured?: boolean;
1087
+ /** @example ["US655664AH33","US9128286R69"] */
1088
+ isin?: string[];
1089
+ issue_date?: InsightBeforeAndAfter;
1090
+ /**
1091
+ * @maxLength 100
1092
+ * @example "Donald's"
1093
+ */
1094
+ issuer?: string;
1095
+ maturity?: InsightBeforeAndAfter;
1096
+ /** @example ["NY"] */
1097
+ municipal_states?: string[];
1098
+ /** @example true */
1099
+ municipal_tax?: boolean;
1100
+ /** @example ["general_obligation"] */
1101
+ municipal_types?: string[];
1102
+ order?: InsightOrdering;
1103
+ paging: InsightPaging;
1104
+ purposes?: string[];
1105
+ /** @example ["SOVEREIGN"] */
1106
+ sectors?: string[];
1107
+ /** @example ["AAA"] */
1108
+ sp_ratings?: string[];
1109
+ /** @example ["called","outstanding"] */
1110
+ statuses?: string[];
1111
+ tickers?: string[];
1112
+ /** @example ["corporate"] */
1113
+ types?: string[];
1114
+ }
875
1115
  export interface InsightGetFixedIncomeHistoricalData {
876
1116
  price: number;
877
1117
  timestamp: string;
@@ -927,12 +1167,12 @@ export interface InsightGetFundScreenerFiltersResponse {
927
1167
  sponsors?: InsightFundFilterSponsor[];
928
1168
  }
929
1169
  export interface InsightGetFundsForHoldingRequest {
930
- /** ANY|LEVERAGE_I|LEVERAGE_II|LEVERAGE_III */
931
- leverage?: string;
1170
+ /** @example "LEVERAGE_I" */
1171
+ leverage: InsightGetFundsForHoldingRequestLeverageEnum;
932
1172
  order?: InsightOrdering;
933
- paging?: InsightPaging;
934
- quote_access_type?: string;
935
- symbol?: string;
1173
+ paging: InsightPaging;
1174
+ /** @example "AAPL" */
1175
+ symbol: string;
936
1176
  }
937
1177
  export interface InsightGetFundsForHoldingResponse {
938
1178
  count: number;
@@ -959,10 +1199,13 @@ export interface InsightGetIndustriesPerformanceResponse {
959
1199
  worst_performing_quotes: InsightStockScreenerQuote[];
960
1200
  }
961
1201
  export interface InsightGetMarketDatesRequest {
962
- end_date?: string;
963
- markets?: string[];
964
- paging?: InsightPaging;
965
- start_date?: string;
1202
+ /** @example "2023-12-31" */
1203
+ end_date: string;
1204
+ /** @example ["NYSE","NASDAQ"] */
1205
+ markets: string[];
1206
+ paging: InsightPaging;
1207
+ /** @example "2023-01-01" */
1208
+ start_date: string;
966
1209
  }
967
1210
  export interface InsightGetMarketDatesResponse {
968
1211
  count: number;
@@ -977,7 +1220,8 @@ export interface InsightGetMarketHoursResponse {
977
1220
  time_zone: string;
978
1221
  }
979
1222
  export interface InsightGetOwnershipsByIDRequest {
980
- owner_id?: string;
1223
+ /** @example "123e4567-e89b-12d3-a456-426614174000" */
1224
+ owner_id: string;
981
1225
  paging?: InsightPaging;
982
1226
  }
983
1227
  export interface InsightGetOwnershipsBySymbolAsDashboardFieldsResponse {
@@ -986,10 +1230,13 @@ export interface InsightGetOwnershipsBySymbolAsDashboardFieldsResponse {
986
1230
  }
987
1231
  export interface InsightGetOwnershipsBySymbolRequest {
988
1232
  order?: InsightOrdering;
989
- owner_type?: string;
990
- paging?: InsightPaging;
1233
+ /** @example "institutional" */
1234
+ owner_type: InsightGetOwnershipsBySymbolRequestOwnerTypeEnum;
1235
+ paging: InsightPaging;
1236
+ /** @example "Apple Inc" */
991
1237
  search_query?: string;
992
- symbols?: string[];
1238
+ /** @example ["AAPL","GOOGL"] */
1239
+ symbols: string[];
993
1240
  }
994
1241
  export interface InsightGetOwnershipsBySymbolResponse {
995
1242
  count: number;
@@ -997,24 +1244,1158 @@ export interface InsightGetOwnershipsBySymbolResponse {
997
1244
  }
998
1245
  export interface InsightGetOwnershipsBySymbolWithoutSearchQueryRequest {
999
1246
  order?: InsightOrdering;
1000
- owner_type?: string;
1001
- paging?: InsightPaging;
1002
- symbols?: string[];
1247
+ /** @example "institutional" */
1248
+ owner_type: InsightGetOwnershipsBySymbolWithoutSearchQueryRequestOwnerTypeEnum;
1249
+ paging: InsightPaging;
1250
+ /** @example ["AAPL","GOOGL"] */
1251
+ symbols: string[];
1003
1252
  }
1004
1253
  export interface InsightGetScreenerPresetsResponse {
1005
1254
  count: number;
1006
1255
  default_presets: InsightScreenerPreset[];
1007
1256
  details: InsightScreenerPreset[];
1008
1257
  }
1009
- export interface InsightGetSliderArticlesResponse {
1010
- slider_articles: number[];
1011
- updated_at: string;
1258
+ export interface InsightGetSymbolFundamentalsAnnualResponse {
1259
+ balance_sheet: {
1260
+ '2021': {
1261
+ accounts_payable?: number;
1262
+ accounts_receivable?: number;
1263
+ accumulated_depreciation?: number;
1264
+ available_for_sale_securities?: number;
1265
+ capital_lease_obligations?: number;
1266
+ capital_stock?: number;
1267
+ cash?: number;
1268
+ cash_and_cash_equivalents?: number;
1269
+ cash_cash_equivalents_and_marketable_securities?: number;
1270
+ cash_equivalents?: number;
1271
+ commercial_paper?: number;
1272
+ common_stock?: number;
1273
+ common_stock_equity?: number;
1274
+ current_assets?: number;
1275
+ current_capital_lease_obligation?: number;
1276
+ current_debt?: number;
1277
+ current_debt_and_capital_lease_obligation?: number;
1278
+ current_deferred_liabilities?: number;
1279
+ current_deferred_revenue?: number;
1280
+ current_liabilities?: number;
1281
+ gains_losses_not_affecting_retained_earnings?: number;
1282
+ gross_ppe?: number;
1283
+ inventory?: number;
1284
+ invested_capital?: number;
1285
+ investmentin_financial_assets?: number;
1286
+ investments_and_advances?: number;
1287
+ land_and_improvements?: number;
1288
+ leases?: number;
1289
+ long_term_capital_lease_obligation?: number;
1290
+ long_term_debt?: number;
1291
+ long_term_debt_and_capital_lease_obligation?: number;
1292
+ machinery_furniture_equipment?: number;
1293
+ net_debt?: number;
1294
+ net_ppe?: number;
1295
+ net_tangible_assets?: number;
1296
+ ordinary_shares_number?: number;
1297
+ other_current_assets?: number;
1298
+ other_current_borrowings?: number;
1299
+ other_current_liabilities?: number;
1300
+ other_equity_adjustments?: number;
1301
+ other_investments?: number;
1302
+ other_non_current_assets?: number;
1303
+ other_non_current_liabilities?: number;
1304
+ other_properties?: number;
1305
+ other_receivables?: number;
1306
+ other_short_term_investments?: number;
1307
+ payables?: number;
1308
+ payables_and_accrued_expenses?: number;
1309
+ properties?: number;
1310
+ receivables?: number;
1311
+ retained_earnings?: number;
1312
+ share_issued?: number;
1313
+ stockholders_equity?: number;
1314
+ tangible_book_value?: number;
1315
+ total_assets?: number;
1316
+ total_capitalization?: number;
1317
+ total_debt?: number;
1318
+ total_equity?: number;
1319
+ total_equity_gross_minority_interest?: number;
1320
+ total_liabilities_net_minority_interest?: number;
1321
+ total_non_current_assets?: number;
1322
+ total_non_current_liabilities_net_minority_interest?: number;
1323
+ tradeand_other_payables_non_current?: number;
1324
+ working_capital?: number;
1325
+ };
1326
+ '2022': {
1327
+ accounts_payable?: number;
1328
+ accounts_receivable?: number;
1329
+ accumulated_depreciation?: number;
1330
+ available_for_sale_securities?: number;
1331
+ capital_lease_obligations?: number;
1332
+ capital_stock?: number;
1333
+ cash?: number;
1334
+ cash_and_cash_equivalents?: number;
1335
+ cash_cash_equivalents_and_marketable_securities?: number;
1336
+ cash_equivalents?: number;
1337
+ commercial_paper?: number;
1338
+ common_stock?: number;
1339
+ common_stock_equity?: number;
1340
+ current_assets?: number;
1341
+ current_capital_lease_obligation?: number;
1342
+ current_debt?: number;
1343
+ current_debt_and_capital_lease_obligation?: number;
1344
+ current_deferred_liabilities?: number;
1345
+ current_deferred_revenue?: number;
1346
+ current_liabilities?: number;
1347
+ gains_losses_not_affecting_retained_earnings?: number;
1348
+ gross_ppe?: number;
1349
+ income_tax_payable?: number;
1350
+ inventory?: number;
1351
+ invested_capital?: number;
1352
+ investmentin_financial_assets?: number;
1353
+ investments_and_advances?: number;
1354
+ land_and_improvements?: number;
1355
+ leases?: number;
1356
+ long_term_capital_lease_obligation?: number;
1357
+ long_term_debt?: number;
1358
+ long_term_debt_and_capital_lease_obligation?: number;
1359
+ machinery_furniture_equipment?: number;
1360
+ net_debt?: number;
1361
+ net_ppe?: number;
1362
+ net_tangible_assets?: number;
1363
+ non_current_deferred_assets?: number;
1364
+ non_current_deferred_taxes_assets?: number;
1365
+ ordinary_shares_number?: number;
1366
+ other_current_assets?: number;
1367
+ other_current_borrowings?: number;
1368
+ other_current_liabilities?: number;
1369
+ other_equity_adjustments?: number;
1370
+ other_investments?: number;
1371
+ other_non_current_assets?: number;
1372
+ other_non_current_liabilities?: number;
1373
+ other_properties?: number;
1374
+ other_receivables?: number;
1375
+ other_short_term_investments?: number;
1376
+ payables?: number;
1377
+ payables_and_accrued_expenses?: number;
1378
+ properties?: number;
1379
+ receivables?: number;
1380
+ retained_earnings?: number;
1381
+ share_issued?: number;
1382
+ stockholders_equity?: number;
1383
+ tangible_book_value?: number;
1384
+ total_assets?: number;
1385
+ total_capitalization?: number;
1386
+ total_debt?: number;
1387
+ total_equity?: number;
1388
+ total_equity_gross_minority_interest?: number;
1389
+ total_liabilities_net_minority_interest?: number;
1390
+ total_non_current_assets?: number;
1391
+ total_non_current_liabilities_net_minority_interest?: number;
1392
+ total_tax_payable?: number;
1393
+ tradeand_other_payables_non_current?: number;
1394
+ working_capital?: number;
1395
+ };
1396
+ '2023': {
1397
+ accounts_payable?: number;
1398
+ accounts_receivable?: number;
1399
+ accumulated_depreciation?: number;
1400
+ available_for_sale_securities?: number;
1401
+ capital_lease_obligations?: number;
1402
+ capital_stock?: number;
1403
+ cash?: number;
1404
+ cash_and_cash_equivalents?: number;
1405
+ cash_cash_equivalents_and_marketable_securities?: number;
1406
+ cash_equivalents?: number;
1407
+ com_tre_sha_num?: number;
1408
+ commercial_paper?: number;
1409
+ common_stock?: number;
1410
+ common_stock_equity?: number;
1411
+ current_assets?: number;
1412
+ current_capital_lease_obligation?: number;
1413
+ current_debt?: number;
1414
+ current_debt_and_capital_lease_obligation?: number;
1415
+ current_deferred_liabilities?: number;
1416
+ current_deferred_revenue?: number;
1417
+ current_liabilities?: number;
1418
+ gains_losses_not_affecting_retained_earnings?: number;
1419
+ gross_ppe?: number;
1420
+ income_tax_payable?: number;
1421
+ inventory?: number;
1422
+ invested_capital?: number;
1423
+ investmentin_financial_assets?: number;
1424
+ investments_and_advances?: number;
1425
+ land_and_improvements?: number;
1426
+ leases?: number;
1427
+ long_term_capital_lease_obligation?: number;
1428
+ long_term_debt?: number;
1429
+ long_term_debt_and_capital_lease_obligation?: number;
1430
+ machinery_furniture_equipment?: number;
1431
+ net_debt?: number;
1432
+ net_ppe?: number;
1433
+ net_tangible_assets?: number;
1434
+ non_current_deferred_assets?: number;
1435
+ non_current_deferred_taxes_assets?: number;
1436
+ ordinary_shares_number?: number;
1437
+ other_current_assets?: number;
1438
+ other_current_borrowings?: number;
1439
+ other_current_liabilities?: number;
1440
+ other_equity_adjustments?: number;
1441
+ other_non_current_assets?: number;
1442
+ other_non_current_liabilities?: number;
1443
+ other_properties?: number;
1444
+ other_receivables?: number;
1445
+ other_short_term_investments?: number;
1446
+ payables?: number;
1447
+ payables_and_accrued_expenses?: number;
1448
+ properties?: number;
1449
+ receivables?: number;
1450
+ retained_earnings?: number;
1451
+ share_issued?: number;
1452
+ stockholders_equity?: number;
1453
+ tangible_book_value?: number;
1454
+ total_assets?: number;
1455
+ total_capitalization?: number;
1456
+ total_debt?: number;
1457
+ total_equity?: number;
1458
+ total_equity_gross_minority_interest?: number;
1459
+ total_liabilities_net_minority_interest?: number;
1460
+ total_non_current_assets?: number;
1461
+ total_non_current_liabilities_net_minority_interest?: number;
1462
+ total_tax_payable?: number;
1463
+ tradeand_other_payables_non_current?: number;
1464
+ treasury_shares_number?: number;
1465
+ working_capital?: number;
1466
+ };
1467
+ '2024': {
1468
+ accounts_payable?: number;
1469
+ accounts_receivable?: number;
1470
+ accumulated_depreciation?: number;
1471
+ available_for_sale_securities?: number;
1472
+ capital_stock?: number;
1473
+ cash?: number;
1474
+ cash_and_cash_equivalents?: number;
1475
+ cash_cash_equivalents_and_marketable_securities?: number;
1476
+ cash_equivalents?: number;
1477
+ commercial_paper?: number;
1478
+ common_stock?: number;
1479
+ common_stock_equity?: number;
1480
+ current_assets?: number;
1481
+ current_debt?: number;
1482
+ current_debt_and_capital_lease_obligation?: number;
1483
+ current_deferred_liabilities?: number;
1484
+ current_deferred_revenue?: number;
1485
+ current_liabilities?: number;
1486
+ gains_losses_not_affecting_retained_earnings?: number;
1487
+ gross_ppe?: number;
1488
+ income_tax_payable?: number;
1489
+ inventory?: number;
1490
+ invested_capital?: number;
1491
+ investmentin_financial_assets?: number;
1492
+ investments_and_advances?: number;
1493
+ land_and_improvements?: number;
1494
+ leases?: number;
1495
+ long_term_debt?: number;
1496
+ long_term_debt_and_capital_lease_obligation?: number;
1497
+ machinery_furniture_equipment?: number;
1498
+ net_debt?: number;
1499
+ net_ppe?: number;
1500
+ net_tangible_assets?: number;
1501
+ non_current_deferred_assets?: number;
1502
+ non_current_deferred_taxes_assets?: number;
1503
+ ordinary_shares_number?: number;
1504
+ other_current_assets?: number;
1505
+ other_current_borrowings?: number;
1506
+ other_current_liabilities?: number;
1507
+ other_equity_adjustments?: number;
1508
+ other_non_current_assets?: number;
1509
+ other_non_current_liabilities?: number;
1510
+ other_receivables?: number;
1511
+ other_short_term_investments?: number;
1512
+ payables?: number;
1513
+ payables_and_accrued_expenses?: number;
1514
+ properties?: number;
1515
+ receivables?: number;
1516
+ retained_earnings?: number;
1517
+ share_issued?: number;
1518
+ stockholders_equity?: number;
1519
+ tangible_book_value?: number;
1520
+ total_assets?: number;
1521
+ total_capitalization?: number;
1522
+ total_debt?: number;
1523
+ total_equity?: number;
1524
+ total_equity_gross_minority_interest?: number;
1525
+ total_liabilities_net_minority_interest?: number;
1526
+ total_non_current_assets?: number;
1527
+ total_non_current_liabilities_net_minority_interest?: number;
1528
+ total_tax_payable?: number;
1529
+ tradeand_other_payables_non_current?: number;
1530
+ working_capital?: number;
1531
+ };
1532
+ currency: string;
1533
+ };
1534
+ cash_flow: {
1535
+ '2021': {
1536
+ beginning_cash_position?: number;
1537
+ capital_expenditure?: number;
1538
+ cash_dividends_paid?: number;
1539
+ cash_flow_from_continuing_financing_activities?: number;
1540
+ cash_flow_from_continuing_investing_activities?: number;
1541
+ cash_flow_from_continuing_operating_activities?: number;
1542
+ change_in_account_payable?: number;
1543
+ change_in_inventory?: number;
1544
+ change_in_other_current_assets?: number;
1545
+ change_in_other_current_liabilities?: number;
1546
+ change_in_other_working_capital?: number;
1547
+ change_in_payable?: number;
1548
+ change_in_payables_and_accrued_expense?: number;
1549
+ change_in_receivables?: number;
1550
+ change_in_working_capital?: number;
1551
+ changes_in_account_receivables?: number;
1552
+ changes_in_cash?: number;
1553
+ common_stock_dividend_paid?: number;
1554
+ common_stock_issuance?: number;
1555
+ common_stock_payments?: number;
1556
+ deferred_income_tax?: number;
1557
+ deferred_tax?: number;
1558
+ depreciation_amortization_depletion?: number;
1559
+ depreciation_and_amortization?: number;
1560
+ end_cash_position?: number;
1561
+ financing_cash_flow?: number;
1562
+ investing_cash_flow?: number;
1563
+ long_term_debt_issuance?: number;
1564
+ long_term_debt_payments?: number;
1565
+ net_business_purchase_and_sale?: number;
1566
+ net_common_stock_issuance?: number;
1567
+ net_income_from_continuing_operations?: number;
1568
+ net_investment_purchase_and_sale?: number;
1569
+ net_issuance_payments_of_debt?: number;
1570
+ net_long_term_debt_issuance?: number;
1571
+ net_other_financing_charges?: number;
1572
+ net_other_investing_changes?: number;
1573
+ net_ppe_purchase_and_sale?: number;
1574
+ net_short_term_debt_issuance?: number;
1575
+ operating_cash_flow?: number;
1576
+ other_non_cash_items?: number;
1577
+ purchase_of_business?: number;
1578
+ purchase_of_investment?: number;
1579
+ purchase_of_ppe?: number;
1580
+ sale_of_investment?: number;
1581
+ stock_based_compensation?: number;
1582
+ };
1583
+ '2022': {
1584
+ beginning_cash_position?: number;
1585
+ capital_expenditure?: number;
1586
+ cash_dividends_paid?: number;
1587
+ cash_flow_from_continuing_financing_activities?: number;
1588
+ cash_flow_from_continuing_investing_activities?: number;
1589
+ cash_flow_from_continuing_operating_activities?: number;
1590
+ change_in_account_payable?: number;
1591
+ change_in_inventory?: number;
1592
+ change_in_other_current_assets?: number;
1593
+ change_in_other_current_liabilities?: number;
1594
+ change_in_other_working_capital?: number;
1595
+ change_in_payable?: number;
1596
+ change_in_payables_and_accrued_expense?: number;
1597
+ change_in_receivables?: number;
1598
+ change_in_working_capital?: number;
1599
+ changes_in_account_receivables?: number;
1600
+ changes_in_cash?: number;
1601
+ common_stock_dividend_paid?: number;
1602
+ common_stock_payments?: number;
1603
+ deferred_income_tax?: number;
1604
+ deferred_tax?: number;
1605
+ depreciation_amortization_depletion?: number;
1606
+ depreciation_and_amortization?: number;
1607
+ end_cash_position?: number;
1608
+ financing_cash_flow?: number;
1609
+ investing_cash_flow?: number;
1610
+ long_term_debt_issuance?: number;
1611
+ long_term_debt_payments?: number;
1612
+ net_business_purchase_and_sale?: number;
1613
+ net_common_stock_issuance?: number;
1614
+ net_income_from_continuing_operations?: number;
1615
+ net_investment_purchase_and_sale?: number;
1616
+ net_issuance_payments_of_debt?: number;
1617
+ net_long_term_debt_issuance?: number;
1618
+ net_other_financing_charges?: number;
1619
+ net_other_investing_changes?: number;
1620
+ net_ppe_purchase_and_sale?: number;
1621
+ net_short_term_debt_issuance?: number;
1622
+ operating_cash_flow?: number;
1623
+ other_non_cash_items?: number;
1624
+ purchase_of_business?: number;
1625
+ purchase_of_investment?: number;
1626
+ purchase_of_ppe?: number;
1627
+ sale_of_investment?: number;
1628
+ short_term_debt_issuance?: number;
1629
+ stock_based_compensation?: number;
1630
+ };
1631
+ '2023': {
1632
+ beginning_cash_position?: number;
1633
+ capital_expenditure?: number;
1634
+ cash_dividends_paid?: number;
1635
+ cash_flow_from_continuing_financing_activities?: number;
1636
+ cash_flow_from_continuing_investing_activities?: number;
1637
+ cash_flow_from_continuing_operating_activities?: number;
1638
+ change_in_account_payable?: number;
1639
+ change_in_inventory?: number;
1640
+ change_in_other_current_assets?: number;
1641
+ change_in_other_current_liabilities?: number;
1642
+ change_in_payable?: number;
1643
+ change_in_payables_and_accrued_expense?: number;
1644
+ change_in_receivables?: number;
1645
+ change_in_working_capital?: number;
1646
+ changes_in_account_receivables?: number;
1647
+ changes_in_cash?: number;
1648
+ common_stock_dividend_paid?: number;
1649
+ common_stock_payments?: number;
1650
+ depreciation_amortization_depletion?: number;
1651
+ depreciation_and_amortization?: number;
1652
+ end_cash_position?: number;
1653
+ financing_cash_flow?: number;
1654
+ investing_cash_flow?: number;
1655
+ long_term_debt_issuance?: number;
1656
+ long_term_debt_payments?: number;
1657
+ net_common_stock_issuance?: number;
1658
+ net_income_from_continuing_operations?: number;
1659
+ net_investment_purchase_and_sale?: number;
1660
+ net_issuance_payments_of_debt?: number;
1661
+ net_long_term_debt_issuance?: number;
1662
+ net_other_financing_charges?: number;
1663
+ net_other_investing_changes?: number;
1664
+ net_ppe_purchase_and_sale?: number;
1665
+ net_short_term_debt_issuance?: number;
1666
+ operating_cash_flow?: number;
1667
+ other_non_cash_items?: number;
1668
+ purchase_of_investment?: number;
1669
+ purchase_of_ppe?: number;
1670
+ sale_of_investment?: number;
1671
+ stock_based_compensation?: number;
1672
+ };
1673
+ '2024': {
1674
+ beginning_cash_position?: number;
1675
+ capital_expenditure?: number;
1676
+ cash_dividends_paid?: number;
1677
+ cash_flow_from_continuing_financing_activities?: number;
1678
+ cash_flow_from_continuing_investing_activities?: number;
1679
+ cash_flow_from_continuing_operating_activities?: number;
1680
+ change_in_account_payable?: number;
1681
+ change_in_inventory?: number;
1682
+ change_in_other_current_assets?: number;
1683
+ change_in_other_current_liabilities?: number;
1684
+ change_in_payable?: number;
1685
+ change_in_payables_and_accrued_expense?: number;
1686
+ change_in_receivables?: number;
1687
+ change_in_working_capital?: number;
1688
+ changes_in_account_receivables?: number;
1689
+ changes_in_cash?: number;
1690
+ common_stock_dividend_paid?: number;
1691
+ common_stock_payments?: number;
1692
+ depreciation_amortization_depletion?: number;
1693
+ depreciation_and_amortization?: number;
1694
+ end_cash_position?: number;
1695
+ financing_cash_flow?: number;
1696
+ investing_cash_flow?: number;
1697
+ long_term_debt_issuance?: number;
1698
+ long_term_debt_payments?: number;
1699
+ net_common_stock_issuance?: number;
1700
+ net_income_from_continuing_operations?: number;
1701
+ net_investment_purchase_and_sale?: number;
1702
+ net_issuance_payments_of_debt?: number;
1703
+ net_long_term_debt_issuance?: number;
1704
+ net_other_financing_charges?: number;
1705
+ net_other_investing_changes?: number;
1706
+ net_ppe_purchase_and_sale?: number;
1707
+ net_short_term_debt_issuance?: number;
1708
+ operating_cash_flow?: number;
1709
+ other_non_cash_items?: number;
1710
+ purchase_of_investment?: number;
1711
+ purchase_of_ppe?: number;
1712
+ sale_of_investment?: number;
1713
+ stock_based_compensation?: number;
1714
+ };
1715
+ currency: string;
1716
+ };
1717
+ income_statement: {
1718
+ '2021': {
1719
+ cost_of_revenue?: number;
1720
+ diluted_ni_availto_com_stockholders?: number;
1721
+ ebit?: number;
1722
+ ebitda?: number;
1723
+ gross_profit?: number;
1724
+ interest_expense?: number;
1725
+ interest_expense_non_operating?: number;
1726
+ interest_income?: number;
1727
+ interest_income_non_operating?: number;
1728
+ net_income?: number;
1729
+ net_income_common_stockholders?: number;
1730
+ net_income_continuous_operations?: number;
1731
+ net_income_from_continuing_and_discontinued_operation?: number;
1732
+ net_income_from_continuing_operation_net_minority_interest?: number;
1733
+ net_income_including_noncontrolling_interests?: number;
1734
+ net_interest_income?: number;
1735
+ net_non_operating_interest_income_expense?: number;
1736
+ normalized_ebitda?: number;
1737
+ normalized_income?: number;
1738
+ operating_expense?: number;
1739
+ operating_income?: number;
1740
+ operating_revenue?: number;
1741
+ other_income_expense?: number;
1742
+ other_non_operating_income_expenses?: number;
1743
+ pretax_income?: number;
1744
+ reconciled_cost_of_revenue?: number;
1745
+ reconciled_depreciation?: number;
1746
+ research_and_development?: number;
1747
+ selling_general_and_administration?: number;
1748
+ tax_effect_of_unusual_items?: number;
1749
+ tax_provision?: number;
1750
+ tax_rate_for_calcs?: number;
1751
+ total_expenses?: number;
1752
+ total_revenue?: number;
1753
+ };
1754
+ '2022': {
1755
+ cost_of_revenue?: number;
1756
+ diluted_ni_availto_com_stockholders?: number;
1757
+ ebit?: number;
1758
+ ebitda?: number;
1759
+ gross_profit?: number;
1760
+ interest_expense?: number;
1761
+ interest_expense_non_operating?: number;
1762
+ interest_income?: number;
1763
+ interest_income_non_operating?: number;
1764
+ net_income?: number;
1765
+ net_income_common_stockholders?: number;
1766
+ net_income_continuous_operations?: number;
1767
+ net_income_from_continuing_and_discontinued_operation?: number;
1768
+ net_income_from_continuing_operation_net_minority_interest?: number;
1769
+ net_income_including_noncontrolling_interests?: number;
1770
+ net_interest_income?: number;
1771
+ net_non_operating_interest_income_expense?: number;
1772
+ normalized_ebitda?: number;
1773
+ normalized_income?: number;
1774
+ operating_expense?: number;
1775
+ operating_income?: number;
1776
+ operating_revenue?: number;
1777
+ other_income_expense?: number;
1778
+ other_non_operating_income_expenses?: number;
1779
+ pretax_income?: number;
1780
+ reconciled_cost_of_revenue?: number;
1781
+ reconciled_depreciation?: number;
1782
+ research_and_development?: number;
1783
+ selling_general_and_administration?: number;
1784
+ tax_effect_of_unusual_items?: number;
1785
+ tax_provision?: number;
1786
+ tax_rate_for_calcs?: number;
1787
+ total_expenses?: number;
1788
+ total_revenue?: number;
1789
+ };
1790
+ '2023': {
1791
+ cost_of_revenue?: number;
1792
+ diluted_ni_availto_com_stockholders?: number;
1793
+ ebit?: number;
1794
+ ebitda?: number;
1795
+ gross_profit?: number;
1796
+ interest_expense?: number;
1797
+ interest_expense_non_operating?: number;
1798
+ interest_income?: number;
1799
+ interest_income_non_operating?: number;
1800
+ net_income?: number;
1801
+ net_income_common_stockholders?: number;
1802
+ net_income_continuous_operations?: number;
1803
+ net_income_from_continuing_and_discontinued_operation?: number;
1804
+ net_income_from_continuing_operation_net_minority_interest?: number;
1805
+ net_income_including_noncontrolling_interests?: number;
1806
+ net_interest_income?: number;
1807
+ net_non_operating_interest_income_expense?: number;
1808
+ normalized_ebitda?: number;
1809
+ normalized_income?: number;
1810
+ operating_expense?: number;
1811
+ operating_income?: number;
1812
+ operating_revenue?: number;
1813
+ other_income_expense?: number;
1814
+ other_non_operating_income_expenses?: number;
1815
+ pretax_income?: number;
1816
+ reconciled_cost_of_revenue?: number;
1817
+ reconciled_depreciation?: number;
1818
+ research_and_development?: number;
1819
+ selling_general_and_administration?: number;
1820
+ tax_effect_of_unusual_items?: number;
1821
+ tax_provision?: number;
1822
+ tax_rate_for_calcs?: number;
1823
+ total_expenses?: number;
1824
+ total_revenue?: number;
1825
+ };
1826
+ '2024': {
1827
+ cost_of_revenue?: number;
1828
+ diluted_ni_availto_com_stockholders?: number;
1829
+ ebit?: number;
1830
+ ebitda?: number;
1831
+ gross_profit?: number;
1832
+ net_income?: number;
1833
+ net_income_common_stockholders?: number;
1834
+ net_income_continuous_operations?: number;
1835
+ net_income_from_continuing_and_discontinued_operation?: number;
1836
+ net_income_from_continuing_operation_net_minority_interest?: number;
1837
+ net_income_including_noncontrolling_interests?: number;
1838
+ normalized_ebitda?: number;
1839
+ normalized_income?: number;
1840
+ operating_expense?: number;
1841
+ operating_income?: number;
1842
+ operating_revenue?: number;
1843
+ other_income_expense?: number;
1844
+ other_non_operating_income_expenses?: number;
1845
+ pretax_income?: number;
1846
+ reconciled_cost_of_revenue?: number;
1847
+ reconciled_depreciation?: number;
1848
+ research_and_development?: number;
1849
+ selling_general_and_administration?: number;
1850
+ tax_effect_of_unusual_items?: number;
1851
+ tax_provision?: number;
1852
+ tax_rate_for_calcs?: number;
1853
+ total_expenses?: number;
1854
+ total_revenue?: number;
1855
+ };
1856
+ currency: string;
1857
+ };
1858
+ }
1859
+ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
1860
+ balance_sheet: {
1861
+ '2024Q1': {
1862
+ accounts_payable?: number;
1863
+ accounts_receivable?: number;
1864
+ accumulated_depreciation?: number;
1865
+ available_for_sale_securities?: number;
1866
+ capital_stock?: number;
1867
+ cash?: number;
1868
+ cash_and_cash_equivalents?: number;
1869
+ cash_cash_equivalents_and_marketable_securities?: number;
1870
+ cash_equivalents?: number;
1871
+ com_tre_sha_num?: number;
1872
+ commercial_paper?: number;
1873
+ common_stock?: number;
1874
+ common_stock_equity?: number;
1875
+ current_assets?: number;
1876
+ current_debt?: number;
1877
+ current_debt_and_capital_lease_obligation?: number;
1878
+ current_deferred_liabilities?: number;
1879
+ current_deferred_revenue?: number;
1880
+ current_liabilities?: number;
1881
+ gains_losses_not_affecting_retained_earnings?: number;
1882
+ gross_ppe?: number;
1883
+ inventory?: number;
1884
+ invested_capital?: number;
1885
+ investmentin_financial_assets?: number;
1886
+ investments_and_advances?: number;
1887
+ long_term_debt?: number;
1888
+ long_term_debt_and_capital_lease_obligation?: number;
1889
+ net_debt?: number;
1890
+ net_ppe?: number;
1891
+ net_tangible_assets?: number;
1892
+ ordinary_shares_number?: number;
1893
+ other_current_assets?: number;
1894
+ other_current_borrowings?: number;
1895
+ other_current_liabilities?: number;
1896
+ other_equity_adjustments?: number;
1897
+ other_non_current_assets?: number;
1898
+ other_non_current_liabilities?: number;
1899
+ other_receivables?: number;
1900
+ other_short_term_investments?: number;
1901
+ payables?: number;
1902
+ payables_and_accrued_expenses?: number;
1903
+ receivables?: number;
1904
+ retained_earnings?: number;
1905
+ share_issued?: number;
1906
+ stockholders_equity?: number;
1907
+ tangible_book_value?: number;
1908
+ total_assets?: number;
1909
+ total_capitalization?: number;
1910
+ total_debt?: number;
1911
+ total_equity?: number;
1912
+ total_equity_gross_minority_interest?: number;
1913
+ total_liabilities_net_minority_interest?: number;
1914
+ total_non_current_assets?: number;
1915
+ total_non_current_liabilities_net_minority_interest?: number;
1916
+ treasury_shares_number?: number;
1917
+ working_capital?: number;
1918
+ };
1919
+ '2024Q2': {
1920
+ accounts_payable?: number;
1921
+ accounts_receivable?: number;
1922
+ accumulated_depreciation?: number;
1923
+ available_for_sale_securities?: number;
1924
+ capital_stock?: number;
1925
+ cash?: number;
1926
+ cash_and_cash_equivalents?: number;
1927
+ cash_cash_equivalents_and_marketable_securities?: number;
1928
+ cash_equivalents?: number;
1929
+ commercial_paper?: number;
1930
+ common_stock?: number;
1931
+ common_stock_equity?: number;
1932
+ current_assets?: number;
1933
+ current_debt?: number;
1934
+ current_debt_and_capital_lease_obligation?: number;
1935
+ current_deferred_liabilities?: number;
1936
+ current_deferred_revenue?: number;
1937
+ current_liabilities?: number;
1938
+ gains_losses_not_affecting_retained_earnings?: number;
1939
+ gross_ppe?: number;
1940
+ inventory?: number;
1941
+ invested_capital?: number;
1942
+ investmentin_financial_assets?: number;
1943
+ investments_and_advances?: number;
1944
+ long_term_debt?: number;
1945
+ long_term_debt_and_capital_lease_obligation?: number;
1946
+ net_debt?: number;
1947
+ net_ppe?: number;
1948
+ net_tangible_assets?: number;
1949
+ ordinary_shares_number?: number;
1950
+ other_current_assets?: number;
1951
+ other_current_borrowings?: number;
1952
+ other_current_liabilities?: number;
1953
+ other_equity_adjustments?: number;
1954
+ other_non_current_assets?: number;
1955
+ other_non_current_liabilities?: number;
1956
+ other_receivables?: number;
1957
+ other_short_term_investments?: number;
1958
+ payables?: number;
1959
+ payables_and_accrued_expenses?: number;
1960
+ receivables?: number;
1961
+ retained_earnings?: number;
1962
+ share_issued?: number;
1963
+ stockholders_equity?: number;
1964
+ tangible_book_value?: number;
1965
+ total_assets?: number;
1966
+ total_capitalization?: number;
1967
+ total_debt?: number;
1968
+ total_equity?: number;
1969
+ total_equity_gross_minority_interest?: number;
1970
+ total_liabilities_net_minority_interest?: number;
1971
+ total_non_current_assets?: number;
1972
+ total_non_current_liabilities_net_minority_interest?: number;
1973
+ working_capital?: number;
1974
+ };
1975
+ '2024Q3': {
1976
+ accounts_payable?: number;
1977
+ accounts_receivable?: number;
1978
+ accumulated_depreciation?: number;
1979
+ available_for_sale_securities?: number;
1980
+ capital_stock?: number;
1981
+ cash?: number;
1982
+ cash_and_cash_equivalents?: number;
1983
+ cash_cash_equivalents_and_marketable_securities?: number;
1984
+ cash_equivalents?: number;
1985
+ commercial_paper?: number;
1986
+ common_stock?: number;
1987
+ common_stock_equity?: number;
1988
+ current_assets?: number;
1989
+ current_debt?: number;
1990
+ current_debt_and_capital_lease_obligation?: number;
1991
+ current_deferred_liabilities?: number;
1992
+ current_deferred_revenue?: number;
1993
+ current_liabilities?: number;
1994
+ gains_losses_not_affecting_retained_earnings?: number;
1995
+ gross_ppe?: number;
1996
+ inventory?: number;
1997
+ invested_capital?: number;
1998
+ investmentin_financial_assets?: number;
1999
+ investments_and_advances?: number;
2000
+ long_term_debt?: number;
2001
+ long_term_debt_and_capital_lease_obligation?: number;
2002
+ net_debt?: number;
2003
+ net_ppe?: number;
2004
+ net_tangible_assets?: number;
2005
+ ordinary_shares_number?: number;
2006
+ other_current_assets?: number;
2007
+ other_current_borrowings?: number;
2008
+ other_current_liabilities?: number;
2009
+ other_equity_adjustments?: number;
2010
+ other_non_current_assets?: number;
2011
+ other_non_current_liabilities?: number;
2012
+ other_receivables?: number;
2013
+ other_short_term_investments?: number;
2014
+ payables?: number;
2015
+ payables_and_accrued_expenses?: number;
2016
+ receivables?: number;
2017
+ retained_earnings?: number;
2018
+ share_issued?: number;
2019
+ stockholders_equity?: number;
2020
+ tangible_book_value?: number;
2021
+ total_assets?: number;
2022
+ total_capitalization?: number;
2023
+ total_debt?: number;
2024
+ total_equity?: number;
2025
+ total_equity_gross_minority_interest?: number;
2026
+ total_liabilities_net_minority_interest?: number;
2027
+ total_non_current_assets?: number;
2028
+ total_non_current_liabilities_net_minority_interest?: number;
2029
+ working_capital?: number;
2030
+ };
2031
+ '2024Q4': {
2032
+ accounts_payable?: number;
2033
+ accounts_receivable?: number;
2034
+ accumulated_depreciation?: number;
2035
+ available_for_sale_securities?: number;
2036
+ capital_stock?: number;
2037
+ cash?: number;
2038
+ cash_and_cash_equivalents?: number;
2039
+ cash_cash_equivalents_and_marketable_securities?: number;
2040
+ cash_equivalents?: number;
2041
+ commercial_paper?: number;
2042
+ common_stock?: number;
2043
+ common_stock_equity?: number;
2044
+ current_assets?: number;
2045
+ current_debt?: number;
2046
+ current_debt_and_capital_lease_obligation?: number;
2047
+ current_deferred_liabilities?: number;
2048
+ current_deferred_revenue?: number;
2049
+ current_liabilities?: number;
2050
+ gains_losses_not_affecting_retained_earnings?: number;
2051
+ gross_ppe?: number;
2052
+ income_tax_payable?: number;
2053
+ inventory?: number;
2054
+ invested_capital?: number;
2055
+ investmentin_financial_assets?: number;
2056
+ investments_and_advances?: number;
2057
+ land_and_improvements?: number;
2058
+ leases?: number;
2059
+ long_term_debt?: number;
2060
+ long_term_debt_and_capital_lease_obligation?: number;
2061
+ machinery_furniture_equipment?: number;
2062
+ net_debt?: number;
2063
+ net_ppe?: number;
2064
+ net_tangible_assets?: number;
2065
+ non_current_deferred_assets?: number;
2066
+ non_current_deferred_taxes_assets?: number;
2067
+ ordinary_shares_number?: number;
2068
+ other_current_assets?: number;
2069
+ other_current_borrowings?: number;
2070
+ other_current_liabilities?: number;
2071
+ other_equity_adjustments?: number;
2072
+ other_non_current_assets?: number;
2073
+ other_non_current_liabilities?: number;
2074
+ other_receivables?: number;
2075
+ other_short_term_investments?: number;
2076
+ payables?: number;
2077
+ payables_and_accrued_expenses?: number;
2078
+ properties?: number;
2079
+ receivables?: number;
2080
+ retained_earnings?: number;
2081
+ share_issued?: number;
2082
+ stockholders_equity?: number;
2083
+ tangible_book_value?: number;
2084
+ total_assets?: number;
2085
+ total_capitalization?: number;
2086
+ total_debt?: number;
2087
+ total_equity?: number;
2088
+ total_equity_gross_minority_interest?: number;
2089
+ total_liabilities_net_minority_interest?: number;
2090
+ total_non_current_assets?: number;
2091
+ total_non_current_liabilities_net_minority_interest?: number;
2092
+ total_tax_payable?: number;
2093
+ tradeand_other_payables_non_current?: number;
2094
+ working_capital?: number;
2095
+ };
2096
+ currency: string;
2097
+ };
2098
+ cash_flow: {
2099
+ '2024Q1': {
2100
+ beginning_cash_position?: number;
2101
+ capital_expenditure?: number;
2102
+ cash_dividends_paid?: number;
2103
+ cash_flow_from_continuing_financing_activities?: number;
2104
+ cash_flow_from_continuing_investing_activities?: number;
2105
+ cash_flow_from_continuing_operating_activities?: number;
2106
+ change_in_account_payable?: number;
2107
+ change_in_inventory?: number;
2108
+ change_in_other_current_assets?: number;
2109
+ change_in_other_current_liabilities?: number;
2110
+ change_in_payable?: number;
2111
+ change_in_payables_and_accrued_expense?: number;
2112
+ change_in_receivables?: number;
2113
+ change_in_working_capital?: number;
2114
+ changes_in_account_receivables?: number;
2115
+ changes_in_cash?: number;
2116
+ common_stock_dividend_paid?: number;
2117
+ common_stock_payments?: number;
2118
+ depreciation_amortization_depletion?: number;
2119
+ depreciation_and_amortization?: number;
2120
+ end_cash_position?: number;
2121
+ financing_cash_flow?: number;
2122
+ investing_cash_flow?: number;
2123
+ long_term_debt_payments?: number;
2124
+ net_common_stock_issuance?: number;
2125
+ net_income_from_continuing_operations?: number;
2126
+ net_investment_purchase_and_sale?: number;
2127
+ net_issuance_payments_of_debt?: number;
2128
+ net_long_term_debt_issuance?: number;
2129
+ net_other_financing_charges?: number;
2130
+ net_other_investing_changes?: number;
2131
+ net_ppe_purchase_and_sale?: number;
2132
+ net_short_term_debt_issuance?: number;
2133
+ operating_cash_flow?: number;
2134
+ other_non_cash_items?: number;
2135
+ purchase_of_investment?: number;
2136
+ purchase_of_ppe?: number;
2137
+ sale_of_investment?: number;
2138
+ short_term_debt_payments?: number;
2139
+ stock_based_compensation?: number;
2140
+ };
2141
+ '2024Q2': {
2142
+ beginning_cash_position?: number;
2143
+ capital_expenditure?: number;
2144
+ cash_dividends_paid?: number;
2145
+ cash_flow_from_continuing_financing_activities?: number;
2146
+ cash_flow_from_continuing_investing_activities?: number;
2147
+ cash_flow_from_continuing_operating_activities?: number;
2148
+ change_in_account_payable?: number;
2149
+ change_in_inventory?: number;
2150
+ change_in_other_current_assets?: number;
2151
+ change_in_other_current_liabilities?: number;
2152
+ change_in_payable?: number;
2153
+ change_in_payables_and_accrued_expense?: number;
2154
+ change_in_receivables?: number;
2155
+ change_in_working_capital?: number;
2156
+ changes_in_account_receivables?: number;
2157
+ changes_in_cash?: number;
2158
+ common_stock_dividend_paid?: number;
2159
+ common_stock_payments?: number;
2160
+ depreciation_amortization_depletion?: number;
2161
+ depreciation_and_amortization?: number;
2162
+ end_cash_position?: number;
2163
+ financing_cash_flow?: number;
2164
+ investing_cash_flow?: number;
2165
+ long_term_debt_payments?: number;
2166
+ net_common_stock_issuance?: number;
2167
+ net_income_from_continuing_operations?: number;
2168
+ net_investment_purchase_and_sale?: number;
2169
+ net_issuance_payments_of_debt?: number;
2170
+ net_long_term_debt_issuance?: number;
2171
+ net_other_financing_charges?: number;
2172
+ net_other_investing_changes?: number;
2173
+ net_ppe_purchase_and_sale?: number;
2174
+ net_short_term_debt_issuance?: number;
2175
+ operating_cash_flow?: number;
2176
+ other_non_cash_items?: number;
2177
+ purchase_of_investment?: number;
2178
+ purchase_of_ppe?: number;
2179
+ sale_of_investment?: number;
2180
+ short_term_debt_payments?: number;
2181
+ stock_based_compensation?: number;
2182
+ };
2183
+ '2024Q3': {
2184
+ beginning_cash_position?: number;
2185
+ capital_expenditure?: number;
2186
+ cash_dividends_paid?: number;
2187
+ cash_flow_from_continuing_financing_activities?: number;
2188
+ cash_flow_from_continuing_investing_activities?: number;
2189
+ cash_flow_from_continuing_operating_activities?: number;
2190
+ change_in_account_payable?: number;
2191
+ change_in_inventory?: number;
2192
+ change_in_other_current_assets?: number;
2193
+ change_in_other_current_liabilities?: number;
2194
+ change_in_payable?: number;
2195
+ change_in_payables_and_accrued_expense?: number;
2196
+ change_in_receivables?: number;
2197
+ change_in_working_capital?: number;
2198
+ changes_in_account_receivables?: number;
2199
+ changes_in_cash?: number;
2200
+ common_stock_dividend_paid?: number;
2201
+ common_stock_payments?: number;
2202
+ depreciation_amortization_depletion?: number;
2203
+ depreciation_and_amortization?: number;
2204
+ end_cash_position?: number;
2205
+ financing_cash_flow?: number;
2206
+ investing_cash_flow?: number;
2207
+ long_term_debt_payments?: number;
2208
+ net_common_stock_issuance?: number;
2209
+ net_income_from_continuing_operations?: number;
2210
+ net_investment_purchase_and_sale?: number;
2211
+ net_issuance_payments_of_debt?: number;
2212
+ net_long_term_debt_issuance?: number;
2213
+ net_other_financing_charges?: number;
2214
+ net_other_investing_changes?: number;
2215
+ net_ppe_purchase_and_sale?: number;
2216
+ net_short_term_debt_issuance?: number;
2217
+ operating_cash_flow?: number;
2218
+ other_non_cash_items?: number;
2219
+ purchase_of_investment?: number;
2220
+ purchase_of_ppe?: number;
2221
+ sale_of_investment?: number;
2222
+ short_term_debt_payments?: number;
2223
+ stock_based_compensation?: number;
2224
+ };
2225
+ '2024Q4': {
2226
+ beginning_cash_position?: number;
2227
+ capital_expenditure?: number;
2228
+ cash_dividends_paid?: number;
2229
+ cash_flow_from_continuing_financing_activities?: number;
2230
+ cash_flow_from_continuing_investing_activities?: number;
2231
+ cash_flow_from_continuing_operating_activities?: number;
2232
+ change_in_account_payable?: number;
2233
+ change_in_inventory?: number;
2234
+ change_in_other_current_assets?: number;
2235
+ change_in_other_current_liabilities?: number;
2236
+ change_in_payable?: number;
2237
+ change_in_payables_and_accrued_expense?: number;
2238
+ change_in_receivables?: number;
2239
+ change_in_working_capital?: number;
2240
+ changes_in_account_receivables?: number;
2241
+ changes_in_cash?: number;
2242
+ common_stock_dividend_paid?: number;
2243
+ common_stock_payments?: number;
2244
+ depreciation_amortization_depletion?: number;
2245
+ depreciation_and_amortization?: number;
2246
+ end_cash_position?: number;
2247
+ financing_cash_flow?: number;
2248
+ investing_cash_flow?: number;
2249
+ long_term_debt_issuance?: number;
2250
+ long_term_debt_payments?: number;
2251
+ net_common_stock_issuance?: number;
2252
+ net_income_from_continuing_operations?: number;
2253
+ net_investment_purchase_and_sale?: number;
2254
+ net_issuance_payments_of_debt?: number;
2255
+ net_long_term_debt_issuance?: number;
2256
+ net_other_financing_charges?: number;
2257
+ net_other_investing_changes?: number;
2258
+ net_ppe_purchase_and_sale?: number;
2259
+ net_short_term_debt_issuance?: number;
2260
+ operating_cash_flow?: number;
2261
+ other_non_cash_items?: number;
2262
+ purchase_of_investment?: number;
2263
+ purchase_of_ppe?: number;
2264
+ sale_of_investment?: number;
2265
+ stock_based_compensation?: number;
2266
+ };
2267
+ currency: string;
2268
+ };
2269
+ income_statement: {
2270
+ '2024Q1': {
2271
+ cost_of_revenue?: number;
2272
+ diluted_ni_availto_com_stockholders?: number;
2273
+ ebit?: number;
2274
+ ebitda?: number;
2275
+ gross_profit?: number;
2276
+ net_income?: number;
2277
+ net_income_common_stockholders?: number;
2278
+ net_income_continuous_operations?: number;
2279
+ net_income_from_continuing_and_discontinued_operation?: number;
2280
+ net_income_from_continuing_operation_net_minority_interest?: number;
2281
+ net_income_including_noncontrolling_interests?: number;
2282
+ normalized_ebitda?: number;
2283
+ normalized_income?: number;
2284
+ operating_expense?: number;
2285
+ operating_income?: number;
2286
+ operating_revenue?: number;
2287
+ other_income_expense?: number;
2288
+ other_non_operating_income_expenses?: number;
2289
+ pretax_income?: number;
2290
+ reconciled_cost_of_revenue?: number;
2291
+ reconciled_depreciation?: number;
2292
+ research_and_development?: number;
2293
+ selling_general_and_administration?: number;
2294
+ tax_effect_of_unusual_items?: number;
2295
+ tax_provision?: number;
2296
+ tax_rate_for_calcs?: number;
2297
+ total_expenses?: number;
2298
+ total_revenue?: number;
2299
+ };
2300
+ '2024Q2': {
2301
+ cost_of_revenue?: number;
2302
+ diluted_ni_availto_com_stockholders?: number;
2303
+ ebit?: number;
2304
+ ebitda?: number;
2305
+ gross_profit?: number;
2306
+ net_income?: number;
2307
+ net_income_common_stockholders?: number;
2308
+ net_income_continuous_operations?: number;
2309
+ net_income_from_continuing_and_discontinued_operation?: number;
2310
+ net_income_from_continuing_operation_net_minority_interest?: number;
2311
+ net_income_including_noncontrolling_interests?: number;
2312
+ normalized_ebitda?: number;
2313
+ normalized_income?: number;
2314
+ operating_expense?: number;
2315
+ operating_income?: number;
2316
+ operating_revenue?: number;
2317
+ other_income_expense?: number;
2318
+ other_non_operating_income_expenses?: number;
2319
+ pretax_income?: number;
2320
+ reconciled_cost_of_revenue?: number;
2321
+ reconciled_depreciation?: number;
2322
+ research_and_development?: number;
2323
+ selling_general_and_administration?: number;
2324
+ tax_effect_of_unusual_items?: number;
2325
+ tax_provision?: number;
2326
+ tax_rate_for_calcs?: number;
2327
+ total_expenses?: number;
2328
+ total_revenue?: number;
2329
+ };
2330
+ '2024Q3': {
2331
+ cost_of_revenue?: number;
2332
+ diluted_ni_availto_com_stockholders?: number;
2333
+ ebit?: number;
2334
+ ebitda?: number;
2335
+ gross_profit?: number;
2336
+ net_income?: number;
2337
+ net_income_common_stockholders?: number;
2338
+ net_income_continuous_operations?: number;
2339
+ net_income_from_continuing_and_discontinued_operation?: number;
2340
+ net_income_from_continuing_operation_net_minority_interest?: number;
2341
+ net_income_including_noncontrolling_interests?: number;
2342
+ normalized_ebitda?: number;
2343
+ normalized_income?: number;
2344
+ operating_expense?: number;
2345
+ operating_income?: number;
2346
+ operating_revenue?: number;
2347
+ other_income_expense?: number;
2348
+ other_non_operating_income_expenses?: number;
2349
+ pretax_income?: number;
2350
+ reconciled_cost_of_revenue?: number;
2351
+ reconciled_depreciation?: number;
2352
+ research_and_development?: number;
2353
+ selling_general_and_administration?: number;
2354
+ tax_effect_of_unusual_items?: number;
2355
+ tax_provision?: number;
2356
+ tax_rate_for_calcs?: number;
2357
+ total_expenses?: number;
2358
+ total_revenue?: number;
2359
+ };
2360
+ '2024Q4': {
2361
+ cost_of_revenue?: number;
2362
+ diluted_ni_availto_com_stockholders?: number;
2363
+ ebit?: number;
2364
+ ebitda?: number;
2365
+ gross_profit?: number;
2366
+ net_income?: number;
2367
+ net_income_common_stockholders?: number;
2368
+ net_income_continuous_operations?: number;
2369
+ net_income_from_continuing_and_discontinued_operation?: number;
2370
+ net_income_from_continuing_operation_net_minority_interest?: number;
2371
+ net_income_including_noncontrolling_interests?: number;
2372
+ normalized_ebitda?: number;
2373
+ normalized_income?: number;
2374
+ operating_expense?: number;
2375
+ operating_income?: number;
2376
+ operating_revenue?: number;
2377
+ other_income_expense?: number;
2378
+ other_non_operating_income_expenses?: number;
2379
+ pretax_income?: number;
2380
+ reconciled_cost_of_revenue?: number;
2381
+ reconciled_depreciation?: number;
2382
+ research_and_development?: number;
2383
+ selling_general_and_administration?: number;
2384
+ tax_effect_of_unusual_items?: number;
2385
+ tax_provision?: number;
2386
+ tax_rate_for_calcs?: number;
2387
+ total_expenses?: number;
2388
+ total_revenue?: number;
2389
+ };
2390
+ currency: string;
2391
+ };
1012
2392
  }
1013
2393
  export interface InsightGetSymbolFundamentalsRequest {
1014
- mode?: string;
1015
- symbol?: string;
2394
+ /** @example "annual" */
2395
+ mode: InsightGetSymbolFundamentalsRequestModeEnum;
2396
+ /** @example "AAPL" */
2397
+ symbol: string;
1016
2398
  }
1017
- export type InsightGetSymbolFundamentalsResponse = Record<string, any>;
1018
2399
  export interface InsightGetSymbolRelatedFieldsResponse {
1019
2400
  asset_allocations: InsightSymbolRelatedField[][];
1020
2401
  continents: InsightSymbolRelatedField[][];
@@ -1033,7 +2414,8 @@ export interface InsightGetSymbolRelatedFieldsResponse {
1033
2414
  symbol_type: string;
1034
2415
  }
1035
2416
  export interface InsightGetSymbolsPerTypeRequest {
1036
- symbols?: string[];
2417
+ /** @example ["AAPL","GOOGL","MSFT"] */
2418
+ symbols: string[];
1037
2419
  }
1038
2420
  export interface InsightGetSymbolsPerTypeResponse {
1039
2421
  EQUITY: string[];
@@ -1042,39 +2424,38 @@ export interface InsightGetSymbolsPerTypeResponse {
1042
2424
  MF: string[];
1043
2425
  }
1044
2426
  export interface InsightGetTopFundsRequest {
1045
- fund_type?: string;
1046
- inverse?: string;
1047
- leverage?: string;
2427
+ /** @example "ETF" */
2428
+ fund_type: InsightGetTopFundsRequestFundTypeEnum;
2429
+ /** @example "ANY" */
2430
+ inverse: InsightGetTopFundsRequestInverseEnum;
2431
+ /** @example "LEVERAGE_I" */
2432
+ leverage: InsightGetTopFundsRequestLeverageEnum;
1048
2433
  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;
2434
+ paging: InsightPaging;
1056
2435
  }
1057
2436
  export interface InsightGetTopFundsResponse {
1058
2437
  count: number;
1059
2438
  details: InsightExtendedFundData[];
1060
2439
  }
1061
- export interface InsightGetTopSymbolsRequest {
2440
+ export interface InsightGetTopSymbolsV1Request {
1062
2441
  exchange?: string[];
1063
2442
  market_cap?: InsightLessAndMore;
1064
2443
  order?: InsightOrdering;
1065
- pagination?: InsightPagination;
1066
2444
  paging?: InsightPaging;
1067
2445
  price?: InsightLessAndMore;
1068
- quote_access_type?: string;
1069
- sorts?: InsightOrdering[];
1070
2446
  volume?: InsightLessAndMore;
1071
2447
  }
1072
2448
  export interface InsightGetUsageDataRequest {
2449
+ /** @example ["NY","LA"] */
1073
2450
  branch_codes?: string[];
1074
- end_time?: string;
2451
+ /** @example "2023-01-31T23:59:59Z" */
2452
+ end_time: string;
2453
+ /** @example [123,456] */
1075
2454
  firm_ids?: number[];
1076
- source?: string;
1077
- start_time?: string;
2455
+ /** @example "MIDDLEWARE" */
2456
+ source: InsightGetUsageDataRequestSourceEnum;
2457
+ /** @example "2023-01-01T00:00:00Z" */
2458
+ start_time: string;
1078
2459
  }
1079
2460
  export interface InsightGlobalIndex {
1080
2461
  continent_id: string;
@@ -1337,17 +2718,17 @@ export interface InsightInstitutionalHolding {
1337
2718
  value: number;
1338
2719
  }
1339
2720
  export interface InsightIntradayRequest {
1340
- /** Format: YYYY-MM-DD (OPTIONAL) */
2721
+ /** @example "2023-01-01" */
1341
2722
  from?: string;
1342
- /** (OPTIONAL) */
2723
+ /** @example true */
1343
2724
  raw_volumes?: boolean;
1344
- /** (REQUIRE) */
1345
- rsi_span?: number;
1346
- /** (OPTIONAL) */
2725
+ /** @example 14 */
2726
+ rsi_span: number;
2727
+ /** @example 5 */
1347
2728
  smoothing?: number;
1348
- /** (REQUIRE) */
1349
- symbol?: string;
1350
- /** Format: YYYY-MM-DD (OPTIONAL) */
2729
+ /** @example "AAPL" */
2730
+ symbol: string;
2731
+ /** @example "2023-01-31" */
1351
2732
  to?: string;
1352
2733
  }
1353
2734
  export interface InsightIntradayResponse {
@@ -1500,23 +2881,34 @@ export interface InsightMaturityBreakdown {
1500
2881
  percentage: number;
1501
2882
  }
1502
2883
  export interface InsightMomentumRatioGraphRequest {
1503
- benchmark?: string;
1504
- mode?: string;
1505
- period?: number;
1506
- range?: string;
1507
- set_ema?: boolean;
1508
- symbols?: string[];
2884
+ /** @example "SPY" */
2885
+ benchmark: string;
2886
+ /** @example "daily" */
2887
+ mode: InsightMomentumRatioGraphRequestModeEnum;
2888
+ /**
2889
+ * @min 4
2890
+ * @max 10
2891
+ * @example 4
2892
+ */
2893
+ period: number;
2894
+ /** @example "1m" */
2895
+ range: string;
2896
+ /** @example true */
2897
+ set_ema: boolean;
2898
+ /** @example ["AAPL","CSCO"] */
2899
+ symbols: string[];
1509
2900
  }
1510
2901
  export interface InsightMomentumRatioGraphResponse {
1511
2902
  AAPL: InsightSymbolMomentum[];
1512
2903
  CSCO: InsightSymbolMomentum[];
1513
2904
  }
1514
2905
  export interface InsightMostPopularTagsRequest {
1515
- /** (REQUIRE) */
1516
- language?: string;
1517
- time?: InsightMostPopularTagsRequestTimeEnum;
1518
- /** (REQUIRE) */
1519
- type?: InsightMostPopularTagsRequestTypeEnum;
2906
+ /** @example "eng" */
2907
+ language: string;
2908
+ /** @example "week" */
2909
+ time: string;
2910
+ /** @example "symbol" */
2911
+ type: string;
1520
2912
  }
1521
2913
  export interface InsightMover {
1522
2914
  company_name: string;
@@ -1526,7 +2918,8 @@ export interface InsightMultipleCryptoLogosRequest {
1526
2918
  symbols?: string[];
1527
2919
  }
1528
2920
  export interface InsightMultipleSymbolLogosRequest {
1529
- symbols?: string[];
2921
+ /** @example ["AAPL","GOOGL","MSFT"] */
2922
+ symbols: string[];
1530
2923
  }
1531
2924
  export interface InsightNews {
1532
2925
  author: string;
@@ -1572,15 +2965,23 @@ export interface InsightNewsData {
1572
2965
  }
1573
2966
  export type InsightNewsExtraData = Record<string, InsightNewsData>;
1574
2967
  export interface InsightNewsFilterRequest {
2968
+ /** @example "John Doe" */
1575
2969
  author?: string;
1576
- channels?: string[];
2970
+ /** @example ["Finance","Technology"] */
2971
+ channels: string[];
2972
+ /** @example "2023-12-31" */
1577
2973
  end_date?: string;
2974
+ /** @example true */
1578
2975
  headline?: boolean;
1579
- paging?: InsightPaging;
2976
+ paging: InsightPaging;
2977
+ /** @example true */
1580
2978
  press_release?: boolean;
2979
+ /** @example "2023-01-01" */
1581
2980
  start_date?: string;
1582
- symbols?: string[];
1583
- tags?: string[];
2981
+ /** @example ["AAPL","GOOGL"] */
2982
+ symbols: string[];
2983
+ /** @example ["Earnings","Market"] */
2984
+ tags: string[];
1584
2985
  }
1585
2986
  export interface InsightNewsImage {
1586
2987
  size: string;
@@ -1597,7 +2998,8 @@ export interface InsightNewsPreview {
1597
2998
  updated: string;
1598
2999
  }
1599
3000
  export interface InsightNewsRequest {
1600
- id?: string;
3001
+ /** @example "123e4567-e89b-12d3-a456-426614174000" */
3002
+ id: string;
1601
3003
  }
1602
3004
  export interface InsightNewsResponse {
1603
3005
  count: number;
@@ -1649,14 +3051,21 @@ export interface InsightNewsfeed {
1649
3051
  user_id: number;
1650
3052
  }
1651
3053
  export interface InsightNewsfeedRequest {
1652
- count?: number;
1653
- /** (REQUIRE) */
1654
- language?: string;
3054
+ /** @example 10 */
3055
+ count: number;
3056
+ /** @example "eng" */
3057
+ language: string;
3058
+ /** @example 1609459200 */
1655
3059
  released_after?: number;
3060
+ /** @example 1625097600 */
1656
3061
  released_before?: number;
3062
+ /** @example "AAPL" */
1657
3063
  symbol?: string;
3064
+ /** @example "technology" */
1658
3065
  tag?: string;
1659
- type?: InsightNewsfeedRequestTypeEnum;
3066
+ /** @example "education" */
3067
+ type?: string;
3068
+ /** @example "group1" */
1660
3069
  with_tag_group?: string;
1661
3070
  }
1662
3071
  export interface InsightOptionData {
@@ -1680,12 +3089,16 @@ export interface InsightOptionValues {
1680
3089
  time_value: number;
1681
3090
  }
1682
3091
  export interface InsightOrdering {
1683
- /** @default "asc" */
3092
+ /**
3093
+ * @default "asc"
3094
+ * @example "asc"
3095
+ */
1684
3096
  direction: InsightOrderingDirectionEnum;
1685
3097
  /**
1686
3098
  * Sort direction:
1687
3099
  * * asc - Ascending, from A to Z.
1688
3100
  * * desc - Descending, from Z to A.
3101
+ * @example "name"
1689
3102
  */
1690
3103
  field: string;
1691
3104
  }
@@ -1699,11 +3112,29 @@ export interface InsightOwnershipDetails {
1699
3112
  symbol: string;
1700
3113
  }
1701
3114
  export interface InsightPagination {
3115
+ /**
3116
+ * @min 1
3117
+ * @example 1
3118
+ */
1702
3119
  page: number;
3120
+ /**
3121
+ * @min 1
3122
+ * @max 50
3123
+ * @example 10
3124
+ */
1703
3125
  size: number;
1704
3126
  }
1705
3127
  export interface InsightPaging {
3128
+ /**
3129
+ * @min 1
3130
+ * @max 100
3131
+ * @example 10
3132
+ */
1706
3133
  limit: number;
3134
+ /**
3135
+ * @min 0
3136
+ * @example 0
3137
+ */
1707
3138
  offset: number;
1708
3139
  }
1709
3140
  export interface InsightPerformanceHistory {
@@ -1724,8 +3155,13 @@ export interface InsightPerformingExpertsRatings {
1724
3155
  ticker: string;
1725
3156
  }
1726
3157
  export interface InsightPeriodFilter {
1727
- type?: InsightPeriodFilterTypeEnum;
1728
- value?: number;
3158
+ /** @example "day" */
3159
+ type: InsightPeriodFilterTypeEnum;
3160
+ /**
3161
+ * @min 1
3162
+ * @example 1
3163
+ */
3164
+ value: number;
1729
3165
  }
1730
3166
  export interface InsightPortfoliosRequest {
1731
3167
  /** (REQUIRED) */
@@ -1806,15 +3242,14 @@ export interface InsightQuoteFundamentalsSearchResponse {
1806
3242
  }
1807
3243
  export interface InsightQuoteHistoryRequest {
1808
3244
  /** Use ONLY one of the next filters: TimeRange OR Period */
1809
- filter?: InsightQuoteHistoryRequestFilter;
3245
+ filter: InsightQuoteHistoryRequestFilter;
1810
3246
  order?: InsightOrdering;
1811
3247
  paging?: InsightPaging;
1812
- /** Type of quote to load Enums(nbbo, delayed, cboe, bats, realtime, realtime_snapshot) (REQUIRED) */
1813
- quote_access_type?: string;
1814
3248
  }
1815
3249
  export interface InsightQuoteHistoryRequestFilter {
1816
3250
  period?: InsightPeriodFilter;
1817
- symbol?: string;
3251
+ /** @example "AAPL" */
3252
+ symbol: string;
1818
3253
  time_range?: InsightTimeRangeFilter;
1819
3254
  }
1820
3255
  export interface InsightQuoteHistoryResponse {
@@ -1835,11 +3270,13 @@ export interface InsightRatios {
1835
3270
  valuation: InsightValuation;
1836
3271
  }
1837
3272
  export interface InsightRecentIPOListRequest {
3273
+ /** @example true */
1838
3274
  load_quotes?: boolean;
1839
3275
  order?: InsightOrdering;
1840
- paging?: InsightPaging;
3276
+ paging: InsightPaging;
1841
3277
  quote_access_type?: string;
1842
- time?: string;
3278
+ /** @example "20y" */
3279
+ time: string;
1843
3280
  }
1844
3281
  export interface InsightRecentNewsPreviewsResponse {
1845
3282
  news: InsightNewsPreview[];
@@ -1852,20 +3289,28 @@ export interface InsightRemoveCustomIndexRequest {
1852
3289
  id?: string;
1853
3290
  }
1854
3291
  export interface InsightRemoveRewrittenFieldValueRequest {
3292
+ /** @example "Removed" */
1855
3293
  comment?: string;
1856
- field_id?: string;
1857
- internal_id?: string;
1858
- symbol?: string;
3294
+ /** @example "price" */
3295
+ field_id: string;
3296
+ /** @example "123e4567-e89b-12d3-a456-426614174000" */
3297
+ internal_id: string;
3298
+ /** @example "AAPL" */
3299
+ symbol: string;
1859
3300
  }
1860
3301
  export interface InsightRemoveScreenerPresetRequest {
1861
3302
  id?: string;
1862
3303
  }
1863
3304
  export interface InsightRewriteFieldValueRequest {
3305
+ /** @example "Updated" */
1864
3306
  comment?: string;
1865
- field_id?: string;
1866
- internal_id?: string;
1867
- new_value?: any;
1868
- symbol?: string;
3307
+ /** @example "price" */
3308
+ field_id: string;
3309
+ /** @example "123e4567-e89b-12d3-a456-426614174000" */
3310
+ internal_id: string;
3311
+ new_value: any;
3312
+ /** @example "AAPL" */
3313
+ symbol: string;
1869
3314
  }
1870
3315
  export interface InsightScreenerPreset {
1871
3316
  created_at: string;
@@ -1877,11 +3322,12 @@ export interface InsightScreenerPreset {
1877
3322
  updated_at: string;
1878
3323
  }
1879
3324
  export interface InsightSearchArticleRequest {
1880
- /** (REQUIRE) */
1881
- language?: string;
1882
- /** (REQUIRE) */
1883
- s?: string;
1884
- type?: InsightSearchArticleRequestTypeEnum;
3325
+ /** @example "eng" */
3326
+ language: string;
3327
+ /** @example "search term" */
3328
+ s: string;
3329
+ /** @example "all" */
3330
+ type: string;
1885
3331
  }
1886
3332
  export interface InsightSeasonalityEntry {
1887
3333
  april: InsightTickerSeasonality;
@@ -1899,10 +3345,20 @@ export interface InsightSeasonalityEntry {
1899
3345
  september: InsightTickerSeasonality;
1900
3346
  }
1901
3347
  export interface InsightSeasonalityRequest {
1902
- benchmark?: string;
1903
- lookahead?: number;
1904
- symbols?: string[];
1905
- years?: number;
3348
+ /** @example "A" */
3349
+ benchmark: string;
3350
+ /**
3351
+ * @min 1
3352
+ * @example 12
3353
+ */
3354
+ lookahead: number;
3355
+ /** @example ["AAPL","GOOGL"] */
3356
+ symbols: string[];
3357
+ /**
3358
+ * @min 1
3359
+ * @example 5
3360
+ */
3361
+ years: number;
1906
3362
  }
1907
3363
  export type InsightSeasonalityResponse = Record<string, InsightSeasonalityEntry>;
1908
3364
  export interface InsightSector {
@@ -1941,6 +3397,10 @@ export interface InsightSentiment {
1941
3397
  neutral: number;
1942
3398
  positive: number;
1943
3399
  }
3400
+ export interface InsightSetFeaturedArticlesRequest {
3401
+ /** @example ["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"] */
3402
+ ids: string[];
3403
+ }
1944
3404
  export interface InsightSignalData {
1945
3405
  based_on_num_hedge_funds: number;
1946
3406
  rating: string;
@@ -2022,8 +3482,8 @@ export interface InsightStockScreenerRequest {
2022
3482
  paging?: InsightPaging;
2023
3483
  pe_ratio?: InsightLessAndMore;
2024
3484
  price?: InsightLessAndMore;
2025
- quote_access_type?: string;
2026
3485
  sorts?: InsightOrdering[];
3486
+ /** @example "ADR" */
2027
3487
  stock_type?: string;
2028
3488
  volume?: InsightLessAndMore;
2029
3489
  }
@@ -2031,6 +3491,23 @@ export interface InsightStockScreenerResponse {
2031
3491
  count: number;
2032
3492
  details: InsightStockScreenerQuote[];
2033
3493
  }
3494
+ export interface InsightStockScreenerV2Request {
3495
+ average_volume_30d?: InsightLessAndMore;
3496
+ dividend_ex_date?: InsightBeforeAndAfter;
3497
+ dividend_pay_date?: InsightBeforeAndAfter;
3498
+ dividend_percent?: InsightLessAndMore;
3499
+ exchange?: InsightIncludeExclude;
3500
+ gap?: InsightLessAndMore;
3501
+ industry?: InsightIncludeExclude;
3502
+ market_cap?: InsightLessAndMore;
3503
+ pagination?: InsightPagination;
3504
+ pe_ratio?: InsightLessAndMore;
3505
+ price?: InsightLessAndMore;
3506
+ sorts?: InsightOrdering[];
3507
+ /** @example "ADR" */
3508
+ stock_type?: string;
3509
+ volume?: InsightLessAndMore;
3510
+ }
2034
3511
  export interface InsightStocksConsensusOverTimeRequest {
2035
3512
  /** "The intervals over which the consensus is given" */
2036
3513
  interval?: string;
@@ -2075,8 +3552,10 @@ export interface InsightSymbolIndustries {
2075
3552
  sub_industry: string;
2076
3553
  }
2077
3554
  export interface InsightSymbolLogoConvertedRequest {
2078
- conversion?: InsightSymbolLogoConvertedRequestConversionEnum;
2079
- symbol?: string;
3555
+ /** @example "normal" */
3556
+ conversion: InsightSymbolLogoConvertedRequestConversionEnum;
3557
+ /** @example "AAPL" */
3558
+ symbol: string;
2080
3559
  }
2081
3560
  export interface InsightSymbolLogosResponse {
2082
3561
  logo: string;
@@ -2135,10 +3614,16 @@ export interface InsightTickerSeasonality {
2135
3614
  yearly_data: InsightYearlyData[];
2136
3615
  }
2137
3616
  export interface InsightTimeRangeFilter {
2138
- /** Use unix timestamp in seconds */
2139
- end_time?: number;
2140
- /** Use unix timestamp in seconds */
2141
- start_time?: number;
3617
+ /**
3618
+ * Use unix timestamp in seconds
3619
+ * @example 1612137600
3620
+ */
3621
+ end_time: number;
3622
+ /**
3623
+ * Use unix timestamp in seconds
3624
+ * @example 1609459200
3625
+ */
3626
+ start_time: number;
2142
3627
  }
2143
3628
  export interface InsightTiprankQuote {
2144
3629
  ask_px: number;
@@ -2282,8 +3767,27 @@ export interface InsightUpdateCustomIndexRequest {
2282
3767
  name?: string;
2283
3768
  private_name?: string;
2284
3769
  }
2285
- export interface InsightUpsertSliderArticlesRequest {
2286
- slider_articles?: number[];
3770
+ export interface InsightUpdateFeaturedArticlesRequest {
3771
+ /** @example "123e4567-e89b-12d3-a456-426614174000" */
3772
+ id: string;
3773
+ /** @example "https://example.com/updated-image.jpg" */
3774
+ image: string;
3775
+ /** @example 1 */
3776
+ source_id: number;
3777
+ /** @example ["AAPL","GOOGL"] */
3778
+ symbols: string[];
3779
+ /** @example ["News","Update"] */
3780
+ tags: string[];
3781
+ /**
3782
+ * @maxLength 1000
3783
+ * @example "This is an updated teaser for the news"
3784
+ */
3785
+ teaser: string;
3786
+ /**
3787
+ * @maxLength 1000
3788
+ * @example "Updated News Title"
3789
+ */
3790
+ title: string;
2287
3791
  }
2288
3792
  export interface InsightUsageDataEntry {
2289
3793
  branch_code: string;
@@ -2370,10 +3874,17 @@ export interface InsightEquityDataResponse {
2370
3874
  volume: number;
2371
3875
  yest_close_px: number;
2372
3876
  }
2373
- export enum InsightArticlesRequestTypeEnum {
2374
- Education = "education",
2375
- NonEducation = "non-education"
3877
+ /** @example "c" */
3878
+ export enum InsightCalculateMatrixParamsRequestOptionTypeEnum {
3879
+ C = "c",
3880
+ P = "p"
3881
+ }
3882
+ /** @example "c" */
3883
+ export enum InsightCalculateParamsRequestOptionTypeEnum {
3884
+ C = "c",
3885
+ P = "p"
2376
3886
  }
3887
+ /** @example "normal" */
2377
3888
  export enum InsightCryptoLogoConvertedRequestConversionEnum {
2378
3889
  Original = "original",
2379
3890
  Default = "default",
@@ -2384,38 +3895,77 @@ export enum InsightCryptoLogoConvertedRequestConversionEnum {
2384
3895
  SquareStrictOrNormal = "square_strict_or_normal",
2385
3896
  BestMatch = "best_match"
2386
3897
  }
2387
- export enum InsightMostPopularTagsRequestTimeEnum {
2388
- Week = "week",
2389
- Month = "month",
2390
- Year = "year"
3898
+ /** @example "LEVERAGE_I" */
3899
+ export enum InsightGetFundsForHoldingRequestLeverageEnum {
3900
+ ANY = "ANY",
3901
+ LEVERAGE_I = "LEVERAGE_I",
3902
+ LEVERAGE_II = "LEVERAGE_II",
3903
+ LEVERAGE_III = "LEVERAGE_III"
2391
3904
  }
2392
- /** (REQUIRE) */
2393
- export enum InsightMostPopularTagsRequestTypeEnum {
2394
- Symbol = "symbol",
2395
- Primary = "primary",
2396
- Tags = "tags"
2397
- }
2398
- export enum InsightNewsfeedRequestTypeEnum {
2399
- Education = "education",
2400
- NonEducation = "non-education"
3905
+ /** @example "institutional" */
3906
+ export enum InsightGetOwnershipsBySymbolRequestOwnerTypeEnum {
3907
+ All = "all",
3908
+ Institutional = "institutional",
3909
+ Fund = "fund",
3910
+ Insider = "insider"
2401
3911
  }
2402
- /** @default "asc" */
3912
+ /** @example "institutional" */
3913
+ export enum InsightGetOwnershipsBySymbolWithoutSearchQueryRequestOwnerTypeEnum {
3914
+ All = "all",
3915
+ Institutional = "institutional",
3916
+ Fund = "fund",
3917
+ Insider = "insider"
3918
+ }
3919
+ /** @example "annual" */
3920
+ export enum InsightGetSymbolFundamentalsRequestModeEnum {
3921
+ Annual = "annual",
3922
+ Quarterly = "quarterly"
3923
+ }
3924
+ /** @example "ETF" */
3925
+ export enum InsightGetTopFundsRequestFundTypeEnum {
3926
+ ANY = "ANY",
3927
+ ETF = "ETF",
3928
+ MF = "MF"
3929
+ }
3930
+ /** @example "ANY" */
3931
+ export enum InsightGetTopFundsRequestInverseEnum {
3932
+ ANY = "ANY",
3933
+ SHORT = "SHORT",
3934
+ LONG = "LONG"
3935
+ }
3936
+ /** @example "LEVERAGE_I" */
3937
+ export enum InsightGetTopFundsRequestLeverageEnum {
3938
+ ANY = "ANY",
3939
+ LEVERAGE_I = "LEVERAGE_I",
3940
+ LEVERAGE_II = "LEVERAGE_II",
3941
+ LEVERAGE_III = "LEVERAGE_III"
3942
+ }
3943
+ /** @example "MIDDLEWARE" */
3944
+ export enum InsightGetUsageDataRequestSourceEnum {
3945
+ USER_MANAGEMENT = "USER_MANAGEMENT",
3946
+ MIDDLEWARE = "MIDDLEWARE"
3947
+ }
3948
+ /** @example "daily" */
3949
+ export enum InsightMomentumRatioGraphRequestModeEnum {
3950
+ Daily = "daily",
3951
+ Weekly = "weekly"
3952
+ }
3953
+ /**
3954
+ * @default "asc"
3955
+ * @example "asc"
3956
+ */
2403
3957
  export enum InsightOrderingDirectionEnum {
2404
3958
  Asc = "asc",
2405
3959
  Desc = "desc"
2406
3960
  }
3961
+ /** @example "day" */
2407
3962
  export enum InsightPeriodFilterTypeEnum {
2408
3963
  Day = "day",
2409
3964
  Week = "week",
2410
3965
  Month = "month",
2411
3966
  Year = "year"
2412
3967
  }
2413
- export enum InsightSearchArticleRequestTypeEnum {
2414
- All = "all",
2415
- Tag = "tag",
2416
- Primary = "primary",
2417
- Symbol = "symbol"
2418
- }
3968
+ /** @example "normal" */
2419
3969
  export enum InsightSymbolLogoConvertedRequestConversionEnum {
2420
3970
  Original = "original",
2421
3971
  Default = "default",
@@ -2547,14 +4097,23 @@ export class CustomLists<HandleError extends boolean = boolean> {
2547
4097
  */
2548
4098
  removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2549
4099
  /**
2550
- * @description get custom list
4100
+ * @description filter custom lists
4101
+ * @tags Custom Lists
4102
+ * @name FilterCustomLists
4103
+ * @summary filter custom lists
4104
+ * @request POST:/custom-lists/filter
4105
+ * @secure
4106
+ */
4107
+ filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
4108
+ /**
4109
+ * @description get custom list with quotes
2551
4110
  * @tags Custom Lists
2552
- * @name GetCustomList
2553
- * @summary get custom list
2554
- * @request GET:/custom-lists/:id
4111
+ * @name GetCustomListWithQuotes
4112
+ * @summary get custom list with quotes
4113
+ * @request GET:/custom-lists/{id-or-slug}
2555
4114
  * @secure
2556
4115
  */
2557
- getCustomList(id: string, query: {
4116
+ getCustomListWithQuotes(idOrSlug: string, query: {
2558
4117
  /** sort direction - asc or desc */
2559
4118
  order_direction: string;
2560
4119
  /** sort field - volume, symbol(alphabetical), market_cap, dividend_percent */
@@ -2564,6 +4123,18 @@ export class CustomLists<HandleError extends boolean = boolean> {
2564
4123
  /** how many equities records to skip */
2565
4124
  offset: number;
2566
4125
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
4126
+ /**
4127
+ * @description filter custom list
4128
+ * @tags Custom Lists
4129
+ * @name FilterCustomList
4130
+ * @summary filter custom list
4131
+ * @request GET:/custom-lists/{id-or-slug}/filter
4132
+ * @secure
4133
+ */
4134
+ filterCustomList(idOrSlug: string, query?: {
4135
+ /** symbols to check inclusion */
4136
+ symbols?: string[];
4137
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
2567
4138
  }
2568
4139
  export class Dashboard<HandleError extends boolean = boolean> {
2569
4140
  protected readonly apiClient: JwtClient<HandleError>;
@@ -2664,7 +4235,7 @@ export class FixedIncome<HandleError extends boolean = boolean> {
2664
4235
  * @request POST:/fixed-income
2665
4236
  * @secure
2666
4237
  */
2667
- getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponse, HandleError>>;
4238
+ getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponse, HandleError>>;
2668
4239
  /**
2669
4240
  * @description Returns historical fixed income
2670
4241
  * @tags FixedIncome
@@ -2801,47 +4372,66 @@ export interface InsightFixedIncomeV2 {
2801
4372
  type: string;
2802
4373
  updated_at: string;
2803
4374
  }
4375
+ export interface InsightGetFixedIncomeEntriesResponseV2 {
4376
+ count: number;
4377
+ data: InsightFixedIncomeV2[];
4378
+ }
2804
4379
  export interface InsightGetFixedIncomeEntriesRequestV2 {
4380
+ /** @example true */
2805
4381
  bank_qualified?: boolean;
4382
+ /** @example true */
2806
4383
  callable?: boolean;
4384
+ /** @example true */
2807
4385
  convertible?: boolean;
4386
+ /** @example ["USA"] */
2808
4387
  country_codes?: string[];
2809
4388
  coupon?: InsightLessAndMoreV2;
4389
+ /** @example ["quarterly","zero"] */
2810
4390
  coupon_frequencies?: string[];
4391
+ /** @example ["655664AH3","9128286R6"] */
2811
4392
  cusip?: string[];
4393
+ /**
4394
+ * @maxLength 100
4395
+ * @example "Donald's"
4396
+ */
2812
4397
  description?: string;
4398
+ /** @example true */
2813
4399
  has_ticker?: boolean;
4400
+ /** @example true */
2814
4401
  insured?: boolean;
4402
+ /** @example ["US655664AH33","US9128286R69"] */
2815
4403
  isin?: string[];
2816
4404
  issue_date?: InsightBeforeAndAfterV2;
4405
+ /**
4406
+ * @maxLength 100
4407
+ * @example "Donald's"
4408
+ */
2817
4409
  issuer?: string;
2818
4410
  maturity?: InsightBeforeAndAfterV2;
4411
+ /** @example ["NY"] */
2819
4412
  municipal_states?: string[];
4413
+ /** @example true */
2820
4414
  municipal_tax?: boolean;
4415
+ /** @example ["general_obligation"] */
2821
4416
  municipal_types?: string[];
2822
- order?: InsightOrderingV2;
2823
- pagination?: InsightPaginationV2;
2824
- paging?: InsightPagingV2;
4417
+ pagination: InsightPaginationV2;
2825
4418
  purposes?: string[];
4419
+ /** @example ["SOVEREIGN"] */
2826
4420
  sectors?: string[];
2827
4421
  sorts?: InsightOrderingV2[];
4422
+ /** @example ["AAA"] */
2828
4423
  sp_ratings?: string[];
4424
+ /** @example ["called","outstanding"] */
2829
4425
  statuses?: string[];
2830
4426
  tickers?: string[];
4427
+ /** @example ["corporate"] */
2831
4428
  types?: string[];
2832
4429
  }
2833
- export interface InsightGetFixedIncomeEntriesResponseV2 {
2834
- count: number;
2835
- data: InsightFixedIncomeV2[];
2836
- }
2837
4430
  export interface InsightGetTopSymbolsRequestV2 {
2838
4431
  exchange?: string[];
2839
4432
  market_cap?: InsightLessAndMoreV2;
2840
- order?: InsightOrderingV2;
2841
4433
  pagination?: InsightPaginationV2;
2842
- paging?: InsightPagingV2;
2843
4434
  price?: InsightLessAndMoreV2;
2844
- quote_access_type?: string;
2845
4435
  sorts?: InsightOrderingV2[];
2846
4436
  volume?: InsightLessAndMoreV2;
2847
4437
  }
@@ -2854,23 +4444,32 @@ export interface InsightLessAndMoreV2 {
2854
4444
  more_than?: number;
2855
4445
  }
2856
4446
  export interface InsightOrderingV2 {
2857
- /** @default "asc" */
4447
+ /**
4448
+ * @default "asc"
4449
+ * @example "asc"
4450
+ */
2858
4451
  direction: InsightOrderingDirectionEnumV2;
2859
4452
  /**
2860
4453
  * Sort direction:
2861
4454
  * * asc - Ascending, from A to Z.
2862
4455
  * * desc - Descending, from Z to A.
4456
+ * @example "name"
2863
4457
  */
2864
4458
  field: string;
2865
4459
  }
2866
4460
  export interface InsightPaginationV2 {
4461
+ /**
4462
+ * @min 1
4463
+ * @example 1
4464
+ */
2867
4465
  page: number;
4466
+ /**
4467
+ * @min 1
4468
+ * @max 50
4469
+ * @example 10
4470
+ */
2868
4471
  size: number;
2869
4472
  }
2870
- export interface InsightPagingV2 {
2871
- limit: number;
2872
- offset: number;
2873
- }
2874
4473
  export interface InsightStockScreenerQuoteV2 {
2875
4474
  average_volume_30d: number;
2876
4475
  company_name: string;
@@ -2899,13 +4498,11 @@ export interface InsightStockScreenerRequestV2 {
2899
4498
  gap?: InsightLessAndMoreV2;
2900
4499
  industry?: InsightIncludeExcludeV2;
2901
4500
  market_cap?: InsightLessAndMoreV2;
2902
- order?: InsightOrderingV2;
2903
4501
  pagination?: InsightPaginationV2;
2904
- paging?: InsightPagingV2;
2905
4502
  pe_ratio?: InsightLessAndMoreV2;
2906
4503
  price?: InsightLessAndMoreV2;
2907
- quote_access_type?: string;
2908
4504
  sorts?: InsightOrderingV2[];
4505
+ /** @example "ADR" */
2909
4506
  stock_type?: string;
2910
4507
  volume?: InsightLessAndMoreV2;
2911
4508
  }
@@ -2916,7 +4513,10 @@ export interface InsightStockScreenerResponseV2 {
2916
4513
  status: number;
2917
4514
  total_records: number;
2918
4515
  }
2919
- /** @default "asc" */
4516
+ /**
4517
+ * @default "asc"
4518
+ * @example "asc"
4519
+ */
2920
4520
  export enum InsightOrderingDirectionEnumV2 {
2921
4521
  Asc = "asc",
2922
4522
  Desc = "desc"
@@ -2945,7 +4545,7 @@ export class Fundamentals<HandleError extends boolean = boolean> {
2945
4545
  * @request POST:/fundamentals
2946
4546
  * @secure
2947
4547
  */
2948
- getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsResponse, HandleError>>;
4548
+ getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
2949
4549
  }
2950
4550
  export class Funds<HandleError extends boolean = boolean> {
2951
4551
  protected readonly apiClient: JwtClient<HandleError>;
@@ -3060,19 +4660,6 @@ export class Ipos<HandleError extends boolean = boolean> {
3060
4660
  offset: number;
3061
4661
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
3062
4662
  }
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
4663
  export class Logos<HandleError extends boolean = boolean> {
3077
4664
  protected readonly apiClient: JwtClient<HandleError>;
3078
4665
  constructor(apiClient: JwtClient<HandleError>);
@@ -3219,6 +4806,69 @@ export class News<HandleError extends boolean = boolean> {
3219
4806
  * @secure
3220
4807
  */
3221
4808
  newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
4809
+ /**
4810
+ * @description Get featured articles
4811
+ * @tags News
4812
+ * @name GetFeaturedArticles
4813
+ * @summary Get featured articles
4814
+ * @request GET:/news/featured-articles
4815
+ * @secure
4816
+ */
4817
+ getFeaturedArticles(query: {
4818
+ /** Limit */
4819
+ limit: number;
4820
+ /** Offset */
4821
+ offset: number;
4822
+ /** Start date */
4823
+ start_date?: string;
4824
+ /** End date */
4825
+ end_date?: string;
4826
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
4827
+ /**
4828
+ * @description Update featured articles
4829
+ * @tags News
4830
+ * @name UpdateFeaturedArticles
4831
+ * @summary Update featured articles
4832
+ * @request PUT:/news/featured-articles
4833
+ * @secure
4834
+ */
4835
+ updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4836
+ /**
4837
+ * @description Create featured articles
4838
+ * @tags News
4839
+ * @name CreateFeaturedArticles
4840
+ * @summary Create featured articles
4841
+ * @request POST:/news/featured-articles
4842
+ * @secure
4843
+ */
4844
+ createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4845
+ /**
4846
+ * @description Get active featured articles
4847
+ * @tags News
4848
+ * @name GetActiveFeaturedArticles
4849
+ * @summary Get active featured articles
4850
+ * @request GET:/news/featured-articles/active
4851
+ * @secure
4852
+ */
4853
+ getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
4854
+ /**
4855
+ * @description Set featured articles
4856
+ * @tags News
4857
+ * @name SetFeaturedArticles
4858
+ * @summary Set featured articles
4859
+ * @request POST:/news/featured-articles/set
4860
+ * @secure
4861
+ */
4862
+ setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4863
+ /**
4864
+ * @description Get featured article
4865
+ * @tags News
4866
+ * @name GetFeaturedArticle
4867
+ * @summary Get featured article
4868
+ * @request GET:/news/featured-articles/{id}
4869
+ * @secure
4870
+ */
4871
+ getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
3222
4872
  /**
3223
4873
  * @description Returns news by filters
3224
4874
  * @tags News
@@ -3377,22 +5027,6 @@ export class Passport<HandleError extends boolean = boolean> {
3377
5027
  * @secure
3378
5028
  */
3379
5029
  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
5030
  }
3397
5031
  export class Public<HandleError extends boolean = boolean> {
3398
5032
  protected readonly apiClient: JwtClient<HandleError>;
@@ -3436,9 +5070,9 @@ export class Public<HandleError extends boolean = boolean> {
3436
5070
  * @secure
3437
5071
  */
3438
5072
  getPublicFundamentalsBySymbolData(symbol: string, query: {
3439
- /** Annual or year */
5073
+ /** Annual or quarterly */
3440
5074
  mode: string;
3441
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsResponse, HandleError>>;
5075
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
3442
5076
  /**
3443
5077
  * @description Daily price history
3444
5078
  * @tags Public
@@ -3557,8 +5191,6 @@ export class Quotes<HandleError extends boolean = boolean> {
3557
5191
  getQuotesEquityData(query: {
3558
5192
  /** Comma separated symbols */
3559
5193
  symbols: string;
3560
- /** NBBO || DELAYED || CBOE || CBOE1 || BATS || REALTIME || REALTIME_SNAPSHOT */
3561
- quote_access_type: string;
3562
5194
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
3563
5195
  }
3564
5196
  export class StockScreener<HandleError extends boolean = boolean> {
@@ -3572,14 +5204,9 @@ export class StockScreener<HandleError extends boolean = boolean> {
3572
5204
  * @request GET:/heatmaps
3573
5205
  * @secure
3574
5206
  */
3575
- stockMarketHeatmap(query: {
5207
+ stockMarketHeatmap(query?: {
3576
5208
  /** Name of symbol list to fetch details for. Empty is default */
3577
5209
  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
5210
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
3584
5211
  /**
3585
5212
  * @description create or update heat map preset
@@ -3607,7 +5234,7 @@ export class StockScreener<HandleError extends boolean = boolean> {
3607
5234
  * @request POST:/stock-screener
3608
5235
  * @secure
3609
5236
  */
3610
- stockScreener(filter: InsightStockScreenerRequest, headers?: {
5237
+ stockScreener(filter: InsightStockScreenerV2Request, headers?: {
3611
5238
  /** Authorization */
3612
5239
  Authorization?: string;
3613
5240
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
@@ -3660,7 +5287,7 @@ export class StockScreener<HandleError extends boolean = boolean> {
3660
5287
  * @request POST:/stock-screener/top
3661
5288
  * @secure
3662
5289
  */
3663
- getTopSymbols(input: InsightGetTopSymbolsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5290
+ getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
3664
5291
  }
3665
5292
  export class StockScreenerV2<HandleError extends boolean = boolean> {
3666
5293
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4169,8 +5796,6 @@ export class WorldMarkets<HandleError extends boolean = boolean> {
4169
5796
  offset: number;
4170
5797
  /** Continent code for filtering */
4171
5798
  continent?: string;
4172
- /** Quote type for price fetch */
4173
- quote_access_type?: string;
4174
5799
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
4175
5800
  /**
4176
5801
  * @description Edit global index
@@ -4258,7 +5883,6 @@ export class InsightApi<HandleError extends boolean = false> extends BaseApi<Han
4258
5883
  fund: Funds<HandleError>;
4259
5884
  intraday: Intraday<HandleError>;
4260
5885
  ipos: Ipos<HandleError>;
4261
- lists: Lists<HandleError>;
4262
5886
  logos: Logos<HandleError>;
4263
5887
  marketDates: MarketDates<HandleError>;
4264
5888
  news: News<HandleError>;