@orbis-systems/orbis-api-clients 0.2.1 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1359,8 +1359,8 @@ export interface InsightLatestAnalystRatingsOnStockResponse {
1359
1359
  url: string;
1360
1360
  }
1361
1361
  export interface InsightLessAndMore {
1362
- less_than: number;
1363
- more_than: number;
1362
+ less_than?: number;
1363
+ more_than?: number;
1364
1364
  }
1365
1365
  export interface InsightLiabilities {
1366
1366
  debt_ratio: number;
@@ -2332,6 +2332,28 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
2332
2332
  Date = "date",
2333
2333
  Rank = "rank"
2334
2334
  }
2335
+ export class AlphaTools<HandleError extends boolean = boolean> {
2336
+ protected readonly apiClient: JwtClient<HandleError>;
2337
+ constructor(apiClient: JwtClient<HandleError>);
2338
+ /**
2339
+ * @description get seasonlity data with comparison to benchmark
2340
+ * @tags AlphaTools
2341
+ * @name GetMomentumRatioGraph
2342
+ * @summary get seasonlity data
2343
+ * @request POST:/rst
2344
+ * @secure
2345
+ */
2346
+ getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
2347
+ /**
2348
+ * @description get seasonlity data with comparison to benchmark
2349
+ * @tags AlphaTools
2350
+ * @name GetSeasonality
2351
+ * @summary get seasonlity data
2352
+ * @request POST:/seasonality
2353
+ * @secure
2354
+ */
2355
+ getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
2356
+ }
2335
2357
  export class CompanyProfile<HandleError extends boolean = boolean> {
2336
2358
  protected readonly apiClient: JwtClient<HandleError>;
2337
2359
  constructor(apiClient: JwtClient<HandleError>);
@@ -2371,190 +2393,6 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
2371
2393
  */
2372
2394
  getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
2373
2395
  }
