@orbis-systems/orbis-api-clients 0.7.13 → 0.7.14
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 +214 -114
- 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/bridgewise/index.d.ts +865 -865
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +1 -1
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +1 -1
- package/dist/bridgewise/index.js.map +1 -1
- package/dist/insight/index.d.ts +1180 -1180
- 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 +46 -46
- 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 +4036 -4036
- 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 +618 -618
- 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/dist/zerohash/index.d.ts +720 -720
- package/dist/zerohash/index.d.ts.map +1 -1
- package/dist/zerohash/index.esm.js +1 -1
- package/dist/zerohash/index.esm.js.map +1 -1
- package/dist/zerohash/index.js +1 -1
- package/dist/zerohash/index.js.map +1 -1
- package/package.json +1 -1
package/dist/insight/index.d.ts
CHANGED
|
@@ -4549,28 +4549,6 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
|
|
|
4549
4549
|
Date = "date",
|
|
4550
4550
|
Rank = "rank"
|
|
4551
4551
|
}
|
|
4552
|
-
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
4553
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4554
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4555
|
-
/**
|
|
4556
|
-
* @description get seasonlity data with comparison to benchmark
|
|
4557
|
-
* @tags AlphaTools
|
|
4558
|
-
* @name GetMomentumRatioGraph
|
|
4559
|
-
* @summary get seasonlity data
|
|
4560
|
-
* @request POST:/rst
|
|
4561
|
-
* @secure
|
|
4562
|
-
*/
|
|
4563
|
-
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
4564
|
-
/**
|
|
4565
|
-
* @description get seasonlity data with comparison to benchmark
|
|
4566
|
-
* @tags AlphaTools
|
|
4567
|
-
* @name GetSeasonality
|
|
4568
|
-
* @summary get seasonlity data
|
|
4569
|
-
* @request POST:/seasonality
|
|
4570
|
-
* @secure
|
|
4571
|
-
*/
|
|
4572
|
-
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
4573
|
-
}
|
|
4574
4552
|
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4575
4553
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4576
4554
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4610,6 +4588,188 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
|
4610
4588
|
*/
|
|
4611
4589
|
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
4612
4590
|
}
|
|
4591
|
+
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
4592
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4593
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4594
|
+
/**
|
|
4595
|
+
* @description Get continents
|
|
4596
|
+
* @tags World Markets
|
|
4597
|
+
* @name ContinentGet
|
|
4598
|
+
* @summary Get continents
|
|
4599
|
+
* @request GET:/continents
|
|
4600
|
+
* @secure
|
|
4601
|
+
*/
|
|
4602
|
+
continentGet(query: {
|
|
4603
|
+
/** Query limit */
|
|
4604
|
+
limit: number;
|
|
4605
|
+
/** Query offset */
|
|
4606
|
+
offset: number;
|
|
4607
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4608
|
+
/**
|
|
4609
|
+
* @description Edit continent
|
|
4610
|
+
* @tags World Markets
|
|
4611
|
+
* @name ContinentEdit
|
|
4612
|
+
* @summary Edit continent
|
|
4613
|
+
* @request PUT:/continents
|
|
4614
|
+
* @secure
|
|
4615
|
+
*/
|
|
4616
|
+
continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4617
|
+
/**
|
|
4618
|
+
* @description Create continents
|
|
4619
|
+
* @tags World Markets
|
|
4620
|
+
* @name ContinentCreate
|
|
4621
|
+
* @summary Create continents
|
|
4622
|
+
* @request POST:/continents
|
|
4623
|
+
* @secure
|
|
4624
|
+
*/
|
|
4625
|
+
continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4626
|
+
/**
|
|
4627
|
+
* @description Delete continent
|
|
4628
|
+
* @tags World Markets
|
|
4629
|
+
* @name ContinentDelete
|
|
4630
|
+
* @summary Delete continent
|
|
4631
|
+
* @request DELETE:/continents
|
|
4632
|
+
* @secure
|
|
4633
|
+
*/
|
|
4634
|
+
continentDelete(query: {
|
|
4635
|
+
/** continent id */
|
|
4636
|
+
id: string;
|
|
4637
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4638
|
+
/**
|
|
4639
|
+
* @description Get country codes
|
|
4640
|
+
* @tags World Markets
|
|
4641
|
+
* @name CountryCodeGet
|
|
4642
|
+
* @summary Get country codes
|
|
4643
|
+
* @request GET:/country-codes
|
|
4644
|
+
* @secure
|
|
4645
|
+
*/
|
|
4646
|
+
countryCodeGet(query: {
|
|
4647
|
+
/** Query limit */
|
|
4648
|
+
limit: number;
|
|
4649
|
+
/** Query offset */
|
|
4650
|
+
offset: number;
|
|
4651
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4652
|
+
/**
|
|
4653
|
+
* @description Edit country code
|
|
4654
|
+
* @tags World Markets
|
|
4655
|
+
* @name CountryCodeEdit
|
|
4656
|
+
* @summary Edit country code
|
|
4657
|
+
* @request PUT:/country-codes
|
|
4658
|
+
* @secure
|
|
4659
|
+
*/
|
|
4660
|
+
countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4661
|
+
/**
|
|
4662
|
+
* @description Add country codes
|
|
4663
|
+
* @tags World Markets
|
|
4664
|
+
* @name CountryCodeAdd
|
|
4665
|
+
* @summary Add country codes
|
|
4666
|
+
* @request POST:/country-codes
|
|
4667
|
+
* @secure
|
|
4668
|
+
*/
|
|
4669
|
+
countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4670
|
+
/**
|
|
4671
|
+
* @description Delete country code
|
|
4672
|
+
* @tags World Markets
|
|
4673
|
+
* @name CountryCodeDelete
|
|
4674
|
+
* @summary Delete country code
|
|
4675
|
+
* @request DELETE:/country-codes
|
|
4676
|
+
* @secure
|
|
4677
|
+
*/
|
|
4678
|
+
countryCodeDelete(query: {
|
|
4679
|
+
/** a3 code */
|
|
4680
|
+
a3code: string;
|
|
4681
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4682
|
+
/**
|
|
4683
|
+
* @description Get global indexes
|
|
4684
|
+
* @tags World Markets
|
|
4685
|
+
* @name GlobalIndexGet
|
|
4686
|
+
* @summary Get global indexes
|
|
4687
|
+
* @request GET:/global-indexes
|
|
4688
|
+
* @secure
|
|
4689
|
+
*/
|
|
4690
|
+
globalIndexGet(query: {
|
|
4691
|
+
/** Query limit */
|
|
4692
|
+
limit: number;
|
|
4693
|
+
/** Query offset */
|
|
4694
|
+
offset: number;
|
|
4695
|
+
/** Continent code for filtering */
|
|
4696
|
+
continent?: string;
|
|
4697
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4698
|
+
/**
|
|
4699
|
+
* @description Edit global index
|
|
4700
|
+
* @tags World Markets
|
|
4701
|
+
* @name GlobalIndexEdit
|
|
4702
|
+
* @summary Edit global index
|
|
4703
|
+
* @request PUT:/global-indexes
|
|
4704
|
+
* @secure
|
|
4705
|
+
*/
|
|
4706
|
+
globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4707
|
+
/**
|
|
4708
|
+
* @description Add global indexes
|
|
4709
|
+
* @tags World Markets
|
|
4710
|
+
* @name GlobalIndexAdd
|
|
4711
|
+
* @summary Add global indexes
|
|
4712
|
+
* @request POST:/global-indexes
|
|
4713
|
+
* @secure
|
|
4714
|
+
*/
|
|
4715
|
+
globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4716
|
+
/**
|
|
4717
|
+
* @description Edit global index
|
|
4718
|
+
* @tags World Markets
|
|
4719
|
+
* @name GlobalIndexDelete
|
|
4720
|
+
* @summary Delete global index
|
|
4721
|
+
* @request DELETE:/global-indexes
|
|
4722
|
+
* @secure
|
|
4723
|
+
*/
|
|
4724
|
+
globalIndexDelete(query: {
|
|
4725
|
+
/** a3 code */
|
|
4726
|
+
a3code: string;
|
|
4727
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4728
|
+
/**
|
|
4729
|
+
* @description Get regions
|
|
4730
|
+
* @tags World Markets
|
|
4731
|
+
* @name RegionGet
|
|
4732
|
+
* @summary Get regions
|
|
4733
|
+
* @request GET:/regions
|
|
4734
|
+
* @secure
|
|
4735
|
+
*/
|
|
4736
|
+
regionGet(query: {
|
|
4737
|
+
/** Query limit */
|
|
4738
|
+
limit: number;
|
|
4739
|
+
/** Query offset */
|
|
4740
|
+
offset: number;
|
|
4741
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
4742
|
+
/**
|
|
4743
|
+
* @description Edit region
|
|
4744
|
+
* @tags World Markets
|
|
4745
|
+
* @name RegionEdit
|
|
4746
|
+
* @summary Edit region
|
|
4747
|
+
* @request PUT:/regions
|
|
4748
|
+
* @secure
|
|
4749
|
+
*/
|
|
4750
|
+
regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4751
|
+
/**
|
|
4752
|
+
* @description Create regions
|
|
4753
|
+
* @tags World Markets
|
|
4754
|
+
* @name RegionCreate
|
|
4755
|
+
* @summary Create regions
|
|
4756
|
+
* @request POST:/regions
|
|
4757
|
+
* @secure
|
|
4758
|
+
*/
|
|
4759
|
+
regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
4760
|
+
/**
|
|
4761
|
+
* @description Delete region
|
|
4762
|
+
* @tags World Markets
|
|
4763
|
+
* @name RegionDelete
|
|
4764
|
+
* @summary Delete region
|
|
4765
|
+
* @request DELETE:/regions
|
|
4766
|
+
* @secure
|
|
4767
|
+
*/
|
|
4768
|
+
regionDelete(query: {
|
|
4769
|
+
/** region id */
|
|
4770
|
+
id: string;
|
|
4771
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4772
|
+
}
|
|
4613
4773
|
export class CustomLists<HandleError extends boolean = boolean> {
|
|
4614
4774
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4615
4775
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4854,256 +5014,18 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
4854
5014
|
*/
|
|
4855
5015
|
getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
|
|
4856
5016
|
}
|
|
4857
|
-
export
|
|
4858
|
-
|
|
4859
|
-
|
|
4860
|
-
|
|
4861
|
-
|
|
4862
|
-
|
|
4863
|
-
|
|
4864
|
-
|
|
4865
|
-
|
|
4866
|
-
|
|
4867
|
-
|
|
4868
|
-
|
|
4869
|
-
close_price_asof: string;
|
|
4870
|
-
close_ytw: number;
|
|
4871
|
-
convertible: boolean;
|
|
4872
|
-
country: string;
|
|
4873
|
-
country_code: string;
|
|
4874
|
-
country_domicile: string;
|
|
4875
|
-
country_issue: string;
|
|
4876
|
-
coupon: number;
|
|
4877
|
-
coupon_frequency: string;
|
|
4878
|
-
coupon_type: string;
|
|
4879
|
-
currency: string;
|
|
4880
|
-
cusip: string;
|
|
4881
|
-
dated_date: string;
|
|
4882
|
-
daycount: string;
|
|
4883
|
-
description: string;
|
|
4884
|
-
description_short: string;
|
|
4885
|
-
duration: number;
|
|
4886
|
-
first_coupon_date: string;
|
|
4887
|
-
insured: boolean;
|
|
4888
|
-
isin: string;
|
|
4889
|
-
issue_date: string;
|
|
4890
|
-
issue_minimum_denomination: number;
|
|
4891
|
-
issue_price: number;
|
|
4892
|
-
issue_size: number;
|
|
4893
|
-
issuer: string;
|
|
4894
|
-
last_coupon_date: string;
|
|
4895
|
-
liquidity_institutional_aggregate: number;
|
|
4896
|
-
liquidity_institutional_buy: number;
|
|
4897
|
-
liquidity_institutional_sell: number;
|
|
4898
|
-
liquidity_micro_aggregate: number;
|
|
4899
|
-
liquidity_micro_buy: number;
|
|
4900
|
-
liquidity_micro_sell: number;
|
|
4901
|
-
liquidity_retail_aggregate: number;
|
|
4902
|
-
liquidity_retail_buy: number;
|
|
4903
|
-
liquidity_retail_sell: number;
|
|
4904
|
-
maturity_date: string;
|
|
4905
|
-
municipal_state: string;
|
|
4906
|
-
municipal_taxable_federal: boolean;
|
|
4907
|
-
municipal_type: string;
|
|
4908
|
-
next_call_date: string;
|
|
4909
|
-
next_call_price: number;
|
|
4910
|
-
next_coupon_date: string;
|
|
4911
|
-
par_value: number;
|
|
4912
|
-
perpetual: boolean;
|
|
4913
|
-
private_placement: boolean;
|
|
4914
|
-
purpose: string;
|
|
4915
|
-
puttable: boolean;
|
|
4916
|
-
reg_s: boolean;
|
|
4917
|
-
sector: string;
|
|
4918
|
-
seniority: string;
|
|
4919
|
-
settlement_convention: string;
|
|
4920
|
-
sinking_fund: boolean;
|
|
4921
|
-
sp_creditwatch: string;
|
|
4922
|
-
sp_creditwatch_date: string;
|
|
4923
|
-
sp_outlook: string;
|
|
4924
|
-
sp_outlook_date: string;
|
|
4925
|
-
sp_rating: string;
|
|
4926
|
-
sp_rating_date: string;
|
|
4927
|
-
status: string;
|
|
4928
|
-
ticker: string;
|
|
4929
|
-
treasury_subtype: string;
|
|
4930
|
-
type: string;
|
|
4931
|
-
updated_at: string;
|
|
4932
|
-
}
|
|
4933
|
-
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
4934
|
-
count: number;
|
|
4935
|
-
data: InsightFixedIncomeV2[];
|
|
4936
|
-
}
|
|
4937
|
-
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
4938
|
-
/** @example true */
|
|
4939
|
-
bank_qualified?: boolean;
|
|
4940
|
-
/** @example true */
|
|
4941
|
-
callable?: boolean;
|
|
4942
|
-
/** @example true */
|
|
4943
|
-
convertible?: boolean;
|
|
4944
|
-
/** @example ["USA"] */
|
|
4945
|
-
country_codes?: string[];
|
|
4946
|
-
coupon?: InsightLessAndMoreV2;
|
|
4947
|
-
/** @example ["quarterly","zero"] */
|
|
4948
|
-
coupon_frequencies?: string[];
|
|
4949
|
-
/** @example ["655664AH3","9128286R6"] */
|
|
4950
|
-
cusip?: string[];
|
|
4951
|
-
/**
|
|
4952
|
-
* @maxLength 100
|
|
4953
|
-
* @example "Donald's"
|
|
4954
|
-
*/
|
|
4955
|
-
description?: string;
|
|
4956
|
-
/** @example true */
|
|
4957
|
-
has_ticker?: boolean;
|
|
4958
|
-
/** @example true */
|
|
4959
|
-
insured?: boolean;
|
|
4960
|
-
/** @example ["US655664AH33","US9128286R69"] */
|
|
4961
|
-
isin?: string[];
|
|
4962
|
-
issue_date?: InsightBeforeAndAfterV2;
|
|
4963
|
-
/**
|
|
4964
|
-
* @maxLength 100
|
|
4965
|
-
* @example "Donald's"
|
|
4966
|
-
*/
|
|
4967
|
-
issuer?: string;
|
|
4968
|
-
maturity?: InsightBeforeAndAfterV2;
|
|
4969
|
-
/** @example ["NY"] */
|
|
4970
|
-
municipal_states?: string[];
|
|
4971
|
-
/** @example true */
|
|
4972
|
-
municipal_tax?: boolean;
|
|
4973
|
-
/** @example ["general_obligation"] */
|
|
4974
|
-
municipal_types?: string[];
|
|
4975
|
-
pagination: InsightPaginationV2;
|
|
4976
|
-
purposes?: string[];
|
|
4977
|
-
/** @example ["SOVEREIGN"] */
|
|
4978
|
-
sectors?: string[];
|
|
4979
|
-
sorts?: InsightOrderingV2[];
|
|
4980
|
-
/** @example ["AAA"] */
|
|
4981
|
-
sp_ratings?: string[];
|
|
4982
|
-
/** @example ["called","outstanding"] */
|
|
4983
|
-
statuses?: string[];
|
|
4984
|
-
tickers?: string[];
|
|
4985
|
-
/** @example ["corporate"] */
|
|
4986
|
-
types?: string[];
|
|
4987
|
-
}
|
|
4988
|
-
export interface InsightGetTopSymbolsRequestV2 {
|
|
4989
|
-
exchange?: string[];
|
|
4990
|
-
market_cap?: InsightLessAndMoreV2;
|
|
4991
|
-
pagination?: InsightPaginationV2;
|
|
4992
|
-
price?: InsightLessAndMoreV2;
|
|
4993
|
-
sorts?: InsightOrderingV2[];
|
|
4994
|
-
volume?: InsightLessAndMoreV2;
|
|
4995
|
-
}
|
|
4996
|
-
export interface InsightIncludeExcludeV2 {
|
|
4997
|
-
exclude?: string[];
|
|
4998
|
-
include?: string[];
|
|
4999
|
-
}
|
|
5000
|
-
export interface InsightLessAndMoreV2 {
|
|
5001
|
-
less_than?: number;
|
|
5002
|
-
more_than?: number;
|
|
5003
|
-
}
|
|
5004
|
-
export interface InsightOrderingV2 {
|
|
5005
|
-
/**
|
|
5006
|
-
* @default "asc"
|
|
5007
|
-
* @example "asc"
|
|
5008
|
-
*/
|
|
5009
|
-
direction: InsightOrderingDirectionEnumV2;
|
|
5010
|
-
/**
|
|
5011
|
-
* Sort direction:
|
|
5012
|
-
* * asc - Ascending, from A to Z.
|
|
5013
|
-
* * desc - Descending, from Z to A.
|
|
5014
|
-
* @example "name"
|
|
5015
|
-
*/
|
|
5016
|
-
field: string;
|
|
5017
|
-
}
|
|
5018
|
-
export interface InsightPaginationV2 {
|
|
5019
|
-
/**
|
|
5020
|
-
* @min 1
|
|
5021
|
-
* @example 1
|
|
5022
|
-
*/
|
|
5023
|
-
page: number;
|
|
5024
|
-
/**
|
|
5025
|
-
* @min 1
|
|
5026
|
-
* @max 50
|
|
5027
|
-
* @example 10
|
|
5028
|
-
*/
|
|
5029
|
-
size: number;
|
|
5030
|
-
}
|
|
5031
|
-
export interface InsightStockScreenerQuoteV2 {
|
|
5032
|
-
average_volume_30d: number;
|
|
5033
|
-
company_name: string;
|
|
5034
|
-
dividend_ex_date: string;
|
|
5035
|
-
dividend_pay_date: string;
|
|
5036
|
-
dividend_percent: number;
|
|
5037
|
-
exchange: string;
|
|
5038
|
-
exchange_name: string;
|
|
5039
|
-
gap: number;
|
|
5040
|
-
industry: string;
|
|
5041
|
-
industry_code: string;
|
|
5042
|
-
last_price: number;
|
|
5043
|
-
market_cap: number;
|
|
5044
|
-
pe_ratio: number;
|
|
5045
|
-
price_change: number;
|
|
5046
|
-
price_change_percent: number;
|
|
5047
|
-
symbol: string;
|
|
5048
|
-
volume: number;
|
|
5049
|
-
}
|
|
5050
|
-
export interface InsightStockScreenerRequestV2 {
|
|
5051
|
-
average_volume_30d?: InsightLessAndMoreV2;
|
|
5052
|
-
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
5053
|
-
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
5054
|
-
dividend_percent?: InsightLessAndMoreV2;
|
|
5055
|
-
exchange?: InsightIncludeExcludeV2;
|
|
5056
|
-
gap?: InsightLessAndMoreV2;
|
|
5057
|
-
industry?: InsightIncludeExcludeV2;
|
|
5058
|
-
market_cap?: InsightLessAndMoreV2;
|
|
5059
|
-
pagination: InsightPaginationV2;
|
|
5060
|
-
pe_ratio?: InsightLessAndMoreV2;
|
|
5061
|
-
price?: InsightLessAndMoreV2;
|
|
5062
|
-
sorts?: InsightOrderingV2[];
|
|
5063
|
-
/** @example "ADR" */
|
|
5064
|
-
stock_type?: string;
|
|
5065
|
-
volume?: InsightLessAndMoreV2;
|
|
5066
|
-
}
|
|
5067
|
-
export interface InsightStockScreenerResponseV2 {
|
|
5068
|
-
current_page: number;
|
|
5069
|
-
data: InsightStockScreenerQuoteV2[];
|
|
5070
|
-
page_count: number;
|
|
5071
|
-
status: number;
|
|
5072
|
-
total_records: number;
|
|
5073
|
-
}
|
|
5074
|
-
/**
|
|
5075
|
-
* @default "asc"
|
|
5076
|
-
* @example "asc"
|
|
5077
|
-
*/
|
|
5078
|
-
export enum InsightOrderingDirectionEnumV2 {
|
|
5079
|
-
Asc = "asc",
|
|
5080
|
-
Desc = "desc"
|
|
5081
|
-
}
|
|
5082
|
-
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
5083
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5084
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5085
|
-
/**
|
|
5086
|
-
* @description get fixed income entries
|
|
5087
|
-
* @tags FixedIncome
|
|
5088
|
-
* @name GetFixedIncomeEntries
|
|
5089
|
-
* @summary get fixed income entries
|
|
5090
|
-
* @request POST:/fixed-income
|
|
5091
|
-
* @secure
|
|
5092
|
-
*/
|
|
5093
|
-
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
5094
|
-
}
|
|
5095
|
-
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
5096
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5097
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5098
|
-
/**
|
|
5099
|
-
* @description get fundamentals by symbol data
|
|
5100
|
-
* @tags Fundamentals
|
|
5101
|
-
* @name GetFundamentalsBySymbolData
|
|
5102
|
-
* @summary get fundamentals by symbol data
|
|
5103
|
-
* @request POST:/fundamentals
|
|
5104
|
-
* @secure
|
|
5105
|
-
*/
|
|
5106
|
-
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5017
|
+
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
5018
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5019
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5020
|
+
/**
|
|
5021
|
+
* @description get fundamentals by symbol data
|
|
5022
|
+
* @tags Fundamentals
|
|
5023
|
+
* @name GetFundamentalsBySymbolData
|
|
5024
|
+
* @summary get fundamentals by symbol data
|
|
5025
|
+
* @request POST:/fundamentals
|
|
5026
|
+
* @secure
|
|
5027
|
+
*/
|
|
5028
|
+
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5107
5029
|
}
|
|
5108
5030
|
export class Funds<HandleError extends boolean = boolean> {
|
|
5109
5031
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5219,1003 +5141,833 @@ export class Funds<HandleError extends boolean = boolean> {
|
|
|
5219
5141
|
Authorization?: string;
|
|
5220
5142
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
|
|
5221
5143
|
}
|
|
5222
|
-
export class
|
|
5144
|
+
export class StockScreener<HandleError extends boolean = boolean> {
|
|
5223
5145
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5224
5146
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5225
5147
|
/**
|
|
5226
|
-
* @description
|
|
5227
|
-
* @tags
|
|
5228
|
-
* @name
|
|
5229
|
-
* @summary
|
|
5230
|
-
* @request
|
|
5148
|
+
* @description data for visual heat map
|
|
5149
|
+
* @tags StockScreener
|
|
5150
|
+
* @name StockMarketHeatmap
|
|
5151
|
+
* @summary data for visual heat map
|
|
5152
|
+
* @request GET:/heatmaps
|
|
5231
5153
|
* @secure
|
|
5232
5154
|
*/
|
|
5233
|
-
|
|
5234
|
-
|
|
5235
|
-
|
|
5236
|
-
|
|
5237
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5155
|
+
stockMarketHeatmap(query?: {
|
|
5156
|
+
/** Name of symbol list to fetch details for. Empty is default */
|
|
5157
|
+
heatmap_name?: string;
|
|
5158
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
5238
5159
|
/**
|
|
5239
|
-
* @description
|
|
5240
|
-
* @tags
|
|
5241
|
-
* @name
|
|
5242
|
-
* @summary
|
|
5243
|
-
* @request POST:/
|
|
5160
|
+
* @description create or update heat map preset
|
|
5161
|
+
* @tags StockScreener
|
|
5162
|
+
* @name CreateStockMarketHeatmapPreset
|
|
5163
|
+
* @summary create or update heat map preset
|
|
5164
|
+
* @request POST:/heatmaps
|
|
5244
5165
|
* @secure
|
|
5245
5166
|
*/
|
|
5246
|
-
|
|
5167
|
+
createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5247
5168
|
/**
|
|
5248
|
-
* @description
|
|
5249
|
-
* @tags
|
|
5250
|
-
* @name
|
|
5251
|
-
* @summary get
|
|
5252
|
-
* @request
|
|
5169
|
+
* @description Sector and Industry Group performance
|
|
5170
|
+
* @tags StockScreener
|
|
5171
|
+
* @name IndustriesPerformance
|
|
5172
|
+
* @summary get industries performance
|
|
5173
|
+
* @request POST:/industries-performance
|
|
5253
5174
|
* @secure
|
|
5254
5175
|
*/
|
|
5255
|
-
|
|
5256
|
-
/** how many records to return. Max value is 50 */
|
|
5257
|
-
limit: number;
|
|
5258
|
-
/** how many records to skip */
|
|
5259
|
-
offset: number;
|
|
5260
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5261
|
-
/**
|
|
5262
|
-
* @description get ipo info by symbol
|
|
5263
|
-
* @tags Ipos
|
|
5264
|
-
* @name GetIpos
|
|
5265
|
-
* @summary get ipo info by symbol
|
|
5266
|
-
* @request GET:/ipos/{symbol}
|
|
5267
|
-
* @secure
|
|
5268
|
-
*/
|
|
5269
|
-
getIpos(symbol: string, query?: {
|
|
5270
|
-
/** load quotes */
|
|
5271
|
-
load_quotes?: boolean;
|
|
5272
|
-
/** statuses */
|
|
5273
|
-
statuses?: string[];
|
|
5274
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
|
|
5275
|
-
}
|
|
5276
|
-
export class Logos<HandleError extends boolean = boolean> {
|
|
5277
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5278
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5279
|
-
/**
|
|
5280
|
-
* @description Returns converted logo for crypto symbol
|
|
5281
|
-
* @tags Logos
|
|
5282
|
-
* @name LogosConvertedCryptoSymbolLogo
|
|
5283
|
-
* @summary Get converted logo for crypto symbol
|
|
5284
|
-
* @request POST:/logos/converted-crypto-symbol-logo
|
|
5285
|
-
* @secure
|
|
5286
|
-
*/
|
|
5287
|
-
logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5176
|
+
industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
|
|
5288
5177
|
/**
|
|
5289
|
-
* @description
|
|
5290
|
-
* @tags
|
|
5291
|
-
* @name
|
|
5292
|
-
* @summary
|
|
5293
|
-
* @request POST:/
|
|
5178
|
+
* @description filter stocks by params
|
|
5179
|
+
* @tags StockScreener
|
|
5180
|
+
* @name StockScreener
|
|
5181
|
+
* @summary filter stocks by params
|
|
5182
|
+
* @request POST:/stock-screener
|
|
5294
5183
|
* @secure
|
|
5295
5184
|
*/
|
|
5296
|
-
|
|
5185
|
+
stockScreener(filter: InsightStockScreenerV1Request, headers?: {
|
|
5186
|
+
/** Authorization */
|
|
5187
|
+
Authorization?: string;
|
|
5188
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
5297
5189
|
/**
|
|
5298
|
-
* @description
|
|
5299
|
-
* @tags
|
|
5300
|
-
* @name
|
|
5301
|
-
* @summary
|
|
5302
|
-
* @request GET:/
|
|
5190
|
+
* @description get screener presets
|
|
5191
|
+
* @tags StockScreener
|
|
5192
|
+
* @name GetScreenerPresets
|
|
5193
|
+
* @summary get screener presets
|
|
5194
|
+
* @request GET:/stock-screener/presets
|
|
5303
5195
|
* @secure
|
|
5304
5196
|
*/
|
|
5305
|
-
|
|
5306
|
-
/**
|
|
5307
|
-
|
|
5308
|
-
|
|
5197
|
+
getScreenerPresets(query: {
|
|
5198
|
+
/** how many records to return */
|
|
5199
|
+
limit: number;
|
|
5200
|
+
/** how many records to skip */
|
|
5201
|
+
offset: number;
|
|
5202
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
5309
5203
|
/**
|
|
5310
|
-
* @description
|
|
5311
|
-
* @tags
|
|
5312
|
-
* @name
|
|
5313
|
-
* @summary
|
|
5314
|
-
* @request
|
|
5204
|
+
* @description update screener preset
|
|
5205
|
+
* @tags StockScreener
|
|
5206
|
+
* @name UpdateScreenerPreset
|
|
5207
|
+
* @summary update screener preset
|
|
5208
|
+
* @request PUT:/stock-screener/presets
|
|
5315
5209
|
* @secure
|
|
5316
5210
|
*/
|
|
5317
|
-
|
|
5318
|
-
/** Company symbol */
|
|
5319
|
-
symbol: string;
|
|
5320
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5211
|
+
updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5321
5212
|
/**
|
|
5322
|
-
* @description
|
|
5323
|
-
* @tags
|
|
5324
|
-
* @name
|
|
5325
|
-
* @summary
|
|
5326
|
-
* @request
|
|
5213
|
+
* @description create screener preset
|
|
5214
|
+
* @tags StockScreener
|
|
5215
|
+
* @name CreateOrScreenerPreset
|
|
5216
|
+
* @summary create screener preset
|
|
5217
|
+
* @request POST:/stock-screener/presets
|
|
5327
5218
|
* @secure
|
|
5328
5219
|
*/
|
|
5329
|
-
|
|
5330
|
-
/** Company symbol */
|
|
5331
|
-
symbol: string;
|
|
5332
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5220
|
+
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5333
5221
|
/**
|
|
5334
|
-
* @description
|
|
5335
|
-
* @tags
|
|
5336
|
-
* @name
|
|
5337
|
-
* @summary
|
|
5338
|
-
* @request
|
|
5222
|
+
* @description remove screener preset
|
|
5223
|
+
* @tags StockScreener
|
|
5224
|
+
* @name RemoveScreenerPreset
|
|
5225
|
+
* @summary remove screener preset
|
|
5226
|
+
* @request DELETE:/stock-screener/presets
|
|
5339
5227
|
* @secure
|
|
5340
5228
|
*/
|
|
5341
|
-
|
|
5229
|
+
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5342
5230
|
/**
|
|
5343
|
-
* @description
|
|
5344
|
-
* @tags
|
|
5345
|
-
* @name
|
|
5346
|
-
* @summary
|
|
5347
|
-
* @request POST:/
|
|
5231
|
+
* @description get top symbols
|
|
5232
|
+
* @tags StockScreener
|
|
5233
|
+
* @name GetTopSymbols
|
|
5234
|
+
* @summary get top symbols
|
|
5235
|
+
* @request POST:/stock-screener/top
|
|
5348
5236
|
* @secure
|
|
5349
5237
|
*/
|
|
5350
|
-
|
|
5238
|
+
getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
5239
|
+
}
|
|
5240
|
+
export class Intraday<HandleError extends boolean = boolean> {
|
|
5241
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5242
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5351
5243
|
/**
|
|
5352
|
-
* @description Returns
|
|
5353
|
-
* @tags
|
|
5354
|
-
* @name
|
|
5355
|
-
* @summary Get
|
|
5356
|
-
* @request
|
|
5244
|
+
* @description Returns an array of intraday chart data values for the given ticker.
|
|
5245
|
+
* @tags Intraday
|
|
5246
|
+
* @name IntradayQuotes
|
|
5247
|
+
* @summary Get an array of intraday chart data values for the given ticker
|
|
5248
|
+
* @request POST:/intraday/quotes
|
|
5357
5249
|
* @secure
|
|
5358
5250
|
*/
|
|
5359
|
-
|
|
5360
|
-
|
|
5361
|
-
|
|
5362
|
-
|
|
5251
|
+
intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
|
|
5252
|
+
}
|
|
5253
|
+
export class Quotes<HandleError extends boolean = boolean> {
|
|
5254
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5255
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5363
5256
|
/**
|
|
5364
|
-
* @description
|
|
5365
|
-
* @tags
|
|
5366
|
-
* @name
|
|
5367
|
-
* @summary Get
|
|
5368
|
-
* @request GET:/
|
|
5257
|
+
* @description Get single historical quote
|
|
5258
|
+
* @tags Quotes
|
|
5259
|
+
* @name GitHistoricalQuote
|
|
5260
|
+
* @summary Get single historical quote
|
|
5261
|
+
* @request GET:/historical/quote
|
|
5369
5262
|
* @secure
|
|
5370
5263
|
*/
|
|
5371
|
-
|
|
5372
|
-
/**
|
|
5264
|
+
gitHistoricalQuote(query: {
|
|
5265
|
+
/** Symbol */
|
|
5373
5266
|
symbol: string;
|
|
5374
|
-
|
|
5375
|
-
|
|
5376
|
-
|
|
5377
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5378
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5267
|
+
/** Date */
|
|
5268
|
+
date: string;
|
|
5269
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
5379
5270
|
/**
|
|
5380
|
-
* @description get
|
|
5381
|
-
* @tags
|
|
5382
|
-
* @name
|
|
5383
|
-
* @summary
|
|
5384
|
-
* @request POST:/
|
|
5271
|
+
* @description get quote history by symbol
|
|
5272
|
+
* @tags Quotes
|
|
5273
|
+
* @name GitQuoteHistory
|
|
5274
|
+
* @summary Get quote history
|
|
5275
|
+
* @request POST:/quote-history
|
|
5385
5276
|
* @secure
|
|
5386
5277
|
*/
|
|
5387
|
-
|
|
5278
|
+
gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
|
|
5388
5279
|
/**
|
|
5389
|
-
* @description
|
|
5390
|
-
* @tags
|
|
5391
|
-
* @name
|
|
5392
|
-
* @summary
|
|
5393
|
-
* @request GET:/
|
|
5280
|
+
* @description Returns a list of quotes equity info for specified symbols.
|
|
5281
|
+
* @tags Quotes
|
|
5282
|
+
* @name GetQuotesEquityData
|
|
5283
|
+
* @summary Get Quotes Equity data
|
|
5284
|
+
* @request GET:/quotes/equity
|
|
5394
5285
|
* @secure
|
|
5395
5286
|
*/
|
|
5396
|
-
|
|
5397
|
-
/**
|
|
5398
|
-
|
|
5399
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5287
|
+
getQuotesEquityData(query: {
|
|
5288
|
+
/** Comma separated symbols */
|
|
5289
|
+
symbols: string;
|
|
5290
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
5400
5291
|
}
|
|
5401
|
-
export class
|
|
5292
|
+
export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
5402
5293
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5403
5294
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5404
5295
|
/**
|
|
5405
|
-
* @description
|
|
5406
|
-
* @tags
|
|
5407
|
-
* @name
|
|
5408
|
-
* @summary
|
|
5409
|
-
* @request
|
|
5296
|
+
* @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
|
|
5297
|
+
* @tags PreIPOCompanies
|
|
5298
|
+
* @name MonarkOghlcDataForSymbol
|
|
5299
|
+
* @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
|
|
5300
|
+
* @request GET:/ipos/market-data/ohlc/{symbol}
|
|
5410
5301
|
* @secure
|
|
5411
5302
|
*/
|
|
5412
|
-
|
|
5303
|
+
monarkOghlcDataForSymbol(symbol: string, query?: {
|
|
5304
|
+
/** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
5305
|
+
from?: string;
|
|
5306
|
+
/** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
5307
|
+
to?: string;
|
|
5308
|
+
/** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
|
|
5309
|
+
interval?: string;
|
|
5310
|
+
/** Limit the number of OHLC data points returned. Default is 100. */
|
|
5311
|
+
limit?: number;
|
|
5312
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
|
|
5313
|
+
close?: number;
|
|
5314
|
+
high?: number;
|
|
5315
|
+
low?: number;
|
|
5316
|
+
open?: number;
|
|
5317
|
+
time?: string;
|
|
5318
|
+
volume?: number;
|
|
5319
|
+
}[], HandleError>>;
|
|
5413
5320
|
/**
|
|
5414
|
-
* @description
|
|
5415
|
-
* @tags
|
|
5416
|
-
* @name
|
|
5417
|
-
* @summary
|
|
5418
|
-
* @request
|
|
5321
|
+
* @description Retrieves all symbols available in the market data
|
|
5322
|
+
* @tags PreIPOCompanies
|
|
5323
|
+
* @name MonarkAllAvailableSymbols
|
|
5324
|
+
* @summary Retrieves all symbols available in the market data
|
|
5325
|
+
* @request GET:/ipos/market-data/symbols
|
|
5419
5326
|
* @secure
|
|
5420
5327
|
*/
|
|
5421
|
-
|
|
5328
|
+
monarkAllAvailableSymbols(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5422
5329
|
/**
|
|
5423
|
-
* @description
|
|
5424
|
-
* @tags
|
|
5425
|
-
* @name
|
|
5426
|
-
* @summary
|
|
5427
|
-
* @request GET:/
|
|
5330
|
+
* @description get pre ipo companies Avaliable categories: on-demand business-video reverse-etl modern-data-stack video-api global-payroll banking-as-a-service ultrafast-delivery online-grocery website-builder fintech b2b venture-capital ecommerce creator-economy productivity real-estate private-markets-exchanges fpa vertical-saas card-issuing connected-fitness gig-marketplaces cms soc-2 analytics cap-table-management contractor-payroll social-media design online-whiteboard conversational-marketing expense-management stock-option-financing customer-onboarding crypto help-desk payroll documents databases mortgage-lending crypto-exchange marketing-automation payments operations checkout cybersecurity messaging investing marketplaces climate-tech robotics data-security online-education gaming universal-api automation biotechnology contact-center defense machine-learning logistics prefab-tech materials telehealth b2c alternative-proteins b2b-marketplaces wealth-management web3 neobank managed-marketplaces plg-crm jamstack public-safety background-checks identity-verification construction home-services sales blockchain-developer-platform space financial-data-aggregation ai writing-assistant autonomous-driving 401k-provider vector-databases ai-models devtools payroll-api internal-tools mlops bookkeeping cloud-infrastructure data-backups personal-finance ai-frameworks generative-ai cloud-gpus micromobility ai-avatars ai-chips life-sciences partnerships wearables fitness-tracking ai-search ai-medical-scribes networking quantum-computing code-editors
|
|
5331
|
+
* @tags PreIPOCompanies
|
|
5332
|
+
* @name GetPreIpoCompanies
|
|
5333
|
+
* @summary get pre ipo companies
|
|
5334
|
+
* @request GET:/ipos/pre-ipo-companies
|
|
5428
5335
|
* @secure
|
|
5429
5336
|
*/
|
|
5430
|
-
|
|
5431
|
-
/**
|
|
5337
|
+
getPreIpoCompanies(query: {
|
|
5338
|
+
/** search by company name */
|
|
5339
|
+
name?: string;
|
|
5340
|
+
/** search by categories */
|
|
5341
|
+
categories?: string;
|
|
5342
|
+
/** how many records to return. Max value is 50 */
|
|
5432
5343
|
limit: number;
|
|
5433
|
-
/**
|
|
5344
|
+
/** how many records to skip */
|
|
5434
5345
|
offset: number;
|
|
5435
|
-
/**
|
|
5436
|
-
|
|
5437
|
-
/**
|
|
5438
|
-
|
|
5439
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5346
|
+
/** sort field */
|
|
5347
|
+
order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
|
|
5348
|
+
/** sort direction */
|
|
5349
|
+
order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
|
|
5350
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
|
|
5440
5351
|
/**
|
|
5441
|
-
* @description
|
|
5442
|
-
* @tags
|
|
5443
|
-
* @name
|
|
5444
|
-
* @summary
|
|
5445
|
-
* @request
|
|
5352
|
+
* @description get pre ipo company by id
|
|
5353
|
+
* @tags PreIPOCompanies
|
|
5354
|
+
* @name GetPreIpoCompaniesById
|
|
5355
|
+
* @summary get pre ipo company by id
|
|
5356
|
+
* @request GET:/ipos/pre-ipo-companies/{id}
|
|
5357
|
+
* @originalName getPreIpoCompanies
|
|
5358
|
+
* @duplicate
|
|
5446
5359
|
* @secure
|
|
5447
5360
|
*/
|
|
5448
|
-
|
|
5361
|
+
getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
|
|
5449
5362
|
/**
|
|
5450
|
-
* @description
|
|
5451
|
-
* @tags
|
|
5452
|
-
* @name
|
|
5453
|
-
* @summary
|
|
5454
|
-
* @request
|
|
5363
|
+
* @description get pre ipo company funding rounds
|
|
5364
|
+
* @tags PreIPOCompanies
|
|
5365
|
+
* @name GetPreIpoCompanyFundingRounds
|
|
5366
|
+
* @summary get pre ipo company funding rounds
|
|
5367
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds
|
|
5455
5368
|
* @secure
|
|
5456
5369
|
*/
|
|
5457
|
-
|
|
5370
|
+
getPreIpoCompanyFundingRounds(query: {
|
|
5371
|
+
/** company id */
|
|
5372
|
+
pre_ipo_company_id?: string;
|
|
5373
|
+
/** search by round name */
|
|
5374
|
+
round_name?: string;
|
|
5375
|
+
/** how many records to return. Max value is 50 */
|
|
5376
|
+
limit: number;
|
|
5377
|
+
/** how many records to skip */
|
|
5378
|
+
offset: number;
|
|
5379
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
|
|
5458
5380
|
/**
|
|
5459
|
-
* @description
|
|
5460
|
-
* @tags
|
|
5461
|
-
* @name
|
|
5462
|
-
* @summary
|
|
5463
|
-
* @request GET:/
|
|
5381
|
+
* @description get pre ipo company funding round by id
|
|
5382
|
+
* @tags PreIPOCompanies
|
|
5383
|
+
* @name GetPreIpoCompanyFundingRoundsById
|
|
5384
|
+
* @summary get pre ipo company funding round by id
|
|
5385
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds/{id}
|
|
5386
|
+
* @originalName getPreIpoCompanyFundingRounds
|
|
5387
|
+
* @duplicate
|
|
5464
5388
|
* @secure
|
|
5465
5389
|
*/
|
|
5466
|
-
|
|
5390
|
+
getPreIpoCompanyFundingRoundsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyFundingRound, HandleError>>;
|
|
5467
5391
|
/**
|
|
5468
|
-
* @description
|
|
5469
|
-
* @tags
|
|
5470
|
-
* @name
|
|
5471
|
-
* @summary
|
|
5472
|
-
* @request
|
|
5392
|
+
* @description get pre ipo company investments
|
|
5393
|
+
* @tags PreIPOCompanies
|
|
5394
|
+
* @name GetPreIpoCompanyInvestments
|
|
5395
|
+
* @summary get pre ipo company investments
|
|
5396
|
+
* @request GET:/ipos/pre-ipo-company-investments
|
|
5473
5397
|
* @secure
|
|
5474
5398
|
*/
|
|
5475
|
-
|
|
5399
|
+
getPreIpoCompanyInvestments(query: {
|
|
5400
|
+
/** company id */
|
|
5401
|
+
pre_ipo_company_id?: string;
|
|
5402
|
+
/** company name */
|
|
5403
|
+
company_name?: string;
|
|
5404
|
+
/** how many records to return. Max value is 50 */
|
|
5405
|
+
limit: number;
|
|
5406
|
+
/** how many records to skip */
|
|
5407
|
+
offset: number;
|
|
5408
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
|
|
5476
5409
|
/**
|
|
5477
|
-
* @description
|
|
5478
|
-
* @tags
|
|
5479
|
-
* @name
|
|
5480
|
-
* @summary
|
|
5481
|
-
* @request GET:/
|
|
5410
|
+
* @description get pre ipo company investment by id
|
|
5411
|
+
* @tags PreIPOCompanies
|
|
5412
|
+
* @name GetPreIpoCompanyInvestmentsById
|
|
5413
|
+
* @summary get pre ipo company investment by id
|
|
5414
|
+
* @request GET:/ipos/pre-ipo-company-investments/{id}
|
|
5415
|
+
* @originalName getPreIpoCompanyInvestments
|
|
5416
|
+
* @duplicate
|
|
5482
5417
|
* @secure
|
|
5483
5418
|
*/
|
|
5484
|
-
|
|
5419
|
+
getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
|
|
5485
5420
|
/**
|
|
5486
|
-
* @description
|
|
5487
|
-
* @tags
|
|
5488
|
-
* @name
|
|
5489
|
-
* @summary
|
|
5490
|
-
* @request
|
|
5421
|
+
* @description get pre ipo company news
|
|
5422
|
+
* @tags PreIPOCompanies
|
|
5423
|
+
* @name GetPreIpoCompanyNews
|
|
5424
|
+
* @summary get pre ipo company news
|
|
5425
|
+
* @request GET:/ipos/pre-ipo-company-news
|
|
5491
5426
|
* @secure
|
|
5492
5427
|
*/
|
|
5493
|
-
|
|
5428
|
+
getPreIpoCompanyNews(query: {
|
|
5429
|
+
/** company id */
|
|
5430
|
+
pre_ipo_company_id?: string;
|
|
5431
|
+
/** search by headline */
|
|
5432
|
+
headline?: string;
|
|
5433
|
+
/** how many records to return. Max value is 50 */
|
|
5434
|
+
limit: number;
|
|
5435
|
+
/** how many records to skip */
|
|
5436
|
+
offset: number;
|
|
5437
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
|
|
5494
5438
|
/**
|
|
5495
|
-
* @description
|
|
5496
|
-
* @tags
|
|
5497
|
-
* @name
|
|
5498
|
-
* @summary
|
|
5499
|
-
* @request
|
|
5439
|
+
* @description get pre ipo company news by id
|
|
5440
|
+
* @tags PreIPOCompanies
|
|
5441
|
+
* @name GetPreIpoCompanyNewsById
|
|
5442
|
+
* @summary get pre ipo company news by id
|
|
5443
|
+
* @request GET:/ipos/pre-ipo-company-news/{id}
|
|
5444
|
+
* @originalName getPreIpoCompanyNews
|
|
5445
|
+
* @duplicate
|
|
5500
5446
|
* @secure
|
|
5501
5447
|
*/
|
|
5502
|
-
|
|
5448
|
+
getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
|
|
5503
5449
|
/**
|
|
5504
|
-
* @description
|
|
5505
|
-
* @tags
|
|
5506
|
-
* @name
|
|
5507
|
-
* @summary
|
|
5508
|
-
* @request GET:/
|
|
5450
|
+
* @description get pre ipo company research documents
|
|
5451
|
+
* @tags PreIPOCompanies
|
|
5452
|
+
* @name GetPreIpoCompanyResearchDocuments
|
|
5453
|
+
* @summary get pre ipo company research documents
|
|
5454
|
+
* @request GET:/ipos/pre-ipo-company-research-documents
|
|
5509
5455
|
* @secure
|
|
5510
5456
|
*/
|
|
5511
|
-
|
|
5512
|
-
/**
|
|
5513
|
-
|
|
5514
|
-
/**
|
|
5515
|
-
|
|
5516
|
-
/** Symbol */
|
|
5517
|
-
symbol?: string;
|
|
5457
|
+
getPreIpoCompanyResearchDocuments(query: {
|
|
5458
|
+
/** company id */
|
|
5459
|
+
pre_ipo_company_id?: string;
|
|
5460
|
+
/** search by title */
|
|
5461
|
+
title?: string;
|
|
5518
5462
|
/** how many records to return. Max value is 50 */
|
|
5519
5463
|
limit: number;
|
|
5520
5464
|
/** how many records to skip */
|
|
5521
5465
|
offset: number;
|
|
5522
|
-
|
|
5523
|
-
|
|
5524
|
-
|
|
5525
|
-
|
|
5526
|
-
|
|
5527
|
-
* @summary Get available stocks in DB (for filters)
|
|
5528
|
-
* @request GET:/news/symbols
|
|
5529
|
-
* @secure
|
|
5530
|
-
*/
|
|
5531
|
-
newsAvailableStocks(query?: {
|
|
5532
|
-
/** Limit */
|
|
5533
|
-
limit?: number;
|
|
5534
|
-
/** Offset */
|
|
5535
|
-
offset?: number;
|
|
5536
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5466
|
+
/** search by research type */
|
|
5467
|
+
research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
|
|
5468
|
+
/** search by relation */
|
|
5469
|
+
relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
|
|
5470
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
|
|
5537
5471
|
/**
|
|
5538
|
-
* @description
|
|
5539
|
-
* @tags
|
|
5540
|
-
* @name
|
|
5541
|
-
* @summary
|
|
5542
|
-
* @request
|
|
5472
|
+
* @description get pre ipo company research document by id
|
|
5473
|
+
* @tags PreIPOCompanies
|
|
5474
|
+
* @name GetPreIpoCompanyResearchDocumentsById
|
|
5475
|
+
* @summary get pre ipo company research document by id
|
|
5476
|
+
* @request GET:/ipos/pre-ipo-company-research-documents/{id}
|
|
5477
|
+
* @originalName getPreIpoCompanyResearchDocuments
|
|
5478
|
+
* @duplicate
|
|
5543
5479
|
* @secure
|
|
5544
5480
|
*/
|
|
5545
|
-
|
|
5546
|
-
}
|
|
5547
|
-
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
5548
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5549
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5481
|
+
getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
|
|
5550
5482
|
/**
|
|
5551
|
-
* @description
|
|
5552
|
-
* @tags
|
|
5553
|
-
* @name
|
|
5554
|
-
* @summary
|
|
5555
|
-
* @request
|
|
5483
|
+
* @description get pre ipo company spvs
|
|
5484
|
+
* @tags PreIPOCompanies
|
|
5485
|
+
* @name GetInvestor
|
|
5486
|
+
* @summary get pre ipo company spvs
|
|
5487
|
+
* @request GET:/ipos/pre-ipo-company-spv/investor/{investor_id}
|
|
5556
5488
|
* @secure
|
|
5557
5489
|
*/
|
|
5558
|
-
|
|
5490
|
+
getInvestor(investorId: string, query: {
|
|
5491
|
+
/** search by monark stage */
|
|
5492
|
+
monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
|
|
5493
|
+
/** Optional param to filter returned spv's based on the exemptions claimed */
|
|
5494
|
+
exemptions_claimed?: string[];
|
|
5495
|
+
/** Optional param to filter returned spv's based on the name */
|
|
5496
|
+
name_filter?: string;
|
|
5497
|
+
/** investment id */
|
|
5498
|
+
pre_ipo_company_id?: string;
|
|
5499
|
+
/** investment id */
|
|
5500
|
+
pre_ipo_company_investment_id?: string;
|
|
5501
|
+
/** page number */
|
|
5502
|
+
page: number;
|
|
5503
|
+
/** page size */
|
|
5504
|
+
page_size: number;
|
|
5505
|
+
/** sort direction */
|
|
5506
|
+
sort_order?: InsightGetInvestorParamsSortOrderEnum;
|
|
5507
|
+
/** sort field */
|
|
5508
|
+
sort_by?: InsightGetInvestorParamsSortByEnum;
|
|
5509
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
|
|
5559
5510
|
/**
|
|
5560
|
-
* @description
|
|
5561
|
-
* @tags
|
|
5562
|
-
* @name
|
|
5563
|
-
* @summary
|
|
5564
|
-
* @request
|
|
5511
|
+
* @description get pre ipo company spv by id
|
|
5512
|
+
* @tags PreIPOCompanies
|
|
5513
|
+
* @name GetInvestorByIdAndInvestorId
|
|
5514
|
+
* @summary get pre ipo company spv by id
|
|
5515
|
+
* @request GET:/ipos/pre-ipo-company-spv/{id}/investor/{investor_id}
|
|
5516
|
+
* @originalName getInvestor
|
|
5517
|
+
* @duplicate
|
|
5565
5518
|
* @secure
|
|
5566
5519
|
*/
|
|
5567
|
-
|
|
5568
|
-
|
|
5569
|
-
|
|
5570
|
-
|
|
5571
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5520
|
+
getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
|
|
5521
|
+
/** default is false, if true documents will be included in the response */
|
|
5522
|
+
include_documents?: boolean;
|
|
5523
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
|
|
5572
5524
|
/**
|
|
5573
|
-
* @description get
|
|
5574
|
-
* @tags
|
|
5575
|
-
* @name
|
|
5576
|
-
* @summary get
|
|
5577
|
-
* @request
|
|
5525
|
+
* @description get pre ipo company spvs
|
|
5526
|
+
* @tags PreIPOCompanies
|
|
5527
|
+
* @name GetPreIpoCompanySpvs
|
|
5528
|
+
* @summary get pre ipo company spvs
|
|
5529
|
+
* @request GET:/ipos/pre-ipo-company-spvs
|
|
5578
5530
|
* @secure
|
|
5579
5531
|
*/
|
|
5580
|
-
|
|
5581
|
-
|
|
5582
|
-
|
|
5583
|
-
|
|
5584
|
-
|
|
5585
|
-
|
|
5586
|
-
|
|
5532
|
+
getPreIpoCompanySpvs(query: {
|
|
5533
|
+
/** company id */
|
|
5534
|
+
pre_ipo_company_id?: string;
|
|
5535
|
+
/** investment id */
|
|
5536
|
+
investment_id?: string;
|
|
5537
|
+
/** search by name */
|
|
5538
|
+
name?: string;
|
|
5539
|
+
/** search by company name */
|
|
5540
|
+
company_name?: string;
|
|
5541
|
+
/** how many records to return. Max value is 50 */
|
|
5542
|
+
limit: number;
|
|
5543
|
+
/** how many records to skip */
|
|
5544
|
+
offset: number;
|
|
5545
|
+
/** search by monark stage */
|
|
5546
|
+
monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
|
|
5547
|
+
/** sort direction */
|
|
5548
|
+
direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
|
|
5549
|
+
/** sort field */
|
|
5550
|
+
field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
|
|
5551
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
|
|
5552
|
+
/**
|
|
5553
|
+
* @description get pre ipo company spv by id
|
|
5554
|
+
* @tags PreIPOCompanies
|
|
5555
|
+
* @name GetPreIpoCompanySpvsById
|
|
5556
|
+
* @summary get pre ipo company spv by id
|
|
5557
|
+
* @request GET:/ipos/pre-ipo-company-spvs/{id}
|
|
5558
|
+
* @originalName getPreIpoCompanySpvs
|
|
5559
|
+
* @duplicate
|
|
5587
5560
|
* @secure
|
|
5588
5561
|
*/
|
|
5589
|
-
|
|
5562
|
+
getPreIpoCompanySpvsById(id: string, query?: {
|
|
5563
|
+
/** default is false, if true documents will be included in the response */
|
|
5564
|
+
include_documents?: boolean;
|
|
5565
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
|
|
5590
5566
|
}
|
|
5591
|
-
export class
|
|
5567
|
+
export class Ipos<HandleError extends boolean = boolean> {
|
|
5592
5568
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5593
5569
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5594
5570
|
/**
|
|
5595
|
-
* @description
|
|
5596
|
-
* @tags
|
|
5597
|
-
* @name
|
|
5598
|
-
* @summary
|
|
5599
|
-
* @request POST:/
|
|
5600
|
-
* @secure
|
|
5601
|
-
*/
|
|
5602
|
-
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
5603
|
-
/**
|
|
5604
|
-
* @description Returns articles
|
|
5605
|
-
* @tags Passport
|
|
5606
|
-
* @name PassportArticles
|
|
5607
|
-
* @summary Get articles
|
|
5608
|
-
* @request POST:/passport/articles
|
|
5571
|
+
* @description get recent ipos info
|
|
5572
|
+
* @tags Ipos
|
|
5573
|
+
* @name PostRecent
|
|
5574
|
+
* @summary get recent ipos info
|
|
5575
|
+
* @request POST:/ipos/recent
|
|
5609
5576
|
* @secure
|
|
5610
5577
|
*/
|
|
5611
|
-
|
|
5578
|
+
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5612
5579
|
/**
|
|
5613
|
-
* @description
|
|
5614
|
-
* @tags
|
|
5615
|
-
* @name
|
|
5616
|
-
* @summary
|
|
5617
|
-
* @request
|
|
5580
|
+
* @description get upcoming ipos info
|
|
5581
|
+
* @tags Ipos
|
|
5582
|
+
* @name GetUpcoming
|
|
5583
|
+
* @summary get upcoming ipos info
|
|
5584
|
+
* @request GET:/ipos/upcoming
|
|
5618
5585
|
* @secure
|
|
5619
5586
|
*/
|
|
5620
|
-
|
|
5587
|
+
getUpcoming(query: {
|
|
5588
|
+
/** how many records to return. Max value is 50 */
|
|
5589
|
+
limit: number;
|
|
5590
|
+
/** how many records to skip */
|
|
5591
|
+
offset: number;
|
|
5592
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5621
5593
|
/**
|
|
5622
|
-
* @description
|
|
5623
|
-
* @tags
|
|
5624
|
-
* @name
|
|
5625
|
-
* @summary
|
|
5626
|
-
* @request
|
|
5594
|
+
* @description get ipo info by symbol
|
|
5595
|
+
* @tags Ipos
|
|
5596
|
+
* @name GetIpos
|
|
5597
|
+
* @summary get ipo info by symbol
|
|
5598
|
+
* @request GET:/ipos/{symbol}
|
|
5627
5599
|
* @secure
|
|
5628
5600
|
*/
|
|
5629
|
-
|
|
5601
|
+
getIpos(symbol: string, query?: {
|
|
5602
|
+
/** load quotes */
|
|
5603
|
+
load_quotes?: boolean;
|
|
5604
|
+
/** statuses */
|
|
5605
|
+
statuses?: string[];
|
|
5606
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
|
|
5607
|
+
}
|
|
5608
|
+
export class MarketDates<HandleError extends boolean = boolean> {
|
|
5609
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5610
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5630
5611
|
/**
|
|
5631
|
-
* @description
|
|
5632
|
-
* @tags
|
|
5633
|
-
* @name
|
|
5634
|
-
* @summary
|
|
5635
|
-
* @request POST:/
|
|
5612
|
+
* @description get market dates history
|
|
5613
|
+
* @tags MarketDates
|
|
5614
|
+
* @name GetMarketDatesHistory
|
|
5615
|
+
* @summary get market dates history
|
|
5616
|
+
* @request POST:/market-dates/history
|
|
5636
5617
|
* @secure
|
|
5637
5618
|
*/
|
|
5638
|
-
|
|
5619
|
+
getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
|
|
5639
5620
|
/**
|
|
5640
|
-
* @description
|
|
5641
|
-
* @tags
|
|
5642
|
-
* @name
|
|
5643
|
-
* @summary
|
|
5644
|
-
* @request
|
|
5621
|
+
* @description get todays market hours
|
|
5622
|
+
* @tags MarketDates
|
|
5623
|
+
* @name GetTodaysMarketHours
|
|
5624
|
+
* @summary get todays market hours
|
|
5625
|
+
* @request GET:/market-dates/today
|
|
5645
5626
|
* @secure
|
|
5646
5627
|
*/
|
|
5647
|
-
|
|
5628
|
+
getTodaysMarketHours(query: {
|
|
5629
|
+
/** Market */
|
|
5630
|
+
market: string;
|
|
5631
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
5648
5632
|
}
|
|
5649
|
-
export class
|
|
5633
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
5650
5634
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5651
5635
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5652
5636
|
/**
|
|
5653
|
-
* @description
|
|
5654
|
-
* @tags
|
|
5655
|
-
* @name
|
|
5656
|
-
* @summary
|
|
5657
|
-
* @request
|
|
5637
|
+
* @description Returns converted logo for crypto symbol
|
|
5638
|
+
* @tags Logos
|
|
5639
|
+
* @name LogosConvertedCryptoSymbolLogo
|
|
5640
|
+
* @summary Get converted logo for crypto symbol
|
|
5641
|
+
* @request POST:/logos/converted-crypto-symbol-logo
|
|
5658
5642
|
* @secure
|
|
5659
5643
|
*/
|
|
5660
|
-
|
|
5661
|
-
/** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
5662
|
-
from?: string;
|
|
5663
|
-
/** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
5664
|
-
to?: string;
|
|
5665
|
-
/** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
|
|
5666
|
-
interval?: string;
|
|
5667
|
-
/** Limit the number of OHLC data points returned. Default is 100. */
|
|
5668
|
-
limit?: number;
|
|
5669
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
|
|
5670
|
-
close?: number;
|
|
5671
|
-
high?: number;
|
|
5672
|
-
low?: number;
|
|
5673
|
-
open?: number;
|
|
5674
|
-
time?: string;
|
|
5675
|
-
volume?: number;
|
|
5676
|
-
}[], HandleError>>;
|
|
5644
|
+
logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5677
5645
|
/**
|
|
5678
|
-
* @description
|
|
5679
|
-
* @tags
|
|
5680
|
-
* @name
|
|
5681
|
-
* @summary
|
|
5682
|
-
* @request
|
|
5646
|
+
* @description Returns converted logo for symbol
|
|
5647
|
+
* @tags Logos
|
|
5648
|
+
* @name LogosConvertedSymbolLogo
|
|
5649
|
+
* @summary Get converted logo for symbol
|
|
5650
|
+
* @request POST:/logos/converted-symbol-logo
|
|
5683
5651
|
* @secure
|
|
5684
5652
|
*/
|
|
5685
|
-
|
|
5653
|
+
logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5686
5654
|
/**
|
|
5687
|
-
* @description
|
|
5688
|
-
* @tags
|
|
5689
|
-
* @name
|
|
5690
|
-
* @summary
|
|
5691
|
-
* @request GET:/
|
|
5655
|
+
* @description Returns logo for crypto symbol
|
|
5656
|
+
* @tags Logos
|
|
5657
|
+
* @name LogosCryptoSymbolLogo
|
|
5658
|
+
* @summary Get logo for crypto symbol
|
|
5659
|
+
* @request GET:/logos/crypto-symbol-logo
|
|
5692
5660
|
* @secure
|
|
5693
5661
|
*/
|
|
5694
|
-
|
|
5695
|
-
/**
|
|
5696
|
-
|
|
5697
|
-
|
|
5698
|
-
categories?: string;
|
|
5699
|
-
/** how many records to return. Max value is 50 */
|
|
5700
|
-
limit: number;
|
|
5701
|
-
/** how many records to skip */
|
|
5702
|
-
offset: number;
|
|
5703
|
-
/** sort field */
|
|
5704
|
-
order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
|
|
5705
|
-
/** sort direction */
|
|
5706
|
-
order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
|
|
5707
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
|
|
5662
|
+
logosCryptoSymbolLogo(query: {
|
|
5663
|
+
/** Company symbol */
|
|
5664
|
+
symbol: string;
|
|
5665
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
|
|
5708
5666
|
/**
|
|
5709
|
-
* @description
|
|
5710
|
-
* @tags
|
|
5711
|
-
* @name
|
|
5712
|
-
* @summary
|
|
5713
|
-
* @request GET:/
|
|
5714
|
-
* @originalName getPreIpoCompanies
|
|
5715
|
-
* @duplicate
|
|
5667
|
+
* @description Returns direct logo for crypto symbol
|
|
5668
|
+
* @tags Logos
|
|
5669
|
+
* @name LogosDirectCryptoSymbolLogo
|
|
5670
|
+
* @summary Get direct logo for crypto symbol
|
|
5671
|
+
* @request GET:/logos/direct-crypto-symbol-logo
|
|
5716
5672
|
* @secure
|
|
5717
5673
|
*/
|
|
5718
|
-
|
|
5674
|
+
logosDirectCryptoSymbolLogo(query: {
|
|
5675
|
+
/** Company symbol */
|
|
5676
|
+
symbol: string;
|
|
5677
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5719
5678
|
/**
|
|
5720
|
-
* @description
|
|
5721
|
-
* @tags
|
|
5722
|
-
* @name
|
|
5723
|
-
* @summary
|
|
5724
|
-
* @request GET:/
|
|
5679
|
+
* @description Returns direct logo for symbol
|
|
5680
|
+
* @tags Logos
|
|
5681
|
+
* @name LogosDirectSymbolLogo
|
|
5682
|
+
* @summary Get direct logo for symbol
|
|
5683
|
+
* @request GET:/logos/direct-symbol-logo
|
|
5725
5684
|
* @secure
|
|
5726
5685
|
*/
|
|
5727
|
-
|
|
5728
|
-
/**
|
|
5729
|
-
|
|
5730
|
-
|
|
5731
|
-
round_name?: string;
|
|
5732
|
-
/** how many records to return. Max value is 50 */
|
|
5733
|
-
limit: number;
|
|
5734
|
-
/** how many records to skip */
|
|
5735
|
-
offset: number;
|
|
5736
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
|
|
5686
|
+
logosDirectSymbolLogo(query: {
|
|
5687
|
+
/** Company symbol */
|
|
5688
|
+
symbol: string;
|
|
5689
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5737
5690
|
/**
|
|
5738
|
-
* @description
|
|
5739
|
-
* @tags
|
|
5740
|
-
* @name
|
|
5741
|
-
* @summary
|
|
5742
|
-
* @request
|
|
5743
|
-
* @originalName getPreIpoCompanyFundingRounds
|
|
5744
|
-
* @duplicate
|
|
5691
|
+
* @description Returns logos for multiple symbols
|
|
5692
|
+
* @tags Logos
|
|
5693
|
+
* @name LogosMultipleCryptoSymbolLogo
|
|
5694
|
+
* @summary Get logos for multiple symbols
|
|
5695
|
+
* @request POST:/logos/multiple-crypto-symbol-logo
|
|
5745
5696
|
* @secure
|
|
5746
5697
|
*/
|
|
5747
|
-
|
|
5698
|
+
logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
|
|
5748
5699
|
/**
|
|
5749
|
-
* @description
|
|
5750
|
-
* @tags
|
|
5751
|
-
* @name
|
|
5752
|
-
* @summary
|
|
5753
|
-
* @request
|
|
5754
|
-
* @secure
|
|
5755
|
-
*/
|
|
5756
|
-
getPreIpoCompanyInvestments(query: {
|
|
5757
|
-
/** company id */
|
|
5758
|
-
pre_ipo_company_id?: string;
|
|
5759
|
-
/** company name */
|
|
5760
|
-
company_name?: string;
|
|
5761
|
-
/** how many records to return. Max value is 50 */
|
|
5762
|
-
limit: number;
|
|
5763
|
-
/** how many records to skip */
|
|
5764
|
-
offset: number;
|
|
5765
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
|
|
5766
|
-
/**
|
|
5767
|
-
* @description get pre ipo company investment by id
|
|
5768
|
-
* @tags PreIPOCompanies
|
|
5769
|
-
* @name GetPreIpoCompanyInvestmentsById
|
|
5770
|
-
* @summary get pre ipo company investment by id
|
|
5771
|
-
* @request GET:/ipos/pre-ipo-company-investments/{id}
|
|
5772
|
-
* @originalName getPreIpoCompanyInvestments
|
|
5773
|
-
* @duplicate
|
|
5700
|
+
* @description Returns logos for multiple symbol
|
|
5701
|
+
* @tags Logos
|
|
5702
|
+
* @name LogosMultipleSymbolLogos
|
|
5703
|
+
* @summary Get logos for multiple symbols
|
|
5704
|
+
* @request POST:/logos/multiple-symbol-logos
|
|
5774
5705
|
* @secure
|
|
5775
5706
|
*/
|
|
5776
|
-
|
|
5707
|
+
logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
|
|
5777
5708
|
/**
|
|
5778
|
-
* @description
|
|
5779
|
-
* @tags
|
|
5780
|
-
* @name
|
|
5781
|
-
* @summary
|
|
5782
|
-
* @request GET:/
|
|
5709
|
+
* @description Returns links of socials logos for symbol
|
|
5710
|
+
* @tags Logos
|
|
5711
|
+
* @name LogosSocialSymbolLogos
|
|
5712
|
+
* @summary Get social logos for symbol
|
|
5713
|
+
* @request GET:/logos/social-symbol-logos
|
|
5783
5714
|
* @secure
|
|
5784
5715
|
*/
|
|
5785
|
-
|
|
5786
|
-
/**
|
|
5787
|
-
|
|
5788
|
-
|
|
5789
|
-
headline?: string;
|
|
5790
|
-
/** how many records to return. Max value is 50 */
|
|
5791
|
-
limit: number;
|
|
5792
|
-
/** how many records to skip */
|
|
5793
|
-
offset: number;
|
|
5794
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
|
|
5716
|
+
logosSocialSymbolLogos(query: {
|
|
5717
|
+
/** Company symbol */
|
|
5718
|
+
symbol: string;
|
|
5719
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
|
|
5795
5720
|
/**
|
|
5796
|
-
* @description
|
|
5797
|
-
* @tags
|
|
5798
|
-
* @name
|
|
5799
|
-
* @summary
|
|
5800
|
-
* @request GET:/
|
|
5801
|
-
* @originalName getPreIpoCompanyNews
|
|
5802
|
-
* @duplicate
|
|
5721
|
+
* @description Returns logos for company symbol
|
|
5722
|
+
* @tags Logos
|
|
5723
|
+
* @name LogosSymbolLogos
|
|
5724
|
+
* @summary Get symbol logos
|
|
5725
|
+
* @request GET:/logos/symbol-logos
|
|
5803
5726
|
* @secure
|
|
5804
5727
|
*/
|
|
5805
|
-
|
|
5728
|
+
logosSymbolLogos(query: {
|
|
5729
|
+
/** Company symbol */
|
|
5730
|
+
symbol: string;
|
|
5731
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
|
|
5732
|
+
}
|
|
5733
|
+
export class News<HandleError extends boolean = boolean> {
|
|
5734
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5735
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5806
5736
|
/**
|
|
5807
|
-
* @description
|
|
5808
|
-
* @tags
|
|
5809
|
-
* @name
|
|
5810
|
-
* @summary
|
|
5811
|
-
* @request
|
|
5737
|
+
* @description Returns available authors in DB
|
|
5738
|
+
* @tags News
|
|
5739
|
+
* @name NewsAvailableAuthors
|
|
5740
|
+
* @summary Get available authors in DB (for filters)
|
|
5741
|
+
* @request POST:/news/authors
|
|
5812
5742
|
* @secure
|
|
5813
5743
|
*/
|
|
5814
|
-
|
|
5815
|
-
/** company id */
|
|
5816
|
-
pre_ipo_company_id?: string;
|
|
5817
|
-
/** search by title */
|
|
5818
|
-
title?: string;
|
|
5819
|
-
/** how many records to return. Max value is 50 */
|
|
5820
|
-
limit: number;
|
|
5821
|
-
/** how many records to skip */
|
|
5822
|
-
offset: number;
|
|
5823
|
-
/** search by research type */
|
|
5824
|
-
research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
|
|
5825
|
-
/** search by relation */
|
|
5826
|
-
relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
|
|
5827
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
|
|
5744
|
+
newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5828
5745
|
/**
|
|
5829
|
-
* @description
|
|
5830
|
-
* @tags
|
|
5831
|
-
* @name
|
|
5832
|
-
* @summary
|
|
5833
|
-
* @request
|
|
5834
|
-
* @originalName getPreIpoCompanyResearchDocuments
|
|
5835
|
-
* @duplicate
|
|
5746
|
+
* @description Returns available channels in DB
|
|
5747
|
+
* @tags News
|
|
5748
|
+
* @name NewsAvailableChannels
|
|
5749
|
+
* @summary Get available channels in DB (for filters)
|
|
5750
|
+
* @request POST:/news/channels
|
|
5836
5751
|
* @secure
|
|
5837
5752
|
*/
|
|
5838
|
-
|
|
5753
|
+
newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5839
5754
|
/**
|
|
5840
|
-
* @description
|
|
5841
|
-
* @tags
|
|
5842
|
-
* @name
|
|
5843
|
-
* @summary
|
|
5844
|
-
* @request GET:/
|
|
5755
|
+
* @description Get featured articles
|
|
5756
|
+
* @tags News
|
|
5757
|
+
* @name GetFeaturedArticles
|
|
5758
|
+
* @summary Get featured articles
|
|
5759
|
+
* @request GET:/news/featured-articles
|
|
5845
5760
|
* @secure
|
|
5846
5761
|
*/
|
|
5847
|
-
|
|
5848
|
-
/**
|
|
5849
|
-
|
|
5850
|
-
/**
|
|
5851
|
-
|
|
5852
|
-
/**
|
|
5853
|
-
|
|
5854
|
-
/**
|
|
5855
|
-
|
|
5856
|
-
|
|
5857
|
-
pre_ipo_company_investment_id?: string;
|
|
5858
|
-
/** page number */
|
|
5859
|
-
page: number;
|
|
5860
|
-
/** page size */
|
|
5861
|
-
page_size: number;
|
|
5862
|
-
/** sort direction */
|
|
5863
|
-
sort_order?: InsightGetInvestorParamsSortOrderEnum;
|
|
5864
|
-
/** sort field */
|
|
5865
|
-
sort_by?: InsightGetInvestorParamsSortByEnum;
|
|
5866
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
|
|
5762
|
+
getFeaturedArticles(query: {
|
|
5763
|
+
/** Limit */
|
|
5764
|
+
limit: number;
|
|
5765
|
+
/** Offset */
|
|
5766
|
+
offset: number;
|
|
5767
|
+
/** Start date */
|
|
5768
|
+
start_date?: string;
|
|
5769
|
+
/** End date */
|
|
5770
|
+
end_date?: string;
|
|
5771
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
|
|
5867
5772
|
/**
|
|
5868
|
-
* @description
|
|
5869
|
-
* @tags
|
|
5870
|
-
* @name
|
|
5871
|
-
* @summary
|
|
5872
|
-
* @request
|
|
5873
|
-
* @originalName getInvestor
|
|
5874
|
-
* @duplicate
|
|
5773
|
+
* @description Update featured articles
|
|
5774
|
+
* @tags News
|
|
5775
|
+
* @name UpdateFeaturedArticles
|
|
5776
|
+
* @summary Update featured articles
|
|
5777
|
+
* @request PUT:/news/featured-articles
|
|
5875
5778
|
* @secure
|
|
5876
5779
|
*/
|
|
5877
|
-
|
|
5878
|
-
/** default is false, if true documents will be included in the response */
|
|
5879
|
-
include_documents?: boolean;
|
|
5880
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
|
|
5780
|
+
updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5881
5781
|
/**
|
|
5882
|
-
* @description
|
|
5883
|
-
* @tags
|
|
5884
|
-
* @name
|
|
5885
|
-
* @summary
|
|
5886
|
-
* @request
|
|
5782
|
+
* @description Create featured articles
|
|
5783
|
+
* @tags News
|
|
5784
|
+
* @name CreateFeaturedArticles
|
|
5785
|
+
* @summary Create featured articles
|
|
5786
|
+
* @request POST:/news/featured-articles
|
|
5887
5787
|
* @secure
|
|
5888
5788
|
*/
|
|
5889
|
-
|
|
5890
|
-
/** company id */
|
|
5891
|
-
pre_ipo_company_id?: string;
|
|
5892
|
-
/** investment id */
|
|
5893
|
-
investment_id?: string;
|
|
5894
|
-
/** search by name */
|
|
5895
|
-
name?: string;
|
|
5896
|
-
/** search by company name */
|
|
5897
|
-
company_name?: string;
|
|
5898
|
-
/** how many records to return. Max value is 50 */
|
|
5899
|
-
limit: number;
|
|
5900
|
-
/** how many records to skip */
|
|
5901
|
-
offset: number;
|
|
5902
|
-
/** search by monark stage */
|
|
5903
|
-
monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
|
|
5904
|
-
/** sort direction */
|
|
5905
|
-
direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
|
|
5906
|
-
/** sort field */
|
|
5907
|
-
field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
|
|
5908
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
|
|
5789
|
+
createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5909
5790
|
/**
|
|
5910
|
-
* @description
|
|
5911
|
-
* @tags
|
|
5912
|
-
* @name
|
|
5913
|
-
* @summary
|
|
5914
|
-
* @request GET:/
|
|
5915
|
-
* @originalName getPreIpoCompanySpvs
|
|
5916
|
-
* @duplicate
|
|
5791
|
+
* @description Get active featured articles
|
|
5792
|
+
* @tags News
|
|
5793
|
+
* @name GetActiveFeaturedArticles
|
|
5794
|
+
* @summary Get active featured articles
|
|
5795
|
+
* @request GET:/news/featured-articles/active
|
|
5917
5796
|
* @secure
|
|
5918
5797
|
*/
|
|
5919
|
-
|
|
5920
|
-
/** default is false, if true documents will be included in the response */
|
|
5921
|
-
include_documents?: boolean;
|
|
5922
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
|
|
5923
|
-
}
|
|
5924
|
-
export class Public<HandleError extends boolean = boolean> {
|
|
5925
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5926
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5798
|
+
getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
|
|
5927
5799
|
/**
|
|
5928
|
-
* @description
|
|
5929
|
-
* @tags
|
|
5930
|
-
* @name
|
|
5931
|
-
* @summary
|
|
5932
|
-
* @request
|
|
5800
|
+
* @description Set featured articles
|
|
5801
|
+
* @tags News
|
|
5802
|
+
* @name SetFeaturedArticles
|
|
5803
|
+
* @summary Set featured articles
|
|
5804
|
+
* @request POST:/news/featured-articles/set
|
|
5933
5805
|
* @secure
|
|
5934
5806
|
*/
|
|
5935
|
-
|
|
5936
|
-
/** Single symbol */
|
|
5937
|
-
symbol: string;
|
|
5938
|
-
/** Non-zero amount */
|
|
5939
|
-
amount: number;
|
|
5940
|
-
/** Start date for calculations */
|
|
5941
|
-
start_date: string;
|
|
5942
|
-
/** End date for calculations */
|
|
5943
|
-
end_date: string;
|
|
5944
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
5807
|
+
setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5945
5808
|
/**
|
|
5946
|
-
* @description
|
|
5947
|
-
* @tags
|
|
5948
|
-
* @name
|
|
5949
|
-
* @summary
|
|
5950
|
-
* @request GET:/
|
|
5809
|
+
* @description Get featured article
|
|
5810
|
+
* @tags News
|
|
5811
|
+
* @name GetFeaturedArticle
|
|
5812
|
+
* @summary Get featured article
|
|
5813
|
+
* @request GET:/news/featured-articles/{id}
|
|
5951
5814
|
* @secure
|
|
5952
5815
|
*/
|
|
5953
|
-
|
|
5954
|
-
/** Comma separated symbols */
|
|
5955
|
-
symbols: string;
|
|
5956
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
5816
|
+
getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
|
|
5957
5817
|
/**
|
|
5958
|
-
* @description
|
|
5959
|
-
* @tags
|
|
5960
|
-
* @name
|
|
5961
|
-
* @summary
|
|
5962
|
-
* @request
|
|
5963
|
-
* @secure
|
|
5964
|
-
*/
|
|
5965
|
-
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
5966
|
-
/** Annual or quarterly */
|
|
5967
|
-
mode: string;
|
|
5968
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5969
|
-
/**
|
|
5970
|
-
* @description Daily price history
|
|
5971
|
-
* @tags Public
|
|
5972
|
-
* @name DailyPriceHistory
|
|
5973
|
-
* @summary Daily price history
|
|
5974
|
-
* @request GET:/public/price-history/daily
|
|
5975
|
-
* @secure
|
|
5976
|
-
*/
|
|
5977
|
-
dailyPriceHistory(query: {
|
|
5978
|
-
/** Single symbol */
|
|
5979
|
-
symbol: string;
|
|
5980
|
-
/** Target date */
|
|
5981
|
-
date: string;
|
|
5982
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
5983
|
-
/**
|
|
5984
|
-
* @description Public quote profile
|
|
5985
|
-
* @tags Public
|
|
5986
|
-
* @name PublicQuoteProfile
|
|
5987
|
-
* @summary Public quote profile
|
|
5988
|
-
* @request GET:/public/quote-profile/{symbol}
|
|
5818
|
+
* @description Returns news by filters
|
|
5819
|
+
* @tags News
|
|
5820
|
+
* @name NewsFiltered
|
|
5821
|
+
* @summary Get filtered news
|
|
5822
|
+
* @request POST:/news/filter
|
|
5989
5823
|
* @secure
|
|
5990
5824
|
*/
|
|
5991
|
-
|
|
5825
|
+
newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
|
|
5992
5826
|
/**
|
|
5993
|
-
* @description
|
|
5994
|
-
* @tags
|
|
5995
|
-
* @name
|
|
5996
|
-
* @summary
|
|
5997
|
-
* @request
|
|
5827
|
+
* @description Returns news by id
|
|
5828
|
+
* @tags News
|
|
5829
|
+
* @name NewsById
|
|
5830
|
+
* @summary Get news by id
|
|
5831
|
+
* @request POST:/news/id
|
|
5998
5832
|
* @secure
|
|
5999
5833
|
*/
|
|
6000
|
-
|
|
5834
|
+
newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
|
|
6001
5835
|
/**
|
|
6002
|
-
* @description
|
|
6003
|
-
* @tags
|
|
6004
|
-
* @name
|
|
6005
|
-
* @summary
|
|
6006
|
-
* @request GET:/
|
|
5836
|
+
* @description Returns news previews
|
|
5837
|
+
* @tags News
|
|
5838
|
+
* @name NewsPreviewsFiltered
|
|
5839
|
+
* @summary Get news previews
|
|
5840
|
+
* @request GET:/news/previews
|
|
6007
5841
|
* @secure
|
|
6008
5842
|
*/
|
|
6009
|
-
|
|
6010
|
-
/**
|
|
6011
|
-
|
|
5843
|
+
newsPreviewsFiltered(query: {
|
|
5844
|
+
/** Start date */
|
|
5845
|
+
start_date?: string;
|
|
5846
|
+
/** End date */
|
|
5847
|
+
end_date?: string;
|
|
5848
|
+
/** Symbol */
|
|
5849
|
+
symbol?: string;
|
|
6012
5850
|
/** how many records to return. Max value is 50 */
|
|
6013
5851
|
limit: number;
|
|
6014
5852
|
/** how many records to skip */
|
|
6015
5853
|
offset: number;
|
|
6016
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5854
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
|
|
6017
5855
|
/**
|
|
6018
|
-
* @description
|
|
6019
|
-
* @tags
|
|
6020
|
-
* @name
|
|
6021
|
-
* @summary
|
|
6022
|
-
* @request GET:/
|
|
5856
|
+
* @description Returns available stocks in DB
|
|
5857
|
+
* @tags News
|
|
5858
|
+
* @name NewsAvailableStocks
|
|
5859
|
+
* @summary Get available stocks in DB (for filters)
|
|
5860
|
+
* @request GET:/news/symbols
|
|
6023
5861
|
* @secure
|
|
6024
5862
|
*/
|
|
6025
|
-
|
|
6026
|
-
/**
|
|
6027
|
-
|
|
6028
|
-
/**
|
|
6029
|
-
|
|
6030
|
-
|
|
6031
|
-
offset: number;
|
|
6032
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
5863
|
+
newsAvailableStocks(query?: {
|
|
5864
|
+
/** Limit */
|
|
5865
|
+
limit?: number;
|
|
5866
|
+
/** Offset */
|
|
5867
|
+
offset?: number;
|
|
5868
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6033
5869
|
/**
|
|
6034
|
-
* @description
|
|
6035
|
-
* @tags
|
|
6036
|
-
* @name
|
|
6037
|
-
* @summary
|
|
6038
|
-
* @request
|
|
5870
|
+
* @description Returns available tags in DB
|
|
5871
|
+
* @tags News
|
|
5872
|
+
* @name NewsAvailableTags
|
|
5873
|
+
* @summary Get available tags in DB (for filters)
|
|
5874
|
+
* @request POST:/news/tags
|
|
6039
5875
|
* @secure
|
|
6040
5876
|
*/
|
|
6041
|
-
|
|
6042
|
-
/** EQUITY|ETF|CRYPTO */
|
|
6043
|
-
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
6044
|
-
/** how many records to return. Max value is 50 */
|
|
6045
|
-
limit: number;
|
|
6046
|
-
/** how many records to skip */
|
|
6047
|
-
offset: number;
|
|
6048
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
5877
|
+
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6049
5878
|
}
|
|
6050
|
-
export class
|
|
5879
|
+
export class Passport<HandleError extends boolean = boolean> {
|
|
6051
5880
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6052
5881
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6053
5882
|
/**
|
|
6054
|
-
* @description
|
|
6055
|
-
* @tags
|
|
6056
|
-
* @name
|
|
6057
|
-
* @summary Get
|
|
6058
|
-
* @request
|
|
5883
|
+
* @description Returns article by id
|
|
5884
|
+
* @tags Passport
|
|
5885
|
+
* @name PassportArticleById
|
|
5886
|
+
* @summary Get article by id
|
|
5887
|
+
* @request POST:/passport/article-by-id
|
|
6059
5888
|
* @secure
|
|
6060
5889
|
*/
|
|
6061
|
-
|
|
6062
|
-
/** Symbol */
|
|
6063
|
-
symbol: string;
|
|
6064
|
-
/** Date */
|
|
6065
|
-
date: string;
|
|
6066
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
5890
|
+
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
6067
5891
|
/**
|
|
6068
|
-
* @description
|
|
6069
|
-
* @tags
|
|
6070
|
-
* @name
|
|
6071
|
-
* @summary Get
|
|
6072
|
-
* @request POST:/
|
|
5892
|
+
* @description Returns articles
|
|
5893
|
+
* @tags Passport
|
|
5894
|
+
* @name PassportArticles
|
|
5895
|
+
* @summary Get articles
|
|
5896
|
+
* @request POST:/passport/articles
|
|
6073
5897
|
* @secure
|
|
6074
5898
|
*/
|
|
6075
|
-
|
|
5899
|
+
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
6076
5900
|
/**
|
|
6077
|
-
* @description Returns
|
|
6078
|
-
* @tags
|
|
6079
|
-
* @name
|
|
6080
|
-
* @summary Get
|
|
6081
|
-
* @request
|
|
5901
|
+
* @description Returns author profile
|
|
5902
|
+
* @tags Passport
|
|
5903
|
+
* @name PassportAuthorProfile
|
|
5904
|
+
* @summary Get author profile
|
|
5905
|
+
* @request POST:/passport/author-profile
|
|
6082
5906
|
* @secure
|
|
6083
5907
|
*/
|
|
6084
|
-
|
|
6085
|
-
/** Comma separated symbols */
|
|
6086
|
-
symbols: string;
|
|
6087
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
6088
|
-
}
|
|
6089
|
-
export class StockScreener<HandleError extends boolean = boolean> {
|
|
6090
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6091
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5908
|
+
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
6092
5909
|
/**
|
|
6093
|
-
* @description
|
|
6094
|
-
* @tags
|
|
6095
|
-
* @name
|
|
6096
|
-
* @summary
|
|
6097
|
-
* @request
|
|
5910
|
+
* @description Returns most popular tags
|
|
5911
|
+
* @tags Passport
|
|
5912
|
+
* @name PassportMostPopularTags
|
|
5913
|
+
* @summary Get most popular tags
|
|
5914
|
+
* @request POST:/passport/most-popular-tags
|
|
6098
5915
|
* @secure
|
|
6099
5916
|
*/
|
|
6100
|
-
|
|
6101
|
-
/** Name of symbol list to fetch details for. Empty is default */
|
|
6102
|
-
heatmap_name?: string;
|
|
6103
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
5917
|
+
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
6104
5918
|
/**
|
|
6105
|
-
* @description
|
|
6106
|
-
* @tags
|
|
6107
|
-
* @name
|
|
6108
|
-
* @summary
|
|
6109
|
-
* @request POST:/
|
|
5919
|
+
* @description Returns news feed
|
|
5920
|
+
* @tags Passport
|
|
5921
|
+
* @name PassportNewsFeed
|
|
5922
|
+
* @summary Get news feed
|
|
5923
|
+
* @request POST:/passport/newsfeed
|
|
6110
5924
|
* @secure
|
|
6111
5925
|
*/
|
|
6112
|
-
|
|
5926
|
+
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
|
|
6113
5927
|
/**
|
|
6114
|
-
* @description
|
|
6115
|
-
* @tags
|
|
6116
|
-
* @name
|
|
6117
|
-
* @summary
|
|
6118
|
-
* @request POST:/
|
|
5928
|
+
* @description Returns article by parameters
|
|
5929
|
+
* @tags Passport
|
|
5930
|
+
* @name PassportSearchArticle
|
|
5931
|
+
* @summary Search article by parameters
|
|
5932
|
+
* @request POST:/passport/search-article
|
|
6119
5933
|
* @secure
|
|
6120
5934
|
*/
|
|
6121
|
-
|
|
5935
|
+
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5936
|
+
}
|
|
5937
|
+
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
5938
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5939
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6122
5940
|
/**
|
|
6123
|
-
* @description
|
|
6124
|
-
* @tags
|
|
6125
|
-
* @name
|
|
6126
|
-
* @summary
|
|
6127
|
-
* @request POST:/
|
|
5941
|
+
* @description get seasonlity data with comparison to benchmark
|
|
5942
|
+
* @tags AlphaTools
|
|
5943
|
+
* @name GetMomentumRatioGraph
|
|
5944
|
+
* @summary get seasonlity data
|
|
5945
|
+
* @request POST:/rst
|
|
6128
5946
|
* @secure
|
|
6129
5947
|
*/
|
|
6130
|
-
|
|
6131
|
-
/** Authorization */
|
|
6132
|
-
Authorization?: string;
|
|
6133
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
5948
|
+
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
6134
5949
|
/**
|
|
6135
|
-
* @description get
|
|
6136
|
-
* @tags
|
|
6137
|
-
* @name
|
|
6138
|
-
* @summary get
|
|
6139
|
-
* @request
|
|
5950
|
+
* @description get seasonlity data with comparison to benchmark
|
|
5951
|
+
* @tags AlphaTools
|
|
5952
|
+
* @name GetSeasonality
|
|
5953
|
+
* @summary get seasonlity data
|
|
5954
|
+
* @request POST:/seasonality
|
|
6140
5955
|
* @secure
|
|
6141
5956
|
*/
|
|
6142
|
-
|
|
6143
|
-
|
|
6144
|
-
|
|
6145
|
-
|
|
6146
|
-
|
|
6147
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
5957
|
+
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
5958
|
+
}
|
|
5959
|
+
export class TipRank<HandleError extends boolean = boolean> {
|
|
5960
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5961
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6148
5962
|
/**
|
|
6149
|
-
* @description
|
|
6150
|
-
* @tags
|
|
6151
|
-
* @name
|
|
6152
|
-
* @summary
|
|
6153
|
-
* @request
|
|
5963
|
+
* @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
|
|
5964
|
+
* @tags TipRank
|
|
5965
|
+
* @name TiprankAnalystConsensus
|
|
5966
|
+
* @summary Get tiprank AnalystConsensus
|
|
5967
|
+
* @request POST:/tipranks/analyst-consensus
|
|
6154
5968
|
* @secure
|
|
6155
5969
|
*/
|
|
6156
|
-
|
|
6157
|
-
/**
|
|
6158
|
-
* @description create screener preset
|
|
6159
|
-
* @tags StockScreener
|
|
6160
|
-
* @name CreateOrScreenerPreset
|
|
6161
|
-
* @summary create screener preset
|
|
6162
|
-
* @request POST:/stock-screener/presets
|
|
6163
|
-
* @secure
|
|
6164
|
-
*/
|
|
6165
|
-
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
6166
|
-
/**
|
|
6167
|
-
* @description remove screener preset
|
|
6168
|
-
* @tags StockScreener
|
|
6169
|
-
* @name RemoveScreenerPreset
|
|
6170
|
-
* @summary remove screener preset
|
|
6171
|
-
* @request DELETE:/stock-screener/presets
|
|
6172
|
-
* @secure
|
|
6173
|
-
*/
|
|
6174
|
-
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6175
|
-
/**
|
|
6176
|
-
* @description get top symbols
|
|
6177
|
-
* @tags StockScreener
|
|
6178
|
-
* @name GetTopSymbols
|
|
6179
|
-
* @summary get top symbols
|
|
6180
|
-
* @request POST:/stock-screener/top
|
|
6181
|
-
* @secure
|
|
6182
|
-
*/
|
|
6183
|
-
getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
6184
|
-
}
|
|
6185
|
-
export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
6186
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6187
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6188
|
-
/**
|
|
6189
|
-
* @description filter stocks by params
|
|
6190
|
-
* @tags StockScreener
|
|
6191
|
-
* @name StockScreener
|
|
6192
|
-
* @summary filter stocks by params
|
|
6193
|
-
* @request POST:/stock-screener
|
|
6194
|
-
* @secure
|
|
6195
|
-
*/
|
|
6196
|
-
stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
6197
|
-
/**
|
|
6198
|
-
* @description get top symbols
|
|
6199
|
-
* @tags StockScreener
|
|
6200
|
-
* @name GetTopSymbols
|
|
6201
|
-
* @summary get top symbols
|
|
6202
|
-
* @request POST:/stock-screener/top
|
|
6203
|
-
* @secure
|
|
6204
|
-
*/
|
|
6205
|
-
getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
6206
|
-
}
|
|
6207
|
-
export class TipRank<HandleError extends boolean = boolean> {
|
|
6208
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6209
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6210
|
-
/**
|
|
6211
|
-
* @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
|
|
6212
|
-
* @tags TipRank
|
|
6213
|
-
* @name TiprankAnalystConsensus
|
|
6214
|
-
* @summary Get tiprank AnalystConsensus
|
|
6215
|
-
* @request POST:/tipranks/analyst-consensus
|
|
6216
|
-
* @secure
|
|
6217
|
-
*/
|
|
6218
|
-
tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
|
|
5970
|
+
tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
|
|
6219
5971
|
/**
|
|
6220
5972
|
* @description Returns the latest analyst ratings on a given stock or multiple stocks.
|
|
6221
5973
|
* @tags TipRank
|
|
@@ -6583,187 +6335,435 @@ export class UsageTracking<HandleError extends boolean = boolean> {
|
|
|
6583
6335
|
*/
|
|
6584
6336
|
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
6585
6337
|
}
|
|
6586
|
-
export class
|
|
6338
|
+
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
6587
6339
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6588
6340
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6589
6341
|
/**
|
|
6590
|
-
* @description
|
|
6591
|
-
* @tags
|
|
6592
|
-
* @name
|
|
6593
|
-
* @summary
|
|
6594
|
-
* @request
|
|
6342
|
+
* @description Returns calculated matrix
|
|
6343
|
+
* @tags OptionGreeks
|
|
6344
|
+
* @name OgCalculateMatrix
|
|
6345
|
+
* @summary Calculate matrix
|
|
6346
|
+
* @request POST:/og/calculate-matrix
|
|
6595
6347
|
* @secure
|
|
6596
6348
|
*/
|
|
6597
|
-
|
|
6598
|
-
/** Query limit */
|
|
6599
|
-
limit: number;
|
|
6600
|
-
/** Query offset */
|
|
6601
|
-
offset: number;
|
|
6602
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
6349
|
+
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
6603
6350
|
/**
|
|
6604
|
-
* @description
|
|
6605
|
-
* @tags
|
|
6606
|
-
* @name
|
|
6607
|
-
* @summary
|
|
6608
|
-
* @request
|
|
6351
|
+
* @description Returns calculated params
|
|
6352
|
+
* @tags OptionGreeks
|
|
6353
|
+
* @name OgCalculateParams
|
|
6354
|
+
* @summary Calculate params
|
|
6355
|
+
* @request POST:/og/calculate-params
|
|
6609
6356
|
* @secure
|
|
6610
6357
|
*/
|
|
6611
|
-
|
|
6358
|
+
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
6359
|
+
}
|
|
6360
|
+
export class Public<HandleError extends boolean = boolean> {
|
|
6361
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6362
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6612
6363
|
/**
|
|
6613
|
-
* @description
|
|
6614
|
-
* @tags
|
|
6615
|
-
* @name
|
|
6616
|
-
* @summary
|
|
6617
|
-
* @request
|
|
6364
|
+
* @description Calculate estimated returns for selected symbols. Uses split adjusted prices
|
|
6365
|
+
* @tags Public
|
|
6366
|
+
* @name CalculateEstimatedReturns
|
|
6367
|
+
* @summary Calculate Estimated Returns
|
|
6368
|
+
* @request GET:/public/estimated-returns
|
|
6618
6369
|
* @secure
|
|
6619
6370
|
*/
|
|
6620
|
-
|
|
6371
|
+
calculateEstimatedReturns(query: {
|
|
6372
|
+
/** Single symbol */
|
|
6373
|
+
symbol: string;
|
|
6374
|
+
/** Non-zero amount */
|
|
6375
|
+
amount: number;
|
|
6376
|
+
/** Start date for calculations */
|
|
6377
|
+
start_date: string;
|
|
6378
|
+
/** End date for calculations */
|
|
6379
|
+
end_date: string;
|
|
6380
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
6621
6381
|
/**
|
|
6622
|
-
* @description
|
|
6623
|
-
* @tags
|
|
6624
|
-
* @name
|
|
6625
|
-
* @summary
|
|
6626
|
-
* @request
|
|
6382
|
+
* @description Returns an expert forecast
|
|
6383
|
+
* @tags Public
|
|
6384
|
+
* @name ExpertForecast
|
|
6385
|
+
* @summary Expert forecast
|
|
6386
|
+
* @request GET:/public/expert-forecast
|
|
6627
6387
|
* @secure
|
|
6628
6388
|
*/
|
|
6629
|
-
|
|
6630
|
-
/**
|
|
6631
|
-
|
|
6632
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
6389
|
+
expertForecast(query: {
|
|
6390
|
+
/** Comma separated symbols */
|
|
6391
|
+
symbols: string;
|
|
6392
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
6633
6393
|
/**
|
|
6634
|
-
* @description
|
|
6635
|
-
* @tags
|
|
6636
|
-
* @name
|
|
6637
|
-
* @summary
|
|
6638
|
-
* @request GET:/
|
|
6394
|
+
* @description get fundamentals by symbol data
|
|
6395
|
+
* @tags Public
|
|
6396
|
+
* @name GetPublicFundamentalsBySymbolData
|
|
6397
|
+
* @summary get fundamentals by symbol data
|
|
6398
|
+
* @request GET:/public/fundamentals/{symbol}
|
|
6639
6399
|
* @secure
|
|
6640
6400
|
*/
|
|
6641
|
-
|
|
6642
|
-
/**
|
|
6643
|
-
|
|
6644
|
-
|
|
6645
|
-
offset: number;
|
|
6646
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
6401
|
+
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
6402
|
+
/** Annual or quarterly */
|
|
6403
|
+
mode: string;
|
|
6404
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
6647
6405
|
/**
|
|
6648
|
-
* @description
|
|
6649
|
-
* @tags
|
|
6650
|
-
* @name
|
|
6651
|
-
* @summary
|
|
6652
|
-
* @request
|
|
6406
|
+
* @description Daily price history
|
|
6407
|
+
* @tags Public
|
|
6408
|
+
* @name DailyPriceHistory
|
|
6409
|
+
* @summary Daily price history
|
|
6410
|
+
* @request GET:/public/price-history/daily
|
|
6653
6411
|
* @secure
|
|
6654
6412
|
*/
|
|
6655
|
-
|
|
6413
|
+
dailyPriceHistory(query: {
|
|
6414
|
+
/** Single symbol */
|
|
6415
|
+
symbol: string;
|
|
6416
|
+
/** Target date */
|
|
6417
|
+
date: string;
|
|
6418
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
6656
6419
|
/**
|
|
6657
|
-
* @description
|
|
6658
|
-
* @tags
|
|
6659
|
-
* @name
|
|
6660
|
-
* @summary
|
|
6661
|
-
* @request
|
|
6420
|
+
* @description Public quote profile
|
|
6421
|
+
* @tags Public
|
|
6422
|
+
* @name PublicQuoteProfile
|
|
6423
|
+
* @summary Public quote profile
|
|
6424
|
+
* @request GET:/public/quote-profile/{symbol}
|
|
6662
6425
|
* @secure
|
|
6663
6426
|
*/
|
|
6664
|
-
|
|
6427
|
+
publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
|
|
6665
6428
|
/**
|
|
6666
|
-
* @description
|
|
6667
|
-
* @tags
|
|
6668
|
-
* @name
|
|
6669
|
-
* @summary
|
|
6670
|
-
* @request
|
|
6429
|
+
* @description get ratios by symbol data
|
|
6430
|
+
* @tags Public
|
|
6431
|
+
* @name GetPublicRatiosBySymbolData
|
|
6432
|
+
* @summary get ratios by symbol data
|
|
6433
|
+
* @request GET:/public/ratios/{symbol}
|
|
6671
6434
|
* @secure
|
|
6672
6435
|
*/
|
|
6673
|
-
|
|
6674
|
-
/** a3 code */
|
|
6675
|
-
a3code: string;
|
|
6676
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6436
|
+
getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
|
|
6677
6437
|
/**
|
|
6678
|
-
* @description
|
|
6679
|
-
* @tags
|
|
6680
|
-
* @name
|
|
6681
|
-
* @summary
|
|
6682
|
-
* @request GET:/
|
|
6438
|
+
* @description find a symbol by name or description
|
|
6439
|
+
* @tags Public
|
|
6440
|
+
* @name QuoteFundamentalsSearch
|
|
6441
|
+
* @summary find a symbol by name or description
|
|
6442
|
+
* @request GET:/public/symbol-search
|
|
6683
6443
|
* @secure
|
|
6684
6444
|
*/
|
|
6685
|
-
|
|
6686
|
-
/**
|
|
6445
|
+
quoteFundamentalsSearch(query: {
|
|
6446
|
+
/** Search query */
|
|
6447
|
+
search_query: string;
|
|
6448
|
+
/** how many records to return. Max value is 50 */
|
|
6687
6449
|
limit: number;
|
|
6688
|
-
/**
|
|
6450
|
+
/** how many records to skip */
|
|
6689
6451
|
offset: number;
|
|
6690
|
-
|
|
6691
|
-
continent?: string;
|
|
6692
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
6452
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
6693
6453
|
/**
|
|
6694
|
-
* @description
|
|
6695
|
-
* @tags
|
|
6696
|
-
* @name
|
|
6697
|
-
* @summary
|
|
6698
|
-
* @request
|
|
6454
|
+
* @description Get top gainers
|
|
6455
|
+
* @tags Public
|
|
6456
|
+
* @name TopGainers
|
|
6457
|
+
* @summary Top Gainers
|
|
6458
|
+
* @request GET:/public/top-gainers
|
|
6699
6459
|
* @secure
|
|
6700
6460
|
*/
|
|
6701
|
-
|
|
6461
|
+
topGainers(query: {
|
|
6462
|
+
/** sort direction - asc or desc */
|
|
6463
|
+
order_direction?: string;
|
|
6464
|
+
/** how many records to return. Max value is 50 */
|
|
6465
|
+
limit: number;
|
|
6466
|
+
/** how many records to skip */
|
|
6467
|
+
offset: number;
|
|
6468
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6702
6469
|
/**
|
|
6703
|
-
* @description
|
|
6704
|
-
* @tags
|
|
6705
|
-
* @name
|
|
6706
|
-
* @summary
|
|
6707
|
-
* @request
|
|
6470
|
+
* @description Get top stocks
|
|
6471
|
+
* @tags Public
|
|
6472
|
+
* @name TopStocks
|
|
6473
|
+
* @summary Top Stocks
|
|
6474
|
+
* @request GET:/public/top-stocks
|
|
6708
6475
|
* @secure
|
|
6709
6476
|
*/
|
|
6710
|
-
|
|
6711
|
-
|
|
6712
|
-
|
|
6713
|
-
|
|
6714
|
-
|
|
6715
|
-
|
|
6716
|
-
|
|
6477
|
+
topStocks(query: {
|
|
6478
|
+
/** EQUITY|ETF|CRYPTO */
|
|
6479
|
+
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
6480
|
+
/** how many records to return. Max value is 50 */
|
|
6481
|
+
limit: number;
|
|
6482
|
+
/** how many records to skip */
|
|
6483
|
+
offset: number;
|
|
6484
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6485
|
+
}
|
|
6486
|
+
export class Ownerships<HandleError extends boolean = boolean> {
|
|
6487
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6488
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6489
|
+
/**
|
|
6490
|
+
* @description get ownerships by id datadata
|
|
6491
|
+
* @tags Ownerships
|
|
6492
|
+
* @name GetOwnershipsByIdData
|
|
6493
|
+
* @summary get ownerships by id data
|
|
6494
|
+
* @request POST:/ownerships
|
|
6717
6495
|
* @secure
|
|
6718
6496
|
*/
|
|
6719
|
-
|
|
6720
|
-
/** a3 code */
|
|
6721
|
-
a3code: string;
|
|
6722
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6497
|
+
getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
6723
6498
|
/**
|
|
6724
|
-
* @description
|
|
6725
|
-
* @tags
|
|
6726
|
-
* @name
|
|
6727
|
-
* @summary
|
|
6728
|
-
* @request
|
|
6499
|
+
* @description get ownerships by symbol data
|
|
6500
|
+
* @tags Ownerships
|
|
6501
|
+
* @name GetOwnershipsBySymbolData
|
|
6502
|
+
* @summary get ownerships by symbol data
|
|
6503
|
+
* @request POST:/symbol-ownerships
|
|
6729
6504
|
* @secure
|
|
6730
6505
|
*/
|
|
6731
|
-
|
|
6732
|
-
|
|
6733
|
-
|
|
6734
|
-
|
|
6735
|
-
|
|
6736
|
-
|
|
6506
|
+
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
6507
|
+
}
|
|
6508
|
+
export interface InsightBeforeAndAfterV2 {
|
|
6509
|
+
after?: string;
|
|
6510
|
+
before?: string;
|
|
6511
|
+
}
|
|
6512
|
+
export interface InsightFixedIncomeV2 {
|
|
6513
|
+
a144: boolean;
|
|
6514
|
+
accrued_interest: number;
|
|
6515
|
+
bank_qualified: boolean;
|
|
6516
|
+
bond_warrant: boolean;
|
|
6517
|
+
call_type: string;
|
|
6518
|
+
callable: boolean;
|
|
6519
|
+
close_price: number;
|
|
6520
|
+
close_price_asof: string;
|
|
6521
|
+
close_ytw: number;
|
|
6522
|
+
convertible: boolean;
|
|
6523
|
+
country: string;
|
|
6524
|
+
country_code: string;
|
|
6525
|
+
country_domicile: string;
|
|
6526
|
+
country_issue: string;
|
|
6527
|
+
coupon: number;
|
|
6528
|
+
coupon_frequency: string;
|
|
6529
|
+
coupon_type: string;
|
|
6530
|
+
currency: string;
|
|
6531
|
+
cusip: string;
|
|
6532
|
+
dated_date: string;
|
|
6533
|
+
daycount: string;
|
|
6534
|
+
description: string;
|
|
6535
|
+
description_short: string;
|
|
6536
|
+
duration: number;
|
|
6537
|
+
first_coupon_date: string;
|
|
6538
|
+
insured: boolean;
|
|
6539
|
+
isin: string;
|
|
6540
|
+
issue_date: string;
|
|
6541
|
+
issue_minimum_denomination: number;
|
|
6542
|
+
issue_price: number;
|
|
6543
|
+
issue_size: number;
|
|
6544
|
+
issuer: string;
|
|
6545
|
+
last_coupon_date: string;
|
|
6546
|
+
liquidity_institutional_aggregate: number;
|
|
6547
|
+
liquidity_institutional_buy: number;
|
|
6548
|
+
liquidity_institutional_sell: number;
|
|
6549
|
+
liquidity_micro_aggregate: number;
|
|
6550
|
+
liquidity_micro_buy: number;
|
|
6551
|
+
liquidity_micro_sell: number;
|
|
6552
|
+
liquidity_retail_aggregate: number;
|
|
6553
|
+
liquidity_retail_buy: number;
|
|
6554
|
+
liquidity_retail_sell: number;
|
|
6555
|
+
maturity_date: string;
|
|
6556
|
+
municipal_state: string;
|
|
6557
|
+
municipal_taxable_federal: boolean;
|
|
6558
|
+
municipal_type: string;
|
|
6559
|
+
next_call_date: string;
|
|
6560
|
+
next_call_price: number;
|
|
6561
|
+
next_coupon_date: string;
|
|
6562
|
+
par_value: number;
|
|
6563
|
+
perpetual: boolean;
|
|
6564
|
+
private_placement: boolean;
|
|
6565
|
+
purpose: string;
|
|
6566
|
+
puttable: boolean;
|
|
6567
|
+
reg_s: boolean;
|
|
6568
|
+
sector: string;
|
|
6569
|
+
seniority: string;
|
|
6570
|
+
settlement_convention: string;
|
|
6571
|
+
sinking_fund: boolean;
|
|
6572
|
+
sp_creditwatch: string;
|
|
6573
|
+
sp_creditwatch_date: string;
|
|
6574
|
+
sp_outlook: string;
|
|
6575
|
+
sp_outlook_date: string;
|
|
6576
|
+
sp_rating: string;
|
|
6577
|
+
sp_rating_date: string;
|
|
6578
|
+
status: string;
|
|
6579
|
+
ticker: string;
|
|
6580
|
+
treasury_subtype: string;
|
|
6581
|
+
type: string;
|
|
6582
|
+
updated_at: string;
|
|
6583
|
+
}
|
|
6584
|
+
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
6585
|
+
count: number;
|
|
6586
|
+
data: InsightFixedIncomeV2[];
|
|
6587
|
+
}
|
|
6588
|
+
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
6589
|
+
/** @example true */
|
|
6590
|
+
bank_qualified?: boolean;
|
|
6591
|
+
/** @example true */
|
|
6592
|
+
callable?: boolean;
|
|
6593
|
+
/** @example true */
|
|
6594
|
+
convertible?: boolean;
|
|
6595
|
+
/** @example ["USA"] */
|
|
6596
|
+
country_codes?: string[];
|
|
6597
|
+
coupon?: InsightLessAndMoreV2;
|
|
6598
|
+
/** @example ["quarterly","zero"] */
|
|
6599
|
+
coupon_frequencies?: string[];
|
|
6600
|
+
/** @example ["655664AH3","9128286R6"] */
|
|
6601
|
+
cusip?: string[];
|
|
6737
6602
|
/**
|
|
6738
|
-
* @
|
|
6739
|
-
* @
|
|
6740
|
-
|
|
6741
|
-
|
|
6742
|
-
|
|
6603
|
+
* @maxLength 100
|
|
6604
|
+
* @example "Donald's"
|
|
6605
|
+
*/
|
|
6606
|
+
description?: string;
|
|
6607
|
+
/** @example true */
|
|
6608
|
+
has_ticker?: boolean;
|
|
6609
|
+
/** @example true */
|
|
6610
|
+
insured?: boolean;
|
|
6611
|
+
/** @example ["US655664AH33","US9128286R69"] */
|
|
6612
|
+
isin?: string[];
|
|
6613
|
+
issue_date?: InsightBeforeAndAfterV2;
|
|
6614
|
+
/**
|
|
6615
|
+
* @maxLength 100
|
|
6616
|
+
* @example "Donald's"
|
|
6617
|
+
*/
|
|
6618
|
+
issuer?: string;
|
|
6619
|
+
maturity?: InsightBeforeAndAfterV2;
|
|
6620
|
+
/** @example ["NY"] */
|
|
6621
|
+
municipal_states?: string[];
|
|
6622
|
+
/** @example true */
|
|
6623
|
+
municipal_tax?: boolean;
|
|
6624
|
+
/** @example ["general_obligation"] */
|
|
6625
|
+
municipal_types?: string[];
|
|
6626
|
+
pagination: InsightPaginationV2;
|
|
6627
|
+
purposes?: string[];
|
|
6628
|
+
/** @example ["SOVEREIGN"] */
|
|
6629
|
+
sectors?: string[];
|
|
6630
|
+
sorts?: InsightOrderingV2[];
|
|
6631
|
+
/** @example ["AAA"] */
|
|
6632
|
+
sp_ratings?: string[];
|
|
6633
|
+
/** @example ["called","outstanding"] */
|
|
6634
|
+
statuses?: string[];
|
|
6635
|
+
tickers?: string[];
|
|
6636
|
+
/** @example ["corporate"] */
|
|
6637
|
+
types?: string[];
|
|
6638
|
+
}
|
|
6639
|
+
export interface InsightGetTopSymbolsRequestV2 {
|
|
6640
|
+
exchange?: string[];
|
|
6641
|
+
market_cap?: InsightLessAndMoreV2;
|
|
6642
|
+
pagination?: InsightPaginationV2;
|
|
6643
|
+
price?: InsightLessAndMoreV2;
|
|
6644
|
+
sorts?: InsightOrderingV2[];
|
|
6645
|
+
volume?: InsightLessAndMoreV2;
|
|
6646
|
+
}
|
|
6647
|
+
export interface InsightIncludeExcludeV2 {
|
|
6648
|
+
exclude?: string[];
|
|
6649
|
+
include?: string[];
|
|
6650
|
+
}
|
|
6651
|
+
export interface InsightLessAndMoreV2 {
|
|
6652
|
+
less_than?: number;
|
|
6653
|
+
more_than?: number;
|
|
6654
|
+
}
|
|
6655
|
+
export interface InsightOrderingV2 {
|
|
6656
|
+
/**
|
|
6657
|
+
* @default "asc"
|
|
6658
|
+
* @example "asc"
|
|
6659
|
+
*/
|
|
6660
|
+
direction: InsightOrderingDirectionEnumV2;
|
|
6661
|
+
/**
|
|
6662
|
+
* Sort direction:
|
|
6663
|
+
* * asc - Ascending, from A to Z.
|
|
6664
|
+
* * desc - Descending, from Z to A.
|
|
6665
|
+
* @example "name"
|
|
6666
|
+
*/
|
|
6667
|
+
field: string;
|
|
6668
|
+
}
|
|
6669
|
+
export interface InsightPaginationV2 {
|
|
6670
|
+
/**
|
|
6671
|
+
* @min 1
|
|
6672
|
+
* @example 1
|
|
6673
|
+
*/
|
|
6674
|
+
page: number;
|
|
6675
|
+
/**
|
|
6676
|
+
* @min 1
|
|
6677
|
+
* @max 50
|
|
6678
|
+
* @example 10
|
|
6679
|
+
*/
|
|
6680
|
+
size: number;
|
|
6681
|
+
}
|
|
6682
|
+
export interface InsightStockScreenerQuoteV2 {
|
|
6683
|
+
average_volume_30d: number;
|
|
6684
|
+
company_name: string;
|
|
6685
|
+
dividend_ex_date: string;
|
|
6686
|
+
dividend_pay_date: string;
|
|
6687
|
+
dividend_percent: number;
|
|
6688
|
+
exchange: string;
|
|
6689
|
+
exchange_name: string;
|
|
6690
|
+
gap: number;
|
|
6691
|
+
industry: string;
|
|
6692
|
+
industry_code: string;
|
|
6693
|
+
last_price: number;
|
|
6694
|
+
market_cap: number;
|
|
6695
|
+
pe_ratio: number;
|
|
6696
|
+
price_change: number;
|
|
6697
|
+
price_change_percent: number;
|
|
6698
|
+
symbol: string;
|
|
6699
|
+
volume: number;
|
|
6700
|
+
}
|
|
6701
|
+
export interface InsightStockScreenerRequestV2 {
|
|
6702
|
+
average_volume_30d?: InsightLessAndMoreV2;
|
|
6703
|
+
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
6704
|
+
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
6705
|
+
dividend_percent?: InsightLessAndMoreV2;
|
|
6706
|
+
exchange?: InsightIncludeExcludeV2;
|
|
6707
|
+
gap?: InsightLessAndMoreV2;
|
|
6708
|
+
industry?: InsightIncludeExcludeV2;
|
|
6709
|
+
market_cap?: InsightLessAndMoreV2;
|
|
6710
|
+
pagination: InsightPaginationV2;
|
|
6711
|
+
pe_ratio?: InsightLessAndMoreV2;
|
|
6712
|
+
price?: InsightLessAndMoreV2;
|
|
6713
|
+
sorts?: InsightOrderingV2[];
|
|
6714
|
+
/** @example "ADR" */
|
|
6715
|
+
stock_type?: string;
|
|
6716
|
+
volume?: InsightLessAndMoreV2;
|
|
6717
|
+
}
|
|
6718
|
+
export interface InsightStockScreenerResponseV2 {
|
|
6719
|
+
current_page: number;
|
|
6720
|
+
data: InsightStockScreenerQuoteV2[];
|
|
6721
|
+
page_count: number;
|
|
6722
|
+
status: number;
|
|
6723
|
+
total_records: number;
|
|
6724
|
+
}
|
|
6725
|
+
/**
|
|
6726
|
+
* @default "asc"
|
|
6727
|
+
* @example "asc"
|
|
6728
|
+
*/
|
|
6729
|
+
export enum InsightOrderingDirectionEnumV2 {
|
|
6730
|
+
Asc = "asc",
|
|
6731
|
+
Desc = "desc"
|
|
6732
|
+
}
|
|
6733
|
+
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
6734
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6735
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6736
|
+
/**
|
|
6737
|
+
* @description get fixed income entries
|
|
6738
|
+
* @tags FixedIncome
|
|
6739
|
+
* @name GetFixedIncomeEntries
|
|
6740
|
+
* @summary get fixed income entries
|
|
6741
|
+
* @request POST:/fixed-income
|
|
6743
6742
|
* @secure
|
|
6744
6743
|
*/
|
|
6745
|
-
|
|
6744
|
+
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
6745
|
+
}
|
|
6746
|
+
export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
6747
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6748
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6746
6749
|
/**
|
|
6747
|
-
* @description
|
|
6748
|
-
* @tags
|
|
6749
|
-
* @name
|
|
6750
|
-
* @summary
|
|
6751
|
-
* @request POST:/
|
|
6750
|
+
* @description filter stocks by params
|
|
6751
|
+
* @tags StockScreener
|
|
6752
|
+
* @name StockScreener
|
|
6753
|
+
* @summary filter stocks by params
|
|
6754
|
+
* @request POST:/stock-screener
|
|
6752
6755
|
* @secure
|
|
6753
6756
|
*/
|
|
6754
|
-
|
|
6757
|
+
stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
6755
6758
|
/**
|
|
6756
|
-
* @description
|
|
6757
|
-
* @tags
|
|
6758
|
-
* @name
|
|
6759
|
-
* @summary
|
|
6760
|
-
* @request
|
|
6759
|
+
* @description get top symbols
|
|
6760
|
+
* @tags StockScreener
|
|
6761
|
+
* @name GetTopSymbols
|
|
6762
|
+
* @summary get top symbols
|
|
6763
|
+
* @request POST:/stock-screener/top
|
|
6761
6764
|
* @secure
|
|
6762
6765
|
*/
|
|
6763
|
-
|
|
6764
|
-
/** region id */
|
|
6765
|
-
id: string;
|
|
6766
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6766
|
+
getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
6767
6767
|
}
|
|
6768
6768
|
export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
6769
6769
|
readonly config: JwtClientConfig<HandleError>;
|