@orbis-systems/orbis-api-clients 0.4.1 → 0.4.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/aesmidas/index.d.ts +85 -85
- package/dist/aesmidas/index.d.ts.map +1 -1
- package/dist/aesmidas/index.esm.js +1 -1
- package/dist/aesmidas/index.esm.js.map +1 -1
- package/dist/aesmidas/index.js +1 -1
- package/dist/aesmidas/index.js.map +1 -1
- package/dist/insight/index.d.ts +639 -639
- package/dist/insight/index.d.ts.map +1 -1
- package/dist/insight/index.esm.js +1 -1
- package/dist/insight/index.esm.js.map +1 -1
- package/dist/insight/index.js +1 -1
- package/dist/insight/index.js.map +1 -1
- package/dist/middleware/index.d.ts +107 -107
- package/dist/middleware/index.d.ts.map +1 -1
- package/dist/middleware/index.esm.js +1 -1
- package/dist/middleware/index.esm.js.map +1 -1
- package/dist/middleware/index.js +1 -1
- package/dist/middleware/index.js.map +1 -1
- package/dist/orbis/index.d.ts +4156 -13643
- package/dist/orbis/index.d.ts.map +1 -1
- package/dist/orbis/index.esm.js +1 -1
- package/dist/orbis/index.esm.js.map +1 -1
- package/dist/orbis/index.js +1 -1
- package/dist/orbis/index.js.map +1 -1
- package/dist/uma/index.d.ts +668 -660
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -1
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -1
- package/dist/uma/index.js.map +1 -1
- package/package.json +22 -19
package/dist/insight/index.d.ts
CHANGED
|
@@ -2431,6 +2431,28 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
|
|
|
2431
2431
|
Date = "date",
|
|
2432
2432
|
Rank = "rank"
|
|
2433
2433
|
}
|
|
2434
|
+
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
2435
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2436
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2437
|
+
/**
|
|
2438
|
+
* @description get seasonlity data with comparison to benchmark
|
|
2439
|
+
* @tags AlphaTools
|
|
2440
|
+
* @name GetMomentumRatioGraph
|
|
2441
|
+
* @summary get seasonlity data
|
|
2442
|
+
* @request POST:/rst
|
|
2443
|
+
* @secure
|
|
2444
|
+
*/
|
|
2445
|
+
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
2446
|
+
/**
|
|
2447
|
+
* @description get seasonlity data with comparison to benchmark
|
|
2448
|
+
* @tags AlphaTools
|
|
2449
|
+
* @name GetSeasonality
|
|
2450
|
+
* @summary get seasonlity data
|
|
2451
|
+
* @request POST:/seasonality
|
|
2452
|
+
* @secure
|
|
2453
|
+
*/
|
|
2454
|
+
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
2455
|
+
}
|
|
2434
2456
|
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
2435
2457
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2436
2458
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2470,190 +2492,6 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
|
2470
2492
|
*/
|
|
2471
2493
|
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
2472
2494
|
}
|
|
2473
|
-
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
2474
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2475
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2476
|
-
/**
|
|
2477
|
-
* @description Get continents
|
|
2478
|
-
* @tags World Markets
|
|
2479
|
-
* @name ContinentGet
|
|
2480
|
-
* @summary Get continents
|
|
2481
|
-
* @request GET:/continents
|
|
2482
|
-
* @secure
|
|
2483
|
-
*/
|
|
2484
|
-
continentGet(query: {
|
|
2485
|
-
/** Query limit */
|
|
2486
|
-
limit: number;
|
|
2487
|
-
/** Query offset */
|
|
2488
|
-
offset: number;
|
|
2489
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
2490
|
-
/**
|
|
2491
|
-
* @description Edit continent
|
|
2492
|
-
* @tags World Markets
|
|
2493
|
-
* @name ContinentEdit
|
|
2494
|
-
* @summary Edit continent
|
|
2495
|
-
* @request PUT:/continents
|
|
2496
|
-
* @secure
|
|
2497
|
-
*/
|
|
2498
|
-
continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2499
|
-
/**
|
|
2500
|
-
* @description Create continents
|
|
2501
|
-
* @tags World Markets
|
|
2502
|
-
* @name ContinentCreate
|
|
2503
|
-
* @summary Create continents
|
|
2504
|
-
* @request POST:/continents
|
|
2505
|
-
* @secure
|
|
2506
|
-
*/
|
|
2507
|
-
continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
2508
|
-
/**
|
|
2509
|
-
* @description Delete continent
|
|
2510
|
-
* @tags World Markets
|
|
2511
|
-
* @name ContinentDelete
|
|
2512
|
-
* @summary Delete continent
|
|
2513
|
-
* @request DELETE:/continents
|
|
2514
|
-
* @secure
|
|
2515
|
-
*/
|
|
2516
|
-
continentDelete(query: {
|
|
2517
|
-
/** continent id */
|
|
2518
|
-
id: string;
|
|
2519
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2520
|
-
/**
|
|
2521
|
-
* @description Get country codes
|
|
2522
|
-
* @tags World Markets
|
|
2523
|
-
* @name CountryCodeGet
|
|
2524
|
-
* @summary Get country codes
|
|
2525
|
-
* @request GET:/country-codes
|
|
2526
|
-
* @secure
|
|
2527
|
-
*/
|
|
2528
|
-
countryCodeGet(query: {
|
|
2529
|
-
/** Query limit */
|
|
2530
|
-
limit: number;
|
|
2531
|
-
/** Query offset */
|
|
2532
|
-
offset: number;
|
|
2533
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
2534
|
-
/**
|
|
2535
|
-
* @description Edit country code
|
|
2536
|
-
* @tags World Markets
|
|
2537
|
-
* @name CountryCodeEdit
|
|
2538
|
-
* @summary Edit country code
|
|
2539
|
-
* @request PUT:/country-codes
|
|
2540
|
-
* @secure
|
|
2541
|
-
*/
|
|
2542
|
-
countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2543
|
-
/**
|
|
2544
|
-
* @description Add country codes
|
|
2545
|
-
* @tags World Markets
|
|
2546
|
-
* @name CountryCodeAdd
|
|
2547
|
-
* @summary Add country codes
|
|
2548
|
-
* @request POST:/country-codes
|
|
2549
|
-
* @secure
|
|
2550
|
-
*/
|
|
2551
|
-
countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
2552
|
-
/**
|
|
2553
|
-
* @description Delete country code
|
|
2554
|
-
* @tags World Markets
|
|
2555
|
-
* @name CountryCodeDelete
|
|
2556
|
-
* @summary Delete country code
|
|
2557
|
-
* @request DELETE:/country-codes
|
|
2558
|
-
* @secure
|
|
2559
|
-
*/
|
|
2560
|
-
countryCodeDelete(query: {
|
|
2561
|
-
/** a3 code */
|
|
2562
|
-
a3code: string;
|
|
2563
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2564
|
-
/**
|
|
2565
|
-
* @description Get global indexes
|
|
2566
|
-
* @tags World Markets
|
|
2567
|
-
* @name GlobalIndexGet
|
|
2568
|
-
* @summary Get global indexes
|
|
2569
|
-
* @request GET:/global-indexes
|
|
2570
|
-
* @secure
|
|
2571
|
-
*/
|
|
2572
|
-
globalIndexGet(query: {
|
|
2573
|
-
/** Query limit */
|
|
2574
|
-
limit: number;
|
|
2575
|
-
/** Query offset */
|
|
2576
|
-
offset: number;
|
|
2577
|
-
/** Continent code for filtering */
|
|
2578
|
-
continent?: string;
|
|
2579
|
-
/** Quote type for price fetch */
|
|
2580
|
-
quote_access_type?: string;
|
|
2581
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
2582
|
-
/**
|
|
2583
|
-
* @description Edit global index
|
|
2584
|
-
* @tags World Markets
|
|
2585
|
-
* @name GlobalIndexEdit
|
|
2586
|
-
* @summary Edit global index
|
|
2587
|
-
* @request PUT:/global-indexes
|
|
2588
|
-
* @secure
|
|
2589
|
-
*/
|
|
2590
|
-
globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2591
|
-
/**
|
|
2592
|
-
* @description Add global indexes
|
|
2593
|
-
* @tags World Markets
|
|
2594
|
-
* @name GlobalIndexAdd
|
|
2595
|
-
* @summary Add global indexes
|
|
2596
|
-
* @request POST:/global-indexes
|
|
2597
|
-
* @secure
|
|
2598
|
-
*/
|
|
2599
|
-
globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
2600
|
-
/**
|
|
2601
|
-
* @description Edit global index
|
|
2602
|
-
* @tags World Markets
|
|
2603
|
-
* @name GlobalIndexDelete
|
|
2604
|
-
* @summary Delete global index
|
|
2605
|
-
* @request DELETE:/global-indexes
|
|
2606
|
-
* @secure
|
|
2607
|
-
*/
|
|
2608
|
-
globalIndexDelete(query: {
|
|
2609
|
-
/** a3 code */
|
|
2610
|
-
a3code: string;
|
|
2611
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2612
|
-
/**
|
|
2613
|
-
* @description Get regions
|
|
2614
|
-
* @tags World Markets
|
|
2615
|
-
* @name RegionGet
|
|
2616
|
-
* @summary Get regions
|
|
2617
|
-
* @request GET:/regions
|
|
2618
|
-
* @secure
|
|
2619
|
-
*/
|
|
2620
|
-
regionGet(query: {
|
|
2621
|
-
/** Query limit */
|
|
2622
|
-
limit: number;
|
|
2623
|
-
/** Query offset */
|
|
2624
|
-
offset: number;
|
|
2625
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
2626
|
-
/**
|
|
2627
|
-
* @description Edit region
|
|
2628
|
-
* @tags World Markets
|
|
2629
|
-
* @name RegionEdit
|
|
2630
|
-
* @summary Edit region
|
|
2631
|
-
* @request PUT:/regions
|
|
2632
|
-
* @secure
|
|
2633
|
-
*/
|
|
2634
|
-
regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2635
|
-
/**
|
|
2636
|
-
* @description Create regions
|
|
2637
|
-
* @tags World Markets
|
|
2638
|
-
* @name RegionCreate
|
|
2639
|
-
* @summary Create regions
|
|
2640
|
-
* @request POST:/regions
|
|
2641
|
-
* @secure
|
|
2642
|
-
*/
|
|
2643
|
-
regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
2644
|
-
/**
|
|
2645
|
-
* @description Delete region
|
|
2646
|
-
* @tags World Markets
|
|
2647
|
-
* @name RegionDelete
|
|
2648
|
-
* @summary Delete region
|
|
2649
|
-
* @request DELETE:/regions
|
|
2650
|
-
* @secure
|
|
2651
|
-
*/
|
|
2652
|
-
regionDelete(query: {
|
|
2653
|
-
/** region id */
|
|
2654
|
-
id: string;
|
|
2655
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2656
|
-
}
|
|
2657
2495
|
export class CustomLists<HandleError extends boolean = boolean> {
|
|
2658
2496
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2659
2497
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2717,19 +2555,6 @@ export class CustomLists<HandleError extends boolean = boolean> {
|
|
|
2717
2555
|
offset: number;
|
|
2718
2556
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
2719
2557
|
}
|
|
2720
|
-
export class Lists<HandleError extends boolean = boolean> {
|
|
2721
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2722
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2723
|
-
/**
|
|
2724
|
-
* @description filter custom lists
|
|
2725
|
-
* @tags lists
|
|
2726
|
-
* @name FilterCustomLists
|
|
2727
|
-
* @summary filter custom lists
|
|
2728
|
-
* @request POST:/custom-lists/filter
|
|
2729
|
-
* @secure
|
|
2730
|
-
*/
|
|
2731
|
-
filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
2732
|
-
}
|
|
2733
2558
|
export class Dashboard<HandleError extends boolean = boolean> {
|
|
2734
2559
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2735
2560
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2890,41 +2715,250 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
2890
2715
|
*/
|
|
2891
2716
|
getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
|
|
2892
2717
|
}
|
|
2893
|
-
export
|
|
2894
|
-
|
|
2895
|
-
|
|
2896
|
-
/**
|
|
2897
|
-
* @description get fundamentals by symbol data
|
|
2898
|
-
* @tags Fundamentals
|
|
2899
|
-
* @name GetFundamentalsBySymbolData
|
|
2900
|
-
* @summary get fundamentals by symbol data
|
|
2901
|
-
* @request POST:/fundamentals
|
|
2902
|
-
* @secure
|
|
2903
|
-
*/
|
|
2904
|
-
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsResponse, HandleError>>;
|
|
2718
|
+
export interface InsightBeforeAndAfterV2 {
|
|
2719
|
+
after?: string;
|
|
2720
|
+
before?: string;
|
|
2905
2721
|
}
|
|
2906
|
-
export
|
|
2907
|
-
|
|
2908
|
-
|
|
2909
|
-
|
|
2910
|
-
|
|
2911
|
-
|
|
2912
|
-
|
|
2913
|
-
|
|
2914
|
-
|
|
2915
|
-
|
|
2916
|
-
|
|
2917
|
-
|
|
2918
|
-
|
|
2919
|
-
|
|
2920
|
-
|
|
2921
|
-
|
|
2922
|
-
|
|
2923
|
-
|
|
2924
|
-
|
|
2925
|
-
|
|
2926
|
-
|
|
2927
|
-
|
|
2722
|
+
export interface InsightFixedIncomeV2 {
|
|
2723
|
+
a144: boolean;
|
|
2724
|
+
accrued_interest: number;
|
|
2725
|
+
bank_qualified: boolean;
|
|
2726
|
+
bond_warrant: boolean;
|
|
2727
|
+
call_type: string;
|
|
2728
|
+
callable: boolean;
|
|
2729
|
+
close_price: number;
|
|
2730
|
+
close_price_asof: string;
|
|
2731
|
+
close_ytw: number;
|
|
2732
|
+
convertible: boolean;
|
|
2733
|
+
country: string;
|
|
2734
|
+
country_code: string;
|
|
2735
|
+
country_domicile: string;
|
|
2736
|
+
country_issue: string;
|
|
2737
|
+
coupon: number;
|
|
2738
|
+
coupon_frequency: string;
|
|
2739
|
+
coupon_type: string;
|
|
2740
|
+
currency: string;
|
|
2741
|
+
cusip: string;
|
|
2742
|
+
dated_date: string;
|
|
2743
|
+
daycount: string;
|
|
2744
|
+
description: string;
|
|
2745
|
+
description_short: string;
|
|
2746
|
+
duration: number;
|
|
2747
|
+
first_coupon_date: string;
|
|
2748
|
+
insured: boolean;
|
|
2749
|
+
isin: string;
|
|
2750
|
+
issue_date: string;
|
|
2751
|
+
issue_minimum_denomination: number;
|
|
2752
|
+
issue_price: number;
|
|
2753
|
+
issue_size: number;
|
|
2754
|
+
issuer: string;
|
|
2755
|
+
last_coupon_date: string;
|
|
2756
|
+
liquidity_institutional_aggregate: number;
|
|
2757
|
+
liquidity_institutional_buy: number;
|
|
2758
|
+
liquidity_institutional_sell: number;
|
|
2759
|
+
liquidity_micro_aggregate: number;
|
|
2760
|
+
liquidity_micro_buy: number;
|
|
2761
|
+
liquidity_micro_sell: number;
|
|
2762
|
+
liquidity_retail_aggregate: number;
|
|
2763
|
+
liquidity_retail_buy: number;
|
|
2764
|
+
liquidity_retail_sell: number;
|
|
2765
|
+
maturity_date: string;
|
|
2766
|
+
municipal_state: string;
|
|
2767
|
+
municipal_taxable_federal: boolean;
|
|
2768
|
+
municipal_type: string;
|
|
2769
|
+
next_call_date: string;
|
|
2770
|
+
next_call_price: number;
|
|
2771
|
+
next_coupon_date: string;
|
|
2772
|
+
par_value: number;
|
|
2773
|
+
perpetual: boolean;
|
|
2774
|
+
private_placement: boolean;
|
|
2775
|
+
purpose: string;
|
|
2776
|
+
puttable: boolean;
|
|
2777
|
+
reg_s: boolean;
|
|
2778
|
+
sector: string;
|
|
2779
|
+
seniority: string;
|
|
2780
|
+
settlement_convention: string;
|
|
2781
|
+
sinking_fund: boolean;
|
|
2782
|
+
sp_creditwatch: string;
|
|
2783
|
+
sp_creditwatch_date: string;
|
|
2784
|
+
sp_outlook: string;
|
|
2785
|
+
sp_outlook_date: string;
|
|
2786
|
+
sp_rating: string;
|
|
2787
|
+
sp_rating_date: string;
|
|
2788
|
+
status: string;
|
|
2789
|
+
ticker: string;
|
|
2790
|
+
treasury_subtype: string;
|
|
2791
|
+
type: string;
|
|
2792
|
+
updated_at: string;
|
|
2793
|
+
}
|
|
2794
|
+
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
2795
|
+
bank_qualified?: boolean;
|
|
2796
|
+
callable?: boolean;
|
|
2797
|
+
convertible?: boolean;
|
|
2798
|
+
country_codes?: string[];
|
|
2799
|
+
coupon?: InsightLessAndMoreV2;
|
|
2800
|
+
coupon_frequencies?: string[];
|
|
2801
|
+
cusip?: string[];
|
|
2802
|
+
description?: string;
|
|
2803
|
+
has_ticker?: boolean;
|
|
2804
|
+
insured?: boolean;
|
|
2805
|
+
isin?: string[];
|
|
2806
|
+
issue_date?: InsightBeforeAndAfterV2;
|
|
2807
|
+
issuer?: string;
|
|
2808
|
+
maturity?: InsightBeforeAndAfterV2;
|
|
2809
|
+
municipal_states?: string[];
|
|
2810
|
+
municipal_tax?: boolean;
|
|
2811
|
+
municipal_types?: string[];
|
|
2812
|
+
order?: InsightOrderingV2;
|
|
2813
|
+
pagination?: InsightPaginationV2;
|
|
2814
|
+
paging?: InsightPagingV2;
|
|
2815
|
+
purposes?: string[];
|
|
2816
|
+
sectors?: string[];
|
|
2817
|
+
sorts?: InsightOrderingV2[];
|
|
2818
|
+
sp_ratings?: string[];
|
|
2819
|
+
statuses?: string[];
|
|
2820
|
+
tickers?: string[];
|
|
2821
|
+
types?: string[];
|
|
2822
|
+
}
|
|
2823
|
+
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
2824
|
+
count: number;
|
|
2825
|
+
data: InsightFixedIncomeV2[];
|
|
2826
|
+
}
|
|
2827
|
+
export interface InsightGetTopSymbolsRequestV2 {
|
|
2828
|
+
exchange?: string[];
|
|
2829
|
+
market_cap?: InsightLessAndMoreV2;
|
|
2830
|
+
order?: InsightOrderingV2;
|
|
2831
|
+
pagination?: InsightPaginationV2;
|
|
2832
|
+
paging?: InsightPagingV2;
|
|
2833
|
+
price?: InsightLessAndMoreV2;
|
|
2834
|
+
quote_access_type?: string;
|
|
2835
|
+
sorts?: InsightOrderingV2[];
|
|
2836
|
+
volume?: InsightLessAndMoreV2;
|
|
2837
|
+
}
|
|
2838
|
+
export interface InsightIncludeExcludeV2 {
|
|
2839
|
+
exclude?: string[];
|
|
2840
|
+
include?: string[];
|
|
2841
|
+
}
|
|
2842
|
+
export interface InsightLessAndMoreV2 {
|
|
2843
|
+
less_than?: number;
|
|
2844
|
+
more_than?: number;
|
|
2845
|
+
}
|
|
2846
|
+
export interface InsightOrderingV2 {
|
|
2847
|
+
/** @default "asc" */
|
|
2848
|
+
direction: InsightOrderingDirectionEnumV2;
|
|
2849
|
+
/**
|
|
2850
|
+
* Sort direction:
|
|
2851
|
+
* * asc - Ascending, from A to Z.
|
|
2852
|
+
* * desc - Descending, from Z to A.
|
|
2853
|
+
*/
|
|
2854
|
+
field: string;
|
|
2855
|
+
}
|
|
2856
|
+
export interface InsightPaginationV2 {
|
|
2857
|
+
page: number;
|
|
2858
|
+
size: number;
|
|
2859
|
+
}
|
|
2860
|
+
export interface InsightPagingV2 {
|
|
2861
|
+
limit: number;
|
|
2862
|
+
offset: number;
|
|
2863
|
+
}
|
|
2864
|
+
export interface InsightStockScreenerQuoteV2 {
|
|
2865
|
+
average_volume_30d: number;
|
|
2866
|
+
company_name: string;
|
|
2867
|
+
dividend_ex_date: string;
|
|
2868
|
+
dividend_pay_date: string;
|
|
2869
|
+
dividend_percent: number;
|
|
2870
|
+
exchange: string;
|
|
2871
|
+
exchange_name: string;
|
|
2872
|
+
gap: number;
|
|
2873
|
+
industry: string;
|
|
2874
|
+
industry_code: string;
|
|
2875
|
+
last_price: number;
|
|
2876
|
+
market_cap: number;
|
|
2877
|
+
pe_ratio: number;
|
|
2878
|
+
price_change: number;
|
|
2879
|
+
price_change_percent: number;
|
|
2880
|
+
symbol: string;
|
|
2881
|
+
volume: number;
|
|
2882
|
+
}
|
|
2883
|
+
export interface InsightStockScreenerRequestV2 {
|
|
2884
|
+
average_volume_30d?: InsightLessAndMoreV2;
|
|
2885
|
+
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
2886
|
+
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
2887
|
+
dividend_percent?: InsightLessAndMoreV2;
|
|
2888
|
+
exchange?: InsightIncludeExcludeV2;
|
|
2889
|
+
gap?: InsightLessAndMoreV2;
|
|
2890
|
+
industry?: InsightIncludeExcludeV2;
|
|
2891
|
+
market_cap?: InsightLessAndMoreV2;
|
|
2892
|
+
order?: InsightOrderingV2;
|
|
2893
|
+
pagination?: InsightPaginationV2;
|
|
2894
|
+
paging?: InsightPagingV2;
|
|
2895
|
+
pe_ratio?: InsightLessAndMoreV2;
|
|
2896
|
+
price?: InsightLessAndMoreV2;
|
|
2897
|
+
quote_access_type?: string;
|
|
2898
|
+
sorts?: InsightOrderingV2[];
|
|
2899
|
+
stock_type?: string;
|
|
2900
|
+
volume?: InsightLessAndMoreV2;
|
|
2901
|
+
}
|
|
2902
|
+
export interface InsightStockScreenerResponseV2 {
|
|
2903
|
+
current_page: number;
|
|
2904
|
+
data: InsightStockScreenerQuoteV2[];
|
|
2905
|
+
page_count: number;
|
|
2906
|
+
status: number;
|
|
2907
|
+
total_records: number;
|
|
2908
|
+
}
|
|
2909
|
+
/** @default "asc" */
|
|
2910
|
+
export enum InsightOrderingDirectionEnumV2 {
|
|
2911
|
+
Asc = "asc",
|
|
2912
|
+
Desc = "desc"
|
|
2913
|
+
}
|
|
2914
|
+
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
2915
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2916
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2917
|
+
/**
|
|
2918
|
+
* @description get fixed income entries
|
|
2919
|
+
* @tags FixedIncome
|
|
2920
|
+
* @name GetFixedIncomeEntries
|
|
2921
|
+
* @summary get fixed income entries
|
|
2922
|
+
* @request POST:/fixed-income
|
|
2923
|
+
* @secure
|
|
2924
|
+
*/
|
|
2925
|
+
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
2926
|
+
}
|
|
2927
|
+
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
2928
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2929
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2930
|
+
/**
|
|
2931
|
+
* @description get fundamentals by symbol data
|
|
2932
|
+
* @tags Fundamentals
|
|
2933
|
+
* @name GetFundamentalsBySymbolData
|
|
2934
|
+
* @summary get fundamentals by symbol data
|
|
2935
|
+
* @request POST:/fundamentals
|
|
2936
|
+
* @secure
|
|
2937
|
+
*/
|
|
2938
|
+
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsResponse, HandleError>>;
|
|
2939
|
+
}
|
|
2940
|
+
export class Funds<HandleError extends boolean = boolean> {
|
|
2941
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2942
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2943
|
+
/**
|
|
2944
|
+
* @description get fund details
|
|
2945
|
+
* @tags Funds
|
|
2946
|
+
* @name GetFundDetails
|
|
2947
|
+
* @summary get fund details
|
|
2948
|
+
* @request GET:/funds/details
|
|
2949
|
+
* @secure
|
|
2950
|
+
*/
|
|
2951
|
+
getFundDetails(query: {
|
|
2952
|
+
/** Fund symbol */
|
|
2953
|
+
symbol: string;
|
|
2954
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError>>;
|
|
2955
|
+
/**
|
|
2956
|
+
* @description get funds for holding
|
|
2957
|
+
* @tags Funds
|
|
2958
|
+
* @name GetFundsForHolding
|
|
2959
|
+
* @summary get funds for holding
|
|
2960
|
+
* @request POST:/funds/funds-for-holding
|
|
2961
|
+
* @secure
|
|
2928
2962
|
*/
|
|
2929
2963
|
getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
|
|
2930
2964
|
/** Authorization */
|
|
@@ -2976,157 +3010,15 @@ export class Funds<HandleError extends boolean = boolean> {
|
|
|
2976
3010
|
Authorization?: string;
|
|
2977
3011
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
|
|
2978
3012
|
}
|
|
2979
|
-
export class
|
|
3013
|
+
export class Intraday<HandleError extends boolean = boolean> {
|
|
2980
3014
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2981
3015
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2982
3016
|
/**
|
|
2983
|
-
* @description data for
|
|
2984
|
-
* @tags
|
|
2985
|
-
* @name
|
|
2986
|
-
* @summary data for
|
|
2987
|
-
* @request
|
|
2988
|
-
* @secure
|
|
2989
|
-
*/
|
|
2990
|
-
stockMarketHeatmap(query: {
|
|
2991
|
-
/** Name of symbol list to fetch details for. Empty is default */
|
|
2992
|
-
heatmap_name?: string;
|
|
2993
|
-
/** NBBO || DELAYED || CBOE || CBOE1 || BATS || REALTIME || REALTIME_SNAPSHOT */
|
|
2994
|
-
quote_access_type: string;
|
|
2995
|
-
}, headers?: {
|
|
2996
|
-
/** Authorization */
|
|
2997
|
-
Authorization?: string;
|
|
2998
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
2999
|
-
/**
|
|
3000
|
-
* @description create or update heat map preset
|
|
3001
|
-
* @tags StockScreener
|
|
3002
|
-
* @name CreateStockMarketHeatmapPreset
|
|
3003
|
-
* @summary create or update heat map preset
|
|
3004
|
-
* @request POST:/heatmaps
|
|
3005
|
-
* @secure
|
|
3006
|
-
*/
|
|
3007
|
-
createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3008
|
-
/**
|
|
3009
|
-
* @description Sector and Industry Group performance
|
|
3010
|
-
* @tags StockScreener
|
|
3011
|
-
* @name IndustriesPerformance
|
|
3012
|
-
* @summary get industries performance
|
|
3013
|
-
* @request POST:/industries-performance
|
|
3014
|
-
* @secure
|
|
3015
|
-
*/
|
|
3016
|
-
industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
|
|
3017
|
-
/**
|
|
3018
|
-
* @description filter stocks by params
|
|
3019
|
-
* @tags StockScreener
|
|
3020
|
-
* @name StockScreener
|
|
3021
|
-
* @summary filter stocks by params
|
|
3022
|
-
* @request POST:/stock-screener
|
|
3023
|
-
* @secure
|
|
3024
|
-
*/
|
|
3025
|
-
stockScreener(filter: InsightStockScreenerRequest, headers?: {
|
|
3026
|
-
/** Authorization */
|
|
3027
|
-
Authorization?: string;
|
|
3028
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
3029
|
-
/**
|
|
3030
|
-
* @description get screener presets
|
|
3031
|
-
* @tags StockScreener
|
|
3032
|
-
* @name GetScreenerPresets
|
|
3033
|
-
* @summary get screener presets
|
|
3034
|
-
* @request GET:/stock-screener/presets
|
|
3035
|
-
* @secure
|
|
3036
|
-
*/
|
|
3037
|
-
getScreenerPresets(query: {
|
|
3038
|
-
/** how many records to return */
|
|
3039
|
-
limit: number;
|
|
3040
|
-
/** how many records to skip */
|
|
3041
|
-
offset: number;
|
|
3042
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
3043
|
-
/**
|
|
3044
|
-
* @description update screener preset
|
|
3045
|
-
* @tags StockScreener
|
|
3046
|
-
* @name UpdateScreenerPreset
|
|
3047
|
-
* @summary update screener preset
|
|
3048
|
-
* @request PUT:/stock-screener/presets
|
|
3049
|
-
* @secure
|
|
3050
|
-
*/
|
|
3051
|
-
updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
3052
|
-
/**
|
|
3053
|
-
* @description create screener preset
|
|
3054
|
-
* @tags StockScreener
|
|
3055
|
-
* @name CreateOrScreenerPreset
|
|
3056
|
-
* @summary create screener preset
|
|
3057
|
-
* @request POST:/stock-screener/presets
|
|
3058
|
-
* @secure
|
|
3059
|
-
*/
|
|
3060
|
-
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
3061
|
-
/**
|
|
3062
|
-
* @description remove screener preset
|
|
3063
|
-
* @tags StockScreener
|
|
3064
|
-
* @name RemoveScreenerPreset
|
|
3065
|
-
* @summary remove screener preset
|
|
3066
|
-
* @request DELETE:/stock-screener/presets
|
|
3067
|
-
* @secure
|
|
3068
|
-
*/
|
|
3069
|
-
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3070
|
-
/**
|
|
3071
|
-
* @description get top symbols
|
|
3072
|
-
* @tags StockScreener
|
|
3073
|
-
* @name GetTopSymbols
|
|
3074
|
-
* @summary get top symbols
|
|
3075
|
-
* @request POST:/stock-screener/top
|
|
3076
|
-
* @secure
|
|
3077
|
-
*/
|
|
3078
|
-
getTopSymbols(input: InsightGetTopSymbolsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
3079
|
-
}
|
|
3080
|
-
export class Quotes<HandleError extends boolean = boolean> {
|
|
3081
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3082
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3083
|
-
/**
|
|
3084
|
-
* @description Get single historical quote
|
|
3085
|
-
* @tags Quotes
|
|
3086
|
-
* @name GitHistoricalQuote
|
|
3087
|
-
* @summary Get single historical quote
|
|
3088
|
-
* @request GET:/historical/quote
|
|
3089
|
-
* @secure
|
|
3090
|
-
*/
|
|
3091
|
-
gitHistoricalQuote(query: {
|
|
3092
|
-
/** Symbol */
|
|
3093
|
-
symbol: string;
|
|
3094
|
-
/** Date */
|
|
3095
|
-
date: string;
|
|
3096
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
3097
|
-
/**
|
|
3098
|
-
* @description get quote history by symbol
|
|
3099
|
-
* @tags Quotes
|
|
3100
|
-
* @name GitQuoteHistory
|
|
3101
|
-
* @summary Get quote history
|
|
3102
|
-
* @request POST:/quote-history
|
|
3103
|
-
* @secure
|
|
3104
|
-
*/
|
|
3105
|
-
gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
|
|
3106
|
-
/**
|
|
3107
|
-
* @description Returns a list of quotes equity info for specified symbols.
|
|
3108
|
-
* @tags Quotes
|
|
3109
|
-
* @name GetQuotesEquityData
|
|
3110
|
-
* @summary Get Quotes Equity data
|
|
3111
|
-
* @request GET:/quotes/equity
|
|
3112
|
-
* @secure
|
|
3113
|
-
*/
|
|
3114
|
-
getQuotesEquityData(query: {
|
|
3115
|
-
/** Comma separated symbols */
|
|
3116
|
-
symbols: string;
|
|
3117
|
-
/** NBBO || DELAYED || CBOE || CBOE1 || BATS || REALTIME || REALTIME_SNAPSHOT */
|
|
3118
|
-
quote_access_type: string;
|
|
3119
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
3120
|
-
}
|
|
3121
|
-
export class Intraday<HandleError extends boolean = boolean> {
|
|
3122
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3123
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3124
|
-
/**
|
|
3125
|
-
* @description Returns an array of intraday chart data values for the given ticker.
|
|
3126
|
-
* @tags Intraday
|
|
3127
|
-
* @name IntradayQuotes
|
|
3128
|
-
* @summary Get an array of intraday chart data values for the given ticker
|
|
3129
|
-
* @request POST:/intraday/quotes
|
|
3017
|
+
* @description Returns an array of intraday chart data values for the given ticker.
|
|
3018
|
+
* @tags Intraday
|
|
3019
|
+
* @name IntradayQuotes
|
|
3020
|
+
* @summary Get an array of intraday chart data values for the given ticker
|
|
3021
|
+
* @request POST:/intraday/quotes
|
|
3130
3022
|
* @secure
|
|
3131
3023
|
*/
|
|
3132
3024
|
intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
|
|
@@ -3158,6 +3050,19 @@ export class Ipos<HandleError extends boolean = boolean> {
|
|
|
3158
3050
|
offset: number;
|
|
3159
3051
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
3160
3052
|
}
|
|
3053
|
+
export class Lists<HandleError extends boolean = boolean> {
|
|
3054
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3055
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3056
|
+
/**
|
|
3057
|
+
* @description filter custom lists
|
|
3058
|
+
* @tags lists
|
|
3059
|
+
* @name FilterCustomLists
|
|
3060
|
+
* @summary filter custom lists
|
|
3061
|
+
* @request POST:/custom-lists/filter
|
|
3062
|
+
* @secure
|
|
3063
|
+
*/
|
|
3064
|
+
filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
3065
|
+
}
|
|
3161
3066
|
export class Logos<HandleError extends boolean = boolean> {
|
|
3162
3067
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3163
3068
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3589,70 +3494,212 @@ export class Public<HandleError extends boolean = boolean> {
|
|
|
3589
3494
|
offset: number;
|
|
3590
3495
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
3591
3496
|
}
|
|
3592
|
-
export class
|
|
3497
|
+
export class Quotes<HandleError extends boolean = boolean> {
|
|
3593
3498
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3594
3499
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3595
3500
|
/**
|
|
3596
|
-
* @description
|
|
3597
|
-
* @tags
|
|
3598
|
-
* @name
|
|
3599
|
-
* @summary
|
|
3600
|
-
* @request
|
|
3501
|
+
* @description Get single historical quote
|
|
3502
|
+
* @tags Quotes
|
|
3503
|
+
* @name GitHistoricalQuote
|
|
3504
|
+
* @summary Get single historical quote
|
|
3505
|
+
* @request GET:/historical/quote
|
|
3601
3506
|
* @secure
|
|
3602
3507
|
*/
|
|
3603
|
-
|
|
3508
|
+
gitHistoricalQuote(query: {
|
|
3509
|
+
/** Symbol */
|
|
3510
|
+
symbol: string;
|
|
3511
|
+
/** Date */
|
|
3512
|
+
date: string;
|
|
3513
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
3604
3514
|
/**
|
|
3605
|
-
* @description get
|
|
3606
|
-
* @tags
|
|
3607
|
-
* @name
|
|
3608
|
-
* @summary
|
|
3609
|
-
* @request POST:/
|
|
3515
|
+
* @description get quote history by symbol
|
|
3516
|
+
* @tags Quotes
|
|
3517
|
+
* @name GitQuoteHistory
|
|
3518
|
+
* @summary Get quote history
|
|
3519
|
+
* @request POST:/quote-history
|
|
3610
3520
|
* @secure
|
|
3611
3521
|
*/
|
|
3612
|
-
|
|
3522
|
+
gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
|
|
3523
|
+
/**
|
|
3524
|
+
* @description Returns a list of quotes equity info for specified symbols.
|
|
3525
|
+
* @tags Quotes
|
|
3526
|
+
* @name GetQuotesEquityData
|
|
3527
|
+
* @summary Get Quotes Equity data
|
|
3528
|
+
* @request GET:/quotes/equity
|
|
3529
|
+
* @secure
|
|
3530
|
+
*/
|
|
3531
|
+
getQuotesEquityData(query: {
|
|
3532
|
+
/** Comma separated symbols */
|
|
3533
|
+
symbols: string;
|
|
3534
|
+
/** NBBO || DELAYED || CBOE || CBOE1 || BATS || REALTIME || REALTIME_SNAPSHOT */
|
|
3535
|
+
quote_access_type: string;
|
|
3536
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
3613
3537
|
}
|
|
3614
|
-
export class
|
|
3538
|
+
export class StockScreener<HandleError extends boolean = boolean> {
|
|
3615
3539
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3616
3540
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3617
3541
|
/**
|
|
3618
|
-
* @description
|
|
3619
|
-
* @tags
|
|
3620
|
-
* @name
|
|
3621
|
-
* @summary
|
|
3622
|
-
* @request
|
|
3542
|
+
* @description data for visual heat map
|
|
3543
|
+
* @tags StockScreener
|
|
3544
|
+
* @name StockMarketHeatmap
|
|
3545
|
+
* @summary data for visual heat map
|
|
3546
|
+
* @request GET:/heatmaps
|
|
3623
3547
|
* @secure
|
|
3624
3548
|
*/
|
|
3625
|
-
|
|
3549
|
+
stockMarketHeatmap(query: {
|
|
3550
|
+
/** Name of symbol list to fetch details for. Empty is default */
|
|
3551
|
+
heatmap_name?: string;
|
|
3552
|
+
/** NBBO || DELAYED || CBOE || CBOE1 || BATS || REALTIME || REALTIME_SNAPSHOT */
|
|
3553
|
+
quote_access_type: string;
|
|
3554
|
+
}, headers?: {
|
|
3555
|
+
/** Authorization */
|
|
3556
|
+
Authorization?: string;
|
|
3557
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
3626
3558
|
/**
|
|
3627
|
-
* @description
|
|
3628
|
-
* @tags
|
|
3629
|
-
* @name
|
|
3630
|
-
* @summary
|
|
3631
|
-
* @request POST:/
|
|
3559
|
+
* @description create or update heat map preset
|
|
3560
|
+
* @tags StockScreener
|
|
3561
|
+
* @name CreateStockMarketHeatmapPreset
|
|
3562
|
+
* @summary create or update heat map preset
|
|
3563
|
+
* @request POST:/heatmaps
|
|
3632
3564
|
* @secure
|
|
3633
3565
|
*/
|
|
3634
|
-
|
|
3566
|
+
createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3635
3567
|
/**
|
|
3636
|
-
* @description
|
|
3637
|
-
* @tags
|
|
3638
|
-
* @name
|
|
3639
|
-
* @summary
|
|
3640
|
-
* @request POST:/
|
|
3568
|
+
* @description Sector and Industry Group performance
|
|
3569
|
+
* @tags StockScreener
|
|
3570
|
+
* @name IndustriesPerformance
|
|
3571
|
+
* @summary get industries performance
|
|
3572
|
+
* @request POST:/industries-performance
|
|
3641
3573
|
* @secure
|
|
3642
3574
|
*/
|
|
3643
|
-
|
|
3644
|
-
/** Authorization */
|
|
3645
|
-
Authorization?: string;
|
|
3646
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError>>;
|
|
3575
|
+
industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
|
|
3647
3576
|
/**
|
|
3648
|
-
* @description
|
|
3649
|
-
* @tags
|
|
3650
|
-
* @name
|
|
3651
|
-
* @summary
|
|
3652
|
-
* @request
|
|
3577
|
+
* @description filter stocks by params
|
|
3578
|
+
* @tags StockScreener
|
|
3579
|
+
* @name StockScreener
|
|
3580
|
+
* @summary filter stocks by params
|
|
3581
|
+
* @request POST:/stock-screener
|
|
3653
3582
|
* @secure
|
|
3654
3583
|
*/
|
|
3655
|
-
|
|
3584
|
+
stockScreener(filter: InsightStockScreenerRequest, headers?: {
|
|
3585
|
+
/** Authorization */
|
|
3586
|
+
Authorization?: string;
|
|
3587
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
3588
|
+
/**
|
|
3589
|
+
* @description get screener presets
|
|
3590
|
+
* @tags StockScreener
|
|
3591
|
+
* @name GetScreenerPresets
|
|
3592
|
+
* @summary get screener presets
|
|
3593
|
+
* @request GET:/stock-screener/presets
|
|
3594
|
+
* @secure
|
|
3595
|
+
*/
|
|
3596
|
+
getScreenerPresets(query: {
|
|
3597
|
+
/** how many records to return */
|
|
3598
|
+
limit: number;
|
|
3599
|
+
/** how many records to skip */
|
|
3600
|
+
offset: number;
|
|
3601
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
3602
|
+
/**
|
|
3603
|
+
* @description update screener preset
|
|
3604
|
+
* @tags StockScreener
|
|
3605
|
+
* @name UpdateScreenerPreset
|
|
3606
|
+
* @summary update screener preset
|
|
3607
|
+
* @request PUT:/stock-screener/presets
|
|
3608
|
+
* @secure
|
|
3609
|
+
*/
|
|
3610
|
+
updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
3611
|
+
/**
|
|
3612
|
+
* @description create screener preset
|
|
3613
|
+
* @tags StockScreener
|
|
3614
|
+
* @name CreateOrScreenerPreset
|
|
3615
|
+
* @summary create screener preset
|
|
3616
|
+
* @request POST:/stock-screener/presets
|
|
3617
|
+
* @secure
|
|
3618
|
+
*/
|
|
3619
|
+
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
3620
|
+
/**
|
|
3621
|
+
* @description remove screener preset
|
|
3622
|
+
* @tags StockScreener
|
|
3623
|
+
* @name RemoveScreenerPreset
|
|
3624
|
+
* @summary remove screener preset
|
|
3625
|
+
* @request DELETE:/stock-screener/presets
|
|
3626
|
+
* @secure
|
|
3627
|
+
*/
|
|
3628
|
+
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3629
|
+
/**
|
|
3630
|
+
* @description get top symbols
|
|
3631
|
+
* @tags StockScreener
|
|
3632
|
+
* @name GetTopSymbols
|
|
3633
|
+
* @summary get top symbols
|
|
3634
|
+
* @request POST:/stock-screener/top
|
|
3635
|
+
* @secure
|
|
3636
|
+
*/
|
|
3637
|
+
getTopSymbols(input: InsightGetTopSymbolsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
3638
|
+
}
|
|
3639
|
+
export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
3640
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3641
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3642
|
+
/**
|
|
3643
|
+
* @description filter stocks by params
|
|
3644
|
+
* @tags StockScreener
|
|
3645
|
+
* @name StockScreener
|
|
3646
|
+
* @summary filter stocks by params
|
|
3647
|
+
* @request POST:/stock-screener
|
|
3648
|
+
* @secure
|
|
3649
|
+
*/
|
|
3650
|
+
stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
3651
|
+
/**
|
|
3652
|
+
* @description get top symbols
|
|
3653
|
+
* @tags StockScreener
|
|
3654
|
+
* @name GetTopSymbols
|
|
3655
|
+
* @summary get top symbols
|
|
3656
|
+
* @request POST:/stock-screener/top
|
|
3657
|
+
* @secure
|
|
3658
|
+
*/
|
|
3659
|
+
getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
3660
|
+
}
|
|
3661
|
+
export class TipRank<HandleError extends boolean = boolean> {
|
|
3662
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3663
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3664
|
+
/**
|
|
3665
|
+
* @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
|
|
3666
|
+
* @tags TipRank
|
|
3667
|
+
* @name TiprankAnalystConsensus
|
|
3668
|
+
* @summary Get tiprank AnalystConsensus
|
|
3669
|
+
* @request POST:/tipranks/analyst-consensus
|
|
3670
|
+
* @secure
|
|
3671
|
+
*/
|
|
3672
|
+
tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
|
|
3673
|
+
/**
|
|
3674
|
+
* @description Returns the latest analyst ratings on a given stock or multiple stocks.
|
|
3675
|
+
* @tags TipRank
|
|
3676
|
+
* @name TiprankLatestAnalystRatingsOnStock
|
|
3677
|
+
* @summary Get tiprank LatestAnalystRatingsOnStock
|
|
3678
|
+
* @request POST:/tipranks/analyst-multi
|
|
3679
|
+
* @secure
|
|
3680
|
+
*/
|
|
3681
|
+
tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError>>;
|
|
3682
|
+
/**
|
|
3683
|
+
* @description Returns the latest analyst portfolio items.
|
|
3684
|
+
* @tags TipRank
|
|
3685
|
+
* @name TiprankPortfolios
|
|
3686
|
+
* @summary Get the latest analyst portfolio items
|
|
3687
|
+
* @request POST:/tipranks/analyst-portfolio
|
|
3688
|
+
* @secure
|
|
3689
|
+
*/
|
|
3690
|
+
tiprankPortfolios(filter: InsightPortfoliosRequest, headers?: {
|
|
3691
|
+
/** Authorization */
|
|
3692
|
+
Authorization?: string;
|
|
3693
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError>>;
|
|
3694
|
+
/**
|
|
3695
|
+
* @description Returns the analyst profile information
|
|
3696
|
+
* @tags TipRank
|
|
3697
|
+
* @name TiprankAnalystProfile
|
|
3698
|
+
* @summary Get tiprank AnalystProfile
|
|
3699
|
+
* @request GET:/tipranks/analyst-profile
|
|
3700
|
+
* @secure
|
|
3701
|
+
*/
|
|
3702
|
+
tiprankAnalystProfile(query: {
|
|
3656
3703
|
/** ID of tiprank analyst profile */
|
|
3657
3704
|
id: string;
|
|
3658
3705
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystProfileResponse, HandleError>>;
|
|
@@ -3990,236 +4037,189 @@ export class UsageTracking<HandleError extends boolean = boolean> {
|
|
|
3990
4037
|
*/
|
|
3991
4038
|
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
3992
4039
|
}
|
|
3993
|
-
export
|
|
3994
|
-
after?: string;
|
|
3995
|
-
before?: string;
|
|
3996
|
-
}
|
|
3997
|
-
export interface InsightFixedIncomeV2 {
|
|
3998
|
-
a144: boolean;
|
|
3999
|
-
accrued_interest: number;
|
|
4000
|
-
bank_qualified: boolean;
|
|
4001
|
-
bond_warrant: boolean;
|
|
4002
|
-
call_type: string;
|
|
4003
|
-
callable: boolean;
|
|
4004
|
-
close_price: number;
|
|
4005
|
-
close_price_asof: string;
|
|
4006
|
-
close_ytw: number;
|
|
4007
|
-
convertible: boolean;
|
|
4008
|
-
country: string;
|
|
4009
|
-
country_code: string;
|
|
4010
|
-
country_domicile: string;
|
|
4011
|
-
country_issue: string;
|
|
4012
|
-
coupon: number;
|
|
4013
|
-
coupon_frequency: string;
|
|
4014
|
-
coupon_type: string;
|
|
4015
|
-
currency: string;
|
|
4016
|
-
cusip: string;
|
|
4017
|
-
dated_date: string;
|
|
4018
|
-
daycount: string;
|
|
4019
|
-
description: string;
|
|
4020
|
-
description_short: string;
|
|
4021
|
-
duration: number;
|
|
4022
|
-
first_coupon_date: string;
|
|
4023
|
-
insured: boolean;
|
|
4024
|
-
isin: string;
|
|
4025
|
-
issue_date: string;
|
|
4026
|
-
issue_minimum_denomination: number;
|
|
4027
|
-
issue_price: number;
|
|
4028
|
-
issue_size: number;
|
|
4029
|
-
issuer: string;
|
|
4030
|
-
last_coupon_date: string;
|
|
4031
|
-
liquidity_institutional_aggregate: number;
|
|
4032
|
-
liquidity_institutional_buy: number;
|
|
4033
|
-
liquidity_institutional_sell: number;
|
|
4034
|
-
liquidity_micro_aggregate: number;
|
|
4035
|
-
liquidity_micro_buy: number;
|
|
4036
|
-
liquidity_micro_sell: number;
|
|
4037
|
-
liquidity_retail_aggregate: number;
|
|
4038
|
-
liquidity_retail_buy: number;
|
|
4039
|
-
liquidity_retail_sell: number;
|
|
4040
|
-
maturity_date: string;
|
|
4041
|
-
municipal_state: string;
|
|
4042
|
-
municipal_taxable_federal: boolean;
|
|
4043
|
-
municipal_type: string;
|
|
4044
|
-
next_call_date: string;
|
|
4045
|
-
next_call_price: number;
|
|
4046
|
-
next_coupon_date: string;
|
|
4047
|
-
par_value: number;
|
|
4048
|
-
perpetual: boolean;
|
|
4049
|
-
private_placement: boolean;
|
|
4050
|
-
purpose: string;
|
|
4051
|
-
puttable: boolean;
|
|
4052
|
-
reg_s: boolean;
|
|
4053
|
-
sector: string;
|
|
4054
|
-
seniority: string;
|
|
4055
|
-
settlement_convention: string;
|
|
4056
|
-
sinking_fund: boolean;
|
|
4057
|
-
sp_creditwatch: string;
|
|
4058
|
-
sp_creditwatch_date: string;
|
|
4059
|
-
sp_outlook: string;
|
|
4060
|
-
sp_outlook_date: string;
|
|
4061
|
-
sp_rating: string;
|
|
4062
|
-
sp_rating_date: string;
|
|
4063
|
-
status: string;
|
|
4064
|
-
ticker: string;
|
|
4065
|
-
treasury_subtype: string;
|
|
4066
|
-
type: string;
|
|
4067
|
-
updated_at: string;
|
|
4068
|
-
}
|
|
4069
|
-
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
4070
|
-
bank_qualified?: boolean;
|
|
4071
|
-
callable?: boolean;
|
|
4072
|
-
convertible?: boolean;
|
|
4073
|
-
country_codes?: string[];
|
|
4074
|
-
coupon?: InsightLessAndMoreV2;
|
|
4075
|
-
coupon_frequencies?: string[];
|
|
4076
|
-
cusip?: string[];
|
|
4077
|
-
description?: string;
|
|
4078
|
-
has_ticker?: boolean;
|
|
4079
|
-
insured?: boolean;
|
|
4080
|
-
isin?: string[];
|
|
4081
|
-
issue_date?: InsightBeforeAndAfterV2;
|
|
4082
|
-
issuer?: string;
|
|
4083
|
-
maturity?: InsightBeforeAndAfterV2;
|
|
4084
|
-
municipal_states?: string[];
|
|
4085
|
-
municipal_tax?: boolean;
|
|
4086
|
-
municipal_types?: string[];
|
|
4087
|
-
order?: InsightOrderingV2;
|
|
4088
|
-
pagination?: InsightPaginationV2;
|
|
4089
|
-
paging?: InsightPagingV2;
|
|
4090
|
-
purposes?: string[];
|
|
4091
|
-
sectors?: string[];
|
|
4092
|
-
sorts?: InsightOrderingV2[];
|
|
4093
|
-
sp_ratings?: string[];
|
|
4094
|
-
statuses?: string[];
|
|
4095
|
-
tickers?: string[];
|
|
4096
|
-
types?: string[];
|
|
4097
|
-
}
|
|
4098
|
-
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
4099
|
-
count: number;
|
|
4100
|
-
data: InsightFixedIncomeV2[];
|
|
4101
|
-
}
|
|
4102
|
-
export interface InsightGetTopSymbolsRequestV2 {
|
|
4103
|
-
exchange?: string[];
|
|
4104
|
-
market_cap?: InsightLessAndMoreV2;
|
|
4105
|
-
order?: InsightOrderingV2;
|
|
4106
|
-
pagination?: InsightPaginationV2;
|
|
4107
|
-
paging?: InsightPagingV2;
|
|
4108
|
-
price?: InsightLessAndMoreV2;
|
|
4109
|
-
quote_access_type?: string;
|
|
4110
|
-
sorts?: InsightOrderingV2[];
|
|
4111
|
-
volume?: InsightLessAndMoreV2;
|
|
4112
|
-
}
|
|
4113
|
-
export interface InsightIncludeExcludeV2 {
|
|
4114
|
-
exclude?: string[];
|
|
4115
|
-
include?: string[];
|
|
4116
|
-
}
|
|
4117
|
-
export interface InsightLessAndMoreV2 {
|
|
4118
|
-
less_than?: number;
|
|
4119
|
-
more_than?: number;
|
|
4120
|
-
}
|
|
4121
|
-
export interface InsightOrderingV2 {
|
|
4122
|
-
/** @default "asc" */
|
|
4123
|
-
direction: InsightOrderingDirectionEnumV2;
|
|
4124
|
-
/**
|
|
4125
|
-
* Sort direction:
|
|
4126
|
-
* * asc - Ascending, from A to Z.
|
|
4127
|
-
* * desc - Descending, from Z to A.
|
|
4128
|
-
*/
|
|
4129
|
-
field: string;
|
|
4130
|
-
}
|
|
4131
|
-
export interface InsightPaginationV2 {
|
|
4132
|
-
page: number;
|
|
4133
|
-
size: number;
|
|
4134
|
-
}
|
|
4135
|
-
export interface InsightPagingV2 {
|
|
4136
|
-
limit: number;
|
|
4137
|
-
offset: number;
|
|
4138
|
-
}
|
|
4139
|
-
export interface InsightStockScreenerQuoteV2 {
|
|
4140
|
-
average_volume_30d: number;
|
|
4141
|
-
company_name: string;
|
|
4142
|
-
dividend_ex_date: string;
|
|
4143
|
-
dividend_pay_date: string;
|
|
4144
|
-
dividend_percent: number;
|
|
4145
|
-
exchange: string;
|
|
4146
|
-
exchange_name: string;
|
|
4147
|
-
gap: number;
|
|
4148
|
-
industry: string;
|
|
4149
|
-
industry_code: string;
|
|
4150
|
-
last_price: number;
|
|
4151
|
-
market_cap: number;
|
|
4152
|
-
pe_ratio: number;
|
|
4153
|
-
price_change: number;
|
|
4154
|
-
price_change_percent: number;
|
|
4155
|
-
symbol: string;
|
|
4156
|
-
volume: number;
|
|
4157
|
-
}
|
|
4158
|
-
export interface InsightStockScreenerRequestV2 {
|
|
4159
|
-
average_volume_30d?: InsightLessAndMoreV2;
|
|
4160
|
-
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
4161
|
-
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
4162
|
-
dividend_percent?: InsightLessAndMoreV2;
|
|
4163
|
-
exchange?: InsightIncludeExcludeV2;
|
|
4164
|
-
gap?: InsightLessAndMoreV2;
|
|
4165
|
-
industry?: InsightIncludeExcludeV2;
|
|
4166
|
-
market_cap?: InsightLessAndMoreV2;
|
|
4167
|
-
order?: InsightOrderingV2;
|
|
4168
|
-
pagination?: InsightPaginationV2;
|
|
4169
|
-
paging?: InsightPagingV2;
|
|
4170
|
-
pe_ratio?: InsightLessAndMoreV2;
|
|
4171
|
-
price?: InsightLessAndMoreV2;
|
|
4172
|
-
quote_access_type?: string;
|
|
4173
|
-
sorts?: InsightOrderingV2[];
|
|
4174
|
-
stock_type?: string;
|
|
4175
|
-
volume?: InsightLessAndMoreV2;
|
|
4176
|
-
}
|
|
4177
|
-
export interface InsightStockScreenerResponseV2 {
|
|
4178
|
-
current_page: number;
|
|
4179
|
-
data: InsightStockScreenerQuoteV2[];
|
|
4180
|
-
page_count: number;
|
|
4181
|
-
status: number;
|
|
4182
|
-
total_records: number;
|
|
4183
|
-
}
|
|
4184
|
-
/** @default "asc" */
|
|
4185
|
-
export enum InsightOrderingDirectionEnumV2 {
|
|
4186
|
-
Asc = "asc",
|
|
4187
|
-
Desc = "desc"
|
|
4188
|
-
}
|
|
4189
|
-
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
4040
|
+
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
4190
4041
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4191
4042
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4192
4043
|
/**
|
|
4193
|
-
* @description
|
|
4194
|
-
* @tags
|
|
4195
|
-
* @name
|
|
4196
|
-
* @summary
|
|
4197
|
-
* @request
|
|
4044
|
+
* @description Get continents
|
|
4045
|
+
* @tags World Markets
|
|
4046
|
+
* @name ContinentGet
|
|
4047
|
+
* @summary Get continents
|
|
4048
|
+
* @request GET:/continents
|
|
4198
4049
|
* @secure
|
|
4199
4050
|
*/
|
|
4200
|
-
|
|
4201
|
-
|
|
4202
|
-
|
|
4203
|
-
|
|
4204
|
-
|
|
4051
|
+
continentGet(query: {
|
|
4052
|
+
/** Query limit */
|
|
4053
|
+
limit: number;
|
|
4054
|
+
/** Query offset */
|
|
4055
|
+
offset: number;
|
|
4056
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4205
4057
|
/**
|
|
4206
|
-
* @description
|
|
4207
|
-
* @tags
|
|
4208
|
-
* @name
|
|
4209
|
-
* @summary
|
|
4210
|
-
* @request
|
|
4058
|
+
* @description Edit continent
|
|
4059
|
+
* @tags World Markets
|
|
4060
|
+
* @name ContinentEdit
|
|
4061
|
+
* @summary Edit continent
|
|
4062
|
+
* @request PUT:/continents
|
|
4211
4063
|
* @secure
|
|
4212
4064
|
*/
|
|
4213
|
-
|
|
4065
|
+
continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4214
4066
|
/**
|
|
4215
|
-
* @description
|
|
4216
|
-
* @tags
|
|
4217
|
-
* @name
|
|
4218
|
-
* @summary
|
|
4219
|
-
* @request POST:/
|
|
4067
|
+
* @description Create continents
|
|
4068
|
+
* @tags World Markets
|
|
4069
|
+
* @name ContinentCreate
|
|
4070
|
+
* @summary Create continents
|
|
4071
|
+
* @request POST:/continents
|
|
4220
4072
|
* @secure
|
|
4221
4073
|
*/
|
|
4222
|
-
|
|
4074
|
+
continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4075
|
+
/**
|
|
4076
|
+
* @description Delete continent
|
|
4077
|
+
* @tags World Markets
|
|
4078
|
+
* @name ContinentDelete
|
|
4079
|
+
* @summary Delete continent
|
|
4080
|
+
* @request DELETE:/continents
|
|
4081
|
+
* @secure
|
|
4082
|
+
*/
|
|
4083
|
+
continentDelete(query: {
|
|
4084
|
+
/** continent id */
|
|
4085
|
+
id: string;
|
|
4086
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4087
|
+
/**
|
|
4088
|
+
* @description Get country codes
|
|
4089
|
+
* @tags World Markets
|
|
4090
|
+
* @name CountryCodeGet
|
|
4091
|
+
* @summary Get country codes
|
|
4092
|
+
* @request GET:/country-codes
|
|
4093
|
+
* @secure
|
|
4094
|
+
*/
|
|
4095
|
+
countryCodeGet(query: {
|
|
4096
|
+
/** Query limit */
|
|
4097
|
+
limit: number;
|
|
4098
|
+
/** Query offset */
|
|
4099
|
+
offset: number;
|
|
4100
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4101
|
+
/**
|
|
4102
|
+
* @description Edit country code
|
|
4103
|
+
* @tags World Markets
|
|
4104
|
+
* @name CountryCodeEdit
|
|
4105
|
+
* @summary Edit country code
|
|
4106
|
+
* @request PUT:/country-codes
|
|
4107
|
+
* @secure
|
|
4108
|
+
*/
|
|
4109
|
+
countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4110
|
+
/**
|
|
4111
|
+
* @description Add country codes
|
|
4112
|
+
* @tags World Markets
|
|
4113
|
+
* @name CountryCodeAdd
|
|
4114
|
+
* @summary Add country codes
|
|
4115
|
+
* @request POST:/country-codes
|
|
4116
|
+
* @secure
|
|
4117
|
+
*/
|
|
4118
|
+
countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4119
|
+
/**
|
|
4120
|
+
* @description Delete country code
|
|
4121
|
+
* @tags World Markets
|
|
4122
|
+
* @name CountryCodeDelete
|
|
4123
|
+
* @summary Delete country code
|
|
4124
|
+
* @request DELETE:/country-codes
|
|
4125
|
+
* @secure
|
|
4126
|
+
*/
|
|
4127
|
+
countryCodeDelete(query: {
|
|
4128
|
+
/** a3 code */
|
|
4129
|
+
a3code: string;
|
|
4130
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4131
|
+
/**
|
|
4132
|
+
* @description Get global indexes
|
|
4133
|
+
* @tags World Markets
|
|
4134
|
+
* @name GlobalIndexGet
|
|
4135
|
+
* @summary Get global indexes
|
|
4136
|
+
* @request GET:/global-indexes
|
|
4137
|
+
* @secure
|
|
4138
|
+
*/
|
|
4139
|
+
globalIndexGet(query: {
|
|
4140
|
+
/** Query limit */
|
|
4141
|
+
limit: number;
|
|
4142
|
+
/** Query offset */
|
|
4143
|
+
offset: number;
|
|
4144
|
+
/** Continent code for filtering */
|
|
4145
|
+
continent?: string;
|
|
4146
|
+
/** Quote type for price fetch */
|
|
4147
|
+
quote_access_type?: string;
|
|
4148
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4149
|
+
/**
|
|
4150
|
+
* @description Edit global index
|
|
4151
|
+
* @tags World Markets
|
|
4152
|
+
* @name GlobalIndexEdit
|
|
4153
|
+
* @summary Edit global index
|
|
4154
|
+
* @request PUT:/global-indexes
|
|
4155
|
+
* @secure
|
|
4156
|
+
*/
|
|
4157
|
+
globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4158
|
+
/**
|
|
4159
|
+
* @description Add global indexes
|
|
4160
|
+
* @tags World Markets
|
|
4161
|
+
* @name GlobalIndexAdd
|
|
4162
|
+
* @summary Add global indexes
|
|
4163
|
+
* @request POST:/global-indexes
|
|
4164
|
+
* @secure
|
|
4165
|
+
*/
|
|
4166
|
+
globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4167
|
+
/**
|
|
4168
|
+
* @description Edit global index
|
|
4169
|
+
* @tags World Markets
|
|
4170
|
+
* @name GlobalIndexDelete
|
|
4171
|
+
* @summary Delete global index
|
|
4172
|
+
* @request DELETE:/global-indexes
|
|
4173
|
+
* @secure
|
|
4174
|
+
*/
|
|
4175
|
+
globalIndexDelete(query: {
|
|
4176
|
+
/** a3 code */
|
|
4177
|
+
a3code: string;
|
|
4178
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4179
|
+
/**
|
|
4180
|
+
* @description Get regions
|
|
4181
|
+
* @tags World Markets
|
|
4182
|
+
* @name RegionGet
|
|
4183
|
+
* @summary Get regions
|
|
4184
|
+
* @request GET:/regions
|
|
4185
|
+
* @secure
|
|
4186
|
+
*/
|
|
4187
|
+
regionGet(query: {
|
|
4188
|
+
/** Query limit */
|
|
4189
|
+
limit: number;
|
|
4190
|
+
/** Query offset */
|
|
4191
|
+
offset: number;
|
|
4192
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
4193
|
+
/**
|
|
4194
|
+
* @description Edit region
|
|
4195
|
+
* @tags World Markets
|
|
4196
|
+
* @name RegionEdit
|
|
4197
|
+
* @summary Edit region
|
|
4198
|
+
* @request PUT:/regions
|
|
4199
|
+
* @secure
|
|
4200
|
+
*/
|
|
4201
|
+
regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4202
|
+
/**
|
|
4203
|
+
* @description Create regions
|
|
4204
|
+
* @tags World Markets
|
|
4205
|
+
* @name RegionCreate
|
|
4206
|
+
* @summary Create regions
|
|
4207
|
+
* @request POST:/regions
|
|
4208
|
+
* @secure
|
|
4209
|
+
*/
|
|
4210
|
+
regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
4211
|
+
/**
|
|
4212
|
+
* @description Delete region
|
|
4213
|
+
* @tags World Markets
|
|
4214
|
+
* @name RegionDelete
|
|
4215
|
+
* @summary Delete region
|
|
4216
|
+
* @request DELETE:/regions
|
|
4217
|
+
* @secure
|
|
4218
|
+
*/
|
|
4219
|
+
regionDelete(query: {
|
|
4220
|
+
/** region id */
|
|
4221
|
+
id: string;
|
|
4222
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4223
4223
|
}
|
|
4224
4224
|
export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
4225
4225
|
alphaTools: AlphaTools<HandleError>;
|