2374
- export class WorldMarkets<HandleError extends boolean = boolean> {
2375
- protected readonly apiClient: JwtClient<HandleError>;
2376
- constructor(apiClient: JwtClient<HandleError>);
2377
- /**
2378
- * @description Get continents
2379
- * @tags World Markets
2380
- * @name ContinentGet
2381
- * @summary Get continents
2382
- * @request GET:/continents
2383
- * @secure
2384
- */
2385
- continentGet(query: {
2386
- /** Query limit */
2387
- limit: number;
2388
- /** Query offset */
2389
- offset: number;
2390
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
2391
- /**
2392
- * @description Edit continent
2393
- * @tags World Markets
2394
- * @name ContinentEdit
2395
- * @summary Edit continent
2396
- * @request PUT:/continents
2397
- * @secure
2398
- */
2399
- continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2400
- /**
2401
- * @description Create continents
2402
- * @tags World Markets
2403
- * @name ContinentCreate
2404
- * @summary Create continents
2405
- * @request POST:/continents
2406
- * @secure
2407
- */
2408
- continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
2409
- /**
2410
- * @description Delete continent
2411
- * @tags World Markets
2412
- * @name ContinentDelete
2413
- * @summary Delete continent
2414
- * @request DELETE:/continents
2415
- * @secure
2416
- */
2417
- continentDelete(query: {
2418
- /** continent id */
2419
- id: string;
2420
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2421
- /**
2422
- * @description Get country codes
2423
- * @tags World Markets
2424
- * @name CountryCodeGet
2425
- * @summary Get country codes
2426
- * @request GET:/country-codes
2427
- * @secure
2428
- */
2429
- countryCodeGet(query: {
2430
- /** Query limit */
2431
- limit: number;
2432
- /** Query offset */
2433
- offset: number;
2434
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
2435
- /**
2436
- * @description Edit country code
2437
- * @tags World Markets
2438
- * @name CountryCodeEdit
2439
- * @summary Edit country code
2440
- * @request PUT:/country-codes
2441
- * @secure
2442
- */
2443
- countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2444
- /**
2445
- * @description Add country codes
2446
- * @tags World Markets
2447
- * @name CountryCodeAdd
2448
- * @summary Add country codes
2449
- * @request POST:/country-codes
2450
- * @secure
2451
- */
2452
- countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
2453
- /**
2454
- * @description Delete country code
2455
- * @tags World Markets
2456
- * @name CountryCodeDelete
2457
- * @summary Delete country code
2458
- * @request DELETE:/country-codes
2459
- * @secure
2460
- */
2461
- countryCodeDelete(query: {
2462
- /** a3 code */
2463
- a3code: string;
2464
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2465
- /**
2466
- * @description Get global indexes
2467
- * @tags World Markets
2468
- * @name GlobalIndexGet
2469
- * @summary Get global indexes
2470
- * @request GET:/global-indexes
2471
- * @secure
2472
- */
2473
- globalIndexGet(query: {
2474
- /** Query limit */
2475
- limit: number;
2476
- /** Query offset */
2477
- offset: number;
2478
- /** Continent code for filtering */
2479
- continent?: string;
2480
- /** Quote type for price fetch */
2481
- quote_access_type?: string;
2482
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
2483
- /**
2484
- * @description Edit global index
2485
- * @tags World Markets
2486
- * @name GlobalIndexEdit
2487
- * @summary Edit global index
2488
- * @request PUT:/global-indexes
2489
- * @secure
2490
- */
2491
- globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2492
- /**
2493
- * @description Add global indexes
2494
- * @tags World Markets
2495
- * @name GlobalIndexAdd
2496
- * @summary Add global indexes
2497
- * @request POST:/global-indexes
2498
- * @secure
2499
- */
2500
- globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
2501
- /**
2502
- * @description Edit global index
2503
- * @tags World Markets
2504
- * @name GlobalIndexDelete
2505
- * @summary Delete global index
2506
- * @request DELETE:/global-indexes
2507
- * @secure
2508
- */
2509
- globalIndexDelete(query: {
2510
- /** a3 code */
2511
- a3code: string;
2512
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2513
- /**
2514
- * @description Get regions
2515
- * @tags World Markets
2516
- * @name RegionGet
2517
- * @summary Get regions
2518
- * @request GET:/regions
2519
- * @secure
2520
- */
2521
- regionGet(query: {
2522
- /** Query limit */
2523
- limit: number;
2524
- /** Query offset */
2525
- offset: number;
2526
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
2527
- /**
2528
- * @description Edit region
2529
- * @tags World Markets
2530
- * @name RegionEdit
2531
- * @summary Edit region
2532
- * @request PUT:/regions
2533
- * @secure
2534
- */
2535
- regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2536
- /**
2537
- * @description Create regions
2538
- * @tags World Markets
2539
- * @name RegionCreate
2540
- * @summary Create regions
2541
- * @request POST:/regions
2542
- * @secure
2543
- */
2544
- regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
2545
- /**
2546
- * @description Delete region
2547
- * @tags World Markets
2548
- * @name RegionDelete
2549
- * @summary Delete region
2550
- * @request DELETE:/regions
2551
- * @secure
2552
- */
2553
- regionDelete(query: {
2554
- /** region id */
2555
- id: string;
2556
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2557
- }
2558
2396
  export class CustomLists<HandleError extends boolean = boolean> {
2559
2397
  protected readonly apiClient: JwtClient<HandleError>;
2560
2398
  constructor(apiClient: JwtClient<HandleError>);
@@ -2618,19 +2456,6 @@ export class CustomLists<HandleError extends boolean = boolean> {
2618
2456
  offset: number;
2619
2457
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
2620
2458
  }
2621
- export class Lists<HandleError extends boolean = boolean> {
2622
- protected readonly apiClient: JwtClient<HandleError>;
2623
- constructor(apiClient: JwtClient<HandleError>);
2624
- /**
2625
- * @description filter custom lists
2626
- * @tags lists
2627
- * @name FilterCustomLists
2628
- * @summary filter custom lists
2629
- * @request POST:/custom-lists/filter
2630
- * @secure
2631
- */
2632
- filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
2633
- }
2634
2459
  export class Dashboard<HandleError extends boolean = boolean> {
2635
2460
  protected readonly apiClient: JwtClient<HandleError>;
2636
2461
  constructor(apiClient: JwtClient<HandleError>);
@@ -2790,40 +2615,256 @@ export class FixedIncome<HandleError extends boolean = boolean> {
2790
2615
  */
2791
2616
  getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
2792
2617
  }
2793
- export class Fundamentals<HandleError extends boolean = boolean> {
2794
- protected readonly apiClient: JwtClient<HandleError>;
2795
- constructor(apiClient: JwtClient<HandleError>);
2796
- /**
2797
- * @description get fundamentals by symbol data
2798
- * @tags Fundamentals
2799
- * @name GetFundamentalsBySymbolData
2800
- * @summary get fundamentals by symbol data
2801
- * @request POST:/fundamentals
2802
- * @secure
2803
- */
2804
- getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsResponse, HandleError>>;
2618
+ export interface InsightStockMarketHeatmapEntryV2 {
2619
+ price_change_percent: number;
2620
+ symbol: string;
2621
+ title: string;
2805
2622
  }
2806
- export class Funds<HandleError extends boolean = boolean> {
2807
- protected readonly apiClient: JwtClient<HandleError>;
2808
- constructor(apiClient: JwtClient<HandleError>);
2809
- /**
2810
- * @description get fund details
2811
- * @tags Funds
2812
- * @name GetFundDetails
2813
- * @summary get fund details
2814
- * @request GET:/funds/details
2815
- * @secure
2816
- */
2817
- getFundDetails(query: {
2818
- /** Fund symbol */
2819
- symbol: string;
2820
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError>>;
2821
- /**
2822
- * @description get funds for holding
2823
- * @tags Funds
2824
- * @name GetFundsForHolding
2825
- * @summary get funds for holding
2826
- * @request POST:/funds/funds-for-holding
2623
+ export interface InsightBeforeAndAfterV2 {
2624
+ after: string;
2625
+ before: string;
2626
+ }
2627
+ export interface InsightFixedIncomeV2 {
2628
+ a144: boolean;
2629
+ accrued_interest: number;
2630
+ bank_qualified: boolean;
2631
+ bond_warrant: boolean;
2632
+ call_type: string;
2633
+ callable: boolean;
2634
+ close_price: number;
2635
+ close_price_asof: string;
2636
+ close_ytw: number;
2637
+ convertible: boolean;
2638
+ country: string;
2639
+ country_code: string;
2640
+ country_domicile: string;
2641
+ country_issue: string;
2642
+ coupon: number;
2643
+ coupon_frequency: string;
2644
+ coupon_type: string;
2645
+ currency: string;
2646
+ cusip: string;
2647
+ dated_date: string;
2648
+ daycount: string;
2649
+ description: string;
2650
+ description_short: string;
2651
+ duration: number;
2652
+ first_coupon_date: string;
2653
+ insured: boolean;
2654
+ isin: string;
2655
+ issue_date: string;
2656
+ issue_minimum_denomination: number;
2657
+ issue_price: number;
2658
+ issue_size: number;
2659
+ issuer: string;
2660
+ last_coupon_date: string;
2661
+ liquidity_institutional_aggregate: number;
2662
+ liquidity_institutional_buy: number;
2663
+ liquidity_institutional_sell: number;
2664
+ liquidity_micro_aggregate: number;
2665
+ liquidity_micro_buy: number;
2666
+ liquidity_micro_sell: number;
2667
+ liquidity_retail_aggregate: number;
2668
+ liquidity_retail_buy: number;
2669
+ liquidity_retail_sell: number;
2670
+ maturity_date: string;
2671
+ municipal_state: string;
2672
+ municipal_taxable_federal: boolean;
2673
+ municipal_type: string;
2674
+ next_call_date: string;
2675
+ next_call_price: number;
2676
+ next_coupon_date: string;
2677
+ par_value: number;
2678
+ perpetual: boolean;
2679
+ private_placement: boolean;
2680
+ purpose: string;
2681
+ puttable: boolean;
2682
+ reg_s: boolean;
2683
+ sector: string;
2684
+ seniority: string;
2685
+ settlement_convention: string;
2686
+ sinking_fund: boolean;
2687
+ sp_creditwatch: string;
2688
+ sp_creditwatch_date: string;
2689
+ sp_outlook: string;
2690
+ sp_outlook_date: string;
2691
+ sp_rating: string;
2692
+ sp_rating_date: string;
2693
+ status: string;
2694
+ ticker: string;
2695
+ treasury_subtype: string;
2696
+ type: string;
2697
+ updated_at: string;
2698
+ }
2699
+ export interface InsightGetFixedIncomeEntriesRequestV2 {
2700
+ bank_qualified?: boolean;
2701
+ callable?: boolean;
2702
+ convertible?: boolean;
2703
+ country_codes?: string[];
2704
+ coupon?: InsightLessAndMoreV2;
2705
+ coupon_frequencies?: string[];
2706
+ cusip?: string[];
2707
+ description?: string;
2708
+ has_ticker?: boolean;
2709
+ insured?: boolean;
2710
+ isin?: string[];
2711
+ issue_date?: InsightBeforeAndAfterV2;
2712
+ issuer?: string;
2713
+ maturity?: InsightBeforeAndAfterV2;
2714
+ municipal_states?: string[];
2715
+ municipal_tax?: boolean;
2716
+ municipal_types?: string[];
2717
+ order?: InsightOrderingV2;
2718
+ pagination?: InsightPaginationV2;
2719
+ paging?: InsightPagingV2;
2720
+ purposes?: string[];
2721
+ sectors?: string[];
2722
+ sorts?: InsightOrderingV2[];
2723
+ sp_ratings?: string[];
2724
+ statuses?: string[];
2725
+ tickers?: string[];
2726
+ types?: string[];
2727
+ }
2728
+ export interface InsightGetFixedIncomeEntriesResponseV2 {
2729
+ count: number;
2730
+ data: InsightFixedIncomeV2[];
2731
+ }
2732
+ export interface InsightGetTopSymbolsRequestV2 {
2733
+ exchange?: string[];
2734
+ market_cap?: InsightLessAndMoreV2;
2735
+ order?: InsightOrderingV2;
2736
+ pagination?: InsightPaginationV2;
2737
+ paging?: InsightPagingV2;
2738
+ price?: InsightLessAndMoreV2;
2739
+ quote_access_type?: string;
2740
+ sorts?: InsightOrderingV2[];
2741
+ volume?: InsightLessAndMoreV2;
2742
+ }
2743
+ export interface InsightIncludeExcludeV2 {
2744
+ exclude: string[];
2745
+ include: string[];
2746
+ }
2747
+ export interface InsightLessAndMoreV2 {
2748
+ less_than?: number;
2749
+ more_than?: number;
2750
+ }
2751
+ export interface InsightOrderingV2 {
2752
+ /** @default "asc" */
2753
+ direction: InsightOrderingV2DirectionEnumV2;
2754
+ /**
2755
+ * Sort direction:
2756
+ * * asc - Ascending, from A to Z.
2757
+ * * desc - Descending, from Z to A.
2758
+ */
2759
+ field: string;
2760
+ }
2761
+ export interface InsightPaginationV2 {
2762
+ page: number;
2763
+ size: number;
2764
+ }
2765
+ export interface InsightPagingV2 {
2766
+ limit: number;
2767
+ offset: number;
2768
+ }
2769
+ export interface InsightStockMarketHeatmapResponseV2 {
2770
+ details: InsightStockMarketHeatmapEntryV2[];
2771
+ max_change: number;
2772
+ min_change: number;
2773
+ }
2774
+ export interface InsightStockScreenerQuoteV2 {
2775
+ average_volume_30d: number;
2776
+ company_name: string;
2777
+ dividend_ex_date: string;
2778
+ dividend_pay_date: string;
2779
+ dividend_percent: number;
2780
+ exchange: string;
2781
+ exchange_name: string;
2782
+ gap: number;
2783
+ industry: string;
2784
+ industry_code: string;
2785
+ last_price: number;
2786
+ market_cap: number;
2787
+ pe_ratio: number;
2788
+ price_change: number;
2789
+ price_change_percent: number;
2790
+ symbol: string;
2791
+ volume: number;
2792
+ }
2793
+ export interface InsightStockScreenerRequestV2 {
2794
+ average_volume_30d?: InsightLessAndMoreV2;
2795
+ dividend_ex_date?: InsightBeforeAndAfterV2;
2796
+ dividend_pay_date?: InsightBeforeAndAfterV2;
2797
+ dividend_percent?: InsightLessAndMoreV2;
2798
+ exchange?: InsightIncludeExcludeV2;
2799
+ gap?: InsightLessAndMoreV2;
2800
+ industry?: InsightIncludeExcludeV2;
2801
+ market_cap?: InsightLessAndMoreV2;
2802
+ order?: InsightOrderingV2;
2803
+ pagination?: InsightPaginationV2;
2804
+ paging?: InsightPagingV2;
2805
+ pe_ratio?: InsightLessAndMoreV2;
2806
+ price?: InsightLessAndMoreV2;
2807
+ quote_access_type?: string;
2808
+ sorts?: InsightOrderingV2[];
2809
+ stock_type?: string;
2810
+ volume?: InsightLessAndMoreV2;
2811
+ }
2812
+ export interface InsightStockScreenerResponseV2 {
2813
+ count: number;
2814
+ details: InsightStockScreenerQuoteV2[];
2815
+ }
2816
+ /** @default "asc" */
2817
+ export enum InsightOrderingV2DirectionEnumV2 {
2818
+ Asc = "asc",
2819
+ Desc = "desc"
2820
+ }
2821
+ export class FixedIncomeV2<HandleError extends boolean = boolean> {
2822
+ protected readonly apiClient: JwtClient<HandleError>;
2823
+ constructor(apiClient: JwtClient<HandleError>);
2824
+ /**
2825
+ * @description get fixed income entries
2826
+ * @tags FixedIncome
2827
+ * @name GetFixedIncomeEntries
2828
+ * @summary get fixed income entries
2829
+ * @request POST:/fixed-income
2830
+ * @secure
2831
+ */
2832
+ getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
2833
+ }
2834
+ export class Fundamentals<HandleError extends boolean = boolean> {
2835
+ protected readonly apiClient: JwtClient<HandleError>;
2836
+ constructor(apiClient: JwtClient<HandleError>);
2837
+ /**
2838
+ * @description get fundamentals by symbol data
2839
+ * @tags Fundamentals
2840
+ * @name GetFundamentalsBySymbolData
2841
+ * @summary get fundamentals by symbol data
2842
+ * @request POST:/fundamentals
2843
+ * @secure
2844
+ */
2845
+ getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsResponse, HandleError>>;
2846
+ }
2847
+ export class Funds<HandleError extends boolean = boolean> {
2848
+ protected readonly apiClient: JwtClient<HandleError>;
2849
+ constructor(apiClient: JwtClient<HandleError>);
2850
+ /**
2851
+ * @description get fund details
2852
+ * @tags Funds
2853
+ * @name GetFundDetails
2854
+ * @summary get fund details
2855
+ * @request GET:/funds/details
2856
+ * @secure
2857
+ */
2858
+ getFundDetails(query: {
2859
+ /** Fund symbol */
2860
+ symbol: string;
2861
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError>>;
2862
+ /**
2863
+ * @description get funds for holding
2864
+ * @tags Funds
2865
+ * @name GetFundsForHolding
2866
+ * @summary get funds for holding
2867
+ * @request POST:/funds/funds-for-holding
2827
2868
  * @secure
2828
2869
  */
2829
2870
  getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
@@ -2876,157 +2917,15 @@ export class Funds<HandleError extends boolean = boolean> {
2876
2917
  Authorization?: string;
2877
2918
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
2878
2919
  }
2879
- export class StockScreener<HandleError extends boolean = boolean> {
2920
+ export class Intraday<HandleError extends boolean = boolean> {
2880
2921
  protected readonly apiClient: JwtClient<HandleError>;
2881
2922
  constructor(apiClient: JwtClient<HandleError>);
2882
2923
  /**
2883
- * @description data for visual heat map
2884
- * @tags StockScreener
2885
- * @name StockMarketHeatmap
2886
- * @summary data for visual heat map
2887
- * @request GET:/heatmaps
2888
- * @secure
2889
- */
2890
- stockMarketHeatmap(query: {
2891
- /** Name of symbol list to fetch details for. Empty is default */
2892
- heatmap_name?: string;
2893
- /** NBBO || DELAYED || CBOE || CBOE1 || BATS || REALTIME || REALTIME_SNAPSHOT */
2894
- quote_access_type: string;
2895
- }, headers?: {
2896
- /** Authorization */
2897
- Authorization?: string;
2898
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
2899
- /**
2900
- * @description create or update heat map preset
2901
- * @tags StockScreener
2902
- * @name CreateStockMarketHeatmapPreset
2903
- * @summary create or update heat map preset
2904
- * @request POST:/heatmaps
2905
- * @secure
2906
- */
2907
- createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2908
- /**
2909
- * @description Sector and Industry Group performance
2910
- * @tags StockScreener
2911
- * @name IndustriesPerformance
2912
- * @summary get industries performance
2913
- * @request POST:/industries-performance
2914
- * @secure
2915
- */
2916
- industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2917
- /**
2918
- * @description filter stocks by params
2919
- * @tags StockScreener
2920
- * @name StockScreener
2921
- * @summary filter stocks by params
2922
- * @request POST:/stock-screener
2923
- * @secure
2924
- */
2925
- stockScreener(filter: InsightStockScreenerRequest, headers?: {
2926
- /** Authorization */
2927
- Authorization?: string;
2928
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
2929
- /**
2930
- * @description get screener presets
2931
- * @tags StockScreener
2932
- * @name GetScreenerPresets
2933
- * @summary get screener presets
2934
- * @request GET:/stock-screener/presets
2935
- * @secure
2936
- */
2937
- getScreenerPresets(query: {
2938
- /** how many records to return */
2939
- limit: number;
2940
- /** how many records to skip */
2941
- offset: number;
2942
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2943
- /**
2944
- * @description update screener preset
2945
- * @tags StockScreener
2946
- * @name UpdateScreenerPreset
2947
- * @summary update screener preset
2948
- * @request PUT:/stock-screener/presets
2949
- * @secure
2950
- */
2951
- updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2952
- /**
2953
- * @description create screener preset
2954
- * @tags StockScreener
2955
- * @name CreateOrScreenerPreset
2956
- * @summary create screener preset
2957
- * @request POST:/stock-screener/presets
2958
- * @secure
2959
- */
2960
- createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2961
- /**
2962
- * @description remove screener preset
2963
- * @tags StockScreener
2964
- * @name RemoveScreenerPreset
2965
- * @summary remove screener preset
2966
- * @request DELETE:/stock-screener/presets
2967
- * @secure
2968
- */
2969
- removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2970
- /**
2971
- * @description get top symbols
2972
- * @tags StockScreener
2973
- * @name GetTopSymbols
2974
- * @summary get top symbols
2975
- * @request POST:/stock-screener/top
2976
- * @secure
2977
- */
2978
- getTopSymbols(input: InsightGetTopSymbolsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
2979
- }
2980
- export class Quotes<HandleError extends boolean = boolean> {
2981
- protected readonly apiClient: JwtClient<HandleError>;
2982
- constructor(apiClient: JwtClient<HandleError>);
2983
- /**
2984
- * @description Get single historical quote
2985
- * @tags Quotes
2986
- * @name GitHistoricalQuote
2987
- * @summary Get single historical quote
2988
- * @request GET:/historical/quote
2989
- * @secure
2990
- */
2991
- gitHistoricalQuote(query: {
2992
- /** Symbol */
2993
- symbol: string;
2994
- /** Date */
2995
- date: string;
2996
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
2997
- /**
2998
- * @description get quote history by symbol
2999
- * @tags Quotes
3000
- * @name GitQuoteHistory
3001
- * @summary Get quote history
3002
- * @request POST:/quote-history
3003
- * @secure
3004
- */
3005
- gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
3006
- /**
3007
- * @description Returns a list of quotes equity info for specified symbols.
3008
- * @tags Quotes
3009
- * @name GetQuotesEquityData
3010
- * @summary Get Quotes Equity data
3011
- * @request GET:/quotes/equity
3012
- * @secure
3013
- */
3014
- getQuotesEquityData(query: {
3015
- /** Comma separated symbols */
3016
- symbols: string;
3017
- /** NBBO || DELAYED || CBOE || CBOE1 || BATS || REALTIME || REALTIME_SNAPSHOT */
3018
- quote_access_type: string;
3019
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
3020
- }
3021
- export class Intraday<HandleError extends boolean = boolean> {
3022
- protected readonly apiClient: JwtClient<HandleError>;
3023
- constructor(apiClient: JwtClient<HandleError>);
3024
- /**
3025
- * @description Returns an array of intraday chart data values for the given ticker.
3026
- * @tags Intraday
3027
- * @name IntradayQuotes
3028
- * @summary Get an array of intraday chart data values for the given ticker
3029
- * @request POST:/intraday/quotes
2924
+ * @description Returns an array of intraday chart data values for the given ticker.
2925
+ * @tags Intraday
2926
+ * @name IntradayQuotes
2927
+ * @summary Get an array of intraday chart data values for the given ticker
2928
+ * @request POST:/intraday/quotes
3030
2929
  * @secure
3031
2930
  */
3032
2931
  intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
@@ -3037,27 +2936,40 @@ export class Ipos<HandleError extends boolean = boolean> {
3037
2936
  /**
3038
2937
  * @description get recent ipos info
3039
2938
  * @tags Ipos
3040
- * @name RecentCreate
2939
+ * @name PostRecent
3041
2940
  * @summary get recent ipos info
3042
2941
  * @request POST:/ipos/recent
3043
2942
  * @secure
3044
2943
  */
3045
- recentCreate(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
2944
+ postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
3046
2945
  /**
3047
2946
  * @description get upcoming ipos info
3048
2947
  * @tags Ipos
3049
- * @name UpcomingList
2948
+ * @name GetUpcoming
3050
2949
  * @summary get upcoming ipos info
3051
2950
  * @request GET:/ipos/upcoming
3052
2951
  * @secure
3053
2952
  */
3054
- upcomingList(query: {
2953
+ getUpcoming(query: {
3055
2954
  /** how many records to return. Max value is 50 */
3056
2955
  limit: number;
3057
2956
  /** how many records to skip */
3058
2957
  offset: number;
3059
2958
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
3060
2959
  }
2960
+ export class Lists<HandleError extends boolean = boolean> {
2961
+ protected readonly apiClient: JwtClient<HandleError>;
2962
+ constructor(apiClient: JwtClient<HandleError>);
2963
+ /**
2964
+ * @description filter custom lists
2965
+ * @tags lists
2966
+ * @name FilterCustomLists
2967
+ * @summary filter custom lists
2968
+ * @request POST:/custom-lists/filter
2969
+ * @secure
2970
+ */
2971
+ filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
2972
+ }
3061
2973
  export class Logos<HandleError extends boolean = boolean> {
3062
2974
  protected readonly apiClient: JwtClient<HandleError>;
3063
2975
  constructor(apiClient: JwtClient<HandleError>);
@@ -3447,61 +3359,203 @@ export class Public<HandleError extends boolean = boolean> {
3447
3359
  offset: number;
3448
3360
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
3449
3361
  }
3450
- export class AlphaTools<HandleError extends boolean = boolean> {
3362
+ export class Quotes<HandleError extends boolean = boolean> {
3451
3363
  protected readonly apiClient: JwtClient<HandleError>;
3452
3364
  constructor(apiClient: JwtClient<HandleError>);
3453
3365
  /**
3454
- * @description get seasonlity data with comparison to benchmark
3455
- * @tags AlphaTools
3456
- * @name GetMomentumRatioGraph
3457
- * @summary get seasonlity data
3458
- * @request POST:/rst
3366
+ * @description Get single historical quote
3367
+ * @tags Quotes
3368
+ * @name GitHistoricalQuote
3369
+ * @summary Get single historical quote
3370
+ * @request GET:/historical/quote
3459
3371
  * @secure
3460
3372
  */
3461
- getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
3373
+ gitHistoricalQuote(query: {
3374
+ /** Symbol */
3375
+ symbol: string;
3376
+ /** Date */
3377
+ date: string;
3378
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
3462
3379
  /**
3463
- * @description get seasonlity data with comparison to benchmark
3464
- * @tags AlphaTools
3465
- * @name GetSeasonality
3466
- * @summary get seasonlity data
3467
- * @request POST:/seasonality
3380
+ * @description get quote history by symbol
3381
+ * @tags Quotes
3382
+ * @name GitQuoteHistory
3383
+ * @summary Get quote history
3384
+ * @request POST:/quote-history
3468
3385
  * @secure
3469
3386
  */
3470
- getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
3387
+ gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
3388
+ /**
3389
+ * @description Returns a list of quotes equity info for specified symbols.
3390
+ * @tags Quotes
3391
+ * @name GetQuotesEquityData
3392
+ * @summary Get Quotes Equity data
3393
+ * @request GET:/quotes/equity
3394
+ * @secure
3395
+ */
3396
+ getQuotesEquityData(query: {
3397
+ /** Comma separated symbols */
3398
+ symbols: string;
3399
+ /** NBBO || DELAYED || CBOE || CBOE1 || BATS || REALTIME || REALTIME_SNAPSHOT */
3400
+ quote_access_type: string;
3401
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
3471
3402
  }
3472
- export class TipRank<HandleError extends boolean = boolean> {
3403
+ export class StockScreener<HandleError extends boolean = boolean> {
3473
3404
  protected readonly apiClient: JwtClient<HandleError>;
3474
3405
  constructor(apiClient: JwtClient<HandleError>);
3475
3406
  /**
3476
- * @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
3477
- * @tags TipRank
3478
- * @name TiprankAnalystConsensus
3479
- * @summary Get tiprank AnalystConsensus
3480
- * @request POST:/tipranks/analyst-consensus
3407
+ * @description data for visual heat map
3408
+ * @tags StockScreener
3409
+ * @name StockMarketHeatmap
3410
+ * @summary data for visual heat map
3411
+ * @request GET:/heatmaps
3481
3412
  * @secure
3482
3413
  */
3483
- tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
3414
+ stockMarketHeatmap(query: {
3415
+ /** Name of symbol list to fetch details for. Empty is default */
3416
+ heatmap_name?: string;
3417
+ /** NBBO || DELAYED || CBOE || CBOE1 || BATS || REALTIME || REALTIME_SNAPSHOT */
3418
+ quote_access_type: string;
3419
+ }, headers?: {
3420
+ /** Authorization */
3421
+ Authorization?: string;
3422
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
3484
3423
  /**
3485
- * @description Returns the latest analyst ratings on a given stock or multiple stocks.
3486
- * @tags TipRank
3487
- * @name TiprankLatestAnalystRatingsOnStock
3488
- * @summary Get tiprank LatestAnalystRatingsOnStock
3489
- * @request POST:/tipranks/analyst-multi
3424
+ * @description create or update heat map preset
3425
+ * @tags StockScreener
3426
+ * @name CreateStockMarketHeatmapPreset
3427
+ * @summary create or update heat map preset
3428
+ * @request POST:/heatmaps
3490
3429
  * @secure
3491
3430
  */
3492
- tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError>>;
3431
+ createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3493
3432
  /**
3494
- * @description Returns the latest analyst portfolio items.
3495
- * @tags TipRank
3496
- * @name TiprankPortfolios
3497
- * @summary Get the latest analyst portfolio items
3498
- * @request POST:/tipranks/analyst-portfolio
3433
+ * @description Sector and Industry Group performance
3434
+ * @tags StockScreener
3435
+ * @name IndustriesPerformance
3436
+ * @summary get industries performance
3437
+ * @request POST:/industries-performance
3499
3438
  * @secure
3500
3439
  */
3501
- tiprankPortfolios(filter: InsightPortfoliosRequest, headers?: {
3440
+ industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3441
+ /**
3442
+ * @description filter stocks by params
3443
+ * @tags StockScreener
3444
+ * @name StockScreener
3445
+ * @summary filter stocks by params
3446
+ * @request POST:/stock-screener
3447
+ * @secure
3448
+ */
3449
+ stockScreener(filter: InsightStockScreenerRequest, headers?: {
3502
3450
  /** Authorization */
3503
3451
  Authorization?: string;
3504
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError>>;
3452
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
3453
+ /**
3454
+ * @description get screener presets
3455
+ * @tags StockScreener
3456
+ * @name GetScreenerPresets
3457
+ * @summary get screener presets
3458
+ * @request GET:/stock-screener/presets
3459
+ * @secure
3460
+ */
3461
+ getScreenerPresets(query: {
3462
+ /** how many records to return */
3463
+ limit: number;
3464
+ /** how many records to skip */
3465
+ offset: number;
3466
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3467
+ /**
3468
+ * @description update screener preset
3469
+ * @tags StockScreener
3470
+ * @name UpdateScreenerPreset
3471
+ * @summary update screener preset
3472
+ * @request PUT:/stock-screener/presets
3473
+ * @secure
3474
+ */
3475
+ updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3476
+ /**
3477
+ * @description create screener preset
3478
+ * @tags StockScreener
3479
+ * @name CreateOrScreenerPreset
3480
+ * @summary create screener preset
3481
+ * @request POST:/stock-screener/presets
3482
+ * @secure
3483
+ */
3484
+ createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3485
+ /**
3486
+ * @description remove screener preset
3487
+ * @tags StockScreener
3488
+ * @name RemoveScreenerPreset
3489
+ * @summary remove screener preset
3490
+ * @request DELETE:/stock-screener/presets
3491
+ * @secure
3492
+ */
3493
+ removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3494
+ /**
3495
+ * @description get top symbols
3496
+ * @tags StockScreener
3497
+ * @name GetTopSymbols
3498
+ * @summary get top symbols
3499
+ * @request POST:/stock-screener/top
3500
+ * @secure
3501
+ */
3502
+ getTopSymbols(input: InsightGetTopSymbolsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
3503
+ }
3504
+ export class StockScreenerV2<HandleError extends boolean = boolean> {
3505
+ protected readonly apiClient: JwtClient<HandleError>;
3506
+ constructor(apiClient: JwtClient<HandleError>);
3507
+ /**
3508
+ * @description filter stocks by params
3509
+ * @tags StockScreener
3510
+ * @name StockScreener
3511
+ * @summary filter stocks by params
3512
+ * @request POST:/stock-screener
3513
+ * @secure
3514
+ */
3515
+ stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
3516
+ /**
3517
+ * @description get top symbols
3518
+ * @tags StockScreener
3519
+ * @name GetTopSymbols
3520
+ * @summary get top symbols
3521
+ * @request POST:/stock-screener/top
3522
+ * @secure
3523
+ */
3524
+ getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponseV2, HandleError>>;
3525
+ }
3526
+ export class TipRank<HandleError extends boolean = boolean> {
3527
+ protected readonly apiClient: JwtClient<HandleError>;
3528
+ constructor(apiClient: JwtClient<HandleError>);
3529
+ /**
3530
+ * @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
3531
+ * @tags TipRank
3532
+ * @name TiprankAnalystConsensus
3533
+ * @summary Get tiprank AnalystConsensus
3534
+ * @request POST:/tipranks/analyst-consensus
3535
+ * @secure
3536
+ */
3537
+ tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
3538
+ /**
3539
+ * @description Returns the latest analyst ratings on a given stock or multiple stocks.
3540
+ * @tags TipRank
3541
+ * @name TiprankLatestAnalystRatingsOnStock
3542
+ * @summary Get tiprank LatestAnalystRatingsOnStock
3543
+ * @request POST:/tipranks/analyst-multi
3544
+ * @secure
3545
+ */
3546
+ tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError>>;
3547
+ /**
3548
+ * @description Returns the latest analyst portfolio items.
3549
+ * @tags TipRank
3550
+ * @name TiprankPortfolios
3551
+ * @summary Get the latest analyst portfolio items
3552
+ * @request POST:/tipranks/analyst-portfolio
3553
+ * @secure
3554
+ */
3555
+ tiprankPortfolios(filter: InsightPortfoliosRequest, headers?: {
3556
+ /** Authorization */
3557
+ Authorization?: string;
3558
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError>>;
3505
3559
  /**
3506
3560
  * @description Returns the analyst profile information
3507
3561
  * @tags TipRank
@@ -3848,243 +3902,189 @@ export class UsageTracking<HandleError extends boolean = boolean> {
3848
3902
  */
3849
3903
  getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
3850
3904
  }
3851
- export interface InsightStockMarketHeatmapEntryV2 {
3852
- price_change_percent: number;
3853
- symbol: string;
3854
- title: string;
3855
- }
3856
- export interface InsightBeforeAndAfterV2 {
3857
- after: string;
3858
- before: string;
3859
- }
3860
- export interface InsightFixedIncomeV2 {
3861
- a144: boolean;
3862
- accrued_interest: number;
3863
- bank_qualified: boolean;
3864
- bond_warrant: boolean;
3865
- call_type: string;
3866
- callable: boolean;
3867
- close_price: number;
3868
- close_price_asof: string;
3869
- close_ytw: number;
3870
- convertible: boolean;
3871
- country: string;
3872
- country_code: string;
3873
- country_domicile: string;
3874
- country_issue: string;
3875
- coupon: number;
3876
- coupon_frequency: string;
3877
- coupon_type: string;
3878
- currency: string;
3879
- cusip: string;
3880
- dated_date: string;
3881
- daycount: string;
3882
- description: string;
3883
- description_short: string;
3884
- duration: number;
3885
- first_coupon_date: string;
3886
- insured: boolean;
3887
- isin: string;
3888
- issue_date: string;
3889
- issue_minimum_denomination: number;
3890
- issue_price: number;
3891
- issue_size: number;
3892
- issuer: string;
3893
- last_coupon_date: string;
3894
- liquidity_institutional_aggregate: number;
3895
- liquidity_institutional_buy: number;
3896
- liquidity_institutional_sell: number;
3897
- liquidity_micro_aggregate: number;
3898
- liquidity_micro_buy: number;
3899
- liquidity_micro_sell: number;
3900
- liquidity_retail_aggregate: number;
3901
- liquidity_retail_buy: number;
3902
- liquidity_retail_sell: number;
3903
- maturity_date: string;
3904
- municipal_state: string;
3905
- municipal_taxable_federal: boolean;
3906
- municipal_type: string;
3907
- next_call_date: string;
3908
- next_call_price: number;
3909
- next_coupon_date: string;
3910
- par_value: number;
3911
- perpetual: boolean;
3912
- private_placement: boolean;
3913
- purpose: string;
3914
- puttable: boolean;
3915
- reg_s: boolean;
3916
- sector: string;
3917
- seniority: string;
3918
- settlement_convention: string;
3919
- sinking_fund: boolean;
3920
- sp_creditwatch: string;
3921
- sp_creditwatch_date: string;
3922
- sp_outlook: string;
3923
- sp_outlook_date: string;
3924
- sp_rating: string;
3925
- sp_rating_date: string;
3926
- status: string;
3927
- ticker: string;
3928
- treasury_subtype: string;
3929
- type: string;
3930
- updated_at: string;
3931
- }
3932
- export interface InsightGetFixedIncomeEntriesRequestV2 {
3933
- bank_qualified?: boolean;
3934
- callable?: boolean;
3935
- convertible?: boolean;
3936
- country_codes?: string[];
3937
- coupon?: InsightLessAndMoreV2;
3938
- coupon_frequencies?: string[];
3939
- cusip?: string[];
3940
- description?: string;
3941
- has_ticker?: boolean;
3942
- insured?: boolean;
3943
- isin?: string[];
3944
- issue_date?: InsightBeforeAndAfterV2;
3945
- issuer?: string;
3946
- maturity?: InsightBeforeAndAfterV2;
3947
- municipal_states?: string[];
3948
- municipal_tax?: boolean;
3949
- municipal_types?: string[];
3950
- order?: InsightOrderingV2;
3951
- pagination?: InsightPaginationV2;
3952
- paging?: InsightPagingV2;
3953
- purposes?: string[];
3954
- sectors?: string[];
3955
- sorts?: InsightOrderingV2[];
3956
- sp_ratings?: string[];
3957
- statuses?: string[];
3958
- tickers?: string[];
3959
- types?: string[];
3960
- }
3961
- export interface InsightGetFixedIncomeEntriesResponseV2 {
3962
- count: number;
3963
- data: InsightFixedIncomeV2[];
3964
- }
3965
- export interface InsightGetTopSymbolsRequestV2 {
3966
- exchange?: string[];
3967
- market_cap?: InsightLessAndMoreV2;
3968
- order?: InsightOrderingV2;
3969
- pagination?: InsightPaginationV2;
3970
- paging?: InsightPagingV2;
3971
- price?: InsightLessAndMoreV2;
3972
- quote_access_type?: string;
3973
- sorts?: InsightOrderingV2[];
3974
- volume?: InsightLessAndMoreV2;
3975
- }
3976
- export interface InsightIncludeExcludeV2 {
3977
- exclude: string[];
3978
- include: string[];
3979
- }
3980
- export interface InsightLessAndMoreV2 {
3981
- less_than: number;
3982
- more_than: number;
3983
- }
3984
- export interface InsightOrderingV2 {
3985
- /** @default "asc" */
3986
- direction: InsightOrderingV2DirectionEnumV2;
3987
- /**
3988
- * Sort direction:
3989
- * * asc - Ascending, from A to Z.
3990
- * * desc - Descending, from Z to A.
3991
- */
3992
- field: string;
3993
- }
3994
- export interface InsightPaginationV2 {
3995
- page: number;
3996
- size: number;
3997
- }
3998
- export interface InsightPagingV2 {
3999
- limit: number;
4000
- offset: number;
4001
- }
4002
- export interface InsightStockMarketHeatmapResponseV2 {
4003
- details: InsightStockMarketHeatmapEntryV2[];
4004
- max_change: number;
4005
- min_change: number;
4006
- }
4007
- export interface InsightStockScreenerQuoteV2 {
4008
- average_volume_30d: number;
4009
- company_name: string;
4010
- dividend_ex_date: string;
4011
- dividend_pay_date: string;
4012
- dividend_percent: number;
4013
- exchange: string;
4014
- exchange_name: string;
4015
- gap: number;
4016
- industry: string;
4017
- industry_code: string;
4018
- last_price: number;
4019
- market_cap: number;
4020
- pe_ratio: number;
4021
- price_change: number;
4022
- price_change_percent: number;
4023
- symbol: string;
4024
- volume: number;
4025
- }
4026
- export interface InsightStockScreenerRequestV2 {
4027
- average_volume_30d?: InsightLessAndMoreV2;
4028
- dividend_ex_date?: InsightBeforeAndAfterV2;
4029
- dividend_pay_date?: InsightBeforeAndAfterV2;
4030
- dividend_percent?: InsightLessAndMoreV2;
4031
- exchange?: InsightIncludeExcludeV2;
4032
- gap?: InsightLessAndMoreV2;
4033
- industry?: InsightIncludeExcludeV2;
4034
- market_cap?: InsightLessAndMoreV2;
4035
- order?: InsightOrderingV2;
4036
- pagination?: InsightPaginationV2;
4037
- paging?: InsightPagingV2;
4038
- pe_ratio?: InsightLessAndMoreV2;
4039
- price?: InsightLessAndMoreV2;
4040
- quote_access_type?: string;
4041
- sorts?: InsightOrderingV2[];
4042
- stock_type?: string;
4043
- volume?: InsightLessAndMoreV2;
4044
- }
4045
- export interface InsightStockScreenerResponseV2 {
4046
- count: number;
4047
- details: InsightStockScreenerQuoteV2[];
4048
- }
4049
- /** @default "asc" */
4050
- export enum InsightOrderingV2DirectionEnumV2 {
4051
- Asc = "asc",
4052
- Desc = "desc"
4053
- }
4054
- export class FixedIncomeV2<HandleError extends boolean = boolean> {
3905
+ export class WorldMarkets<HandleError extends boolean = boolean> {
4055
3906
  protected readonly apiClient: JwtClient<HandleError>;
4056
3907
  constructor(apiClient: JwtClient<HandleError>);
4057
3908
  /**
4058
- * @description get fixed income entries
4059
- * @tags FixedIncome
4060
- * @name GetFixedIncomeEntries
4061
- * @summary get fixed income entries
4062
- * @request POST:/fixed-income
3909
+ * @description Get continents
3910
+ * @tags World Markets
3911
+ * @name ContinentGet
3912
+ * @summary Get continents
3913
+ * @request GET:/continents
4063
3914
  * @secure
4064
3915
  */
4065
- getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
4066
- }
4067
- export class StockScreenerV2<HandleError extends boolean = boolean> {
4068
- protected readonly apiClient: JwtClient<HandleError>;
4069
- constructor(apiClient: JwtClient<HandleError>);
3916
+ continentGet(query: {
3917
+ /** Query limit */
3918
+ limit: number;
3919
+ /** Query offset */
3920
+ offset: number;
3921
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
4070
3922
  /**
4071
- * @description filter stocks by params
4072
- * @tags StockScreener
4073
- * @name StockScreener
4074
- * @summary filter stocks by params
4075
- * @request POST:/stock-screener
3923
+ * @description Edit continent
3924
+ * @tags World Markets
3925
+ * @name ContinentEdit
3926
+ * @summary Edit continent
3927
+ * @request PUT:/continents
4076
3928
  * @secure
4077
3929
  */
4078
- stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
3930
+ continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4079
3931
  /**
4080
- * @description get top symbols
4081
- * @tags StockScreener
4082
- * @name GetTopSymbols
4083
- * @summary get top symbols
4084
- * @request POST:/stock-screener/top
3932
+ * @description Create continents
3933
+ * @tags World Markets
3934
+ * @name ContinentCreate
3935
+ * @summary Create continents
3936
+ * @request POST:/continents
4085
3937
  * @secure
4086
3938
  */
4087
- getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponseV2, HandleError>>;
3939
+ continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
3940
+ /**
3941
+ * @description Delete continent
3942
+ * @tags World Markets
3943
+ * @name ContinentDelete
3944
+ * @summary Delete continent
3945
+ * @request DELETE:/continents
3946
+ * @secure
3947
+ */
3948
+ continentDelete(query: {
3949
+ /** continent id */
3950
+ id: string;
3951
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3952
+ /**
3953
+ * @description Get country codes
3954
+ * @tags World Markets
3955
+ * @name CountryCodeGet
3956
+ * @summary Get country codes
3957
+ * @request GET:/country-codes
3958
+ * @secure
3959
+ */
3960
+ countryCodeGet(query: {
3961
+ /** Query limit */
3962
+ limit: number;
3963
+ /** Query offset */
3964
+ offset: number;
3965
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
3966
+ /**
3967
+ * @description Edit country code
3968
+ * @tags World Markets
3969
+ * @name CountryCodeEdit
3970
+ * @summary Edit country code
3971
+ * @request PUT:/country-codes
3972
+ * @secure
3973
+ */
3974
+ countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3975
+ /**
3976
+ * @description Add country codes
3977
+ * @tags World Markets
3978
+ * @name CountryCodeAdd
3979
+ * @summary Add country codes
3980
+ * @request POST:/country-codes
3981
+ * @secure
3982
+ */
3983
+ countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
3984
+ /**
3985
+ * @description Delete country code
3986
+ * @tags World Markets
3987
+ * @name CountryCodeDelete
3988
+ * @summary Delete country code
3989
+ * @request DELETE:/country-codes
3990
+ * @secure
3991
+ */
3992
+ countryCodeDelete(query: {
3993
+ /** a3 code */
3994
+ a3code: string;
3995
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3996
+ /**
3997
+ * @description Get global indexes
3998
+ * @tags World Markets
3999
+ * @name GlobalIndexGet
4000
+ * @summary Get global indexes
4001
+ * @request GET:/global-indexes
4002
+ * @secure
4003
+ */
4004
+ globalIndexGet(query: {
4005
+ /** Query limit */
4006
+ limit: number;
4007
+ /** Query offset */
4008
+ offset: number;
4009
+ /** Continent code for filtering */
4010
+ continent?: string;
4011
+ /** Quote type for price fetch */
4012
+ quote_access_type?: string;
4013
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
4014
+ /**
4015
+ * @description Edit global index
4016
+ * @tags World Markets
4017
+ * @name GlobalIndexEdit
4018
+ * @summary Edit global index
4019
+ * @request PUT:/global-indexes
4020
+ * @secure
4021
+ */
4022
+ globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4023
+ /**
4024
+ * @description Add global indexes
4025
+ * @tags World Markets
4026
+ * @name GlobalIndexAdd
4027
+ * @summary Add global indexes
4028
+ * @request POST:/global-indexes
4029
+ * @secure
4030
+ */
4031
+ globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
4032
+ /**
4033
+ * @description Edit global index
4034
+ * @tags World Markets
4035
+ * @name GlobalIndexDelete
4036
+ * @summary Delete global index
4037
+ * @request DELETE:/global-indexes
4038
+ * @secure
4039
+ */
4040
+ globalIndexDelete(query: {
4041
+ /** a3 code */
4042
+ a3code: string;
4043
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4044
+ /**
4045
+ * @description Get regions
4046
+ * @tags World Markets
4047
+ * @name RegionGet
4048
+ * @summary Get regions
4049
+ * @request GET:/regions
4050
+ * @secure
4051
+ */
4052
+ regionGet(query: {
4053
+ /** Query limit */
4054
+ limit: number;
4055
+ /** Query offset */
4056
+ offset: number;
4057
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
4058
+ /**
4059
+ * @description Edit region
4060
+ * @tags World Markets
4061
+ * @name RegionEdit
4062
+ * @summary Edit region
4063
+ * @request PUT:/regions
4064
+ * @secure
4065
+ */
4066
+ regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4067
+ /**
4068
+ * @description Create regions
4069
+ * @tags World Markets
4070
+ * @name RegionCreate
4071
+ * @summary Create regions
4072
+ * @request POST:/regions
4073
+ * @secure
4074
+ */
4075
+ regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
4076
+ /**
4077
+ * @description Delete region
4078
+ * @tags World Markets
4079
+ * @name RegionDelete
4080
+ * @summary Delete region
4081
+ * @request DELETE:/regions
4082
+ * @secure
4083
+ */
4084
+ regionDelete(query: {
4085
+ /** region id */
4086
+ id: string;
4087
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4088
4088
  }
4089
4089
  export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
4090
4090
  alphaTools: AlphaTools<HandleError>;
@@ -23377,13 +23377,13 @@ export class WatchmenInstances<HandleError extends boolean = boolean> {
23377
23377
  declare class _B2BAuth1<HandleError extends boolean = boolean> extends B2BAuth<HandleError> {
23378
23378
  basicLogin(basicLoginParams: UmaBasicB2BLoginDto, headers?: {
23379
23379
  'Debug-Token'?: string;
23380
- }, config?: RequestConfig<HandleError> | undefined): Promise<import("BaseClient").ClientResponse<import("apis/uma/__generated__").UmaBasicB2BLoginSerializer, HandleError>>;
23380
+ }, config?: RequestConfig<HandleError> | undefined): Promise<ClientResponse<UmaBasicB2BLoginSerializer, HandleError>>;
23381
23381
  }
23382
23382
  declare class _B2CAuth1<HandleError extends boolean = boolean> extends B2CAuth<HandleError> {
23383
23383
  basicLogin(basicLoginParams: UmaBasicB2CLoginDto, headers?: {
23384
23384
  BRANCH?: string;
23385
23385
  FIRM?: string;
23386
- }, config?: RequestConfig<HandleError> | undefined): Promise<import("BaseClient").ClientResponse<import("apis/uma/__generated__").UmaB2CLoginResultSerializer, HandleError>>;
23386
+ }, config?: RequestConfig<HandleError> | undefined): Promise<ClientResponse<UmaB2CLoginResultSerializer, HandleError>>;
23387
23387
  }
23388
23388
  export interface UmaClientConfig<HandleError extends boolean = boolean> extends JwtClientConfig<HandleError> {
23389
23389
  firmId: string;