@orbis-systems/orbis-api-clients 0.7.17 → 0.7.18
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 +68 -68
- 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 +884 -884
- 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 +1347 -1346
- 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 +99 -99
- 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 +3863 -3863
- 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/package.json +4 -13
- package/dist/zerohash/index.d.ts +0 -15498
- package/dist/zerohash/index.d.ts.map +0 -1
- package/dist/zerohash/index.esm.js +0 -2
- package/dist/zerohash/index.esm.js.map +0 -1
- package/dist/zerohash/index.js +0 -2
- package/dist/zerohash/index.js.map +0 -1
package/dist/insight/index.d.ts
CHANGED
|
@@ -4147,6 +4147,7 @@ export interface InsightTagShortInfo {
|
|
|
4147
4147
|
}
|
|
4148
4148
|
export interface InsightTickerData {
|
|
4149
4149
|
historic_volatility: number;
|
|
4150
|
+
risk_free_rate: number;
|
|
4150
4151
|
ticker: string;
|
|
4151
4152
|
}
|
|
4152
4153
|
export interface InsightTickerSeasonality {
|
|
@@ -4761,6 +4762,28 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
|
|
|
4761
4762
|
Date = "date",
|
|
4762
4763
|
Rank = "rank"
|
|
4763
4764
|
}
|
|
4765
|
+
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
4766
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4767
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4768
|
+
/**
|
|
4769
|
+
* @description get seasonlity data with comparison to benchmark
|
|
4770
|
+
* @tags AlphaTools
|
|
4771
|
+
* @name GetMomentumRatioGraph
|
|
4772
|
+
* @summary get seasonlity data
|
|
4773
|
+
* @request POST:/rst
|
|
4774
|
+
* @secure
|
|
4775
|
+
*/
|
|
4776
|
+
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
4777
|
+
/**
|
|
4778
|
+
* @description get seasonlity data with comparison to benchmark
|
|
4779
|
+
* @tags AlphaTools
|
|
4780
|
+
* @name GetSeasonality
|
|
4781
|
+
* @summary get seasonlity data
|
|
4782
|
+
* @request POST:/seasonality
|
|
4783
|
+
* @secure
|
|
4784
|
+
*/
|
|
4785
|
+
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
4786
|
+
}
|
|
4764
4787
|
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4765
4788
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4766
4789
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4800,188 +4823,6 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
|
4800
4823
|
*/
|
|
4801
4824
|
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
4802
4825
|
}
|
|
4803
|
-
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
4804
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4805
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4806
|
-
/**
|
|
4807
|
-
* @description Get continents
|
|
4808
|
-
* @tags World Markets
|
|
4809
|
-
* @name ContinentGet
|
|
4810
|
-
* @summary Get continents
|
|
4811
|
-
* @request GET:/continents
|
|
4812
|
-
* @secure
|
|
4813
|
-
*/
|
|
4814
|
-
continentGet(query: {
|
|
4815
|
-
/** Query limit */
|
|
4816
|
-
limit: number;
|
|
4817
|
-
/** Query offset */
|
|
4818
|
-
offset: number;
|
|
4819
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4820
|
-
/**
|
|
4821
|
-
* @description Edit continent
|
|
4822
|
-
* @tags World Markets
|
|
4823
|
-
* @name ContinentEdit
|
|
4824
|
-
* @summary Edit continent
|
|
4825
|
-
* @request PUT:/continents
|
|
4826
|
-
* @secure
|
|
4827
|
-
*/
|
|
4828
|
-
continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4829
|
-
/**
|
|
4830
|
-
* @description Create continents
|
|
4831
|
-
* @tags World Markets
|
|
4832
|
-
* @name ContinentCreate
|
|
4833
|
-
* @summary Create continents
|
|
4834
|
-
* @request POST:/continents
|
|
4835
|
-
* @secure
|
|
4836
|
-
*/
|
|
4837
|
-
continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4838
|
-
/**
|
|
4839
|
-
* @description Delete continent
|
|
4840
|
-
* @tags World Markets
|
|
4841
|
-
* @name ContinentDelete
|
|
4842
|
-
* @summary Delete continent
|
|
4843
|
-
* @request DELETE:/continents
|
|
4844
|
-
* @secure
|
|
4845
|
-
*/
|
|
4846
|
-
continentDelete(query: {
|
|
4847
|
-
/** continent id */
|
|
4848
|
-
id: string;
|
|
4849
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4850
|
-
/**
|
|
4851
|
-
* @description Get country codes
|
|
4852
|
-
* @tags World Markets
|
|
4853
|
-
* @name CountryCodeGet
|
|
4854
|
-
* @summary Get country codes
|
|
4855
|
-
* @request GET:/country-codes
|
|
4856
|
-
* @secure
|
|
4857
|
-
*/
|
|
4858
|
-
countryCodeGet(query: {
|
|
4859
|
-
/** Query limit */
|
|
4860
|
-
limit: number;
|
|
4861
|
-
/** Query offset */
|
|
4862
|
-
offset: number;
|
|
4863
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4864
|
-
/**
|
|
4865
|
-
* @description Edit country code
|
|
4866
|
-
* @tags World Markets
|
|
4867
|
-
* @name CountryCodeEdit
|
|
4868
|
-
* @summary Edit country code
|
|
4869
|
-
* @request PUT:/country-codes
|
|
4870
|
-
* @secure
|
|
4871
|
-
*/
|
|
4872
|
-
countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4873
|
-
/**
|
|
4874
|
-
* @description Add country codes
|
|
4875
|
-
* @tags World Markets
|
|
4876
|
-
* @name CountryCodeAdd
|
|
4877
|
-
* @summary Add country codes
|
|
4878
|
-
* @request POST:/country-codes
|
|
4879
|
-
* @secure
|
|
4880
|
-
*/
|
|
4881
|
-
countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4882
|
-
/**
|
|
4883
|
-
* @description Delete country code
|
|
4884
|
-
* @tags World Markets
|
|
4885
|
-
* @name CountryCodeDelete
|
|
4886
|
-
* @summary Delete country code
|
|
4887
|
-
* @request DELETE:/country-codes
|
|
4888
|
-
* @secure
|
|
4889
|
-
*/
|
|
4890
|
-
countryCodeDelete(query: {
|
|
4891
|
-
/** a3 code */
|
|
4892
|
-
a3code: string;
|
|
4893
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4894
|
-
/**
|
|
4895
|
-
* @description Get global indexes
|
|
4896
|
-
* @tags World Markets
|
|
4897
|
-
* @name GlobalIndexGet
|
|
4898
|
-
* @summary Get global indexes
|
|
4899
|
-
* @request GET:/global-indexes
|
|
4900
|
-
* @secure
|
|
4901
|
-
*/
|
|
4902
|
-
globalIndexGet(query: {
|
|
4903
|
-
/** Query limit */
|
|
4904
|
-
limit: number;
|
|
4905
|
-
/** Query offset */
|
|
4906
|
-
offset: number;
|
|
4907
|
-
/** Continent code for filtering */
|
|
4908
|
-
continent?: string;
|
|
4909
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4910
|
-
/**
|
|
4911
|
-
* @description Edit global index
|
|
4912
|
-
* @tags World Markets
|
|
4913
|
-
* @name GlobalIndexEdit
|
|
4914
|
-
* @summary Edit global index
|
|
4915
|
-
* @request PUT:/global-indexes
|
|
4916
|
-
* @secure
|
|
4917
|
-
*/
|
|
4918
|
-
globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4919
|
-
/**
|
|
4920
|
-
* @description Add global indexes
|
|
4921
|
-
* @tags World Markets
|
|
4922
|
-
* @name GlobalIndexAdd
|
|
4923
|
-
* @summary Add global indexes
|
|
4924
|
-
* @request POST:/global-indexes
|
|
4925
|
-
* @secure
|
|
4926
|
-
*/
|
|
4927
|
-
globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4928
|
-
/**
|
|
4929
|
-
* @description Edit global index
|
|
4930
|
-
* @tags World Markets
|
|
4931
|
-
* @name GlobalIndexDelete
|
|
4932
|
-
* @summary Delete global index
|
|
4933
|
-
* @request DELETE:/global-indexes
|
|
4934
|
-
* @secure
|
|
4935
|
-
*/
|
|
4936
|
-
globalIndexDelete(query: {
|
|
4937
|
-
/** a3 code */
|
|
4938
|
-
a3code: string;
|
|
4939
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4940
|
-
/**
|
|
4941
|
-
* @description Get regions
|
|
4942
|
-
* @tags World Markets
|
|
4943
|
-
* @name RegionGet
|
|
4944
|
-
* @summary Get regions
|
|
4945
|
-
* @request GET:/regions
|
|
4946
|
-
* @secure
|
|
4947
|
-
*/
|
|
4948
|
-
regionGet(query: {
|
|
4949
|
-
/** Query limit */
|
|
4950
|
-
limit: number;
|
|
4951
|
-
/** Query offset */
|
|
4952
|
-
offset: number;
|
|
4953
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
4954
|
-
/**
|
|
4955
|
-
* @description Edit region
|
|
4956
|
-
* @tags World Markets
|
|
4957
|
-
* @name RegionEdit
|
|
4958
|
-
* @summary Edit region
|
|
4959
|
-
* @request PUT:/regions
|
|
4960
|
-
* @secure
|
|
4961
|
-
*/
|
|
4962
|
-
regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4963
|
-
/**
|
|
4964
|
-
* @description Create regions
|
|
4965
|
-
* @tags World Markets
|
|
4966
|
-
* @name RegionCreate
|
|
4967
|
-
* @summary Create regions
|
|
4968
|
-
* @request POST:/regions
|
|
4969
|
-
* @secure
|
|
4970
|
-
*/
|
|
4971
|
-
regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
4972
|
-
/**
|
|
4973
|
-
* @description Delete region
|
|
4974
|
-
* @tags World Markets
|
|
4975
|
-
* @name RegionDelete
|
|
4976
|
-
* @summary Delete region
|
|
4977
|
-
* @request DELETE:/regions
|
|
4978
|
-
* @secure
|
|
4979
|
-
*/
|
|
4980
|
-
regionDelete(query: {
|
|
4981
|
-
/** region id */
|
|
4982
|
-
id: string;
|
|
4983
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4984
|
-
}
|
|
4985
4826
|
export class CustomLists<HandleError extends boolean = boolean> {
|
|
4986
4827
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4987
4828
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5226,56 +5067,298 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5226
5067
|
*/
|
|
5227
5068
|
getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
|
|
5228
5069
|
}
|
|
5229
|
-
export
|
|
5230
|
-
|
|
5231
|
-
|
|
5232
|
-
/**
|
|
5233
|
-
* @description get fundamentals by symbol data
|
|
5234
|
-
* @tags Fundamentals
|
|
5235
|
-
* @name GetFundamentalsBySymbolData
|
|
5236
|
-
* @summary get fundamentals by symbol data
|
|
5237
|
-
* @request POST:/fundamentals
|
|
5238
|
-
* @secure
|
|
5239
|
-
*/
|
|
5240
|
-
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5070
|
+
export interface InsightBeforeAndAfterV2 {
|
|
5071
|
+
after?: string;
|
|
5072
|
+
before?: string;
|
|
5241
5073
|
}
|
|
5242
|
-
export
|
|
5243
|
-
|
|
5244
|
-
|
|
5245
|
-
|
|
5246
|
-
|
|
5247
|
-
|
|
5248
|
-
|
|
5249
|
-
|
|
5250
|
-
|
|
5251
|
-
|
|
5252
|
-
|
|
5253
|
-
|
|
5254
|
-
|
|
5255
|
-
|
|
5256
|
-
|
|
5257
|
-
|
|
5258
|
-
|
|
5259
|
-
|
|
5260
|
-
|
|
5261
|
-
|
|
5262
|
-
|
|
5263
|
-
|
|
5264
|
-
|
|
5265
|
-
|
|
5266
|
-
|
|
5267
|
-
|
|
5268
|
-
|
|
5269
|
-
|
|
5270
|
-
|
|
5271
|
-
|
|
5272
|
-
|
|
5273
|
-
|
|
5274
|
-
|
|
5275
|
-
|
|
5276
|
-
|
|
5277
|
-
|
|
5278
|
-
|
|
5074
|
+
export interface InsightFixedIncomeV2 {
|
|
5075
|
+
a144: boolean;
|
|
5076
|
+
accrued_interest: number;
|
|
5077
|
+
bank_qualified: boolean;
|
|
5078
|
+
bond_warrant: boolean;
|
|
5079
|
+
call_type: string;
|
|
5080
|
+
callable: boolean;
|
|
5081
|
+
close_price: number;
|
|
5082
|
+
close_price_asof: string;
|
|
5083
|
+
close_ytw: number;
|
|
5084
|
+
convertible: boolean;
|
|
5085
|
+
country: string;
|
|
5086
|
+
country_code: string;
|
|
5087
|
+
country_domicile: string;
|
|
5088
|
+
country_issue: string;
|
|
5089
|
+
coupon: number;
|
|
5090
|
+
coupon_frequency: string;
|
|
5091
|
+
coupon_type: string;
|
|
5092
|
+
currency: string;
|
|
5093
|
+
cusip: string;
|
|
5094
|
+
dated_date: string;
|
|
5095
|
+
daycount: string;
|
|
5096
|
+
description: string;
|
|
5097
|
+
description_short: string;
|
|
5098
|
+
duration: number;
|
|
5099
|
+
first_coupon_date: string;
|
|
5100
|
+
insured: boolean;
|
|
5101
|
+
isin: string;
|
|
5102
|
+
issue_date: string;
|
|
5103
|
+
issue_minimum_denomination: number;
|
|
5104
|
+
issue_price: number;
|
|
5105
|
+
issue_size: number;
|
|
5106
|
+
issuer: string;
|
|
5107
|
+
last_coupon_date: string;
|
|
5108
|
+
liquidity_institutional_aggregate: number;
|
|
5109
|
+
liquidity_institutional_buy: number;
|
|
5110
|
+
liquidity_institutional_sell: number;
|
|
5111
|
+
liquidity_micro_aggregate: number;
|
|
5112
|
+
liquidity_micro_buy: number;
|
|
5113
|
+
liquidity_micro_sell: number;
|
|
5114
|
+
liquidity_retail_aggregate: number;
|
|
5115
|
+
liquidity_retail_buy: number;
|
|
5116
|
+
liquidity_retail_sell: number;
|
|
5117
|
+
maturity_date: string;
|
|
5118
|
+
municipal_state: string;
|
|
5119
|
+
municipal_taxable_federal: boolean;
|
|
5120
|
+
municipal_type: string;
|
|
5121
|
+
next_call_date: string;
|
|
5122
|
+
next_call_price: number;
|
|
5123
|
+
next_coupon_date: string;
|
|
5124
|
+
par_value: number;
|
|
5125
|
+
perpetual: boolean;
|
|
5126
|
+
private_placement: boolean;
|
|
5127
|
+
purpose: string;
|
|
5128
|
+
puttable: boolean;
|
|
5129
|
+
reg_s: boolean;
|
|
5130
|
+
sector: string;
|
|
5131
|
+
seniority: string;
|
|
5132
|
+
settlement_convention: string;
|
|
5133
|
+
sinking_fund: boolean;
|
|
5134
|
+
sp_creditwatch: string;
|
|
5135
|
+
sp_creditwatch_date: string;
|
|
5136
|
+
sp_outlook: string;
|
|
5137
|
+
sp_outlook_date: string;
|
|
5138
|
+
sp_rating: string;
|
|
5139
|
+
sp_rating_date: string;
|
|
5140
|
+
status: string;
|
|
5141
|
+
ticker: string;
|
|
5142
|
+
treasury_subtype: string;
|
|
5143
|
+
type: string;
|
|
5144
|
+
updated_at: string;
|
|
5145
|
+
}
|
|
5146
|
+
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
5147
|
+
count: number;
|
|
5148
|
+
data: InsightFixedIncomeV2[];
|
|
5149
|
+
}
|
|
5150
|
+
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
5151
|
+
/** @example true */
|
|
5152
|
+
bank_qualified?: boolean;
|
|
5153
|
+
/** @example true */
|
|
5154
|
+
callable?: boolean;
|
|
5155
|
+
/** @example true */
|
|
5156
|
+
convertible?: boolean;
|
|
5157
|
+
/** @example ["USA"] */
|
|
5158
|
+
country_codes?: string[];
|
|
5159
|
+
coupon?: InsightLessAndMoreV2;
|
|
5160
|
+
/** @example ["quarterly","zero"] */
|
|
5161
|
+
coupon_frequencies?: string[];
|
|
5162
|
+
/** @example ["655664AH3","9128286R6"] */
|
|
5163
|
+
cusip?: string[];
|
|
5164
|
+
/**
|
|
5165
|
+
* @maxLength 100
|
|
5166
|
+
* @example "Donald's"
|
|
5167
|
+
*/
|
|
5168
|
+
description?: string;
|
|
5169
|
+
/** @example true */
|
|
5170
|
+
has_ticker?: boolean;
|
|
5171
|
+
/** @example true */
|
|
5172
|
+
insured?: boolean;
|
|
5173
|
+
/** @example ["US655664AH33","US9128286R69"] */
|
|
5174
|
+
isin?: string[];
|
|
5175
|
+
issue_date?: InsightBeforeAndAfterV2;
|
|
5176
|
+
/**
|
|
5177
|
+
* @maxLength 100
|
|
5178
|
+
* @example "Donald's"
|
|
5179
|
+
*/
|
|
5180
|
+
issuer?: string;
|
|
5181
|
+
maturity?: InsightBeforeAndAfterV2;
|
|
5182
|
+
/** @example ["NY"] */
|
|
5183
|
+
municipal_states?: string[];
|
|
5184
|
+
/** @example true */
|
|
5185
|
+
municipal_tax?: boolean;
|
|
5186
|
+
/** @example ["general_obligation"] */
|
|
5187
|
+
municipal_types?: string[];
|
|
5188
|
+
pagination: InsightPaginationV2;
|
|
5189
|
+
purposes?: string[];
|
|
5190
|
+
/** @example ["SOVEREIGN"] */
|
|
5191
|
+
sectors?: string[];
|
|
5192
|
+
sorts?: InsightOrderingV2[];
|
|
5193
|
+
/** @example ["AAA"] */
|
|
5194
|
+
sp_ratings?: string[];
|
|
5195
|
+
/** @example ["called","outstanding"] */
|
|
5196
|
+
statuses?: string[];
|
|
5197
|
+
tickers?: string[];
|
|
5198
|
+
/** @example ["corporate"] */
|
|
5199
|
+
types?: string[];
|
|
5200
|
+
}
|
|
5201
|
+
export interface InsightGetTopSymbolsRequestV2 {
|
|
5202
|
+
exchange?: string[];
|
|
5203
|
+
market_cap?: InsightLessAndMoreV2;
|
|
5204
|
+
pagination?: InsightPaginationV2;
|
|
5205
|
+
price?: InsightLessAndMoreV2;
|
|
5206
|
+
sorts?: InsightOrderingV2[];
|
|
5207
|
+
volume?: InsightLessAndMoreV2;
|
|
5208
|
+
}
|
|
5209
|
+
export interface InsightIncludeExcludeV2 {
|
|
5210
|
+
exclude?: string[];
|
|
5211
|
+
include?: string[];
|
|
5212
|
+
}
|
|
5213
|
+
export interface InsightLessAndMoreV2 {
|
|
5214
|
+
less_than?: number;
|
|
5215
|
+
more_than?: number;
|
|
5216
|
+
}
|
|
5217
|
+
export enum InsightOrderDirectionV2 {
|
|
5218
|
+
OrderASC = "asc",
|
|
5219
|
+
OrderDESC = "desc"
|
|
5220
|
+
}
|
|
5221
|
+
export interface InsightOrderingV2 {
|
|
5222
|
+
/**
|
|
5223
|
+
* @default "asc"
|
|
5224
|
+
* @example "asc"
|
|
5225
|
+
*/
|
|
5226
|
+
direction: InsightOrderingDirectionEnumV2;
|
|
5227
|
+
/**
|
|
5228
|
+
* Sort direction:
|
|
5229
|
+
* * asc - Ascending, from A to Z.
|
|
5230
|
+
* * desc - Descending, from Z to A.
|
|
5231
|
+
* @example "name"
|
|
5232
|
+
*/
|
|
5233
|
+
field: string;
|
|
5234
|
+
}
|
|
5235
|
+
export interface InsightPaginationV2 {
|
|
5236
|
+
/**
|
|
5237
|
+
* @min 1
|
|
5238
|
+
* @example 1
|
|
5239
|
+
*/
|
|
5240
|
+
page: number;
|
|
5241
|
+
/**
|
|
5242
|
+
* @min 1
|
|
5243
|
+
* @max 50
|
|
5244
|
+
* @example 10
|
|
5245
|
+
*/
|
|
5246
|
+
size: number;
|
|
5247
|
+
}
|
|
5248
|
+
export interface InsightStockScreenerQuoteV2 {
|
|
5249
|
+
average_volume_30d: number;
|
|
5250
|
+
company_name: string;
|
|
5251
|
+
dividend_ex_date: string;
|
|
5252
|
+
dividend_pay_date: string;
|
|
5253
|
+
dividend_percent: number;
|
|
5254
|
+
exchange: string;
|
|
5255
|
+
exchange_name: string;
|
|
5256
|
+
gap: number;
|
|
5257
|
+
industry: string;
|
|
5258
|
+
industry_code: string;
|
|
5259
|
+
last_price: number;
|
|
5260
|
+
market_cap: number;
|
|
5261
|
+
pe_ratio: number;
|
|
5262
|
+
price_change: number;
|
|
5263
|
+
price_change_percent: number;
|
|
5264
|
+
symbol: string;
|
|
5265
|
+
volume: number;
|
|
5266
|
+
}
|
|
5267
|
+
export interface InsightStockScreenerRequestV2 {
|
|
5268
|
+
average_volume_30d?: InsightLessAndMoreV2;
|
|
5269
|
+
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
5270
|
+
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
5271
|
+
dividend_percent?: InsightLessAndMoreV2;
|
|
5272
|
+
exchange?: InsightIncludeExcludeV2;
|
|
5273
|
+
gap?: InsightLessAndMoreV2;
|
|
5274
|
+
industry?: InsightIncludeExcludeV2;
|
|
5275
|
+
market_cap?: InsightLessAndMoreV2;
|
|
5276
|
+
pagination: InsightPaginationV2;
|
|
5277
|
+
pe_ratio?: InsightLessAndMoreV2;
|
|
5278
|
+
price?: InsightLessAndMoreV2;
|
|
5279
|
+
sorts?: InsightOrderingV2[];
|
|
5280
|
+
/** @example "ADR" */
|
|
5281
|
+
stock_type?: string;
|
|
5282
|
+
volume?: InsightLessAndMoreV2;
|
|
5283
|
+
}
|
|
5284
|
+
export interface InsightStockScreenerResponseV2 {
|
|
5285
|
+
current_page: number;
|
|
5286
|
+
data: InsightStockScreenerQuoteV2[];
|
|
5287
|
+
page_count: number;
|
|
5288
|
+
status: number;
|
|
5289
|
+
total_records: number;
|
|
5290
|
+
}
|
|
5291
|
+
/**
|
|
5292
|
+
* @default "asc"
|
|
5293
|
+
* @example "asc"
|
|
5294
|
+
*/
|
|
5295
|
+
export enum InsightOrderingDirectionEnumV2 {
|
|
5296
|
+
Asc = "asc",
|
|
5297
|
+
Desc = "desc"
|
|
5298
|
+
}
|
|
5299
|
+
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
5300
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5301
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5302
|
+
/**
|
|
5303
|
+
* @description get fixed income entries
|
|
5304
|
+
* @tags FixedIncome
|
|
5305
|
+
* @name GetFixedIncomeEntries
|
|
5306
|
+
* @summary get fixed income entries
|
|
5307
|
+
* @request POST:/fixed-income
|
|
5308
|
+
* @secure
|
|
5309
|
+
*/
|
|
5310
|
+
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
5311
|
+
}
|
|
5312
|
+
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
5313
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5314
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5315
|
+
/**
|
|
5316
|
+
* @description get fundamentals by symbol data
|
|
5317
|
+
* @tags Fundamentals
|
|
5318
|
+
* @name GetFundamentalsBySymbolData
|
|
5319
|
+
* @summary get fundamentals by symbol data
|
|
5320
|
+
* @request POST:/fundamentals
|
|
5321
|
+
* @secure
|
|
5322
|
+
*/
|
|
5323
|
+
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5324
|
+
}
|
|
5325
|
+
export class Funds<HandleError extends boolean = boolean> {
|
|
5326
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5327
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5328
|
+
/**
|
|
5329
|
+
* @description get fund details
|
|
5330
|
+
* @tags Funds
|
|
5331
|
+
* @name GetFundDetails
|
|
5332
|
+
* @summary get fund details
|
|
5333
|
+
* @request GET:/funds/details
|
|
5334
|
+
* @secure
|
|
5335
|
+
*/
|
|
5336
|
+
getFundDetails(query: {
|
|
5337
|
+
/** Fund symbol */
|
|
5338
|
+
symbol: string;
|
|
5339
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError>>;
|
|
5340
|
+
/**
|
|
5341
|
+
* @description get funds for holding
|
|
5342
|
+
* @tags Funds
|
|
5343
|
+
* @name GetFundsForHolding
|
|
5344
|
+
* @summary get funds for holding
|
|
5345
|
+
* @request POST:/funds/funds-for-holding
|
|
5346
|
+
* @secure
|
|
5347
|
+
*/
|
|
5348
|
+
getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
|
|
5349
|
+
/** Authorization */
|
|
5350
|
+
Authorization?: string;
|
|
5351
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError>>;
|
|
5352
|
+
/**
|
|
5353
|
+
* @description filter funds by params
|
|
5354
|
+
* @tags Funds
|
|
5355
|
+
* @name FundScreener
|
|
5356
|
+
* @summary filter funds by params
|
|
5357
|
+
* @request POST:/funds/screener
|
|
5358
|
+
* @secure
|
|
5359
|
+
*/
|
|
5360
|
+
fundScreener(filter: InsightFundScreenerRequest, headers?: {
|
|
5361
|
+
/** Authorization */
|
|
5279
5362
|
Authorization?: string;
|
|
5280
5363
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
5281
5364
|
/**
|
|
@@ -5318,1031 +5401,1147 @@ export class Funds<HandleError extends boolean = boolean> {
|
|
|
5318
5401
|
* @request POST:/funds/screener/presets
|
|
5319
5402
|
* @secure
|
|
5320
5403
|
*/
|
|
5321
|
-
createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5404
|
+
createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5405
|
+
/**
|
|
5406
|
+
* @description remove fund screener preset
|
|
5407
|
+
* @tags Funds
|
|
5408
|
+
* @name RemoveFundScreenerPreset
|
|
5409
|
+
* @summary remove fund screener preset
|
|
5410
|
+
* @request DELETE:/funds/screener/presets
|
|
5411
|
+
* @secure
|
|
5412
|
+
*/
|
|
5413
|
+
removeFundScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5414
|
+
/**
|
|
5415
|
+
* @description filter funds by params
|
|
5416
|
+
* @tags Funds
|
|
5417
|
+
* @name FundSectorScreener
|
|
5418
|
+
* @summary filter funds by params
|
|
5419
|
+
* @request POST:/funds/sector-screener
|
|
5420
|
+
* @secure
|
|
5421
|
+
*/
|
|
5422
|
+
fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
|
|
5423
|
+
/** Authorization */
|
|
5424
|
+
Authorization?: string;
|
|
5425
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
5426
|
+
/**
|
|
5427
|
+
* @description get top funds
|
|
5428
|
+
* @tags Funds
|
|
5429
|
+
* @name GetTopFunds
|
|
5430
|
+
* @summary get top funds
|
|
5431
|
+
* @request POST:/funds/top
|
|
5432
|
+
* @secure
|
|
5433
|
+
*/
|
|
5434
|
+
getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
|
|
5435
|
+
/** Authorization */
|
|
5436
|
+
Authorization?: string;
|
|
5437
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
|
|
5438
|
+
}
|
|
5439
|
+
export class Intraday<HandleError extends boolean = boolean> {
|
|
5440
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5441
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5442
|
+
/**
|
|
5443
|
+
* @description Returns an array of intraday chart data values for the given ticker.
|
|
5444
|
+
* @tags Intraday
|
|
5445
|
+
* @name IntradayQuotes
|
|
5446
|
+
* @summary Get an array of intraday chart data values for the given ticker
|
|
5447
|
+
* @request POST:/intraday/quotes
|
|
5448
|
+
* @secure
|
|
5449
|
+
*/
|
|
5450
|
+
intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
|
|
5451
|
+
}
|
|
5452
|
+
export class Ipos<HandleError extends boolean = boolean> {
|
|
5453
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5454
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5455
|
+
/**
|
|
5456
|
+
* @description get recent ipos info
|
|
5457
|
+
* @tags Ipos
|
|
5458
|
+
* @name PostRecent
|
|
5459
|
+
* @summary get recent ipos info
|
|
5460
|
+
* @request POST:/ipos/recent
|
|
5461
|
+
* @secure
|
|
5462
|
+
*/
|
|
5463
|
+
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5464
|
+
/**
|
|
5465
|
+
* @description get upcoming ipos info
|
|
5466
|
+
* @tags Ipos
|
|
5467
|
+
* @name GetUpcoming
|
|
5468
|
+
* @summary get upcoming ipos info
|
|
5469
|
+
* @request GET:/ipos/upcoming
|
|
5470
|
+
* @secure
|
|
5471
|
+
*/
|
|
5472
|
+
getUpcoming(query: {
|
|
5473
|
+
/** how many records to return. Max value is 50 */
|
|
5474
|
+
limit: number;
|
|
5475
|
+
/** how many records to skip */
|
|
5476
|
+
offset: number;
|
|
5477
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5478
|
+
/**
|
|
5479
|
+
* @description get ipo info by symbol
|
|
5480
|
+
* @tags Ipos
|
|
5481
|
+
* @name GetIpos
|
|
5482
|
+
* @summary get ipo info by symbol
|
|
5483
|
+
* @request GET:/ipos/{symbol}
|
|
5484
|
+
* @secure
|
|
5485
|
+
*/
|
|
5486
|
+
getIpos(symbol: string, query?: {
|
|
5487
|
+
/** load quotes */
|
|
5488
|
+
load_quotes?: boolean;
|
|
5489
|
+
/** statuses */
|
|
5490
|
+
statuses?: string[];
|
|
5491
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
|
|
5492
|
+
}
|
|
5493
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
5494
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5495
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5496
|
+
/**
|
|
5497
|
+
* @description Returns converted logo for crypto symbol
|
|
5498
|
+
* @tags Logos
|
|
5499
|
+
* @name LogosConvertedCryptoSymbolLogo
|
|
5500
|
+
* @summary Get converted logo for crypto symbol
|
|
5501
|
+
* @request POST:/logos/converted-crypto-symbol-logo
|
|
5502
|
+
* @secure
|
|
5503
|
+
*/
|
|
5504
|
+
logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5322
5505
|
/**
|
|
5323
|
-
* @description
|
|
5324
|
-
* @tags
|
|
5325
|
-
* @name
|
|
5326
|
-
* @summary
|
|
5327
|
-
* @request
|
|
5506
|
+
* @description Returns converted logo for symbol
|
|
5507
|
+
* @tags Logos
|
|
5508
|
+
* @name LogosConvertedSymbolLogo
|
|
5509
|
+
* @summary Get converted logo for symbol
|
|
5510
|
+
* @request POST:/logos/converted-symbol-logo
|
|
5328
5511
|
* @secure
|
|
5329
5512
|
*/
|
|
5330
|
-
|
|
5513
|
+
logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5331
5514
|
/**
|
|
5332
|
-
* @description
|
|
5333
|
-
* @tags
|
|
5334
|
-
* @name
|
|
5335
|
-
* @summary
|
|
5336
|
-
* @request
|
|
5515
|
+
* @description Returns logo for crypto symbol
|
|
5516
|
+
* @tags Logos
|
|
5517
|
+
* @name LogosCryptoSymbolLogo
|
|
5518
|
+
* @summary Get logo for crypto symbol
|
|
5519
|
+
* @request GET:/logos/crypto-symbol-logo
|
|
5337
5520
|
* @secure
|
|
5338
5521
|
*/
|
|
5339
|
-
|
|
5340
|
-
/**
|
|
5341
|
-
|
|
5342
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5522
|
+
logosCryptoSymbolLogo(query: {
|
|
5523
|
+
/** Company symbol */
|
|
5524
|
+
symbol: string;
|
|
5525
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
|
|
5343
5526
|
/**
|
|
5344
|
-
* @description
|
|
5345
|
-
* @tags
|
|
5346
|
-
* @name
|
|
5347
|
-
* @summary
|
|
5348
|
-
* @request
|
|
5527
|
+
* @description Returns direct logo for crypto symbol
|
|
5528
|
+
* @tags Logos
|
|
5529
|
+
* @name LogosDirectCryptoSymbolLogo
|
|
5530
|
+
* @summary Get direct logo for crypto symbol
|
|
5531
|
+
* @request GET:/logos/direct-crypto-symbol-logo
|
|
5349
5532
|
* @secure
|
|
5350
5533
|
*/
|
|
5351
|
-
|
|
5352
|
-
/**
|
|
5353
|
-
|
|
5354
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5355
|
-
}
|
|
5356
|
-
export class StockScreener<HandleError extends boolean = boolean> {
|
|
5357
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5358
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5534
|
+
logosDirectCryptoSymbolLogo(query: {
|
|
5535
|
+
/** Company symbol */
|
|
5536
|
+
symbol: string;
|
|
5537
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5359
5538
|
/**
|
|
5360
|
-
* @description
|
|
5361
|
-
* @tags
|
|
5362
|
-
* @name
|
|
5363
|
-
* @summary
|
|
5364
|
-
* @request GET:/
|
|
5539
|
+
* @description Returns direct logo for symbol
|
|
5540
|
+
* @tags Logos
|
|
5541
|
+
* @name LogosDirectSymbolLogo
|
|
5542
|
+
* @summary Get direct logo for symbol
|
|
5543
|
+
* @request GET:/logos/direct-symbol-logo
|
|
5365
5544
|
* @secure
|
|
5366
5545
|
*/
|
|
5367
|
-
|
|
5368
|
-
/**
|
|
5369
|
-
|
|
5370
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5546
|
+
logosDirectSymbolLogo(query: {
|
|
5547
|
+
/** Company symbol */
|
|
5548
|
+
symbol: string;
|
|
5549
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5371
5550
|
/**
|
|
5372
|
-
* @description
|
|
5373
|
-
* @tags
|
|
5374
|
-
* @name
|
|
5375
|
-
* @summary
|
|
5376
|
-
* @request POST:/
|
|
5551
|
+
* @description Returns logos for multiple symbols
|
|
5552
|
+
* @tags Logos
|
|
5553
|
+
* @name LogosMultipleCryptoSymbolLogo
|
|
5554
|
+
* @summary Get logos for multiple symbols
|
|
5555
|
+
* @request POST:/logos/multiple-crypto-symbol-logo
|
|
5377
5556
|
* @secure
|
|
5378
5557
|
*/
|
|
5379
|
-
|
|
5558
|
+
logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
|
|
5380
5559
|
/**
|
|
5381
|
-
* @description
|
|
5382
|
-
* @tags
|
|
5383
|
-
* @name
|
|
5384
|
-
* @summary
|
|
5385
|
-
* @request POST:/
|
|
5560
|
+
* @description Returns logos for multiple symbol
|
|
5561
|
+
* @tags Logos
|
|
5562
|
+
* @name LogosMultipleSymbolLogos
|
|
5563
|
+
* @summary Get logos for multiple symbols
|
|
5564
|
+
* @request POST:/logos/multiple-symbol-logos
|
|
5386
5565
|
* @secure
|
|
5387
5566
|
*/
|
|
5388
|
-
|
|
5567
|
+
logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
|
|
5389
5568
|
/**
|
|
5390
|
-
* @description
|
|
5391
|
-
* @tags
|
|
5392
|
-
* @name
|
|
5393
|
-
* @summary
|
|
5394
|
-
* @request
|
|
5569
|
+
* @description Returns links of socials logos for symbol
|
|
5570
|
+
* @tags Logos
|
|
5571
|
+
* @name LogosSocialSymbolLogos
|
|
5572
|
+
* @summary Get social logos for symbol
|
|
5573
|
+
* @request GET:/logos/social-symbol-logos
|
|
5395
5574
|
* @secure
|
|
5396
5575
|
*/
|
|
5397
|
-
|
|
5398
|
-
/**
|
|
5399
|
-
|
|
5400
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5576
|
+
logosSocialSymbolLogos(query: {
|
|
5577
|
+
/** Company symbol */
|
|
5578
|
+
symbol: string;
|
|
5579
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
|
|
5401
5580
|
/**
|
|
5402
|
-
* @description
|
|
5403
|
-
* @tags
|
|
5404
|
-
* @name
|
|
5405
|
-
* @summary
|
|
5406
|
-
* @request GET:/
|
|
5581
|
+
* @description Returns logos for company symbol
|
|
5582
|
+
* @tags Logos
|
|
5583
|
+
* @name LogosSymbolLogos
|
|
5584
|
+
* @summary Get symbol logos
|
|
5585
|
+
* @request GET:/logos/symbol-logos
|
|
5407
5586
|
* @secure
|
|
5408
5587
|
*/
|
|
5409
|
-
|
|
5410
|
-
/**
|
|
5411
|
-
|
|
5412
|
-
|
|
5413
|
-
|
|
5414
|
-
|
|
5588
|
+
logosSymbolLogos(query: {
|
|
5589
|
+
/** Company symbol */
|
|
5590
|
+
symbol: string;
|
|
5591
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
|
|
5592
|
+
}
|
|
5593
|
+
export class MarketDates<HandleError extends boolean = boolean> {
|
|
5594
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5595
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5415
5596
|
/**
|
|
5416
|
-
* @description update
|
|
5417
|
-
* @tags
|
|
5418
|
-
* @name
|
|
5419
|
-
* @summary update
|
|
5420
|
-
* @request
|
|
5597
|
+
* @description Create or update market date
|
|
5598
|
+
* @tags MarketDates
|
|
5599
|
+
* @name CreateOrUpdateMarketDate
|
|
5600
|
+
* @summary Create or update market date
|
|
5601
|
+
* @request POST:/market-dates
|
|
5421
5602
|
* @secure
|
|
5422
5603
|
*/
|
|
5423
|
-
|
|
5604
|
+
createOrUpdateMarketDate(market: InsightMarketDates[], config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate[], HandleError>>;
|
|
5424
5605
|
/**
|
|
5425
|
-
* @description
|
|
5426
|
-
* @tags
|
|
5427
|
-
* @name
|
|
5428
|
-
* @summary
|
|
5429
|
-
* @request
|
|
5606
|
+
* @description Remove market date
|
|
5607
|
+
* @tags MarketDates
|
|
5608
|
+
* @name RemoveMarketDate
|
|
5609
|
+
* @summary Remove market date
|
|
5610
|
+
* @request DELETE:/market-dates
|
|
5430
5611
|
* @secure
|
|
5431
5612
|
*/
|
|
5432
|
-
|
|
5613
|
+
removeMarketDate(market: InsightRemoveMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5433
5614
|
/**
|
|
5434
|
-
* @description
|
|
5435
|
-
* @tags
|
|
5436
|
-
* @name
|
|
5437
|
-
* @summary
|
|
5438
|
-
* @request
|
|
5615
|
+
* @description Get market dates history
|
|
5616
|
+
* @tags MarketDates
|
|
5617
|
+
* @name GetMarketDatesHistory
|
|
5618
|
+
* @summary Get market dates history
|
|
5619
|
+
* @request POST:/market-dates/history
|
|
5439
5620
|
* @secure
|
|
5440
5621
|
*/
|
|
5441
|
-
|
|
5622
|
+
getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
|
|
5442
5623
|
/**
|
|
5443
|
-
* @description
|
|
5444
|
-
* @tags
|
|
5445
|
-
* @name
|
|
5446
|
-
* @summary
|
|
5447
|
-
* @request
|
|
5624
|
+
* @description Search locode data by search string and field
|
|
5625
|
+
* @tags MarketDates
|
|
5626
|
+
* @name SearchLocodeData
|
|
5627
|
+
* @summary Search locode data
|
|
5628
|
+
* @request GET:/market-dates/locode
|
|
5448
5629
|
* @secure
|
|
5449
5630
|
*/
|
|
5450
|
-
|
|
5451
|
-
|
|
5452
|
-
|
|
5453
|
-
|
|
5454
|
-
|
|
5631
|
+
searchLocodeData(query?: {
|
|
5632
|
+
/** Search string */
|
|
5633
|
+
search?: string;
|
|
5634
|
+
/** Search field */
|
|
5635
|
+
field?: InsightSearchLocodeDataParamsFieldEnum;
|
|
5636
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchLocodeDataResponse, HandleError>>;
|
|
5455
5637
|
/**
|
|
5456
|
-
* @description
|
|
5457
|
-
* @tags
|
|
5458
|
-
* @name
|
|
5459
|
-
* @summary Get
|
|
5460
|
-
* @request
|
|
5638
|
+
* @description Get markets
|
|
5639
|
+
* @tags MarketDates
|
|
5640
|
+
* @name GetMarkets
|
|
5641
|
+
* @summary Get markets
|
|
5642
|
+
* @request GET:/market-dates/markets
|
|
5461
5643
|
* @secure
|
|
5462
5644
|
*/
|
|
5463
|
-
|
|
5464
|
-
}
|
|
5465
|
-
export class Quotes<HandleError extends boolean = boolean> {
|
|
5466
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5467
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5645
|
+
getMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketsResponse, HandleError>>;
|
|
5468
5646
|
/**
|
|
5469
|
-
* @description
|
|
5470
|
-
* @tags
|
|
5471
|
-
* @name
|
|
5472
|
-
* @summary
|
|
5473
|
-
* @request
|
|
5647
|
+
* @description Create or update market
|
|
5648
|
+
* @tags MarketDates
|
|
5649
|
+
* @name CreateOrUpdateMarket
|
|
5650
|
+
* @summary Create or update market
|
|
5651
|
+
* @request POST:/market-dates/markets
|
|
5474
5652
|
* @secure
|
|
5475
5653
|
*/
|
|
5476
|
-
|
|
5477
|
-
/** Symbol */
|
|
5478
|
-
symbol: string;
|
|
5479
|
-
/** Date */
|
|
5480
|
-
date: string;
|
|
5481
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
5654
|
+
createOrUpdateMarket(market: InsightCreateOrUpdateMarketRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
|
|
5482
5655
|
/**
|
|
5483
|
-
* @description
|
|
5484
|
-
* @tags
|
|
5485
|
-
* @name
|
|
5486
|
-
* @summary Get
|
|
5487
|
-
* @request
|
|
5656
|
+
* @description Get market
|
|
5657
|
+
* @tags MarketDates
|
|
5658
|
+
* @name GetMarket
|
|
5659
|
+
* @summary Get market
|
|
5660
|
+
* @request GET:/market-dates/markets/{market}
|
|
5488
5661
|
* @secure
|
|
5489
5662
|
*/
|
|
5490
|
-
|
|
5663
|
+
getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
|
|
5491
5664
|
/**
|
|
5492
|
-
* @description
|
|
5493
|
-
* @tags
|
|
5494
|
-
* @name
|
|
5495
|
-
* @summary
|
|
5496
|
-
* @request
|
|
5665
|
+
* @description Remove market
|
|
5666
|
+
* @tags MarketDates
|
|
5667
|
+
* @name RemoveMarket
|
|
5668
|
+
* @summary Remove market
|
|
5669
|
+
* @request DELETE:/market-dates/markets/{market}
|
|
5670
|
+
* @secure
|
|
5671
|
+
*/
|
|
5672
|
+
removeMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5673
|
+
/**
|
|
5674
|
+
* @description CreateOrUpdateMarketSchedule market schedule
|
|
5675
|
+
* @tags MarketDates
|
|
5676
|
+
* @name CreateOrUpdateMarketSchedule
|
|
5677
|
+
* @summary CreateOrUpdateMarketSchedule market schedule
|
|
5678
|
+
* @request POST:/market-dates/schedule
|
|
5497
5679
|
* @secure
|
|
5498
5680
|
*/
|
|
5499
|
-
|
|
5500
|
-
/** Comma separated symbols */
|
|
5501
|
-
symbols: string;
|
|
5502
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
5503
|
-
}
|
|
5504
|
-
export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
5505
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5506
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5681
|
+
createOrUpdateMarketSchedule(market: InsightCreateOrUpdateMarketScheduleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
|
|
5507
5682
|
/**
|
|
5508
|
-
* @description
|
|
5509
|
-
* @tags
|
|
5510
|
-
* @name
|
|
5511
|
-
* @summary
|
|
5512
|
-
* @request GET:/
|
|
5683
|
+
* @description Get market schedule
|
|
5684
|
+
* @tags MarketDates
|
|
5685
|
+
* @name GetMarketSchedule
|
|
5686
|
+
* @summary Get market schedule
|
|
5687
|
+
* @request GET:/market-dates/schedule/{market}
|
|
5513
5688
|
* @secure
|
|
5514
5689
|
*/
|
|
5515
|
-
|
|
5516
|
-
/** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
5517
|
-
from?: string;
|
|
5518
|
-
/** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
5519
|
-
to?: string;
|
|
5520
|
-
/** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
|
|
5521
|
-
interval?: string;
|
|
5522
|
-
/** Limit the number of OHLC data points returned. Default is 100. */
|
|
5523
|
-
limit?: number;
|
|
5524
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
|
|
5525
|
-
close?: number;
|
|
5526
|
-
high?: number;
|
|
5527
|
-
low?: number;
|
|
5528
|
-
open?: number;
|
|
5529
|
-
time?: string;
|
|
5530
|
-
volume?: number;
|
|
5531
|
-
}[], HandleError>>;
|
|
5690
|
+
getMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
|
|
5532
5691
|
/**
|
|
5533
|
-
* @description
|
|
5534
|
-
* @tags
|
|
5535
|
-
* @name
|
|
5536
|
-
* @summary
|
|
5537
|
-
* @request
|
|
5692
|
+
* @description Remove market schedule
|
|
5693
|
+
* @tags MarketDates
|
|
5694
|
+
* @name RemoveMarketSchedule
|
|
5695
|
+
* @summary Remove market schedule
|
|
5696
|
+
* @request DELETE:/market-dates/schedule/{market}
|
|
5538
5697
|
* @secure
|
|
5539
5698
|
*/
|
|
5540
|
-
|
|
5699
|
+
removeMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5541
5700
|
/**
|
|
5542
|
-
* @description
|
|
5543
|
-
* @tags
|
|
5544
|
-
* @name
|
|
5545
|
-
* @summary
|
|
5546
|
-
* @request GET:/
|
|
5701
|
+
* @description Get market schedules
|
|
5702
|
+
* @tags MarketDates
|
|
5703
|
+
* @name GetMarketSchedules
|
|
5704
|
+
* @summary Get market schedules
|
|
5705
|
+
* @request GET:/market-dates/schedules
|
|
5547
5706
|
* @secure
|
|
5548
5707
|
*/
|
|
5549
|
-
|
|
5550
|
-
/**
|
|
5551
|
-
|
|
5552
|
-
|
|
5553
|
-
categories?: string;
|
|
5554
|
-
/** search by listing type */
|
|
5555
|
-
listing_type?: string;
|
|
5556
|
-
/** filter by active status */
|
|
5557
|
-
is_active?: InsightGetPreIpoCompaniesParamsIsActiveEnum;
|
|
5558
|
-
/** filter by minimum last valuation */
|
|
5559
|
-
min_last_valuation?: number;
|
|
5560
|
-
/** filter by maximum last valuation */
|
|
5561
|
-
max_last_valuation?: number;
|
|
5562
|
-
/** filter by minimum total funding */
|
|
5563
|
-
min_total_funding?: number;
|
|
5564
|
-
/** filter by maximum total funding */
|
|
5565
|
-
max_total_funding?: number;
|
|
5566
|
-
/** how many records to return. Max value is 50 */
|
|
5567
|
-
limit: number;
|
|
5568
|
-
/** how many records to skip */
|
|
5569
|
-
offset: number;
|
|
5570
|
-
/** sort field */
|
|
5571
|
-
order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
|
|
5572
|
-
/** sort direction */
|
|
5573
|
-
order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
|
|
5574
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
|
|
5708
|
+
getMarketSchedules(query?: {
|
|
5709
|
+
/** Market codes, comma separated */
|
|
5710
|
+
market?: string;
|
|
5711
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError>>;
|
|
5575
5712
|
/**
|
|
5576
|
-
* @description
|
|
5577
|
-
* @tags
|
|
5578
|
-
* @name
|
|
5579
|
-
* @summary
|
|
5580
|
-
* @request GET:/
|
|
5581
|
-
* @originalName getPreIpoCompanies
|
|
5582
|
-
* @duplicate
|
|
5713
|
+
* @description Get todays market hours
|
|
5714
|
+
* @tags MarketDates
|
|
5715
|
+
* @name GetTodaysMarketHours
|
|
5716
|
+
* @summary Get todays market hours
|
|
5717
|
+
* @request GET:/market-dates/today
|
|
5583
5718
|
* @secure
|
|
5584
5719
|
*/
|
|
5585
|
-
|
|
5720
|
+
getTodaysMarketHours(query: {
|
|
5721
|
+
/** Market */
|
|
5722
|
+
market: string;
|
|
5723
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
5724
|
+
}
|
|
5725
|
+
export class News<HandleError extends boolean = boolean> {
|
|
5726
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5727
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5586
5728
|
/**
|
|
5587
|
-
* @description
|
|
5588
|
-
* @tags
|
|
5589
|
-
* @name
|
|
5590
|
-
* @summary
|
|
5591
|
-
* @request
|
|
5729
|
+
* @description Returns available authors in DB
|
|
5730
|
+
* @tags News
|
|
5731
|
+
* @name NewsAvailableAuthors
|
|
5732
|
+
* @summary Get available authors in DB (for filters)
|
|
5733
|
+
* @request POST:/news/authors
|
|
5592
5734
|
* @secure
|
|
5593
5735
|
*/
|
|
5594
|
-
|
|
5595
|
-
/** company id */
|
|
5596
|
-
pre_ipo_company_id?: string;
|
|
5597
|
-
/** search by round name */
|
|
5598
|
-
round_name?: string;
|
|
5599
|
-
/** how many records to return. Max value is 50 */
|
|
5600
|
-
limit: number;
|
|
5601
|
-
/** how many records to skip */
|
|
5602
|
-
offset: number;
|
|
5603
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
|
|
5736
|
+
newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5604
5737
|
/**
|
|
5605
|
-
* @description
|
|
5606
|
-
* @tags
|
|
5607
|
-
* @name
|
|
5608
|
-
* @summary
|
|
5609
|
-
* @request
|
|
5610
|
-
* @originalName getPreIpoCompanyFundingRounds
|
|
5611
|
-
* @duplicate
|
|
5738
|
+
* @description Returns available channels in DB
|
|
5739
|
+
* @tags News
|
|
5740
|
+
* @name NewsAvailableChannels
|
|
5741
|
+
* @summary Get available channels in DB (for filters)
|
|
5742
|
+
* @request POST:/news/channels
|
|
5612
5743
|
* @secure
|
|
5613
5744
|
*/
|
|
5614
|
-
|
|
5745
|
+
newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5615
5746
|
/**
|
|
5616
|
-
* @description
|
|
5617
|
-
* @tags
|
|
5618
|
-
* @name
|
|
5619
|
-
* @summary
|
|
5620
|
-
* @request GET:/
|
|
5747
|
+
* @description Get featured articles
|
|
5748
|
+
* @tags News
|
|
5749
|
+
* @name GetFeaturedArticles
|
|
5750
|
+
* @summary Get featured articles
|
|
5751
|
+
* @request GET:/news/featured-articles
|
|
5621
5752
|
* @secure
|
|
5622
5753
|
*/
|
|
5623
|
-
|
|
5624
|
-
/**
|
|
5625
|
-
pre_ipo_company_id?: string;
|
|
5626
|
-
/** company name */
|
|
5627
|
-
company_name?: string;
|
|
5628
|
-
/** how many records to return. Max value is 50 */
|
|
5754
|
+
getFeaturedArticles(query: {
|
|
5755
|
+
/** Limit */
|
|
5629
5756
|
limit: number;
|
|
5630
|
-
/**
|
|
5757
|
+
/** Offset */
|
|
5631
5758
|
offset: number;
|
|
5632
|
-
|
|
5759
|
+
/** Start date */
|
|
5760
|
+
start_date?: string;
|
|
5761
|
+
/** End date */
|
|
5762
|
+
end_date?: string;
|
|
5763
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
|
|
5633
5764
|
/**
|
|
5634
|
-
* @description
|
|
5635
|
-
* @tags
|
|
5636
|
-
* @name
|
|
5637
|
-
* @summary
|
|
5638
|
-
* @request
|
|
5639
|
-
* @originalName getPreIpoCompanyInvestments
|
|
5640
|
-
* @duplicate
|
|
5765
|
+
* @description Update featured articles
|
|
5766
|
+
* @tags News
|
|
5767
|
+
* @name UpdateFeaturedArticles
|
|
5768
|
+
* @summary Update featured articles
|
|
5769
|
+
* @request PUT:/news/featured-articles
|
|
5641
5770
|
* @secure
|
|
5642
5771
|
*/
|
|
5643
|
-
|
|
5772
|
+
updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5644
5773
|
/**
|
|
5645
|
-
* @description
|
|
5646
|
-
* @tags
|
|
5647
|
-
* @name
|
|
5648
|
-
* @summary
|
|
5649
|
-
* @request
|
|
5774
|
+
* @description Create featured articles
|
|
5775
|
+
* @tags News
|
|
5776
|
+
* @name CreateFeaturedArticles
|
|
5777
|
+
* @summary Create featured articles
|
|
5778
|
+
* @request POST:/news/featured-articles
|
|
5650
5779
|
* @secure
|
|
5651
5780
|
*/
|
|
5652
|
-
|
|
5653
|
-
/** company id */
|
|
5654
|
-
pre_ipo_company_id?: string;
|
|
5655
|
-
/** search by headline */
|
|
5656
|
-
headline?: string;
|
|
5657
|
-
/** how many records to return. Max value is 50 */
|
|
5658
|
-
limit: number;
|
|
5659
|
-
/** how many records to skip */
|
|
5660
|
-
offset: number;
|
|
5661
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
|
|
5781
|
+
createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5662
5782
|
/**
|
|
5663
|
-
* @description
|
|
5664
|
-
* @tags
|
|
5665
|
-
* @name
|
|
5666
|
-
* @summary
|
|
5667
|
-
* @request GET:/
|
|
5668
|
-
* @originalName getPreIpoCompanyNews
|
|
5669
|
-
* @duplicate
|
|
5783
|
+
* @description Get active featured articles
|
|
5784
|
+
* @tags News
|
|
5785
|
+
* @name GetActiveFeaturedArticles
|
|
5786
|
+
* @summary Get active featured articles
|
|
5787
|
+
* @request GET:/news/featured-articles/active
|
|
5670
5788
|
* @secure
|
|
5671
5789
|
*/
|
|
5672
|
-
|
|
5790
|
+
getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
|
|
5673
5791
|
/**
|
|
5674
|
-
* @description
|
|
5675
|
-
* @tags
|
|
5676
|
-
* @name
|
|
5677
|
-
* @summary
|
|
5678
|
-
* @request
|
|
5792
|
+
* @description Set featured articles
|
|
5793
|
+
* @tags News
|
|
5794
|
+
* @name SetFeaturedArticles
|
|
5795
|
+
* @summary Set featured articles
|
|
5796
|
+
* @request POST:/news/featured-articles/set
|
|
5679
5797
|
* @secure
|
|
5680
5798
|
*/
|
|
5681
|
-
|
|
5682
|
-
|
|
5683
|
-
|
|
5684
|
-
|
|
5685
|
-
|
|
5686
|
-
|
|
5687
|
-
|
|
5688
|
-
/** how many records to skip */
|
|
5689
|
-
offset: number;
|
|
5690
|
-
/** search by research type */
|
|
5691
|
-
research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
|
|
5692
|
-
/** search by relation */
|
|
5693
|
-
relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
|
|
5694
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
|
|
5695
|
-
/**
|
|
5696
|
-
* @description get pre ipo company research document by id
|
|
5697
|
-
* @tags PreIPOCompanies
|
|
5698
|
-
* @name GetPreIpoCompanyResearchDocumentsById
|
|
5699
|
-
* @summary get pre ipo company research document by id
|
|
5700
|
-
* @request GET:/ipos/pre-ipo-company-research-documents/{id}
|
|
5701
|
-
* @originalName getPreIpoCompanyResearchDocuments
|
|
5702
|
-
* @duplicate
|
|
5799
|
+
setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5800
|
+
/**
|
|
5801
|
+
* @description Get featured article
|
|
5802
|
+
* @tags News
|
|
5803
|
+
* @name GetFeaturedArticle
|
|
5804
|
+
* @summary Get featured article
|
|
5805
|
+
* @request GET:/news/featured-articles/{id}
|
|
5703
5806
|
* @secure
|
|
5704
5807
|
*/
|
|
5705
|
-
|
|
5808
|
+
getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
|
|
5706
5809
|
/**
|
|
5707
|
-
* @description
|
|
5708
|
-
* @tags
|
|
5709
|
-
* @name
|
|
5710
|
-
* @summary
|
|
5711
|
-
* @request
|
|
5810
|
+
* @description Returns news by filters
|
|
5811
|
+
* @tags News
|
|
5812
|
+
* @name NewsFiltered
|
|
5813
|
+
* @summary Get filtered news
|
|
5814
|
+
* @request POST:/news/filter
|
|
5712
5815
|
* @secure
|
|
5713
5816
|
*/
|
|
5714
|
-
|
|
5715
|
-
/** search by monark stage */
|
|
5716
|
-
monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
|
|
5717
|
-
/** Optional param to filter returned spv's based on the exemptions claimed */
|
|
5718
|
-
exemptions_claimed?: string[];
|
|
5719
|
-
/** Optional param to filter returned spv's based on the name */
|
|
5720
|
-
name_filter?: string;
|
|
5721
|
-
/** investment id */
|
|
5722
|
-
pre_ipo_company_id?: string;
|
|
5723
|
-
/** investment id */
|
|
5724
|
-
pre_ipo_company_investment_id?: string;
|
|
5725
|
-
/** page number */
|
|
5726
|
-
page: number;
|
|
5727
|
-
/** page size */
|
|
5728
|
-
page_size: number;
|
|
5729
|
-
/** sort direction */
|
|
5730
|
-
sort_order?: InsightGetInvestorParamsSortOrderEnum;
|
|
5731
|
-
/** sort field */
|
|
5732
|
-
sort_by?: InsightGetInvestorParamsSortByEnum;
|
|
5733
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
|
|
5817
|
+
newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
|
|
5734
5818
|
/**
|
|
5735
|
-
* @description
|
|
5736
|
-
* @tags
|
|
5737
|
-
* @name
|
|
5738
|
-
* @summary
|
|
5739
|
-
* @request
|
|
5740
|
-
* @originalName getInvestor
|
|
5741
|
-
* @duplicate
|
|
5819
|
+
* @description Returns news by id
|
|
5820
|
+
* @tags News
|
|
5821
|
+
* @name NewsById
|
|
5822
|
+
* @summary Get news by id
|
|
5823
|
+
* @request POST:/news/id
|
|
5742
5824
|
* @secure
|
|
5743
5825
|
*/
|
|
5744
|
-
|
|
5745
|
-
/** default is false, if true documents will be included in the response */
|
|
5746
|
-
include_documents?: boolean;
|
|
5747
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
|
|
5826
|
+
newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
|
|
5748
5827
|
/**
|
|
5749
|
-
* @description
|
|
5750
|
-
* @tags
|
|
5751
|
-
* @name
|
|
5752
|
-
* @summary
|
|
5753
|
-
* @request GET:/
|
|
5828
|
+
* @description Returns news previews
|
|
5829
|
+
* @tags News
|
|
5830
|
+
* @name NewsPreviewsFiltered
|
|
5831
|
+
* @summary Get news previews
|
|
5832
|
+
* @request GET:/news/previews
|
|
5754
5833
|
* @secure
|
|
5755
5834
|
*/
|
|
5756
|
-
|
|
5757
|
-
/**
|
|
5758
|
-
|
|
5759
|
-
/**
|
|
5760
|
-
|
|
5761
|
-
/**
|
|
5762
|
-
|
|
5763
|
-
/** search by company name */
|
|
5764
|
-
company_name?: string;
|
|
5835
|
+
newsPreviewsFiltered(query: {
|
|
5836
|
+
/** Start date */
|
|
5837
|
+
start_date?: string;
|
|
5838
|
+
/** End date */
|
|
5839
|
+
end_date?: string;
|
|
5840
|
+
/** Symbol */
|
|
5841
|
+
symbol?: string;
|
|
5765
5842
|
/** how many records to return. Max value is 50 */
|
|
5766
5843
|
limit: number;
|
|
5767
5844
|
/** how many records to skip */
|
|
5768
5845
|
offset: number;
|
|
5769
|
-
|
|
5770
|
-
monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
|
|
5771
|
-
/** sort direction */
|
|
5772
|
-
direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
|
|
5773
|
-
/** sort field */
|
|
5774
|
-
field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
|
|
5775
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
|
|
5846
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
|
|
5776
5847
|
/**
|
|
5777
|
-
* @description
|
|
5778
|
-
* @tags
|
|
5779
|
-
* @name
|
|
5780
|
-
* @summary
|
|
5781
|
-
* @request GET:/
|
|
5782
|
-
* @originalName getPreIpoCompanySpvs
|
|
5783
|
-
* @duplicate
|
|
5848
|
+
* @description Returns available stocks in DB
|
|
5849
|
+
* @tags News
|
|
5850
|
+
* @name NewsAvailableStocks
|
|
5851
|
+
* @summary Get available stocks in DB (for filters)
|
|
5852
|
+
* @request GET:/news/symbols
|
|
5784
5853
|
* @secure
|
|
5785
5854
|
*/
|
|
5786
|
-
|
|
5787
|
-
/**
|
|
5788
|
-
|
|
5789
|
-
|
|
5790
|
-
|
|
5791
|
-
|
|
5792
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5793
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5855
|
+
newsAvailableStocks(query?: {
|
|
5856
|
+
/** Limit */
|
|
5857
|
+
limit?: number;
|
|
5858
|
+
/** Offset */
|
|
5859
|
+
offset?: number;
|
|
5860
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5794
5861
|
/**
|
|
5795
|
-
* @description
|
|
5796
|
-
* @tags
|
|
5797
|
-
* @name
|
|
5798
|
-
* @summary
|
|
5799
|
-
* @request POST:/
|
|
5862
|
+
* @description Returns available tags in DB
|
|
5863
|
+
* @tags News
|
|
5864
|
+
* @name NewsAvailableTags
|
|
5865
|
+
* @summary Get available tags in DB (for filters)
|
|
5866
|
+
* @request POST:/news/tags
|
|
5800
5867
|
* @secure
|
|
5801
5868
|
*/
|
|
5802
|
-
|
|
5869
|
+
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5870
|
+
}
|
|
5871
|
+
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
5872
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5873
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5803
5874
|
/**
|
|
5804
|
-
* @description
|
|
5805
|
-
* @tags
|
|
5806
|
-
* @name
|
|
5807
|
-
* @summary
|
|
5808
|
-
* @request
|
|
5875
|
+
* @description Returns calculated matrix
|
|
5876
|
+
* @tags OptionGreeks
|
|
5877
|
+
* @name OgCalculateMatrix
|
|
5878
|
+
* @summary Calculate matrix
|
|
5879
|
+
* @request POST:/og/calculate-matrix
|
|
5809
5880
|
* @secure
|
|
5810
5881
|
*/
|
|
5811
|
-
|
|
5812
|
-
/** how many records to return. Max value is 50 */
|
|
5813
|
-
limit: number;
|
|
5814
|
-
/** how many records to skip */
|
|
5815
|
-
offset: number;
|
|
5816
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5882
|
+
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
5817
5883
|
/**
|
|
5818
|
-
* @description
|
|
5819
|
-
* @tags
|
|
5820
|
-
* @name
|
|
5821
|
-
* @summary
|
|
5822
|
-
* @request
|
|
5884
|
+
* @description Returns calculated params
|
|
5885
|
+
* @tags OptionGreeks
|
|
5886
|
+
* @name OgCalculateParams
|
|
5887
|
+
* @summary Calculate params
|
|
5888
|
+
* @request POST:/og/calculate-params
|
|
5823
5889
|
* @secure
|
|
5824
5890
|
*/
|
|
5825
|
-
|
|
5826
|
-
/** load quotes */
|
|
5827
|
-
load_quotes?: boolean;
|
|
5828
|
-
/** statuses */
|
|
5829
|
-
statuses?: string[];
|
|
5830
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
|
|
5891
|
+
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
5831
5892
|
}
|
|
5832
|
-
export class
|
|
5893
|
+
export class Ownerships<HandleError extends boolean = boolean> {
|
|
5833
5894
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5834
5895
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5835
5896
|
/**
|
|
5836
|
-
* @description
|
|
5837
|
-
* @tags
|
|
5838
|
-
* @name
|
|
5839
|
-
* @summary
|
|
5840
|
-
* @request POST:/
|
|
5841
|
-
* @secure
|
|
5842
|
-
*/
|
|
5843
|
-
logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5844
|
-
/**
|
|
5845
|
-
* @description Returns converted logo for symbol
|
|
5846
|
-
* @tags Logos
|
|
5847
|
-
* @name LogosConvertedSymbolLogo
|
|
5848
|
-
* @summary Get converted logo for symbol
|
|
5849
|
-
* @request POST:/logos/converted-symbol-logo
|
|
5897
|
+
* @description get ownerships by id datadata
|
|
5898
|
+
* @tags Ownerships
|
|
5899
|
+
* @name GetOwnershipsByIdData
|
|
5900
|
+
* @summary get ownerships by id data
|
|
5901
|
+
* @request POST:/ownerships
|
|
5850
5902
|
* @secure
|
|
5851
5903
|
*/
|
|
5852
|
-
|
|
5904
|
+
getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
5853
5905
|
/**
|
|
5854
|
-
* @description
|
|
5855
|
-
* @tags
|
|
5856
|
-
* @name
|
|
5857
|
-
* @summary
|
|
5858
|
-
* @request
|
|
5906
|
+
* @description get ownerships by symbol data
|
|
5907
|
+
* @tags Ownerships
|
|
5908
|
+
* @name GetOwnershipsBySymbolData
|
|
5909
|
+
* @summary get ownerships by symbol data
|
|
5910
|
+
* @request POST:/symbol-ownerships
|
|
5859
5911
|
* @secure
|
|
5860
5912
|
*/
|
|
5861
|
-
|
|
5862
|
-
|
|
5863
|
-
|
|
5864
|
-
|
|
5913
|
+
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
5914
|
+
}
|
|
5915
|
+
export class Passport<HandleError extends boolean = boolean> {
|
|
5916
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5917
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5865
5918
|
/**
|
|
5866
|
-
* @description Returns
|
|
5867
|
-
* @tags
|
|
5868
|
-
* @name
|
|
5869
|
-
* @summary Get
|
|
5870
|
-
* @request
|
|
5919
|
+
* @description Returns article by id
|
|
5920
|
+
* @tags Passport
|
|
5921
|
+
* @name PassportArticleById
|
|
5922
|
+
* @summary Get article by id
|
|
5923
|
+
* @request POST:/passport/article-by-id
|
|
5871
5924
|
* @secure
|
|
5872
5925
|
*/
|
|
5873
|
-
|
|
5874
|
-
/** Company symbol */
|
|
5875
|
-
symbol: string;
|
|
5876
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5926
|
+
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
5877
5927
|
/**
|
|
5878
|
-
* @description Returns
|
|
5879
|
-
* @tags
|
|
5880
|
-
* @name
|
|
5881
|
-
* @summary Get
|
|
5882
|
-
* @request
|
|
5928
|
+
* @description Returns articles
|
|
5929
|
+
* @tags Passport
|
|
5930
|
+
* @name PassportArticles
|
|
5931
|
+
* @summary Get articles
|
|
5932
|
+
* @request POST:/passport/articles
|
|
5883
5933
|
* @secure
|
|
5884
5934
|
*/
|
|
5885
|
-
|
|
5886
|
-
/** Company symbol */
|
|
5887
|
-
symbol: string;
|
|
5888
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5935
|
+
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5889
5936
|
/**
|
|
5890
|
-
* @description Returns
|
|
5891
|
-
* @tags
|
|
5892
|
-
* @name
|
|
5893
|
-
* @summary Get
|
|
5894
|
-
* @request POST:/
|
|
5937
|
+
* @description Returns author profile
|
|
5938
|
+
* @tags Passport
|
|
5939
|
+
* @name PassportAuthorProfile
|
|
5940
|
+
* @summary Get author profile
|
|
5941
|
+
* @request POST:/passport/author-profile
|
|
5895
5942
|
* @secure
|
|
5896
5943
|
*/
|
|
5897
|
-
|
|
5898
|
-
/**
|
|
5899
|
-
* @description Returns
|
|
5900
|
-
* @tags
|
|
5901
|
-
* @name
|
|
5902
|
-
* @summary Get
|
|
5903
|
-
* @request POST:/
|
|
5944
|
+
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
5945
|
+
/**
|
|
5946
|
+
* @description Returns most popular tags
|
|
5947
|
+
* @tags Passport
|
|
5948
|
+
* @name PassportMostPopularTags
|
|
5949
|
+
* @summary Get most popular tags
|
|
5950
|
+
* @request POST:/passport/most-popular-tags
|
|
5904
5951
|
* @secure
|
|
5905
5952
|
*/
|
|
5906
|
-
|
|
5953
|
+
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
5907
5954
|
/**
|
|
5908
|
-
* @description Returns
|
|
5909
|
-
* @tags
|
|
5910
|
-
* @name
|
|
5911
|
-
* @summary Get
|
|
5912
|
-
* @request
|
|
5955
|
+
* @description Returns news feed
|
|
5956
|
+
* @tags Passport
|
|
5957
|
+
* @name PassportNewsFeed
|
|
5958
|
+
* @summary Get news feed
|
|
5959
|
+
* @request POST:/passport/newsfeed
|
|
5913
5960
|
* @secure
|
|
5914
5961
|
*/
|
|
5915
|
-
|
|
5916
|
-
/** Company symbol */
|
|
5917
|
-
symbol: string;
|
|
5918
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
|
|
5962
|
+
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
|
|
5919
5963
|
/**
|
|
5920
|
-
* @description Returns
|
|
5921
|
-
* @tags
|
|
5922
|
-
* @name
|
|
5923
|
-
* @summary
|
|
5924
|
-
* @request
|
|
5964
|
+
* @description Returns article by parameters
|
|
5965
|
+
* @tags Passport
|
|
5966
|
+
* @name PassportSearchArticle
|
|
5967
|
+
* @summary Search article by parameters
|
|
5968
|
+
* @request POST:/passport/search-article
|
|
5925
5969
|
* @secure
|
|
5926
5970
|
*/
|
|
5927
|
-
|
|
5928
|
-
/** Company symbol */
|
|
5929
|
-
symbol: string;
|
|
5930
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
|
|
5971
|
+
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5931
5972
|
}
|
|
5932
|
-
export class
|
|
5973
|
+
export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
5933
5974
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5934
5975
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5935
5976
|
/**
|
|
5936
|
-
* @description
|
|
5937
|
-
* @tags
|
|
5938
|
-
* @name
|
|
5939
|
-
* @summary
|
|
5940
|
-
* @request
|
|
5941
|
-
* @secure
|
|
5942
|
-
*/
|
|
5943
|
-
createOrUpdateMarketDate(market: InsightMarketDates[], config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate[], HandleError>>;
|
|
5944
|
-
/**
|
|
5945
|
-
* @description Remove market date
|
|
5946
|
-
* @tags MarketDates
|
|
5947
|
-
* @name RemoveMarketDate
|
|
5948
|
-
* @summary Remove market date
|
|
5949
|
-
* @request DELETE:/market-dates
|
|
5977
|
+
* @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
|
|
5978
|
+
* @tags PreIPOCompanies
|
|
5979
|
+
* @name MonarkOghlcDataForSymbol
|
|
5980
|
+
* @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
|
|
5981
|
+
* @request GET:/ipos/market-data/ohlc/{symbol}
|
|
5950
5982
|
* @secure
|
|
5951
5983
|
*/
|
|
5952
|
-
|
|
5984
|
+
monarkOghlcDataForSymbol(symbol: string, query?: {
|
|
5985
|
+
/** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
5986
|
+
from?: string;
|
|
5987
|
+
/** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
5988
|
+
to?: string;
|
|
5989
|
+
/** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
|
|
5990
|
+
interval?: string;
|
|
5991
|
+
/** Limit the number of OHLC data points returned. Default is 100. */
|
|
5992
|
+
limit?: number;
|
|
5993
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
|
|
5994
|
+
close?: number;
|
|
5995
|
+
high?: number;
|
|
5996
|
+
low?: number;
|
|
5997
|
+
open?: number;
|
|
5998
|
+
time?: string;
|
|
5999
|
+
volume?: number;
|
|
6000
|
+
}[], HandleError>>;
|
|
5953
6001
|
/**
|
|
5954
|
-
* @description
|
|
5955
|
-
* @tags
|
|
5956
|
-
* @name
|
|
5957
|
-
* @summary
|
|
5958
|
-
* @request
|
|
6002
|
+
* @description Retrieves all symbols available in the market data
|
|
6003
|
+
* @tags PreIPOCompanies
|
|
6004
|
+
* @name MonarkAllAvailableSymbols
|
|
6005
|
+
* @summary Retrieves all symbols available in the market data
|
|
6006
|
+
* @request GET:/ipos/market-data/symbols
|
|
5959
6007
|
* @secure
|
|
5960
6008
|
*/
|
|
5961
|
-
|
|
6009
|
+
monarkAllAvailableSymbols(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5962
6010
|
/**
|
|
5963
|
-
* @description
|
|
5964
|
-
* @tags
|
|
5965
|
-
* @name
|
|
5966
|
-
* @summary
|
|
5967
|
-
* @request GET:/
|
|
6011
|
+
* @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
|
|
6012
|
+
* @tags PreIPOCompanies
|
|
6013
|
+
* @name GetPreIpoCompanies
|
|
6014
|
+
* @summary get pre ipo companies
|
|
6015
|
+
* @request GET:/ipos/pre-ipo-companies
|
|
5968
6016
|
* @secure
|
|
5969
6017
|
*/
|
|
5970
|
-
|
|
5971
|
-
/**
|
|
5972
|
-
|
|
5973
|
-
/**
|
|
5974
|
-
|
|
5975
|
-
|
|
6018
|
+
getPreIpoCompanies(query: {
|
|
6019
|
+
/** search by company name */
|
|
6020
|
+
name?: string;
|
|
6021
|
+
/** search by categories */
|
|
6022
|
+
categories?: string;
|
|
6023
|
+
/** search by listing type */
|
|
6024
|
+
listing_type?: string;
|
|
6025
|
+
/** filter by active status */
|
|
6026
|
+
is_active?: InsightGetPreIpoCompaniesParamsIsActiveEnum;
|
|
6027
|
+
/** filter by minimum last valuation */
|
|
6028
|
+
min_last_valuation?: number;
|
|
6029
|
+
/** filter by maximum last valuation */
|
|
6030
|
+
max_last_valuation?: number;
|
|
6031
|
+
/** filter by minimum total funding */
|
|
6032
|
+
min_total_funding?: number;
|
|
6033
|
+
/** filter by maximum total funding */
|
|
6034
|
+
max_total_funding?: number;
|
|
6035
|
+
/** how many records to return. Max value is 50 */
|
|
6036
|
+
limit: number;
|
|
6037
|
+
/** how many records to skip */
|
|
6038
|
+
offset: number;
|
|
6039
|
+
/** sort field */
|
|
6040
|
+
order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
|
|
6041
|
+
/** sort direction */
|
|
6042
|
+
order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
|
|
6043
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
|
|
5976
6044
|
/**
|
|
5977
|
-
* @description
|
|
5978
|
-
* @tags
|
|
5979
|
-
* @name
|
|
5980
|
-
* @summary
|
|
5981
|
-
* @request GET:/
|
|
6045
|
+
* @description get pre ipo company by id
|
|
6046
|
+
* @tags PreIPOCompanies
|
|
6047
|
+
* @name GetPreIpoCompaniesById
|
|
6048
|
+
* @summary get pre ipo company by id
|
|
6049
|
+
* @request GET:/ipos/pre-ipo-companies/{id}
|
|
6050
|
+
* @originalName getPreIpoCompanies
|
|
6051
|
+
* @duplicate
|
|
5982
6052
|
* @secure
|
|
5983
6053
|
*/
|
|
5984
|
-
|
|
6054
|
+
getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
|
|
5985
6055
|
/**
|
|
5986
|
-
* @description
|
|
5987
|
-
* @tags
|
|
5988
|
-
* @name
|
|
5989
|
-
* @summary
|
|
5990
|
-
* @request
|
|
6056
|
+
* @description get pre ipo company funding rounds
|
|
6057
|
+
* @tags PreIPOCompanies
|
|
6058
|
+
* @name GetPreIpoCompanyFundingRounds
|
|
6059
|
+
* @summary get pre ipo company funding rounds
|
|
6060
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds
|
|
5991
6061
|
* @secure
|
|
5992
6062
|
*/
|
|
5993
|
-
|
|
6063
|
+
getPreIpoCompanyFundingRounds(query: {
|
|
6064
|
+
/** company id */
|
|
6065
|
+
pre_ipo_company_id?: string;
|
|
6066
|
+
/** search by round name */
|
|
6067
|
+
round_name?: string;
|
|
6068
|
+
/** how many records to return. Max value is 50 */
|
|
6069
|
+
limit: number;
|
|
6070
|
+
/** how many records to skip */
|
|
6071
|
+
offset: number;
|
|
6072
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
|
|
5994
6073
|
/**
|
|
5995
|
-
* @description
|
|
5996
|
-
* @tags
|
|
5997
|
-
* @name
|
|
5998
|
-
* @summary
|
|
5999
|
-
* @request GET:/
|
|
6074
|
+
* @description get pre ipo company funding round by id
|
|
6075
|
+
* @tags PreIPOCompanies
|
|
6076
|
+
* @name GetPreIpoCompanyFundingRoundsById
|
|
6077
|
+
* @summary get pre ipo company funding round by id
|
|
6078
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds/{id}
|
|
6079
|
+
* @originalName getPreIpoCompanyFundingRounds
|
|
6080
|
+
* @duplicate
|
|
6000
6081
|
* @secure
|
|
6001
6082
|
*/
|
|
6002
|
-
|
|
6083
|
+
getPreIpoCompanyFundingRoundsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyFundingRound, HandleError>>;
|
|
6003
6084
|
/**
|
|
6004
|
-
* @description
|
|
6005
|
-
* @tags
|
|
6006
|
-
* @name
|
|
6007
|
-
* @summary
|
|
6008
|
-
* @request
|
|
6085
|
+
* @description get pre ipo company investments
|
|
6086
|
+
* @tags PreIPOCompanies
|
|
6087
|
+
* @name GetPreIpoCompanyInvestments
|
|
6088
|
+
* @summary get pre ipo company investments
|
|
6089
|
+
* @request GET:/ipos/pre-ipo-company-investments
|
|
6009
6090
|
* @secure
|
|
6010
6091
|
*/
|
|
6011
|
-
|
|
6092
|
+
getPreIpoCompanyInvestments(query: {
|
|
6093
|
+
/** company id */
|
|
6094
|
+
pre_ipo_company_id?: string;
|
|
6095
|
+
/** company name */
|
|
6096
|
+
company_name?: string;
|
|
6097
|
+
/** how many records to return. Max value is 50 */
|
|
6098
|
+
limit: number;
|
|
6099
|
+
/** how many records to skip */
|
|
6100
|
+
offset: number;
|
|
6101
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
|
|
6012
6102
|
/**
|
|
6013
|
-
* @description
|
|
6014
|
-
* @tags
|
|
6015
|
-
* @name
|
|
6016
|
-
* @summary
|
|
6017
|
-
* @request
|
|
6103
|
+
* @description get pre ipo company investment by id
|
|
6104
|
+
* @tags PreIPOCompanies
|
|
6105
|
+
* @name GetPreIpoCompanyInvestmentsById
|
|
6106
|
+
* @summary get pre ipo company investment by id
|
|
6107
|
+
* @request GET:/ipos/pre-ipo-company-investments/{id}
|
|
6108
|
+
* @originalName getPreIpoCompanyInvestments
|
|
6109
|
+
* @duplicate
|
|
6018
6110
|
* @secure
|
|
6019
6111
|
*/
|
|
6020
|
-
|
|
6112
|
+
getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
|
|
6021
6113
|
/**
|
|
6022
|
-
* @description
|
|
6023
|
-
* @tags
|
|
6024
|
-
* @name
|
|
6025
|
-
* @summary
|
|
6026
|
-
* @request GET:/
|
|
6114
|
+
* @description get pre ipo company news
|
|
6115
|
+
* @tags PreIPOCompanies
|
|
6116
|
+
* @name GetPreIpoCompanyNews
|
|
6117
|
+
* @summary get pre ipo company news
|
|
6118
|
+
* @request GET:/ipos/pre-ipo-company-news
|
|
6027
6119
|
* @secure
|
|
6028
6120
|
*/
|
|
6029
|
-
|
|
6121
|
+
getPreIpoCompanyNews(query: {
|
|
6122
|
+
/** company id */
|
|
6123
|
+
pre_ipo_company_id?: string;
|
|
6124
|
+
/** search by headline */
|
|
6125
|
+
headline?: string;
|
|
6126
|
+
/** how many records to return. Max value is 50 */
|
|
6127
|
+
limit: number;
|
|
6128
|
+
/** how many records to skip */
|
|
6129
|
+
offset: number;
|
|
6130
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
|
|
6030
6131
|
/**
|
|
6031
|
-
* @description
|
|
6032
|
-
* @tags
|
|
6033
|
-
* @name
|
|
6034
|
-
* @summary
|
|
6035
|
-
* @request
|
|
6132
|
+
* @description get pre ipo company news by id
|
|
6133
|
+
* @tags PreIPOCompanies
|
|
6134
|
+
* @name GetPreIpoCompanyNewsById
|
|
6135
|
+
* @summary get pre ipo company news by id
|
|
6136
|
+
* @request GET:/ipos/pre-ipo-company-news/{id}
|
|
6137
|
+
* @originalName getPreIpoCompanyNews
|
|
6138
|
+
* @duplicate
|
|
6036
6139
|
* @secure
|
|
6037
|
-
*/
|
|
6038
|
-
|
|
6039
|
-
/**
|
|
6040
|
-
* @description
|
|
6041
|
-
* @tags
|
|
6042
|
-
* @name
|
|
6043
|
-
* @summary
|
|
6044
|
-
* @request GET:/
|
|
6140
|
+
*/
|
|
6141
|
+
getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
|
|
6142
|
+
/**
|
|
6143
|
+
* @description get pre ipo company research documents
|
|
6144
|
+
* @tags PreIPOCompanies
|
|
6145
|
+
* @name GetPreIpoCompanyResearchDocuments
|
|
6146
|
+
* @summary get pre ipo company research documents
|
|
6147
|
+
* @request GET:/ipos/pre-ipo-company-research-documents
|
|
6045
6148
|
* @secure
|
|
6046
6149
|
*/
|
|
6047
|
-
|
|
6048
|
-
/**
|
|
6049
|
-
|
|
6050
|
-
|
|
6150
|
+
getPreIpoCompanyResearchDocuments(query: {
|
|
6151
|
+
/** company id */
|
|
6152
|
+
pre_ipo_company_id?: string;
|
|
6153
|
+
/** search by title */
|
|
6154
|
+
title?: string;
|
|
6155
|
+
/** how many records to return. Max value is 50 */
|
|
6156
|
+
limit: number;
|
|
6157
|
+
/** how many records to skip */
|
|
6158
|
+
offset: number;
|
|
6159
|
+
/** search by research type */
|
|
6160
|
+
research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
|
|
6161
|
+
/** search by relation */
|
|
6162
|
+
relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
|
|
6163
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
|
|
6051
6164
|
/**
|
|
6052
|
-
* @description
|
|
6053
|
-
* @tags
|
|
6054
|
-
* @name
|
|
6055
|
-
* @summary
|
|
6056
|
-
* @request GET:/
|
|
6165
|
+
* @description get pre ipo company research document by id
|
|
6166
|
+
* @tags PreIPOCompanies
|
|
6167
|
+
* @name GetPreIpoCompanyResearchDocumentsById
|
|
6168
|
+
* @summary get pre ipo company research document by id
|
|
6169
|
+
* @request GET:/ipos/pre-ipo-company-research-documents/{id}
|
|
6170
|
+
* @originalName getPreIpoCompanyResearchDocuments
|
|
6171
|
+
* @duplicate
|
|
6057
6172
|
* @secure
|
|
6058
6173
|
*/
|
|
6059
|
-
|
|
6060
|
-
/** Market */
|
|
6061
|
-
market: string;
|
|
6062
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
6063
|
-
}
|
|
6064
|
-
export class News<HandleError extends boolean = boolean> {
|
|
6065
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6066
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6174
|
+
getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
|
|
6067
6175
|
/**
|
|
6068
|
-
* @description
|
|
6069
|
-
* @tags
|
|
6070
|
-
* @name
|
|
6071
|
-
* @summary
|
|
6072
|
-
* @request
|
|
6176
|
+
* @description get pre ipo company spvs with investor id
|
|
6177
|
+
* @tags PreIPOCompanies
|
|
6178
|
+
* @name GetInvestor
|
|
6179
|
+
* @summary get pre ipo company spvs with investor id
|
|
6180
|
+
* @request GET:/ipos/pre-ipo-company-spv/investor/{investor_id}
|
|
6073
6181
|
* @secure
|
|
6074
6182
|
*/
|
|
6075
|
-
|
|
6183
|
+
getInvestor(investorId: string, query: {
|
|
6184
|
+
/** search by monark stage */
|
|
6185
|
+
monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
|
|
6186
|
+
/** Optional param to filter returned spv's based on the exemptions claimed */
|
|
6187
|
+
exemptions_claimed?: string[];
|
|
6188
|
+
/** Optional param to filter returned spv's based on the name */
|
|
6189
|
+
name_filter?: string;
|
|
6190
|
+
/** investment id */
|
|
6191
|
+
pre_ipo_company_id?: string;
|
|
6192
|
+
/** investment id */
|
|
6193
|
+
pre_ipo_company_investment_id?: string;
|
|
6194
|
+
/** page number */
|
|
6195
|
+
page: number;
|
|
6196
|
+
/** page size */
|
|
6197
|
+
page_size: number;
|
|
6198
|
+
/** sort direction */
|
|
6199
|
+
sort_order?: InsightGetInvestorParamsSortOrderEnum;
|
|
6200
|
+
/** sort field */
|
|
6201
|
+
sort_by?: InsightGetInvestorParamsSortByEnum;
|
|
6202
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
|
|
6076
6203
|
/**
|
|
6077
|
-
* @description
|
|
6078
|
-
* @tags
|
|
6079
|
-
* @name
|
|
6080
|
-
* @summary
|
|
6081
|
-
* @request
|
|
6204
|
+
* @description get pre ipo company spv by id with investor id
|
|
6205
|
+
* @tags PreIPOCompanies
|
|
6206
|
+
* @name GetInvestorByIdAndInvestorId
|
|
6207
|
+
* @summary get pre ipo company spv by id with investor id
|
|
6208
|
+
* @request GET:/ipos/pre-ipo-company-spv/{id}/investor/{investor_id}
|
|
6209
|
+
* @originalName getInvestor
|
|
6210
|
+
* @duplicate
|
|
6082
6211
|
* @secure
|
|
6083
6212
|
*/
|
|
6084
|
-
|
|
6213
|
+
getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
|
|
6214
|
+
/** default is false, if true documents will be included in the response */
|
|
6215
|
+
include_documents?: boolean;
|
|
6216
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
|
|
6085
6217
|
/**
|
|
6086
|
-
* @description
|
|
6087
|
-
* @tags
|
|
6088
|
-
* @name
|
|
6089
|
-
* @summary
|
|
6090
|
-
* @request GET:/
|
|
6218
|
+
* @description get pre ipo company spvs
|
|
6219
|
+
* @tags PreIPOCompanies
|
|
6220
|
+
* @name GetPreIpoCompanySpvs
|
|
6221
|
+
* @summary get pre ipo company spvs
|
|
6222
|
+
* @request GET:/ipos/pre-ipo-company-spvs
|
|
6091
6223
|
* @secure
|
|
6092
6224
|
*/
|
|
6093
|
-
|
|
6094
|
-
/**
|
|
6225
|
+
getPreIpoCompanySpvs(query: {
|
|
6226
|
+
/** company id */
|
|
6227
|
+
pre_ipo_company_id?: string;
|
|
6228
|
+
/** investment id */
|
|
6229
|
+
investment_id?: string;
|
|
6230
|
+
/** search by name */
|
|
6231
|
+
name?: string;
|
|
6232
|
+
/** search by company name */
|
|
6233
|
+
company_name?: string;
|
|
6234
|
+
/** how many records to return. Max value is 50 */
|
|
6095
6235
|
limit: number;
|
|
6096
|
-
/**
|
|
6236
|
+
/** how many records to skip */
|
|
6097
6237
|
offset: number;
|
|
6098
|
-
/**
|
|
6099
|
-
|
|
6100
|
-
/**
|
|
6101
|
-
|
|
6102
|
-
|
|
6238
|
+
/** search by monark stage */
|
|
6239
|
+
monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
|
|
6240
|
+
/** sort direction */
|
|
6241
|
+
direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
|
|
6242
|
+
/** sort field */
|
|
6243
|
+
field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
|
|
6244
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
|
|
6103
6245
|
/**
|
|
6104
|
-
* @description
|
|
6105
|
-
* @tags
|
|
6106
|
-
* @name
|
|
6107
|
-
* @summary
|
|
6108
|
-
* @request
|
|
6246
|
+
* @description get pre ipo company spv by id
|
|
6247
|
+
* @tags PreIPOCompanies
|
|
6248
|
+
* @name GetPreIpoCompanySpvsById
|
|
6249
|
+
* @summary get pre ipo company spv by id
|
|
6250
|
+
* @request GET:/ipos/pre-ipo-company-spvs/{id}
|
|
6251
|
+
* @originalName getPreIpoCompanySpvs
|
|
6252
|
+
* @duplicate
|
|
6109
6253
|
* @secure
|
|
6110
6254
|
*/
|
|
6111
|
-
|
|
6255
|
+
getPreIpoCompanySpvsById(id: string, query?: {
|
|
6256
|
+
/** default is false, if true documents will be included in the response */
|
|
6257
|
+
include_documents?: boolean;
|
|
6258
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
|
|
6259
|
+
}
|
|
6260
|
+
export class Public<HandleError extends boolean = boolean> {
|
|
6261
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6262
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6112
6263
|
/**
|
|
6113
|
-
* @description
|
|
6114
|
-
* @tags
|
|
6115
|
-
* @name
|
|
6116
|
-
* @summary
|
|
6117
|
-
* @request
|
|
6264
|
+
* @description Calculate estimated returns for selected symbols. Uses split adjusted prices
|
|
6265
|
+
* @tags Public
|
|
6266
|
+
* @name CalculateEstimatedReturns
|
|
6267
|
+
* @summary Calculate Estimated Returns
|
|
6268
|
+
* @request GET:/public/estimated-returns
|
|
6118
6269
|
* @secure
|
|
6119
6270
|
*/
|
|
6120
|
-
|
|
6271
|
+
calculateEstimatedReturns(query: {
|
|
6272
|
+
/** Single symbol */
|
|
6273
|
+
symbol: string;
|
|
6274
|
+
/**
|
|
6275
|
+
* Non-zero amount
|
|
6276
|
+
* @format float64
|
|
6277
|
+
*/
|
|
6278
|
+
amount: number;
|
|
6279
|
+
/** Start date for calculations */
|
|
6280
|
+
start_date: string;
|
|
6281
|
+
/** End date for calculations */
|
|
6282
|
+
end_date: string;
|
|
6283
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
6121
6284
|
/**
|
|
6122
|
-
* @description
|
|
6123
|
-
* @tags
|
|
6124
|
-
* @name
|
|
6125
|
-
* @summary
|
|
6126
|
-
* @request GET:/
|
|
6285
|
+
* @description Returns an expert forecast
|
|
6286
|
+
* @tags Public
|
|
6287
|
+
* @name ExpertForecast
|
|
6288
|
+
* @summary Expert forecast
|
|
6289
|
+
* @request GET:/public/expert-forecast
|
|
6127
6290
|
* @secure
|
|
6128
6291
|
*/
|
|
6129
|
-
|
|
6292
|
+
expertForecast(query: {
|
|
6293
|
+
/** Comma separated symbols */
|
|
6294
|
+
symbols: string;
|
|
6295
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
6130
6296
|
/**
|
|
6131
|
-
* @description
|
|
6132
|
-
* @tags
|
|
6133
|
-
* @name
|
|
6134
|
-
* @summary
|
|
6135
|
-
* @request
|
|
6297
|
+
* @description get fundamentals by symbol data
|
|
6298
|
+
* @tags Public
|
|
6299
|
+
* @name GetPublicFundamentalsBySymbolData
|
|
6300
|
+
* @summary get fundamentals by symbol data
|
|
6301
|
+
* @request GET:/public/fundamentals/{symbol}
|
|
6136
6302
|
* @secure
|
|
6137
6303
|
*/
|
|
6138
|
-
|
|
6304
|
+
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
6305
|
+
/** Annual or quarterly */
|
|
6306
|
+
mode: string;
|
|
6307
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
6139
6308
|
/**
|
|
6140
|
-
* @description
|
|
6141
|
-
* @tags
|
|
6142
|
-
* @name
|
|
6143
|
-
* @summary
|
|
6144
|
-
* @request GET:/
|
|
6309
|
+
* @description Daily price history
|
|
6310
|
+
* @tags Public
|
|
6311
|
+
* @name DailyPriceHistory
|
|
6312
|
+
* @summary Daily price history
|
|
6313
|
+
* @request GET:/public/price-history/daily
|
|
6145
6314
|
* @secure
|
|
6146
6315
|
*/
|
|
6147
|
-
|
|
6316
|
+
dailyPriceHistory(query: {
|
|
6317
|
+
/** Single symbol */
|
|
6318
|
+
symbol: string;
|
|
6319
|
+
/** Target date */
|
|
6320
|
+
date: string;
|
|
6321
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
6148
6322
|
/**
|
|
6149
|
-
* @description
|
|
6150
|
-
* @tags
|
|
6151
|
-
* @name
|
|
6152
|
-
* @summary
|
|
6153
|
-
* @request
|
|
6323
|
+
* @description Public quote profile
|
|
6324
|
+
* @tags Public
|
|
6325
|
+
* @name PublicQuoteProfile
|
|
6326
|
+
* @summary Public quote profile
|
|
6327
|
+
* @request GET:/public/quote-profile/{symbol}
|
|
6154
6328
|
* @secure
|
|
6155
6329
|
*/
|
|
6156
|
-
|
|
6330
|
+
publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
|
|
6157
6331
|
/**
|
|
6158
|
-
* @description
|
|
6159
|
-
* @tags
|
|
6160
|
-
* @name
|
|
6161
|
-
* @summary
|
|
6162
|
-
* @request
|
|
6332
|
+
* @description get ratios by symbol data
|
|
6333
|
+
* @tags Public
|
|
6334
|
+
* @name GetPublicRatiosBySymbolData
|
|
6335
|
+
* @summary get ratios by symbol data
|
|
6336
|
+
* @request GET:/public/ratios/{symbol}
|
|
6163
6337
|
* @secure
|
|
6164
6338
|
*/
|
|
6165
|
-
|
|
6339
|
+
getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
|
|
6166
6340
|
/**
|
|
6167
|
-
* @description
|
|
6168
|
-
* @tags
|
|
6169
|
-
* @name
|
|
6170
|
-
* @summary
|
|
6171
|
-
* @request GET:/
|
|
6341
|
+
* @description find a symbol by name or description
|
|
6342
|
+
* @tags Public
|
|
6343
|
+
* @name QuoteFundamentalsSearch
|
|
6344
|
+
* @summary find a symbol by name or description
|
|
6345
|
+
* @request GET:/public/symbol-search
|
|
6172
6346
|
* @secure
|
|
6173
6347
|
*/
|
|
6174
|
-
|
|
6175
|
-
/**
|
|
6176
|
-
|
|
6177
|
-
/** End date */
|
|
6178
|
-
end_date?: string;
|
|
6179
|
-
/** Symbol */
|
|
6180
|
-
symbol?: string;
|
|
6348
|
+
quoteFundamentalsSearch(query: {
|
|
6349
|
+
/** Search query */
|
|
6350
|
+
search_query: string;
|
|
6181
6351
|
/** how many records to return. Max value is 50 */
|
|
6182
6352
|
limit: number;
|
|
6183
6353
|
/** how many records to skip */
|
|
6184
6354
|
offset: number;
|
|
6185
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
6355
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
6186
6356
|
/**
|
|
6187
|
-
* @description
|
|
6188
|
-
* @tags
|
|
6189
|
-
* @name
|
|
6190
|
-
* @summary
|
|
6191
|
-
* @request GET:/
|
|
6357
|
+
* @description Get top gainers
|
|
6358
|
+
* @tags Public
|
|
6359
|
+
* @name TopGainers
|
|
6360
|
+
* @summary Top Gainers
|
|
6361
|
+
* @request GET:/public/top-gainers
|
|
6192
6362
|
* @secure
|
|
6193
6363
|
*/
|
|
6194
|
-
|
|
6195
|
-
/**
|
|
6196
|
-
|
|
6197
|
-
/**
|
|
6198
|
-
|
|
6199
|
-
|
|
6364
|
+
topGainers(query: {
|
|
6365
|
+
/** sort direction - asc or desc */
|
|
6366
|
+
order_direction?: string;
|
|
6367
|
+
/** how many records to return. Max value is 50 */
|
|
6368
|
+
limit: number;
|
|
6369
|
+
/** how many records to skip */
|
|
6370
|
+
offset: number;
|
|
6371
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6200
6372
|
/**
|
|
6201
|
-
* @description
|
|
6202
|
-
* @tags
|
|
6203
|
-
* @name
|
|
6204
|
-
* @summary
|
|
6205
|
-
* @request
|
|
6373
|
+
* @description Get top stocks
|
|
6374
|
+
* @tags Public
|
|
6375
|
+
* @name TopStocks
|
|
6376
|
+
* @summary Top Stocks
|
|
6377
|
+
* @request GET:/public/top-stocks
|
|
6206
6378
|
* @secure
|
|
6207
6379
|
*/
|
|
6208
|
-
|
|
6380
|
+
topStocks(query: {
|
|
6381
|
+
/** EQUITY|ETF|CRYPTO */
|
|
6382
|
+
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
6383
|
+
/** how many records to return. Max value is 50 */
|
|
6384
|
+
limit: number;
|
|
6385
|
+
/** how many records to skip */
|
|
6386
|
+
offset: number;
|
|
6387
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6209
6388
|
}
|
|
6210
|
-
export class
|
|
6389
|
+
export class Quotes<HandleError extends boolean = boolean> {
|
|
6211
6390
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6212
6391
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6213
6392
|
/**
|
|
6214
|
-
* @description
|
|
6215
|
-
* @tags
|
|
6216
|
-
* @name
|
|
6217
|
-
* @summary Get
|
|
6218
|
-
* @request
|
|
6393
|
+
* @description Get single historical quote
|
|
6394
|
+
* @tags Quotes
|
|
6395
|
+
* @name GitHistoricalQuote
|
|
6396
|
+
* @summary Get single historical quote
|
|
6397
|
+
* @request GET:/historical/quote
|
|
6219
6398
|
* @secure
|
|
6220
6399
|
*/
|
|
6221
|
-
|
|
6400
|
+
gitHistoricalQuote(query: {
|
|
6401
|
+
/** Symbol */
|
|
6402
|
+
symbol: string;
|
|
6403
|
+
/** Date */
|
|
6404
|
+
date: string;
|
|
6405
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
6222
6406
|
/**
|
|
6223
|
-
* @description
|
|
6224
|
-
* @tags
|
|
6225
|
-
* @name
|
|
6226
|
-
* @summary Get
|
|
6227
|
-
* @request POST:/
|
|
6407
|
+
* @description get quote history by symbol
|
|
6408
|
+
* @tags Quotes
|
|
6409
|
+
* @name GitQuoteHistory
|
|
6410
|
+
* @summary Get quote history
|
|
6411
|
+
* @request POST:/quote-history
|
|
6228
6412
|
* @secure
|
|
6229
6413
|
*/
|
|
6230
|
-
|
|
6414
|
+
gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
|
|
6231
6415
|
/**
|
|
6232
|
-
* @description Returns
|
|
6233
|
-
* @tags
|
|
6234
|
-
* @name
|
|
6235
|
-
* @summary Get
|
|
6236
|
-
* @request
|
|
6416
|
+
* @description Returns a list of quotes equity info for specified symbols.
|
|
6417
|
+
* @tags Quotes
|
|
6418
|
+
* @name GetQuotesEquityData
|
|
6419
|
+
* @summary Get Quotes Equity data
|
|
6420
|
+
* @request GET:/quotes/equity
|
|
6237
6421
|
* @secure
|
|
6238
6422
|
*/
|
|
6239
|
-
|
|
6423
|
+
getQuotesEquityData(query: {
|
|
6424
|
+
/** Comma separated symbols */
|
|
6425
|
+
symbols: string;
|
|
6426
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
6427
|
+
}
|
|
6428
|
+
export class StockScreener<HandleError extends boolean = boolean> {
|
|
6429
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6430
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6240
6431
|
/**
|
|
6241
|
-
* @description
|
|
6242
|
-
* @tags
|
|
6243
|
-
* @name
|
|
6244
|
-
* @summary
|
|
6245
|
-
* @request
|
|
6432
|
+
* @description data for visual heat map
|
|
6433
|
+
* @tags StockScreener
|
|
6434
|
+
* @name StockMarketHeatmap
|
|
6435
|
+
* @summary data for visual heat map
|
|
6436
|
+
* @request GET:/heatmaps
|
|
6246
6437
|
* @secure
|
|
6247
6438
|
*/
|
|
6248
|
-
|
|
6439
|
+
stockMarketHeatmap(query?: {
|
|
6440
|
+
/** Name of symbol list to fetch details for. Empty is default */
|
|
6441
|
+
heatmap_name?: string;
|
|
6442
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
6249
6443
|
/**
|
|
6250
|
-
* @description
|
|
6251
|
-
* @tags
|
|
6252
|
-
* @name
|
|
6253
|
-
* @summary
|
|
6254
|
-
* @request POST:/
|
|
6444
|
+
* @description create or update heat map preset
|
|
6445
|
+
* @tags StockScreener
|
|
6446
|
+
* @name CreateStockMarketHeatmapPreset
|
|
6447
|
+
* @summary create or update heat map preset
|
|
6448
|
+
* @request POST:/heatmaps
|
|
6255
6449
|
* @secure
|
|
6256
6450
|
*/
|
|
6257
|
-
|
|
6451
|
+
createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6258
6452
|
/**
|
|
6259
|
-
* @description
|
|
6260
|
-
* @tags
|
|
6261
|
-
* @name
|
|
6262
|
-
* @summary
|
|
6263
|
-
* @request POST:/
|
|
6453
|
+
* @description Sector and Industry Group performance
|
|
6454
|
+
* @tags StockScreener
|
|
6455
|
+
* @name IndustriesPerformance
|
|
6456
|
+
* @summary get industries performance
|
|
6457
|
+
* @request POST:/industries-performance
|
|
6264
6458
|
* @secure
|
|
6265
6459
|
*/
|
|
6266
|
-
|
|
6267
|
-
}
|
|
6268
|
-
export class Ownerships<HandleError extends boolean = boolean> {
|
|
6269
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6270
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6460
|
+
industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
|
|
6271
6461
|
/**
|
|
6272
|
-
* @description
|
|
6273
|
-
* @tags
|
|
6274
|
-
* @name
|
|
6275
|
-
* @summary
|
|
6276
|
-
* @request POST:/
|
|
6462
|
+
* @description filter stocks by params
|
|
6463
|
+
* @tags StockScreener
|
|
6464
|
+
* @name StockScreener
|
|
6465
|
+
* @summary filter stocks by params
|
|
6466
|
+
* @request POST:/stock-screener
|
|
6277
6467
|
* @secure
|
|
6278
6468
|
*/
|
|
6279
|
-
|
|
6469
|
+
stockScreener(filter: InsightStockScreenerV1Request, headers?: {
|
|
6470
|
+
/** Authorization */
|
|
6471
|
+
Authorization?: string;
|
|
6472
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
6280
6473
|
/**
|
|
6281
|
-
* @description get
|
|
6282
|
-
* @tags
|
|
6283
|
-
* @name
|
|
6284
|
-
* @summary get
|
|
6285
|
-
* @request
|
|
6474
|
+
* @description get screener presets
|
|
6475
|
+
* @tags StockScreener
|
|
6476
|
+
* @name GetScreenerPresets
|
|
6477
|
+
* @summary get screener presets
|
|
6478
|
+
* @request GET:/stock-screener/presets
|
|
6286
6479
|
* @secure
|
|
6287
6480
|
*/
|
|
6288
|
-
|
|
6289
|
-
|
|
6290
|
-
|
|
6291
|
-
|
|
6292
|
-
|
|
6481
|
+
getScreenerPresets(query: {
|
|
6482
|
+
/** how many records to return */
|
|
6483
|
+
limit: number;
|
|
6484
|
+
/** how many records to skip */
|
|
6485
|
+
offset: number;
|
|
6486
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
6293
6487
|
/**
|
|
6294
|
-
* @description
|
|
6295
|
-
* @tags
|
|
6296
|
-
* @name
|
|
6297
|
-
* @summary
|
|
6298
|
-
* @request
|
|
6488
|
+
* @description update screener preset
|
|
6489
|
+
* @tags StockScreener
|
|
6490
|
+
* @name UpdateScreenerPreset
|
|
6491
|
+
* @summary update screener preset
|
|
6492
|
+
* @request PUT:/stock-screener/presets
|
|
6299
6493
|
* @secure
|
|
6300
6494
|
*/
|
|
6301
|
-
|
|
6495
|
+
updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
6302
6496
|
/**
|
|
6303
|
-
* @description
|
|
6304
|
-
* @tags
|
|
6305
|
-
* @name
|
|
6306
|
-
* @summary
|
|
6307
|
-
* @request POST:/
|
|
6497
|
+
* @description create screener preset
|
|
6498
|
+
* @tags StockScreener
|
|
6499
|
+
* @name CreateOrScreenerPreset
|
|
6500
|
+
* @summary create screener preset
|
|
6501
|
+
* @request POST:/stock-screener/presets
|
|
6308
6502
|
* @secure
|
|
6309
6503
|
*/
|
|
6310
|
-
|
|
6311
|
-
}
|
|
6312
|
-
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
6313
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6314
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6504
|
+
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
6315
6505
|
/**
|
|
6316
|
-
* @description
|
|
6317
|
-
* @tags
|
|
6318
|
-
* @name
|
|
6319
|
-
* @summary
|
|
6320
|
-
* @request
|
|
6506
|
+
* @description remove screener preset
|
|
6507
|
+
* @tags StockScreener
|
|
6508
|
+
* @name RemoveScreenerPreset
|
|
6509
|
+
* @summary remove screener preset
|
|
6510
|
+
* @request DELETE:/stock-screener/presets
|
|
6321
6511
|
* @secure
|
|
6322
6512
|
*/
|
|
6323
|
-
|
|
6513
|
+
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6324
6514
|
/**
|
|
6325
|
-
* @description get
|
|
6326
|
-
* @tags
|
|
6327
|
-
* @name
|
|
6328
|
-
* @summary get
|
|
6329
|
-
* @request POST:/
|
|
6515
|
+
* @description get top symbols
|
|
6516
|
+
* @tags StockScreener
|
|
6517
|
+
* @name GetTopSymbols
|
|
6518
|
+
* @summary get top symbols
|
|
6519
|
+
* @request POST:/stock-screener/top
|
|
6330
6520
|
* @secure
|
|
6331
6521
|
*/
|
|
6332
|
-
|
|
6522
|
+
getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
6333
6523
|
}
|
|
6334
|
-
export class
|
|
6524
|
+
export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
6335
6525
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6336
6526
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6337
6527
|
/**
|
|
6338
|
-
* @description
|
|
6339
|
-
* @tags
|
|
6340
|
-
* @name
|
|
6341
|
-
* @summary
|
|
6342
|
-
* @request POST:/
|
|
6528
|
+
* @description filter stocks by params
|
|
6529
|
+
* @tags StockScreener
|
|
6530
|
+
* @name StockScreener
|
|
6531
|
+
* @summary filter stocks by params
|
|
6532
|
+
* @request POST:/stock-screener
|
|
6533
|
+
* @secure
|
|
6534
|
+
*/
|
|
6535
|
+
stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
6536
|
+
/**
|
|
6537
|
+
* @description get top symbols
|
|
6538
|
+
* @tags StockScreener
|
|
6539
|
+
* @name GetTopSymbols
|
|
6540
|
+
* @summary get top symbols
|
|
6541
|
+
* @request POST:/stock-screener/top
|
|
6343
6542
|
* @secure
|
|
6344
6543
|
*/
|
|
6345
|
-
|
|
6544
|
+
getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
6346
6545
|
}
|
|
6347
6546
|
export class TipRank<HandleError extends boolean = boolean> {
|
|
6348
6547
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -6710,398 +6909,200 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6710
6909
|
Authorization?: string;
|
|
6711
6910
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
|
|
6712
6911
|
}
|
|
6713
|
-
export class
|
|
6912
|
+
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
6714
6913
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6715
6914
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6716
6915
|
/**
|
|
6717
|
-
* @description
|
|
6718
|
-
* @tags
|
|
6719
|
-
* @name
|
|
6720
|
-
* @summary
|
|
6721
|
-
* @request
|
|
6722
|
-
* @secure
|
|
6723
|
-
*/
|
|
6724
|
-
calculateEstimatedReturns(query: {
|
|
6725
|
-
/** Single symbol */
|
|
6726
|
-
symbol: string;
|
|
6727
|
-
/**
|
|
6728
|
-
* Non-zero amount
|
|
6729
|
-
* @format float64
|
|
6730
|
-
*/
|
|
6731
|
-
amount: number;
|
|
6732
|
-
/** Start date for calculations */
|
|
6733
|
-
start_date: string;
|
|
6734
|
-
/** End date for calculations */
|
|
6735
|
-
end_date: string;
|
|
6736
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
6737
|
-
/**
|
|
6738
|
-
* @description Returns an expert forecast
|
|
6739
|
-
* @tags Public
|
|
6740
|
-
* @name ExpertForecast
|
|
6741
|
-
* @summary Expert forecast
|
|
6742
|
-
* @request GET:/public/expert-forecast
|
|
6743
|
-
* @secure
|
|
6744
|
-
*/
|
|
6745
|
-
expertForecast(query: {
|
|
6746
|
-
/** Comma separated symbols */
|
|
6747
|
-
symbols: string;
|
|
6748
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
6749
|
-
/**
|
|
6750
|
-
* @description get fundamentals by symbol data
|
|
6751
|
-
* @tags Public
|
|
6752
|
-
* @name GetPublicFundamentalsBySymbolData
|
|
6753
|
-
* @summary get fundamentals by symbol data
|
|
6754
|
-
* @request GET:/public/fundamentals/{symbol}
|
|
6755
|
-
* @secure
|
|
6756
|
-
*/
|
|
6757
|
-
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
6758
|
-
/** Annual or quarterly */
|
|
6759
|
-
mode: string;
|
|
6760
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
6761
|
-
/**
|
|
6762
|
-
* @description Daily price history
|
|
6763
|
-
* @tags Public
|
|
6764
|
-
* @name DailyPriceHistory
|
|
6765
|
-
* @summary Daily price history
|
|
6766
|
-
* @request GET:/public/price-history/daily
|
|
6916
|
+
* @description get usage date per branch for a period
|
|
6917
|
+
* @tags UsageTracking
|
|
6918
|
+
* @name GetUsageData
|
|
6919
|
+
* @summary get insight usage data
|
|
6920
|
+
* @request POST:/tracking/usage
|
|
6767
6921
|
* @secure
|
|
6768
6922
|
*/
|
|
6769
|
-
|
|
6770
|
-
|
|
6771
|
-
|
|
6772
|
-
|
|
6773
|
-
|
|
6774
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
6923
|
+
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
6924
|
+
}
|
|
6925
|
+
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
6926
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6927
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6775
6928
|
/**
|
|
6776
|
-
* @description
|
|
6777
|
-
* @tags
|
|
6778
|
-
* @name
|
|
6779
|
-
* @summary
|
|
6780
|
-
* @request GET:/
|
|
6929
|
+
* @description Get continents
|
|
6930
|
+
* @tags World Markets
|
|
6931
|
+
* @name ContinentGet
|
|
6932
|
+
* @summary Get continents
|
|
6933
|
+
* @request GET:/continents
|
|
6781
6934
|
* @secure
|
|
6782
6935
|
*/
|
|
6783
|
-
|
|
6936
|
+
continentGet(query: {
|
|
6937
|
+
/** Query limit */
|
|
6938
|
+
limit: number;
|
|
6939
|
+
/** Query offset */
|
|
6940
|
+
offset: number;
|
|
6941
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
6784
6942
|
/**
|
|
6785
|
-
* @description
|
|
6786
|
-
* @tags
|
|
6787
|
-
* @name
|
|
6788
|
-
* @summary
|
|
6789
|
-
* @request
|
|
6943
|
+
* @description Edit continent
|
|
6944
|
+
* @tags World Markets
|
|
6945
|
+
* @name ContinentEdit
|
|
6946
|
+
* @summary Edit continent
|
|
6947
|
+
* @request PUT:/continents
|
|
6790
6948
|
* @secure
|
|
6791
6949
|
*/
|
|
6792
|
-
|
|
6950
|
+
continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6793
6951
|
/**
|
|
6794
|
-
* @description
|
|
6795
|
-
* @tags
|
|
6796
|
-
* @name
|
|
6797
|
-
* @summary
|
|
6798
|
-
* @request
|
|
6952
|
+
* @description Create continents
|
|
6953
|
+
* @tags World Markets
|
|
6954
|
+
* @name ContinentCreate
|
|
6955
|
+
* @summary Create continents
|
|
6956
|
+
* @request POST:/continents
|
|
6799
6957
|
* @secure
|
|
6800
6958
|
*/
|
|
6801
|
-
|
|
6802
|
-
/** Search query */
|
|
6803
|
-
search_query: string;
|
|
6804
|
-
/** how many records to return. Max value is 50 */
|
|
6805
|
-
limit: number;
|
|
6806
|
-
/** how many records to skip */
|
|
6807
|
-
offset: number;
|
|
6808
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
6959
|
+
continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
6809
6960
|
/**
|
|
6810
|
-
* @description
|
|
6811
|
-
* @tags
|
|
6812
|
-
* @name
|
|
6813
|
-
* @summary
|
|
6814
|
-
* @request
|
|
6961
|
+
* @description Delete continent
|
|
6962
|
+
* @tags World Markets
|
|
6963
|
+
* @name ContinentDelete
|
|
6964
|
+
* @summary Delete continent
|
|
6965
|
+
* @request DELETE:/continents
|
|
6815
6966
|
* @secure
|
|
6816
6967
|
*/
|
|
6817
|
-
|
|
6818
|
-
/**
|
|
6819
|
-
|
|
6820
|
-
|
|
6821
|
-
limit: number;
|
|
6822
|
-
/** how many records to skip */
|
|
6823
|
-
offset: number;
|
|
6824
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6968
|
+
continentDelete(query: {
|
|
6969
|
+
/** continent id */
|
|
6970
|
+
id: string;
|
|
6971
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6825
6972
|
/**
|
|
6826
|
-
* @description Get
|
|
6827
|
-
* @tags
|
|
6828
|
-
* @name
|
|
6829
|
-
* @summary
|
|
6830
|
-
* @request GET:/
|
|
6831
|
-
* @secure
|
|
6832
|
-
*/
|
|
6833
|
-
|
|
6834
|
-
/**
|
|
6835
|
-
|
|
6836
|
-
/**
|
|
6837
|
-
|
|
6838
|
-
|
|
6839
|
-
offset: number;
|
|
6840
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6841
|
-
}
|
|
6842
|
-
export interface InsightBeforeAndAfterV2 {
|
|
6843
|
-
after?: string;
|
|
6844
|
-
before?: string;
|
|
6845
|
-
}
|
|
6846
|
-
export interface InsightFixedIncomeV2 {
|
|
6847
|
-
a144: boolean;
|
|
6848
|
-
accrued_interest: number;
|
|
6849
|
-
bank_qualified: boolean;
|
|
6850
|
-
bond_warrant: boolean;
|
|
6851
|
-
call_type: string;
|
|
6852
|
-
callable: boolean;
|
|
6853
|
-
close_price: number;
|
|
6854
|
-
close_price_asof: string;
|
|
6855
|
-
close_ytw: number;
|
|
6856
|
-
convertible: boolean;
|
|
6857
|
-
country: string;
|
|
6858
|
-
country_code: string;
|
|
6859
|
-
country_domicile: string;
|
|
6860
|
-
country_issue: string;
|
|
6861
|
-
coupon: number;
|
|
6862
|
-
coupon_frequency: string;
|
|
6863
|
-
coupon_type: string;
|
|
6864
|
-
currency: string;
|
|
6865
|
-
cusip: string;
|
|
6866
|
-
dated_date: string;
|
|
6867
|
-
daycount: string;
|
|
6868
|
-
description: string;
|
|
6869
|
-
description_short: string;
|
|
6870
|
-
duration: number;
|
|
6871
|
-
first_coupon_date: string;
|
|
6872
|
-
insured: boolean;
|
|
6873
|
-
isin: string;
|
|
6874
|
-
issue_date: string;
|
|
6875
|
-
issue_minimum_denomination: number;
|
|
6876
|
-
issue_price: number;
|
|
6877
|
-
issue_size: number;
|
|
6878
|
-
issuer: string;
|
|
6879
|
-
last_coupon_date: string;
|
|
6880
|
-
liquidity_institutional_aggregate: number;
|
|
6881
|
-
liquidity_institutional_buy: number;
|
|
6882
|
-
liquidity_institutional_sell: number;
|
|
6883
|
-
liquidity_micro_aggregate: number;
|
|
6884
|
-
liquidity_micro_buy: number;
|
|
6885
|
-
liquidity_micro_sell: number;
|
|
6886
|
-
liquidity_retail_aggregate: number;
|
|
6887
|
-
liquidity_retail_buy: number;
|
|
6888
|
-
liquidity_retail_sell: number;
|
|
6889
|
-
maturity_date: string;
|
|
6890
|
-
municipal_state: string;
|
|
6891
|
-
municipal_taxable_federal: boolean;
|
|
6892
|
-
municipal_type: string;
|
|
6893
|
-
next_call_date: string;
|
|
6894
|
-
next_call_price: number;
|
|
6895
|
-
next_coupon_date: string;
|
|
6896
|
-
par_value: number;
|
|
6897
|
-
perpetual: boolean;
|
|
6898
|
-
private_placement: boolean;
|
|
6899
|
-
purpose: string;
|
|
6900
|
-
puttable: boolean;
|
|
6901
|
-
reg_s: boolean;
|
|
6902
|
-
sector: string;
|
|
6903
|
-
seniority: string;
|
|
6904
|
-
settlement_convention: string;
|
|
6905
|
-
sinking_fund: boolean;
|
|
6906
|
-
sp_creditwatch: string;
|
|
6907
|
-
sp_creditwatch_date: string;
|
|
6908
|
-
sp_outlook: string;
|
|
6909
|
-
sp_outlook_date: string;
|
|
6910
|
-
sp_rating: string;
|
|
6911
|
-
sp_rating_date: string;
|
|
6912
|
-
status: string;
|
|
6913
|
-
ticker: string;
|
|
6914
|
-
treasury_subtype: string;
|
|
6915
|
-
type: string;
|
|
6916
|
-
updated_at: string;
|
|
6917
|
-
}
|
|
6918
|
-
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
6919
|
-
count: number;
|
|
6920
|
-
data: InsightFixedIncomeV2[];
|
|
6921
|
-
}
|
|
6922
|
-
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
6923
|
-
/** @example true */
|
|
6924
|
-
bank_qualified?: boolean;
|
|
6925
|
-
/** @example true */
|
|
6926
|
-
callable?: boolean;
|
|
6927
|
-
/** @example true */
|
|
6928
|
-
convertible?: boolean;
|
|
6929
|
-
/** @example ["USA"] */
|
|
6930
|
-
country_codes?: string[];
|
|
6931
|
-
coupon?: InsightLessAndMoreV2;
|
|
6932
|
-
/** @example ["quarterly","zero"] */
|
|
6933
|
-
coupon_frequencies?: string[];
|
|
6934
|
-
/** @example ["655664AH3","9128286R6"] */
|
|
6935
|
-
cusip?: string[];
|
|
6973
|
+
* @description Get country codes
|
|
6974
|
+
* @tags World Markets
|
|
6975
|
+
* @name CountryCodeGet
|
|
6976
|
+
* @summary Get country codes
|
|
6977
|
+
* @request GET:/country-codes
|
|
6978
|
+
* @secure
|
|
6979
|
+
*/
|
|
6980
|
+
countryCodeGet(query: {
|
|
6981
|
+
/** Query limit */
|
|
6982
|
+
limit: number;
|
|
6983
|
+
/** Query offset */
|
|
6984
|
+
offset: number;
|
|
6985
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
6936
6986
|
/**
|
|
6937
|
-
* @
|
|
6938
|
-
* @
|
|
6987
|
+
* @description Edit country code
|
|
6988
|
+
* @tags World Markets
|
|
6989
|
+
* @name CountryCodeEdit
|
|
6990
|
+
* @summary Edit country code
|
|
6991
|
+
* @request PUT:/country-codes
|
|
6992
|
+
* @secure
|
|
6939
6993
|
*/
|
|
6940
|
-
|
|
6941
|
-
/** @example true */
|
|
6942
|
-
has_ticker?: boolean;
|
|
6943
|
-
/** @example true */
|
|
6944
|
-
insured?: boolean;
|
|
6945
|
-
/** @example ["US655664AH33","US9128286R69"] */
|
|
6946
|
-
isin?: string[];
|
|
6947
|
-
issue_date?: InsightBeforeAndAfterV2;
|
|
6994
|
+
countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6948
6995
|
/**
|
|
6949
|
-
* @
|
|
6950
|
-
* @
|
|
6996
|
+
* @description Add country codes
|
|
6997
|
+
* @tags World Markets
|
|
6998
|
+
* @name CountryCodeAdd
|
|
6999
|
+
* @summary Add country codes
|
|
7000
|
+
* @request POST:/country-codes
|
|
7001
|
+
* @secure
|
|
6951
7002
|
*/
|
|
6952
|
-
|
|
6953
|
-
maturity?: InsightBeforeAndAfterV2;
|
|
6954
|
-
/** @example ["NY"] */
|
|
6955
|
-
municipal_states?: string[];
|
|
6956
|
-
/** @example true */
|
|
6957
|
-
municipal_tax?: boolean;
|
|
6958
|
-
/** @example ["general_obligation"] */
|
|
6959
|
-
municipal_types?: string[];
|
|
6960
|
-
pagination: InsightPaginationV2;
|
|
6961
|
-
purposes?: string[];
|
|
6962
|
-
/** @example ["SOVEREIGN"] */
|
|
6963
|
-
sectors?: string[];
|
|
6964
|
-
sorts?: InsightOrderingV2[];
|
|
6965
|
-
/** @example ["AAA"] */
|
|
6966
|
-
sp_ratings?: string[];
|
|
6967
|
-
/** @example ["called","outstanding"] */
|
|
6968
|
-
statuses?: string[];
|
|
6969
|
-
tickers?: string[];
|
|
6970
|
-
/** @example ["corporate"] */
|
|
6971
|
-
types?: string[];
|
|
6972
|
-
}
|
|
6973
|
-
export interface InsightGetTopSymbolsRequestV2 {
|
|
6974
|
-
exchange?: string[];
|
|
6975
|
-
market_cap?: InsightLessAndMoreV2;
|
|
6976
|
-
pagination?: InsightPaginationV2;
|
|
6977
|
-
price?: InsightLessAndMoreV2;
|
|
6978
|
-
sorts?: InsightOrderingV2[];
|
|
6979
|
-
volume?: InsightLessAndMoreV2;
|
|
6980
|
-
}
|
|
6981
|
-
export interface InsightIncludeExcludeV2 {
|
|
6982
|
-
exclude?: string[];
|
|
6983
|
-
include?: string[];
|
|
6984
|
-
}
|
|
6985
|
-
export interface InsightLessAndMoreV2 {
|
|
6986
|
-
less_than?: number;
|
|
6987
|
-
more_than?: number;
|
|
6988
|
-
}
|
|
6989
|
-
export enum InsightOrderDirectionV2 {
|
|
6990
|
-
OrderASC = "asc",
|
|
6991
|
-
OrderDESC = "desc"
|
|
6992
|
-
}
|
|
6993
|
-
export interface InsightOrderingV2 {
|
|
7003
|
+
countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
6994
7004
|
/**
|
|
6995
|
-
* @
|
|
6996
|
-
* @
|
|
7005
|
+
* @description Delete country code
|
|
7006
|
+
* @tags World Markets
|
|
7007
|
+
* @name CountryCodeDelete
|
|
7008
|
+
* @summary Delete country code
|
|
7009
|
+
* @request DELETE:/country-codes
|
|
7010
|
+
* @secure
|
|
6997
7011
|
*/
|
|
6998
|
-
|
|
7012
|
+
countryCodeDelete(query: {
|
|
7013
|
+
/** a3 code */
|
|
7014
|
+
a3code: string;
|
|
7015
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6999
7016
|
/**
|
|
7000
|
-
*
|
|
7001
|
-
*
|
|
7002
|
-
*
|
|
7003
|
-
* @
|
|
7017
|
+
* @description Get global indexes
|
|
7018
|
+
* @tags World Markets
|
|
7019
|
+
* @name GlobalIndexGet
|
|
7020
|
+
* @summary Get global indexes
|
|
7021
|
+
* @request GET:/global-indexes
|
|
7022
|
+
* @secure
|
|
7004
7023
|
*/
|
|
7005
|
-
|
|
7006
|
-
|
|
7007
|
-
|
|
7024
|
+
globalIndexGet(query: {
|
|
7025
|
+
/** Query limit */
|
|
7026
|
+
limit: number;
|
|
7027
|
+
/** Query offset */
|
|
7028
|
+
offset: number;
|
|
7029
|
+
/** Continent code for filtering */
|
|
7030
|
+
continent?: string;
|
|
7031
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
7008
7032
|
/**
|
|
7009
|
-
* @
|
|
7010
|
-
* @
|
|
7033
|
+
* @description Edit global index
|
|
7034
|
+
* @tags World Markets
|
|
7035
|
+
* @name GlobalIndexEdit
|
|
7036
|
+
* @summary Edit global index
|
|
7037
|
+
* @request PUT:/global-indexes
|
|
7038
|
+
* @secure
|
|
7011
7039
|
*/
|
|
7012
|
-
|
|
7040
|
+
globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7013
7041
|
/**
|
|
7014
|
-
* @
|
|
7015
|
-
* @
|
|
7016
|
-
* @
|
|
7042
|
+
* @description Add global indexes
|
|
7043
|
+
* @tags World Markets
|
|
7044
|
+
* @name GlobalIndexAdd
|
|
7045
|
+
* @summary Add global indexes
|
|
7046
|
+
* @request POST:/global-indexes
|
|
7047
|
+
* @secure
|
|
7017
7048
|
*/
|
|
7018
|
-
|
|
7019
|
-
}
|
|
7020
|
-
export interface InsightStockScreenerQuoteV2 {
|
|
7021
|
-
average_volume_30d: number;
|
|
7022
|
-
company_name: string;
|
|
7023
|
-
dividend_ex_date: string;
|
|
7024
|
-
dividend_pay_date: string;
|
|
7025
|
-
dividend_percent: number;
|
|
7026
|
-
exchange: string;
|
|
7027
|
-
exchange_name: string;
|
|
7028
|
-
gap: number;
|
|
7029
|
-
industry: string;
|
|
7030
|
-
industry_code: string;
|
|
7031
|
-
last_price: number;
|
|
7032
|
-
market_cap: number;
|
|
7033
|
-
pe_ratio: number;
|
|
7034
|
-
price_change: number;
|
|
7035
|
-
price_change_percent: number;
|
|
7036
|
-
symbol: string;
|
|
7037
|
-
volume: number;
|
|
7038
|
-
}
|
|
7039
|
-
export interface InsightStockScreenerRequestV2 {
|
|
7040
|
-
average_volume_30d?: InsightLessAndMoreV2;
|
|
7041
|
-
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
7042
|
-
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
7043
|
-
dividend_percent?: InsightLessAndMoreV2;
|
|
7044
|
-
exchange?: InsightIncludeExcludeV2;
|
|
7045
|
-
gap?: InsightLessAndMoreV2;
|
|
7046
|
-
industry?: InsightIncludeExcludeV2;
|
|
7047
|
-
market_cap?: InsightLessAndMoreV2;
|
|
7048
|
-
pagination: InsightPaginationV2;
|
|
7049
|
-
pe_ratio?: InsightLessAndMoreV2;
|
|
7050
|
-
price?: InsightLessAndMoreV2;
|
|
7051
|
-
sorts?: InsightOrderingV2[];
|
|
7052
|
-
/** @example "ADR" */
|
|
7053
|
-
stock_type?: string;
|
|
7054
|
-
volume?: InsightLessAndMoreV2;
|
|
7055
|
-
}
|
|
7056
|
-
export interface InsightStockScreenerResponseV2 {
|
|
7057
|
-
current_page: number;
|
|
7058
|
-
data: InsightStockScreenerQuoteV2[];
|
|
7059
|
-
page_count: number;
|
|
7060
|
-
status: number;
|
|
7061
|
-
total_records: number;
|
|
7062
|
-
}
|
|
7063
|
-
/**
|
|
7064
|
-
* @default "asc"
|
|
7065
|
-
* @example "asc"
|
|
7066
|
-
*/
|
|
7067
|
-
export enum InsightOrderingDirectionEnumV2 {
|
|
7068
|
-
Asc = "asc",
|
|
7069
|
-
Desc = "desc"
|
|
7070
|
-
}
|
|
7071
|
-
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
7072
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
7073
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
7049
|
+
globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
7074
7050
|
/**
|
|
7075
|
-
* @description
|
|
7076
|
-
* @tags
|
|
7077
|
-
* @name
|
|
7078
|
-
* @summary
|
|
7079
|
-
* @request
|
|
7051
|
+
* @description Edit global index
|
|
7052
|
+
* @tags World Markets
|
|
7053
|
+
* @name GlobalIndexDelete
|
|
7054
|
+
* @summary Delete global index
|
|
7055
|
+
* @request DELETE:/global-indexes
|
|
7080
7056
|
* @secure
|
|
7081
7057
|
*/
|
|
7082
|
-
|
|
7083
|
-
|
|
7084
|
-
|
|
7085
|
-
|
|
7086
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
7058
|
+
globalIndexDelete(query: {
|
|
7059
|
+
/** a3 code */
|
|
7060
|
+
a3code: string;
|
|
7061
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7087
7062
|
/**
|
|
7088
|
-
* @description
|
|
7089
|
-
* @tags
|
|
7090
|
-
* @name
|
|
7091
|
-
* @summary
|
|
7092
|
-
* @request
|
|
7063
|
+
* @description Get regions
|
|
7064
|
+
* @tags World Markets
|
|
7065
|
+
* @name RegionGet
|
|
7066
|
+
* @summary Get regions
|
|
7067
|
+
* @request GET:/regions
|
|
7093
7068
|
* @secure
|
|
7094
7069
|
*/
|
|
7095
|
-
|
|
7070
|
+
regionGet(query: {
|
|
7071
|
+
/** Query limit */
|
|
7072
|
+
limit: number;
|
|
7073
|
+
/** Query offset */
|
|
7074
|
+
offset: number;
|
|
7075
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
7096
7076
|
/**
|
|
7097
|
-
* @description
|
|
7098
|
-
* @tags
|
|
7099
|
-
* @name
|
|
7100
|
-
* @summary
|
|
7101
|
-
* @request
|
|
7077
|
+
* @description Edit region
|
|
7078
|
+
* @tags World Markets
|
|
7079
|
+
* @name RegionEdit
|
|
7080
|
+
* @summary Edit region
|
|
7081
|
+
* @request PUT:/regions
|
|
7102
7082
|
* @secure
|
|
7103
7083
|
*/
|
|
7104
|
-
|
|
7084
|
+
regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7085
|
+
/**
|
|
7086
|
+
* @description Create regions
|
|
7087
|
+
* @tags World Markets
|
|
7088
|
+
* @name RegionCreate
|
|
7089
|
+
* @summary Create regions
|
|
7090
|
+
* @request POST:/regions
|
|
7091
|
+
* @secure
|
|
7092
|
+
*/
|
|
7093
|
+
regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
7094
|
+
/**
|
|
7095
|
+
* @description Delete region
|
|
7096
|
+
* @tags World Markets
|
|
7097
|
+
* @name RegionDelete
|
|
7098
|
+
* @summary Delete region
|
|
7099
|
+
* @request DELETE:/regions
|
|
7100
|
+
* @secure
|
|
7101
|
+
*/
|
|
7102
|
+
regionDelete(query: {
|
|
7103
|
+
/** region id */
|
|
7104
|
+
id: string;
|
|
7105
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7105
7106
|
}
|
|
7106
7107
|
export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
7107
7108
|
readonly config: JwtClientConfig<HandleError>;
|