@orbis-systems/orbis-api-clients 0.8.0 → 0.8.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/aesmidas/index.d.ts +443 -286
- 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 +5928 -4813
- 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 +1319 -1297
- 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 +102 -81
- 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 +3985 -3985
- 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 +876 -906
- 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 +1 -1
package/dist/insight/index.d.ts
CHANGED
|
@@ -1213,15 +1213,32 @@ export interface InsightGetFundDetailsResponse {
|
|
|
1213
1213
|
fund_net_assets: number;
|
|
1214
1214
|
fund_type: string;
|
|
1215
1215
|
holdings: InsightHoldingBreakdown[];
|
|
1216
|
+
inception_date: string;
|
|
1217
|
+
inception_market_price: number;
|
|
1218
|
+
inception_nav: number;
|
|
1216
1219
|
inverse: boolean;
|
|
1217
1220
|
leverage: number;
|
|
1218
1221
|
long_description: string;
|
|
1219
1222
|
market_caps: InsightMarketCapBreakdown[];
|
|
1220
1223
|
maturities: InsightMaturityBreakdown[];
|
|
1224
|
+
month_end_nav: number;
|
|
1225
|
+
month_end_nav_date: string;
|
|
1221
1226
|
phone: string;
|
|
1227
|
+
primary_benchmark: string;
|
|
1228
|
+
primary_index_beta_y1: number;
|
|
1222
1229
|
sectors: InsightSectorBreakdown[];
|
|
1223
1230
|
structure: string;
|
|
1224
1231
|
symbol: string;
|
|
1232
|
+
tracking_error_y1: number;
|
|
1233
|
+
trailing_return_m1: number;
|
|
1234
|
+
trailing_return_m3: number;
|
|
1235
|
+
trailing_return_m6: number;
|
|
1236
|
+
trailing_return_y1: number;
|
|
1237
|
+
trailing_return_y10: number;
|
|
1238
|
+
trailing_return_y2: number;
|
|
1239
|
+
trailing_return_y3: number;
|
|
1240
|
+
trailing_return_y5: number;
|
|
1241
|
+
trailing_return_ytd: number;
|
|
1225
1242
|
website: string;
|
|
1226
1243
|
}
|
|
1227
1244
|
export interface InsightGetFundScreenerFiltersResponse {
|
|
@@ -2818,6 +2835,7 @@ export interface InsightHedgeFundsResponse {
|
|
|
2818
2835
|
}
|
|
2819
2836
|
export interface InsightHelpRequestWithSymbol {
|
|
2820
2837
|
paging?: InsightPaging;
|
|
2838
|
+
search_query?: string;
|
|
2821
2839
|
symbol?: string;
|
|
2822
2840
|
}
|
|
2823
2841
|
export interface InsightHistoricalIPO {
|
|
@@ -3350,6 +3368,8 @@ export interface InsightNewsFilterRequest {
|
|
|
3350
3368
|
symbols?: string[];
|
|
3351
3369
|
/** @example ["Earnings","Market"] */
|
|
3352
3370
|
tags?: string[];
|
|
3371
|
+
/** @example true */
|
|
3372
|
+
with_images_only?: boolean;
|
|
3353
3373
|
}
|
|
3354
3374
|
export interface InsightNewsImage {
|
|
3355
3375
|
size: string;
|
|
@@ -4783,28 +4803,6 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
|
|
|
4783
4803
|
Date = "date",
|
|
4784
4804
|
Rank = "rank"
|
|
4785
4805
|
}
|
|
4786
|
-
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
4787
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4788
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4789
|
-
/**
|
|
4790
|
-
* @description get seasonlity data with comparison to benchmark
|
|
4791
|
-
* @tags AlphaTools
|
|
4792
|
-
* @name GetMomentumRatioGraph
|
|
4793
|
-
* @summary get seasonlity data
|
|
4794
|
-
* @request POST:/rst
|
|
4795
|
-
* @secure
|
|
4796
|
-
*/
|
|
4797
|
-
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
4798
|
-
/**
|
|
4799
|
-
* @description get seasonlity data with comparison to benchmark
|
|
4800
|
-
* @tags AlphaTools
|
|
4801
|
-
* @name GetSeasonality
|
|
4802
|
-
* @summary get seasonlity data
|
|
4803
|
-
* @request POST:/seasonality
|
|
4804
|
-
* @secure
|
|
4805
|
-
*/
|
|
4806
|
-
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
4807
|
-
}
|
|
4808
4806
|
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4809
4807
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4810
4808
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4844,6 +4842,188 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
|
4844
4842
|
*/
|
|
4845
4843
|
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
4846
4844
|
}
|
|
4845
|
+
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
4846
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4847
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4848
|
+
/**
|
|
4849
|
+
* @description Get continents
|
|
4850
|
+
* @tags World Markets
|
|
4851
|
+
* @name ContinentGet
|
|
4852
|
+
* @summary Get continents
|
|
4853
|
+
* @request GET:/continents
|
|
4854
|
+
* @secure
|
|
4855
|
+
*/
|
|
4856
|
+
continentGet(query: {
|
|
4857
|
+
/** Query limit */
|
|
4858
|
+
limit: number;
|
|
4859
|
+
/** Query offset */
|
|
4860
|
+
offset: number;
|
|
4861
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4862
|
+
/**
|
|
4863
|
+
* @description Edit continent
|
|
4864
|
+
* @tags World Markets
|
|
4865
|
+
* @name ContinentEdit
|
|
4866
|
+
* @summary Edit continent
|
|
4867
|
+
* @request PUT:/continents
|
|
4868
|
+
* @secure
|
|
4869
|
+
*/
|
|
4870
|
+
continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4871
|
+
/**
|
|
4872
|
+
* @description Create continents
|
|
4873
|
+
* @tags World Markets
|
|
4874
|
+
* @name ContinentCreate
|
|
4875
|
+
* @summary Create continents
|
|
4876
|
+
* @request POST:/continents
|
|
4877
|
+
* @secure
|
|
4878
|
+
*/
|
|
4879
|
+
continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4880
|
+
/**
|
|
4881
|
+
* @description Delete continent
|
|
4882
|
+
* @tags World Markets
|
|
4883
|
+
* @name ContinentDelete
|
|
4884
|
+
* @summary Delete continent
|
|
4885
|
+
* @request DELETE:/continents
|
|
4886
|
+
* @secure
|
|
4887
|
+
*/
|
|
4888
|
+
continentDelete(query: {
|
|
4889
|
+
/** continent id */
|
|
4890
|
+
id: string;
|
|
4891
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4892
|
+
/**
|
|
4893
|
+
* @description Get country codes
|
|
4894
|
+
* @tags World Markets
|
|
4895
|
+
* @name CountryCodeGet
|
|
4896
|
+
* @summary Get country codes
|
|
4897
|
+
* @request GET:/country-codes
|
|
4898
|
+
* @secure
|
|
4899
|
+
*/
|
|
4900
|
+
countryCodeGet(query: {
|
|
4901
|
+
/** Query limit */
|
|
4902
|
+
limit: number;
|
|
4903
|
+
/** Query offset */
|
|
4904
|
+
offset: number;
|
|
4905
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4906
|
+
/**
|
|
4907
|
+
* @description Edit country code
|
|
4908
|
+
* @tags World Markets
|
|
4909
|
+
* @name CountryCodeEdit
|
|
4910
|
+
* @summary Edit country code
|
|
4911
|
+
* @request PUT:/country-codes
|
|
4912
|
+
* @secure
|
|
4913
|
+
*/
|
|
4914
|
+
countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4915
|
+
/**
|
|
4916
|
+
* @description Add country codes
|
|
4917
|
+
* @tags World Markets
|
|
4918
|
+
* @name CountryCodeAdd
|
|
4919
|
+
* @summary Add country codes
|
|
4920
|
+
* @request POST:/country-codes
|
|
4921
|
+
* @secure
|
|
4922
|
+
*/
|
|
4923
|
+
countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4924
|
+
/**
|
|
4925
|
+
* @description Delete country code
|
|
4926
|
+
* @tags World Markets
|
|
4927
|
+
* @name CountryCodeDelete
|
|
4928
|
+
* @summary Delete country code
|
|
4929
|
+
* @request DELETE:/country-codes
|
|
4930
|
+
* @secure
|
|
4931
|
+
*/
|
|
4932
|
+
countryCodeDelete(query: {
|
|
4933
|
+
/** a3 code */
|
|
4934
|
+
a3code: string;
|
|
4935
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4936
|
+
/**
|
|
4937
|
+
* @description Get global indexes
|
|
4938
|
+
* @tags World Markets
|
|
4939
|
+
* @name GlobalIndexGet
|
|
4940
|
+
* @summary Get global indexes
|
|
4941
|
+
* @request GET:/global-indexes
|
|
4942
|
+
* @secure
|
|
4943
|
+
*/
|
|
4944
|
+
globalIndexGet(query: {
|
|
4945
|
+
/** Query limit */
|
|
4946
|
+
limit: number;
|
|
4947
|
+
/** Query offset */
|
|
4948
|
+
offset: number;
|
|
4949
|
+
/** Continent code for filtering */
|
|
4950
|
+
continent?: string;
|
|
4951
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4952
|
+
/**
|
|
4953
|
+
* @description Edit global index
|
|
4954
|
+
* @tags World Markets
|
|
4955
|
+
* @name GlobalIndexEdit
|
|
4956
|
+
* @summary Edit global index
|
|
4957
|
+
* @request PUT:/global-indexes
|
|
4958
|
+
* @secure
|
|
4959
|
+
*/
|
|
4960
|
+
globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4961
|
+
/**
|
|
4962
|
+
* @description Add global indexes
|
|
4963
|
+
* @tags World Markets
|
|
4964
|
+
* @name GlobalIndexAdd
|
|
4965
|
+
* @summary Add global indexes
|
|
4966
|
+
* @request POST:/global-indexes
|
|
4967
|
+
* @secure
|
|
4968
|
+
*/
|
|
4969
|
+
globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4970
|
+
/**
|
|
4971
|
+
* @description Edit global index
|
|
4972
|
+
* @tags World Markets
|
|
4973
|
+
* @name GlobalIndexDelete
|
|
4974
|
+
* @summary Delete global index
|
|
4975
|
+
* @request DELETE:/global-indexes
|
|
4976
|
+
* @secure
|
|
4977
|
+
*/
|
|
4978
|
+
globalIndexDelete(query: {
|
|
4979
|
+
/** a3 code */
|
|
4980
|
+
a3code: string;
|
|
4981
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4982
|
+
/**
|
|
4983
|
+
* @description Get regions
|
|
4984
|
+
* @tags World Markets
|
|
4985
|
+
* @name RegionGet
|
|
4986
|
+
* @summary Get regions
|
|
4987
|
+
* @request GET:/regions
|
|
4988
|
+
* @secure
|
|
4989
|
+
*/
|
|
4990
|
+
regionGet(query: {
|
|
4991
|
+
/** Query limit */
|
|
4992
|
+
limit: number;
|
|
4993
|
+
/** Query offset */
|
|
4994
|
+
offset: number;
|
|
4995
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
4996
|
+
/**
|
|
4997
|
+
* @description Edit region
|
|
4998
|
+
* @tags World Markets
|
|
4999
|
+
* @name RegionEdit
|
|
5000
|
+
* @summary Edit region
|
|
5001
|
+
* @request PUT:/regions
|
|
5002
|
+
* @secure
|
|
5003
|
+
*/
|
|
5004
|
+
regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5005
|
+
/**
|
|
5006
|
+
* @description Create regions
|
|
5007
|
+
* @tags World Markets
|
|
5008
|
+
* @name RegionCreate
|
|
5009
|
+
* @summary Create regions
|
|
5010
|
+
* @request POST:/regions
|
|
5011
|
+
* @secure
|
|
5012
|
+
*/
|
|
5013
|
+
regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
5014
|
+
/**
|
|
5015
|
+
* @description Delete region
|
|
5016
|
+
* @tags World Markets
|
|
5017
|
+
* @name RegionDelete
|
|
5018
|
+
* @summary Delete region
|
|
5019
|
+
* @request DELETE:/regions
|
|
5020
|
+
* @secure
|
|
5021
|
+
*/
|
|
5022
|
+
regionDelete(query: {
|
|
5023
|
+
/** region id */
|
|
5024
|
+
id: string;
|
|
5025
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5026
|
+
}
|
|
4847
5027
|
export class CustomLists<HandleError extends boolean = boolean> {
|
|
4848
5028
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4849
5029
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5131,260 +5311,18 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5131
5311
|
*/
|
|
5132
5312
|
getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
|
|
5133
5313
|
}
|
|
5134
|
-
export
|
|
5135
|
-
|
|
5136
|
-
|
|
5137
|
-
|
|
5138
|
-
|
|
5139
|
-
|
|
5140
|
-
|
|
5141
|
-
|
|
5142
|
-
|
|
5143
|
-
|
|
5144
|
-
|
|
5145
|
-
|
|
5146
|
-
close_price_asof: string;
|
|
5147
|
-
close_ytw: number;
|
|
5148
|
-
convertible: boolean;
|
|
5149
|
-
country: string;
|
|
5150
|
-
country_code: string;
|
|
5151
|
-
country_domicile: string;
|
|
5152
|
-
country_issue: string;
|
|
5153
|
-
coupon: number;
|
|
5154
|
-
coupon_frequency: string;
|
|
5155
|
-
coupon_type: string;
|
|
5156
|
-
currency: string;
|
|
5157
|
-
cusip: string;
|
|
5158
|
-
dated_date: string;
|
|
5159
|
-
daycount: string;
|
|
5160
|
-
description: string;
|
|
5161
|
-
description_short: string;
|
|
5162
|
-
duration: number;
|
|
5163
|
-
first_coupon_date: string;
|
|
5164
|
-
insured: boolean;
|
|
5165
|
-
isin: string;
|
|
5166
|
-
issue_date: string;
|
|
5167
|
-
issue_minimum_denomination: number;
|
|
5168
|
-
issue_price: number;
|
|
5169
|
-
issue_size: number;
|
|
5170
|
-
issuer: string;
|
|
5171
|
-
last_coupon_date: string;
|
|
5172
|
-
liquidity_institutional_aggregate: number;
|
|
5173
|
-
liquidity_institutional_buy: number;
|
|
5174
|
-
liquidity_institutional_sell: number;
|
|
5175
|
-
liquidity_micro_aggregate: number;
|
|
5176
|
-
liquidity_micro_buy: number;
|
|
5177
|
-
liquidity_micro_sell: number;
|
|
5178
|
-
liquidity_retail_aggregate: number;
|
|
5179
|
-
liquidity_retail_buy: number;
|
|
5180
|
-
liquidity_retail_sell: number;
|
|
5181
|
-
maturity_date: string;
|
|
5182
|
-
municipal_state: string;
|
|
5183
|
-
municipal_taxable_federal: boolean;
|
|
5184
|
-
municipal_type: string;
|
|
5185
|
-
next_call_date: string;
|
|
5186
|
-
next_call_price: number;
|
|
5187
|
-
next_coupon_date: string;
|
|
5188
|
-
par_value: number;
|
|
5189
|
-
perpetual: boolean;
|
|
5190
|
-
private_placement: boolean;
|
|
5191
|
-
purpose: string;
|
|
5192
|
-
puttable: boolean;
|
|
5193
|
-
reg_s: boolean;
|
|
5194
|
-
sector: string;
|
|
5195
|
-
seniority: string;
|
|
5196
|
-
settlement_convention: string;
|
|
5197
|
-
sinking_fund: boolean;
|
|
5198
|
-
sp_creditwatch: string;
|
|
5199
|
-
sp_creditwatch_date: string;
|
|
5200
|
-
sp_outlook: string;
|
|
5201
|
-
sp_outlook_date: string;
|
|
5202
|
-
sp_rating: string;
|
|
5203
|
-
sp_rating_date: string;
|
|
5204
|
-
status: string;
|
|
5205
|
-
ticker: string;
|
|
5206
|
-
treasury_subtype: string;
|
|
5207
|
-
type: string;
|
|
5208
|
-
updated_at: string;
|
|
5209
|
-
}
|
|
5210
|
-
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
5211
|
-
count: number;
|
|
5212
|
-
data: InsightFixedIncomeV2[];
|
|
5213
|
-
}
|
|
5214
|
-
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
5215
|
-
/** @example true */
|
|
5216
|
-
bank_qualified?: boolean;
|
|
5217
|
-
/** @example true */
|
|
5218
|
-
callable?: boolean;
|
|
5219
|
-
/** @example true */
|
|
5220
|
-
convertible?: boolean;
|
|
5221
|
-
/** @example ["USA"] */
|
|
5222
|
-
country_codes?: string[];
|
|
5223
|
-
coupon?: InsightLessAndMoreV2;
|
|
5224
|
-
/** @example ["quarterly","zero"] */
|
|
5225
|
-
coupon_frequencies?: string[];
|
|
5226
|
-
/** @example ["655664AH3","9128286R6"] */
|
|
5227
|
-
cusip?: string[];
|
|
5228
|
-
/**
|
|
5229
|
-
* @maxLength 100
|
|
5230
|
-
* @example "Donald's"
|
|
5231
|
-
*/
|
|
5232
|
-
description?: string;
|
|
5233
|
-
/** @example true */
|
|
5234
|
-
has_ticker?: boolean;
|
|
5235
|
-
/** @example true */
|
|
5236
|
-
insured?: boolean;
|
|
5237
|
-
/** @example ["US655664AH33","US9128286R69"] */
|
|
5238
|
-
isin?: string[];
|
|
5239
|
-
issue_date?: InsightBeforeAndAfterV2;
|
|
5240
|
-
/**
|
|
5241
|
-
* @maxLength 100
|
|
5242
|
-
* @example "Donald's"
|
|
5243
|
-
*/
|
|
5244
|
-
issuer?: string;
|
|
5245
|
-
maturity?: InsightBeforeAndAfterV2;
|
|
5246
|
-
/** @example ["NY"] */
|
|
5247
|
-
municipal_states?: string[];
|
|
5248
|
-
/** @example true */
|
|
5249
|
-
municipal_tax?: boolean;
|
|
5250
|
-
/** @example ["general_obligation"] */
|
|
5251
|
-
municipal_types?: string[];
|
|
5252
|
-
pagination: InsightPaginationV2;
|
|
5253
|
-
purposes?: string[];
|
|
5254
|
-
/** @example ["SOVEREIGN"] */
|
|
5255
|
-
sectors?: string[];
|
|
5256
|
-
sorts?: InsightOrderingV2[];
|
|
5257
|
-
/** @example ["AAA"] */
|
|
5258
|
-
sp_ratings?: string[];
|
|
5259
|
-
/** @example ["called","outstanding"] */
|
|
5260
|
-
statuses?: string[];
|
|
5261
|
-
tickers?: string[];
|
|
5262
|
-
/** @example ["corporate"] */
|
|
5263
|
-
types?: string[];
|
|
5264
|
-
}
|
|
5265
|
-
export interface InsightGetTopSymbolsRequestV2 {
|
|
5266
|
-
exchange?: string[];
|
|
5267
|
-
market_cap?: InsightLessAndMoreV2;
|
|
5268
|
-
pagination?: InsightPaginationV2;
|
|
5269
|
-
price?: InsightLessAndMoreV2;
|
|
5270
|
-
sorts?: InsightOrderingV2[];
|
|
5271
|
-
volume?: InsightLessAndMoreV2;
|
|
5272
|
-
}
|
|
5273
|
-
export interface InsightIncludeExcludeV2 {
|
|
5274
|
-
exclude?: string[];
|
|
5275
|
-
include?: string[];
|
|
5276
|
-
}
|
|
5277
|
-
export interface InsightLessAndMoreV2 {
|
|
5278
|
-
less_than?: number;
|
|
5279
|
-
more_than?: number;
|
|
5280
|
-
}
|
|
5281
|
-
export enum InsightOrderDirectionV2 {
|
|
5282
|
-
OrderASC = "asc",
|
|
5283
|
-
OrderDESC = "desc"
|
|
5284
|
-
}
|
|
5285
|
-
export interface InsightOrderingV2 {
|
|
5286
|
-
/**
|
|
5287
|
-
* @default "asc"
|
|
5288
|
-
* @example "asc"
|
|
5289
|
-
*/
|
|
5290
|
-
direction: InsightOrderingDirectionEnumV2;
|
|
5291
|
-
/**
|
|
5292
|
-
* Sort direction:
|
|
5293
|
-
* * asc - Ascending, from A to Z.
|
|
5294
|
-
* * desc - Descending, from Z to A.
|
|
5295
|
-
* @example "name"
|
|
5296
|
-
*/
|
|
5297
|
-
field: string;
|
|
5298
|
-
}
|
|
5299
|
-
export interface InsightPaginationV2 {
|
|
5300
|
-
/**
|
|
5301
|
-
* @min 1
|
|
5302
|
-
* @example 1
|
|
5303
|
-
*/
|
|
5304
|
-
page: number;
|
|
5305
|
-
/**
|
|
5306
|
-
* @min 1
|
|
5307
|
-
* @max 50
|
|
5308
|
-
* @example 10
|
|
5309
|
-
*/
|
|
5310
|
-
size: number;
|
|
5311
|
-
}
|
|
5312
|
-
export interface InsightStockScreenerQuoteV2 {
|
|
5313
|
-
average_volume_30d: number;
|
|
5314
|
-
company_name: string;
|
|
5315
|
-
dividend_ex_date: string;
|
|
5316
|
-
dividend_pay_date: string;
|
|
5317
|
-
dividend_percent: number;
|
|
5318
|
-
exchange: string;
|
|
5319
|
-
exchange_name: string;
|
|
5320
|
-
gap: number;
|
|
5321
|
-
industry: string;
|
|
5322
|
-
industry_code: string;
|
|
5323
|
-
last_price: number;
|
|
5324
|
-
market_cap: number;
|
|
5325
|
-
pe_ratio: number;
|
|
5326
|
-
price_change: number;
|
|
5327
|
-
price_change_percent: number;
|
|
5328
|
-
symbol: string;
|
|
5329
|
-
volume: number;
|
|
5330
|
-
}
|
|
5331
|
-
export interface InsightStockScreenerRequestV2 {
|
|
5332
|
-
average_volume_30d?: InsightLessAndMoreV2;
|
|
5333
|
-
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
5334
|
-
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
5335
|
-
dividend_percent?: InsightLessAndMoreV2;
|
|
5336
|
-
exchange?: InsightIncludeExcludeV2;
|
|
5337
|
-
gap?: InsightLessAndMoreV2;
|
|
5338
|
-
industry?: InsightIncludeExcludeV2;
|
|
5339
|
-
market_cap?: InsightLessAndMoreV2;
|
|
5340
|
-
pagination: InsightPaginationV2;
|
|
5341
|
-
pe_ratio?: InsightLessAndMoreV2;
|
|
5342
|
-
price?: InsightLessAndMoreV2;
|
|
5343
|
-
sorts?: InsightOrderingV2[];
|
|
5344
|
-
/** @example "ADR" */
|
|
5345
|
-
stock_type?: string;
|
|
5346
|
-
volume?: InsightLessAndMoreV2;
|
|
5347
|
-
}
|
|
5348
|
-
export interface InsightStockScreenerResponseV2 {
|
|
5349
|
-
current_page: number;
|
|
5350
|
-
data: InsightStockScreenerQuoteV2[];
|
|
5351
|
-
page_count: number;
|
|
5352
|
-
status: number;
|
|
5353
|
-
total_records: number;
|
|
5354
|
-
}
|
|
5355
|
-
/**
|
|
5356
|
-
* @default "asc"
|
|
5357
|
-
* @example "asc"
|
|
5358
|
-
*/
|
|
5359
|
-
export enum InsightOrderingDirectionEnumV2 {
|
|
5360
|
-
Asc = "asc",
|
|
5361
|
-
Desc = "desc"
|
|
5362
|
-
}
|
|
5363
|
-
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
5364
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5365
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5366
|
-
/**
|
|
5367
|
-
* @description get fixed income entries
|
|
5368
|
-
* @tags FixedIncome
|
|
5369
|
-
* @name GetFixedIncomeEntries
|
|
5370
|
-
* @summary get fixed income entries
|
|
5371
|
-
* @request POST:/fixed-income
|
|
5372
|
-
* @secure
|
|
5373
|
-
*/
|
|
5374
|
-
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
5375
|
-
}
|
|
5376
|
-
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
5377
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5378
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5379
|
-
/**
|
|
5380
|
-
* @description get fundamentals by symbol data
|
|
5381
|
-
* @tags Fundamentals
|
|
5382
|
-
* @name GetFundamentalsBySymbolData
|
|
5383
|
-
* @summary get fundamentals by symbol data
|
|
5384
|
-
* @request POST:/fundamentals
|
|
5385
|
-
* @secure
|
|
5386
|
-
*/
|
|
5387
|
-
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5314
|
+
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
5315
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5316
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5317
|
+
/**
|
|
5318
|
+
* @description get fundamentals by symbol data
|
|
5319
|
+
* @tags Fundamentals
|
|
5320
|
+
* @name GetFundamentalsBySymbolData
|
|
5321
|
+
* @summary get fundamentals by symbol data
|
|
5322
|
+
* @request POST:/fundamentals
|
|
5323
|
+
* @secure
|
|
5324
|
+
*/
|
|
5325
|
+
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5388
5326
|
}
|
|
5389
5327
|
export class Funds<HandleError extends boolean = boolean> {
|
|
5390
5328
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5500,1122 +5438,1137 @@ export class Funds<HandleError extends boolean = boolean> {
|
|
|
5500
5438
|
Authorization?: string;
|
|
5501
5439
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
|
|
5502
5440
|
}
|
|
5503
|
-
export class
|
|
5441
|
+
export class StockScreener<HandleError extends boolean = boolean> {
|
|
5504
5442
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5505
5443
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5506
5444
|
/**
|
|
5507
|
-
* @description
|
|
5508
|
-
* @tags
|
|
5509
|
-
* @name
|
|
5510
|
-
* @summary
|
|
5511
|
-
* @request
|
|
5445
|
+
* @description data for visual heat map
|
|
5446
|
+
* @tags StockScreener
|
|
5447
|
+
* @name StockMarketHeatmap
|
|
5448
|
+
* @summary data for visual heat map
|
|
5449
|
+
* @request GET:/heatmaps
|
|
5512
5450
|
* @secure
|
|
5513
5451
|
*/
|
|
5514
|
-
|
|
5515
|
-
|
|
5516
|
-
|
|
5517
|
-
|
|
5518
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5452
|
+
stockMarketHeatmap(query?: {
|
|
5453
|
+
/** Name of symbol list to fetch details for. Empty is default */
|
|
5454
|
+
heatmap_name?: string;
|
|
5455
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
5519
5456
|
/**
|
|
5520
|
-
* @description
|
|
5521
|
-
* @tags
|
|
5522
|
-
* @name
|
|
5523
|
-
* @summary
|
|
5524
|
-
* @request POST:/
|
|
5457
|
+
* @description create or update heat map preset
|
|
5458
|
+
* @tags StockScreener
|
|
5459
|
+
* @name CreateStockMarketHeatmapPreset
|
|
5460
|
+
* @summary create or update heat map preset
|
|
5461
|
+
* @request POST:/heatmaps
|
|
5525
5462
|
* @secure
|
|
5526
5463
|
*/
|
|
5527
|
-
|
|
5464
|
+
createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5528
5465
|
/**
|
|
5529
|
-
* @description
|
|
5530
|
-
* @tags
|
|
5531
|
-
* @name
|
|
5532
|
-
* @summary get
|
|
5533
|
-
* @request
|
|
5534
|
-
* @secure
|
|
5535
|
-
*/
|
|
5536
|
-
getUpcoming(query: {
|
|
5537
|
-
/** how many records to return. Max value is 50 */
|
|
5538
|
-
limit: number;
|
|
5539
|
-
/** how many records to skip */
|
|
5540
|
-
offset: number;
|
|
5541
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5542
|
-
/**
|
|
5543
|
-
* @description get ipo info by symbol
|
|
5544
|
-
* @tags Ipos
|
|
5545
|
-
* @name GetIpos
|
|
5546
|
-
* @summary get ipo info by symbol
|
|
5547
|
-
* @request GET:/ipos/{symbol}
|
|
5466
|
+
* @description Sector and Industry Group performance
|
|
5467
|
+
* @tags StockScreener
|
|
5468
|
+
* @name IndustriesPerformance
|
|
5469
|
+
* @summary get industries performance
|
|
5470
|
+
* @request POST:/industries-performance
|
|
5548
5471
|
* @secure
|
|
5549
5472
|
*/
|
|
5550
|
-
|
|
5551
|
-
/** load quotes */
|
|
5552
|
-
load_quotes?: boolean;
|
|
5553
|
-
/** statuses */
|
|
5554
|
-
statuses?: string[];
|
|
5555
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
|
|
5556
|
-
}
|
|
5557
|
-
export class Logos<HandleError extends boolean = boolean> {
|
|
5558
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5559
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5473
|
+
industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
|
|
5560
5474
|
/**
|
|
5561
|
-
* @description
|
|
5562
|
-
* @tags
|
|
5563
|
-
* @name
|
|
5564
|
-
* @summary
|
|
5565
|
-
* @request POST:/
|
|
5475
|
+
* @description filter stocks by params
|
|
5476
|
+
* @tags StockScreener
|
|
5477
|
+
* @name StockScreener
|
|
5478
|
+
* @summary filter stocks by params
|
|
5479
|
+
* @request POST:/stock-screener
|
|
5566
5480
|
* @secure
|
|
5567
5481
|
*/
|
|
5568
|
-
|
|
5482
|
+
stockScreener(filter: InsightStockScreenerV1Request, headers?: {
|
|
5483
|
+
/** Authorization */
|
|
5484
|
+
Authorization?: string;
|
|
5485
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
5569
5486
|
/**
|
|
5570
|
-
* @description
|
|
5571
|
-
* @tags
|
|
5572
|
-
* @name
|
|
5573
|
-
* @summary
|
|
5574
|
-
* @request
|
|
5487
|
+
* @description get screener presets
|
|
5488
|
+
* @tags StockScreener
|
|
5489
|
+
* @name GetScreenerPresets
|
|
5490
|
+
* @summary get screener presets
|
|
5491
|
+
* @request GET:/stock-screener/presets
|
|
5575
5492
|
* @secure
|
|
5576
5493
|
*/
|
|
5577
|
-
|
|
5494
|
+
getScreenerPresets(query: {
|
|
5495
|
+
/** how many records to return */
|
|
5496
|
+
limit: number;
|
|
5497
|
+
/** how many records to skip */
|
|
5498
|
+
offset: number;
|
|
5499
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
5578
5500
|
/**
|
|
5579
|
-
* @description
|
|
5580
|
-
* @tags
|
|
5581
|
-
* @name
|
|
5582
|
-
* @summary
|
|
5583
|
-
* @request
|
|
5501
|
+
* @description update screener preset
|
|
5502
|
+
* @tags StockScreener
|
|
5503
|
+
* @name UpdateScreenerPreset
|
|
5504
|
+
* @summary update screener preset
|
|
5505
|
+
* @request PUT:/stock-screener/presets
|
|
5584
5506
|
* @secure
|
|
5585
5507
|
*/
|
|
5586
|
-
|
|
5587
|
-
/** Company symbol */
|
|
5588
|
-
symbol: string;
|
|
5589
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
|
|
5508
|
+
updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5590
5509
|
/**
|
|
5591
|
-
* @description
|
|
5592
|
-
* @tags
|
|
5593
|
-
* @name
|
|
5594
|
-
* @summary
|
|
5595
|
-
* @request
|
|
5510
|
+
* @description create screener preset
|
|
5511
|
+
* @tags StockScreener
|
|
5512
|
+
* @name CreateOrScreenerPreset
|
|
5513
|
+
* @summary create screener preset
|
|
5514
|
+
* @request POST:/stock-screener/presets
|
|
5596
5515
|
* @secure
|
|
5597
5516
|
*/
|
|
5598
|
-
|
|
5599
|
-
/** Company symbol */
|
|
5600
|
-
symbol: string;
|
|
5601
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5517
|
+
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5602
5518
|
/**
|
|
5603
|
-
* @description
|
|
5604
|
-
* @tags
|
|
5605
|
-
* @name
|
|
5606
|
-
* @summary
|
|
5607
|
-
* @request
|
|
5519
|
+
* @description remove screener preset
|
|
5520
|
+
* @tags StockScreener
|
|
5521
|
+
* @name RemoveScreenerPreset
|
|
5522
|
+
* @summary remove screener preset
|
|
5523
|
+
* @request DELETE:/stock-screener/presets
|
|
5608
5524
|
* @secure
|
|
5609
5525
|
*/
|
|
5610
|
-
|
|
5611
|
-
/** Company symbol */
|
|
5612
|
-
symbol: string;
|
|
5613
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5526
|
+
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5614
5527
|
/**
|
|
5615
|
-
* @description
|
|
5616
|
-
* @tags
|
|
5617
|
-
* @name
|
|
5618
|
-
* @summary
|
|
5619
|
-
* @request POST:/
|
|
5528
|
+
* @description get top symbols
|
|
5529
|
+
* @tags StockScreener
|
|
5530
|
+
* @name GetTopSymbols
|
|
5531
|
+
* @summary get top symbols
|
|
5532
|
+
* @request POST:/stock-screener/top
|
|
5620
5533
|
* @secure
|
|
5621
5534
|
*/
|
|
5622
|
-
|
|
5535
|
+
getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
5536
|
+
}
|
|
5537
|
+
export class Quotes<HandleError extends boolean = boolean> {
|
|
5538
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5539
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5623
5540
|
/**
|
|
5624
|
-
* @description
|
|
5625
|
-
* @tags
|
|
5626
|
-
* @name
|
|
5627
|
-
* @summary Get
|
|
5628
|
-
* @request
|
|
5541
|
+
* @description Get single historical quote
|
|
5542
|
+
* @tags Quotes
|
|
5543
|
+
* @name GitHistoricalQuote
|
|
5544
|
+
* @summary Get single historical quote
|
|
5545
|
+
* @request GET:/historical/quote
|
|
5629
5546
|
* @secure
|
|
5630
5547
|
*/
|
|
5631
|
-
|
|
5548
|
+
gitHistoricalQuote(query: {
|
|
5549
|
+
/** Symbol */
|
|
5550
|
+
symbol: string;
|
|
5551
|
+
/** Date */
|
|
5552
|
+
date: string;
|
|
5553
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
5632
5554
|
/**
|
|
5633
|
-
* @description
|
|
5634
|
-
* @tags
|
|
5635
|
-
* @name
|
|
5636
|
-
* @summary Get
|
|
5637
|
-
* @request
|
|
5555
|
+
* @description get quote history by symbol
|
|
5556
|
+
* @tags Quotes
|
|
5557
|
+
* @name GitQuoteHistory
|
|
5558
|
+
* @summary Get quote history
|
|
5559
|
+
* @request POST:/quote-history
|
|
5638
5560
|
* @secure
|
|
5639
5561
|
*/
|
|
5640
|
-
|
|
5641
|
-
/** Company symbol */
|
|
5642
|
-
symbol: string;
|
|
5643
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
|
|
5562
|
+
gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
|
|
5644
5563
|
/**
|
|
5645
|
-
* @description Returns
|
|
5646
|
-
* @tags
|
|
5647
|
-
* @name
|
|
5648
|
-
* @summary Get
|
|
5649
|
-
* @request GET:/
|
|
5564
|
+
* @description Returns a list of quotes equity info for specified symbols.
|
|
5565
|
+
* @tags Quotes
|
|
5566
|
+
* @name GetQuotesEquityData
|
|
5567
|
+
* @summary Get Quotes Equity data
|
|
5568
|
+
* @request GET:/quotes/equity
|
|
5650
5569
|
* @secure
|
|
5651
5570
|
*/
|
|
5652
|
-
|
|
5653
|
-
/**
|
|
5654
|
-
|
|
5655
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5571
|
+
getQuotesEquityData(query: {
|
|
5572
|
+
/** Comma separated symbols */
|
|
5573
|
+
symbols: string;
|
|
5574
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
5656
5575
|
}
|
|
5657
|
-
export class
|
|
5576
|
+
export class Intraday<HandleError extends boolean = boolean> {
|
|
5658
5577
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5659
5578
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5660
5579
|
/**
|
|
5661
|
-
* @description
|
|
5662
|
-
* @tags
|
|
5663
|
-
* @name
|
|
5664
|
-
* @summary
|
|
5665
|
-
* @request POST:/
|
|
5666
|
-
* @secure
|
|
5667
|
-
*/
|
|
5668
|
-
createOrUpdateMarketDate(market: InsightMarketDates[], config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate[], HandleError>>;
|
|
5669
|
-
/**
|
|
5670
|
-
* @description Remove market date
|
|
5671
|
-
* @tags MarketDates
|
|
5672
|
-
* @name RemoveMarketDate
|
|
5673
|
-
* @summary Remove market date
|
|
5674
|
-
* @request DELETE:/market-dates
|
|
5580
|
+
* @description Returns an array of intraday chart data values for the given ticker.
|
|
5581
|
+
* @tags Intraday
|
|
5582
|
+
* @name IntradayQuotes
|
|
5583
|
+
* @summary Get an array of intraday chart data values for the given ticker
|
|
5584
|
+
* @request POST:/intraday/quotes
|
|
5675
5585
|
* @secure
|
|
5676
5586
|
*/
|
|
5677
|
-
|
|
5587
|
+
intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
|
|
5588
|
+
}
|
|
5589
|
+
export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
5590
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5591
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5678
5592
|
/**
|
|
5679
|
-
* @description
|
|
5680
|
-
* @tags
|
|
5681
|
-
* @name
|
|
5682
|
-
* @summary
|
|
5683
|
-
* @request
|
|
5593
|
+
* @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
|
|
5594
|
+
* @tags PreIPOCompanies
|
|
5595
|
+
* @name MonarkOghlcDataForSymbol
|
|
5596
|
+
* @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
|
|
5597
|
+
* @request GET:/ipos/market-data/ohlc/{symbol}
|
|
5684
5598
|
* @secure
|
|
5685
5599
|
*/
|
|
5686
|
-
|
|
5600
|
+
monarkOghlcDataForSymbol(symbol: string, query?: {
|
|
5601
|
+
/** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
5602
|
+
from?: string;
|
|
5603
|
+
/** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
5604
|
+
to?: string;
|
|
5605
|
+
/** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
|
|
5606
|
+
interval?: string;
|
|
5607
|
+
/** Limit the number of OHLC data points returned. Default is 100. */
|
|
5608
|
+
limit?: number;
|
|
5609
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
|
|
5610
|
+
close?: number;
|
|
5611
|
+
high?: number;
|
|
5612
|
+
low?: number;
|
|
5613
|
+
open?: number;
|
|
5614
|
+
time?: string;
|
|
5615
|
+
volume?: number;
|
|
5616
|
+
}[], HandleError>>;
|
|
5687
5617
|
/**
|
|
5688
|
-
* @description
|
|
5689
|
-
* @tags
|
|
5690
|
-
* @name
|
|
5691
|
-
* @summary
|
|
5692
|
-
* @request GET:/market-
|
|
5618
|
+
* @description Retrieves all symbols available in the market data
|
|
5619
|
+
* @tags PreIPOCompanies
|
|
5620
|
+
* @name MonarkAllAvailableSymbols
|
|
5621
|
+
* @summary Retrieves all symbols available in the market data
|
|
5622
|
+
* @request GET:/ipos/market-data/symbols
|
|
5693
5623
|
* @secure
|
|
5694
5624
|
*/
|
|
5695
|
-
|
|
5696
|
-
/** Search string */
|
|
5697
|
-
search?: string;
|
|
5698
|
-
/** Search field */
|
|
5699
|
-
field?: InsightSearchLocodeDataParamsFieldEnum;
|
|
5700
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchLocodeDataResponse, HandleError>>;
|
|
5625
|
+
monarkAllAvailableSymbols(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5701
5626
|
/**
|
|
5702
|
-
* @description
|
|
5703
|
-
* @tags
|
|
5704
|
-
* @name
|
|
5705
|
-
* @summary
|
|
5706
|
-
* @request GET:/
|
|
5627
|
+
* @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
|
|
5628
|
+
* @tags PreIPOCompanies
|
|
5629
|
+
* @name GetPreIpoCompanies
|
|
5630
|
+
* @summary get pre ipo companies
|
|
5631
|
+
* @request GET:/ipos/pre-ipo-companies
|
|
5707
5632
|
* @secure
|
|
5708
5633
|
*/
|
|
5709
|
-
|
|
5710
|
-
|
|
5711
|
-
|
|
5712
|
-
|
|
5713
|
-
|
|
5714
|
-
|
|
5715
|
-
|
|
5716
|
-
|
|
5717
|
-
|
|
5718
|
-
|
|
5719
|
-
|
|
5720
|
-
|
|
5721
|
-
|
|
5722
|
-
|
|
5723
|
-
|
|
5724
|
-
|
|
5725
|
-
|
|
5726
|
-
|
|
5727
|
-
|
|
5728
|
-
|
|
5729
|
-
|
|
5730
|
-
|
|
5731
|
-
|
|
5732
|
-
|
|
5733
|
-
|
|
5734
|
-
|
|
5735
|
-
*/
|
|
5736
|
-
removeMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5634
|
+
getPreIpoCompanies(query: {
|
|
5635
|
+
/** search by company name */
|
|
5636
|
+
name?: string;
|
|
5637
|
+
/** search by categories */
|
|
5638
|
+
categories?: string;
|
|
5639
|
+
/** search by listing type */
|
|
5640
|
+
listing_type?: string;
|
|
5641
|
+
/** filter by active status */
|
|
5642
|
+
is_active?: InsightGetPreIpoCompaniesParamsIsActiveEnum;
|
|
5643
|
+
/** filter by minimum last valuation */
|
|
5644
|
+
min_last_valuation?: number;
|
|
5645
|
+
/** filter by maximum last valuation */
|
|
5646
|
+
max_last_valuation?: number;
|
|
5647
|
+
/** filter by minimum total funding */
|
|
5648
|
+
min_total_funding?: number;
|
|
5649
|
+
/** filter by maximum total funding */
|
|
5650
|
+
max_total_funding?: number;
|
|
5651
|
+
/** how many records to return. Max value is 50 */
|
|
5652
|
+
limit: number;
|
|
5653
|
+
/** how many records to skip */
|
|
5654
|
+
offset: number;
|
|
5655
|
+
/** sort field */
|
|
5656
|
+
order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
|
|
5657
|
+
/** sort direction */
|
|
5658
|
+
order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
|
|
5659
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
|
|
5737
5660
|
/**
|
|
5738
|
-
* @description
|
|
5739
|
-
* @tags
|
|
5740
|
-
* @name
|
|
5741
|
-
* @summary
|
|
5742
|
-
* @request GET:/
|
|
5661
|
+
* @description get pre ipo company by id
|
|
5662
|
+
* @tags PreIPOCompanies
|
|
5663
|
+
* @name GetPreIpoCompaniesById
|
|
5664
|
+
* @summary get pre ipo company by id
|
|
5665
|
+
* @request GET:/ipos/pre-ipo-companies/{id}
|
|
5666
|
+
* @originalName getPreIpoCompanies
|
|
5667
|
+
* @duplicate
|
|
5743
5668
|
* @secure
|
|
5744
5669
|
*/
|
|
5745
|
-
|
|
5746
|
-
/** Market codes, comma separated */
|
|
5747
|
-
market?: string;
|
|
5748
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError>>;
|
|
5670
|
+
getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
|
|
5749
5671
|
/**
|
|
5750
|
-
* @description
|
|
5751
|
-
* @tags
|
|
5752
|
-
* @name
|
|
5753
|
-
* @summary
|
|
5754
|
-
* @request
|
|
5672
|
+
* @description get pre ipo company funding rounds
|
|
5673
|
+
* @tags PreIPOCompanies
|
|
5674
|
+
* @name GetPreIpoCompanyFundingRounds
|
|
5675
|
+
* @summary get pre ipo company funding rounds
|
|
5676
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds
|
|
5755
5677
|
* @secure
|
|
5756
5678
|
*/
|
|
5757
|
-
|
|
5679
|
+
getPreIpoCompanyFundingRounds(query: {
|
|
5680
|
+
/** company id */
|
|
5681
|
+
pre_ipo_company_id?: string;
|
|
5682
|
+
/** search by round name */
|
|
5683
|
+
round_name?: string;
|
|
5684
|
+
/** how many records to return. Max value is 50 */
|
|
5685
|
+
limit: number;
|
|
5686
|
+
/** how many records to skip */
|
|
5687
|
+
offset: number;
|
|
5688
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
|
|
5758
5689
|
/**
|
|
5759
|
-
* @description
|
|
5760
|
-
* @tags
|
|
5761
|
-
* @name
|
|
5762
|
-
* @summary
|
|
5763
|
-
* @request GET:/
|
|
5690
|
+
* @description get pre ipo company funding round by id
|
|
5691
|
+
* @tags PreIPOCompanies
|
|
5692
|
+
* @name GetPreIpoCompanyFundingRoundsById
|
|
5693
|
+
* @summary get pre ipo company funding round by id
|
|
5694
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds/{id}
|
|
5695
|
+
* @originalName getPreIpoCompanyFundingRounds
|
|
5696
|
+
* @duplicate
|
|
5764
5697
|
* @secure
|
|
5765
5698
|
*/
|
|
5766
|
-
|
|
5699
|
+
getPreIpoCompanyFundingRoundsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyFundingRound, HandleError>>;
|
|
5767
5700
|
/**
|
|
5768
|
-
* @description
|
|
5769
|
-
* @tags
|
|
5770
|
-
* @name
|
|
5771
|
-
* @summary
|
|
5772
|
-
* @request
|
|
5701
|
+
* @description get pre ipo company investments
|
|
5702
|
+
* @tags PreIPOCompanies
|
|
5703
|
+
* @name GetPreIpoCompanyInvestments
|
|
5704
|
+
* @summary get pre ipo company investments
|
|
5705
|
+
* @request GET:/ipos/pre-ipo-company-investments
|
|
5773
5706
|
* @secure
|
|
5774
5707
|
*/
|
|
5775
|
-
|
|
5708
|
+
getPreIpoCompanyInvestments(query: {
|
|
5709
|
+
/** company id */
|
|
5710
|
+
pre_ipo_company_id?: string;
|
|
5711
|
+
/** company name */
|
|
5712
|
+
company_name?: string;
|
|
5713
|
+
/** how many records to return. Max value is 50 */
|
|
5714
|
+
limit: number;
|
|
5715
|
+
/** how many records to skip */
|
|
5716
|
+
offset: number;
|
|
5717
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
|
|
5776
5718
|
/**
|
|
5777
|
-
* @description
|
|
5778
|
-
* @tags
|
|
5779
|
-
* @name
|
|
5780
|
-
* @summary
|
|
5781
|
-
* @request GET:/
|
|
5719
|
+
* @description get pre ipo company investment by id
|
|
5720
|
+
* @tags PreIPOCompanies
|
|
5721
|
+
* @name GetPreIpoCompanyInvestmentsById
|
|
5722
|
+
* @summary get pre ipo company investment by id
|
|
5723
|
+
* @request GET:/ipos/pre-ipo-company-investments/{id}
|
|
5724
|
+
* @originalName getPreIpoCompanyInvestments
|
|
5725
|
+
* @duplicate
|
|
5782
5726
|
* @secure
|
|
5783
5727
|
*/
|
|
5784
|
-
|
|
5785
|
-
/** Market */
|
|
5786
|
-
market: string;
|
|
5787
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
5788
|
-
}
|
|
5789
|
-
export class News<HandleError extends boolean = boolean> {
|
|
5790
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5791
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5728
|
+
getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
|
|
5792
5729
|
/**
|
|
5793
|
-
* @description
|
|
5794
|
-
* @tags
|
|
5795
|
-
* @name
|
|
5796
|
-
* @summary
|
|
5797
|
-
* @request
|
|
5730
|
+
* @description get pre ipo company news
|
|
5731
|
+
* @tags PreIPOCompanies
|
|
5732
|
+
* @name GetPreIpoCompanyNews
|
|
5733
|
+
* @summary get pre ipo company news
|
|
5734
|
+
* @request GET:/ipos/pre-ipo-company-news
|
|
5798
5735
|
* @secure
|
|
5799
5736
|
*/
|
|
5800
|
-
|
|
5737
|
+
getPreIpoCompanyNews(query: {
|
|
5738
|
+
/** company id */
|
|
5739
|
+
pre_ipo_company_id?: string;
|
|
5740
|
+
/** search by headline */
|
|
5741
|
+
headline?: string;
|
|
5742
|
+
/** how many records to return. Max value is 50 */
|
|
5743
|
+
limit: number;
|
|
5744
|
+
/** how many records to skip */
|
|
5745
|
+
offset: number;
|
|
5746
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
|
|
5801
5747
|
/**
|
|
5802
|
-
* @description
|
|
5803
|
-
* @tags
|
|
5804
|
-
* @name
|
|
5805
|
-
* @summary
|
|
5806
|
-
* @request
|
|
5748
|
+
* @description get pre ipo company news by id
|
|
5749
|
+
* @tags PreIPOCompanies
|
|
5750
|
+
* @name GetPreIpoCompanyNewsById
|
|
5751
|
+
* @summary get pre ipo company news by id
|
|
5752
|
+
* @request GET:/ipos/pre-ipo-company-news/{id}
|
|
5753
|
+
* @originalName getPreIpoCompanyNews
|
|
5754
|
+
* @duplicate
|
|
5807
5755
|
* @secure
|
|
5808
5756
|
*/
|
|
5809
|
-
|
|
5757
|
+
getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
|
|
5810
5758
|
/**
|
|
5811
|
-
* @description
|
|
5812
|
-
* @tags
|
|
5813
|
-
* @name
|
|
5814
|
-
* @summary
|
|
5815
|
-
* @request GET:/
|
|
5759
|
+
* @description get pre ipo company research documents
|
|
5760
|
+
* @tags PreIPOCompanies
|
|
5761
|
+
* @name GetPreIpoCompanyResearchDocuments
|
|
5762
|
+
* @summary get pre ipo company research documents
|
|
5763
|
+
* @request GET:/ipos/pre-ipo-company-research-documents
|
|
5816
5764
|
* @secure
|
|
5817
5765
|
*/
|
|
5818
|
-
|
|
5819
|
-
/**
|
|
5766
|
+
getPreIpoCompanyResearchDocuments(query: {
|
|
5767
|
+
/** company id */
|
|
5768
|
+
pre_ipo_company_id?: string;
|
|
5769
|
+
/** search by title */
|
|
5770
|
+
title?: string;
|
|
5771
|
+
/** how many records to return. Max value is 50 */
|
|
5820
5772
|
limit: number;
|
|
5821
|
-
/**
|
|
5773
|
+
/** how many records to skip */
|
|
5822
5774
|
offset: number;
|
|
5823
|
-
/**
|
|
5824
|
-
|
|
5825
|
-
/**
|
|
5826
|
-
|
|
5827
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5775
|
+
/** search by research type */
|
|
5776
|
+
research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
|
|
5777
|
+
/** search by relation */
|
|
5778
|
+
relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
|
|
5779
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
|
|
5828
5780
|
/**
|
|
5829
|
-
* @description
|
|
5830
|
-
* @tags
|
|
5831
|
-
* @name
|
|
5832
|
-
* @summary
|
|
5833
|
-
* @request
|
|
5781
|
+
* @description get pre ipo company research document by id
|
|
5782
|
+
* @tags PreIPOCompanies
|
|
5783
|
+
* @name GetPreIpoCompanyResearchDocumentsById
|
|
5784
|
+
* @summary get pre ipo company research document by id
|
|
5785
|
+
* @request GET:/ipos/pre-ipo-company-research-documents/{id}
|
|
5786
|
+
* @originalName getPreIpoCompanyResearchDocuments
|
|
5787
|
+
* @duplicate
|
|
5834
5788
|
* @secure
|
|
5835
5789
|
*/
|
|
5836
|
-
|
|
5790
|
+
getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
|
|
5837
5791
|
/**
|
|
5838
|
-
* @description
|
|
5839
|
-
* @tags
|
|
5840
|
-
* @name
|
|
5841
|
-
* @summary
|
|
5842
|
-
* @request
|
|
5792
|
+
* @description get pre ipo company spvs with investor id
|
|
5793
|
+
* @tags PreIPOCompanies
|
|
5794
|
+
* @name GetInvestor
|
|
5795
|
+
* @summary get pre ipo company spvs with investor id
|
|
5796
|
+
* @request GET:/ipos/pre-ipo-company-spv/investor/{investor_id}
|
|
5843
5797
|
* @secure
|
|
5844
5798
|
*/
|
|
5845
|
-
|
|
5799
|
+
getInvestor(investorId: string, query: {
|
|
5800
|
+
/** search by monark stage */
|
|
5801
|
+
monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
|
|
5802
|
+
/** Optional param to filter returned spv's based on the exemptions claimed */
|
|
5803
|
+
exemptions_claimed?: string[];
|
|
5804
|
+
/** Optional param to filter returned spv's based on the name */
|
|
5805
|
+
name_filter?: string;
|
|
5806
|
+
/** investment id */
|
|
5807
|
+
pre_ipo_company_id?: string;
|
|
5808
|
+
/** investment id */
|
|
5809
|
+
pre_ipo_company_investment_id?: string;
|
|
5810
|
+
/** page number */
|
|
5811
|
+
page: number;
|
|
5812
|
+
/** page size */
|
|
5813
|
+
page_size: number;
|
|
5814
|
+
/** sort direction */
|
|
5815
|
+
sort_order?: InsightGetInvestorParamsSortOrderEnum;
|
|
5816
|
+
/** sort field */
|
|
5817
|
+
sort_by?: InsightGetInvestorParamsSortByEnum;
|
|
5818
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
|
|
5846
5819
|
/**
|
|
5847
|
-
* @description
|
|
5848
|
-
* @tags
|
|
5849
|
-
* @name
|
|
5850
|
-
* @summary
|
|
5851
|
-
* @request GET:/
|
|
5852
|
-
* @
|
|
5853
|
-
|
|
5854
|
-
getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
|
|
5855
|
-
/**
|
|
5856
|
-
* @description Set featured articles
|
|
5857
|
-
* @tags News
|
|
5858
|
-
* @name SetFeaturedArticles
|
|
5859
|
-
* @summary Set featured articles
|
|
5860
|
-
* @request POST:/news/featured-articles/set
|
|
5820
|
+
* @description get pre ipo company spv by id with investor id
|
|
5821
|
+
* @tags PreIPOCompanies
|
|
5822
|
+
* @name GetInvestorByIdAndInvestorId
|
|
5823
|
+
* @summary get pre ipo company spv by id with investor id
|
|
5824
|
+
* @request GET:/ipos/pre-ipo-company-spv/{id}/investor/{investor_id}
|
|
5825
|
+
* @originalName getInvestor
|
|
5826
|
+
* @duplicate
|
|
5861
5827
|
* @secure
|
|
5862
5828
|
*/
|
|
5863
|
-
|
|
5829
|
+
getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
|
|
5830
|
+
/** default is false, if true documents will be included in the response */
|
|
5831
|
+
include_documents?: boolean;
|
|
5832
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
|
|
5864
5833
|
/**
|
|
5865
|
-
* @description
|
|
5866
|
-
* @tags
|
|
5867
|
-
* @name
|
|
5868
|
-
* @summary
|
|
5869
|
-
* @request GET:/
|
|
5834
|
+
* @description get pre ipo company spvs
|
|
5835
|
+
* @tags PreIPOCompanies
|
|
5836
|
+
* @name GetPreIpoCompanySpvs
|
|
5837
|
+
* @summary get pre ipo company spvs
|
|
5838
|
+
* @request GET:/ipos/pre-ipo-company-spvs
|
|
5870
5839
|
* @secure
|
|
5871
5840
|
*/
|
|
5872
|
-
|
|
5841
|
+
getPreIpoCompanySpvs(query: {
|
|
5842
|
+
/** company id */
|
|
5843
|
+
pre_ipo_company_id?: string;
|
|
5844
|
+
/** investment id */
|
|
5845
|
+
investment_id?: string;
|
|
5846
|
+
/** search by name */
|
|
5847
|
+
name?: string;
|
|
5848
|
+
/** search by company name */
|
|
5849
|
+
company_name?: string;
|
|
5850
|
+
/** how many records to return. Max value is 50 */
|
|
5851
|
+
limit: number;
|
|
5852
|
+
/** how many records to skip */
|
|
5853
|
+
offset: number;
|
|
5854
|
+
/** search by monark stage */
|
|
5855
|
+
monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
|
|
5856
|
+
/** sort direction */
|
|
5857
|
+
direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
|
|
5858
|
+
/** sort field */
|
|
5859
|
+
field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
|
|
5860
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
|
|
5873
5861
|
/**
|
|
5874
|
-
* @description
|
|
5875
|
-
* @tags
|
|
5876
|
-
* @name
|
|
5877
|
-
* @summary
|
|
5878
|
-
* @request
|
|
5862
|
+
* @description get pre ipo company spv by id
|
|
5863
|
+
* @tags PreIPOCompanies
|
|
5864
|
+
* @name GetPreIpoCompanySpvsById
|
|
5865
|
+
* @summary get pre ipo company spv by id
|
|
5866
|
+
* @request GET:/ipos/pre-ipo-company-spvs/{id}
|
|
5867
|
+
* @originalName getPreIpoCompanySpvs
|
|
5868
|
+
* @duplicate
|
|
5879
5869
|
* @secure
|
|
5880
5870
|
*/
|
|
5881
|
-
|
|
5871
|
+
getPreIpoCompanySpvsById(id: string, query?: {
|
|
5872
|
+
/** default is false, if true documents will be included in the response */
|
|
5873
|
+
include_documents?: boolean;
|
|
5874
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
|
|
5875
|
+
}
|
|
5876
|
+
export class Ipos<HandleError extends boolean = boolean> {
|
|
5877
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5878
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5882
5879
|
/**
|
|
5883
|
-
* @description
|
|
5884
|
-
* @tags
|
|
5885
|
-
* @name
|
|
5886
|
-
* @summary
|
|
5887
|
-
* @request POST:/
|
|
5880
|
+
* @description get recent ipos info
|
|
5881
|
+
* @tags Ipos
|
|
5882
|
+
* @name PostRecent
|
|
5883
|
+
* @summary get recent ipos info
|
|
5884
|
+
* @request POST:/ipos/recent
|
|
5888
5885
|
* @secure
|
|
5889
5886
|
*/
|
|
5890
|
-
|
|
5887
|
+
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5891
5888
|
/**
|
|
5892
|
-
* @description
|
|
5893
|
-
* @tags
|
|
5894
|
-
* @name
|
|
5895
|
-
* @summary
|
|
5896
|
-
* @request GET:/
|
|
5889
|
+
* @description get upcoming ipos info
|
|
5890
|
+
* @tags Ipos
|
|
5891
|
+
* @name GetUpcoming
|
|
5892
|
+
* @summary get upcoming ipos info
|
|
5893
|
+
* @request GET:/ipos/upcoming
|
|
5897
5894
|
* @secure
|
|
5898
5895
|
*/
|
|
5899
|
-
|
|
5900
|
-
/** Start date */
|
|
5901
|
-
start_date?: string;
|
|
5902
|
-
/** End date */
|
|
5903
|
-
end_date?: string;
|
|
5904
|
-
/** Symbol */
|
|
5905
|
-
symbol?: string;
|
|
5896
|
+
getUpcoming(query: {
|
|
5906
5897
|
/** how many records to return. Max value is 50 */
|
|
5907
5898
|
limit: number;
|
|
5908
5899
|
/** how many records to skip */
|
|
5909
5900
|
offset: number;
|
|
5910
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5911
|
-
/**
|
|
5912
|
-
* @description Returns available stocks in DB
|
|
5913
|
-
* @tags News
|
|
5914
|
-
* @name NewsAvailableStocks
|
|
5915
|
-
* @summary Get available stocks in DB (for filters)
|
|
5916
|
-
* @request GET:/news/symbols
|
|
5917
|
-
* @secure
|
|
5918
|
-
*/
|
|
5919
|
-
newsAvailableStocks(query?: {
|
|
5920
|
-
/** Limit */
|
|
5921
|
-
limit?: number;
|
|
5922
|
-
/** Offset */
|
|
5923
|
-
offset?: number;
|
|
5924
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5901
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5925
5902
|
/**
|
|
5926
|
-
* @description
|
|
5927
|
-
* @tags
|
|
5928
|
-
* @name
|
|
5929
|
-
* @summary
|
|
5930
|
-
* @request
|
|
5903
|
+
* @description get ipo info by symbol
|
|
5904
|
+
* @tags Ipos
|
|
5905
|
+
* @name GetIpos
|
|
5906
|
+
* @summary get ipo info by symbol
|
|
5907
|
+
* @request GET:/ipos/{symbol}
|
|
5931
5908
|
* @secure
|
|
5932
5909
|
*/
|
|
5933
|
-
|
|
5910
|
+
getIpos(symbol: string, query?: {
|
|
5911
|
+
/** load quotes */
|
|
5912
|
+
load_quotes?: boolean;
|
|
5913
|
+
/** statuses */
|
|
5914
|
+
statuses?: string[];
|
|
5915
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
|
|
5934
5916
|
}
|
|
5935
|
-
export class
|
|
5917
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
5936
5918
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5937
5919
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5938
5920
|
/**
|
|
5939
|
-
* @description Returns
|
|
5940
|
-
* @tags
|
|
5941
|
-
* @name
|
|
5942
|
-
* @summary
|
|
5943
|
-
* @request POST:/
|
|
5921
|
+
* @description Returns converted logo for crypto symbol
|
|
5922
|
+
* @tags Logos
|
|
5923
|
+
* @name LogosConvertedCryptoSymbolLogo
|
|
5924
|
+
* @summary Get converted logo for crypto symbol
|
|
5925
|
+
* @request POST:/logos/converted-crypto-symbol-logo
|
|
5944
5926
|
* @secure
|
|
5945
5927
|
*/
|
|
5946
|
-
|
|
5928
|
+
logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5947
5929
|
/**
|
|
5948
|
-
* @description Returns
|
|
5949
|
-
* @tags
|
|
5950
|
-
* @name
|
|
5951
|
-
* @summary
|
|
5952
|
-
* @request POST:/
|
|
5930
|
+
* @description Returns converted logo for symbol
|
|
5931
|
+
* @tags Logos
|
|
5932
|
+
* @name LogosConvertedSymbolLogo
|
|
5933
|
+
* @summary Get converted logo for symbol
|
|
5934
|
+
* @request POST:/logos/converted-symbol-logo
|
|
5953
5935
|
* @secure
|
|
5954
5936
|
*/
|
|
5955
|
-
|
|
5956
|
-
}
|
|
5957
|
-
export class Ownerships<HandleError extends boolean = boolean> {
|
|
5958
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5959
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5937
|
+
logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5960
5938
|
/**
|
|
5961
|
-
* @description
|
|
5962
|
-
* @tags
|
|
5963
|
-
* @name
|
|
5964
|
-
* @summary
|
|
5965
|
-
* @request
|
|
5939
|
+
* @description Returns logo for crypto symbol
|
|
5940
|
+
* @tags Logos
|
|
5941
|
+
* @name LogosCryptoSymbolLogo
|
|
5942
|
+
* @summary Get logo for crypto symbol
|
|
5943
|
+
* @request GET:/logos/crypto-symbol-logo
|
|
5966
5944
|
* @secure
|
|
5967
5945
|
*/
|
|
5968
|
-
|
|
5946
|
+
logosCryptoSymbolLogo(query: {
|
|
5947
|
+
/** Company symbol */
|
|
5948
|
+
symbol: string;
|
|
5949
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
|
|
5969
5950
|
/**
|
|
5970
|
-
* @description
|
|
5971
|
-
* @tags
|
|
5972
|
-
* @name
|
|
5973
|
-
* @summary
|
|
5974
|
-
* @request
|
|
5951
|
+
* @description Returns direct logo for crypto symbol
|
|
5952
|
+
* @tags Logos
|
|
5953
|
+
* @name LogosDirectCryptoSymbolLogo
|
|
5954
|
+
* @summary Get direct logo for crypto symbol
|
|
5955
|
+
* @request GET:/logos/direct-crypto-symbol-logo
|
|
5975
5956
|
* @secure
|
|
5976
5957
|
*/
|
|
5977
|
-
|
|
5978
|
-
|
|
5979
|
-
|
|
5980
|
-
|
|
5981
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5958
|
+
logosDirectCryptoSymbolLogo(query: {
|
|
5959
|
+
/** Company symbol */
|
|
5960
|
+
symbol: string;
|
|
5961
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5982
5962
|
/**
|
|
5983
|
-
* @description Returns
|
|
5984
|
-
* @tags
|
|
5985
|
-
* @name
|
|
5986
|
-
* @summary Get
|
|
5987
|
-
* @request
|
|
5963
|
+
* @description Returns direct logo for symbol
|
|
5964
|
+
* @tags Logos
|
|
5965
|
+
* @name LogosDirectSymbolLogo
|
|
5966
|
+
* @summary Get direct logo for symbol
|
|
5967
|
+
* @request GET:/logos/direct-symbol-logo
|
|
5988
5968
|
* @secure
|
|
5989
5969
|
*/
|
|
5990
|
-
|
|
5970
|
+
logosDirectSymbolLogo(query: {
|
|
5971
|
+
/** Company symbol */
|
|
5972
|
+
symbol: string;
|
|
5973
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5991
5974
|
/**
|
|
5992
|
-
* @description Returns
|
|
5993
|
-
* @tags
|
|
5994
|
-
* @name
|
|
5995
|
-
* @summary Get
|
|
5996
|
-
* @request POST:/
|
|
5975
|
+
* @description Returns logos for multiple symbols
|
|
5976
|
+
* @tags Logos
|
|
5977
|
+
* @name LogosMultipleCryptoSymbolLogo
|
|
5978
|
+
* @summary Get logos for multiple symbols
|
|
5979
|
+
* @request POST:/logos/multiple-crypto-symbol-logo
|
|
5997
5980
|
* @secure
|
|
5998
5981
|
*/
|
|
5999
|
-
|
|
5982
|
+
logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
|
|
6000
5983
|
/**
|
|
6001
|
-
* @description Returns
|
|
6002
|
-
* @tags
|
|
6003
|
-
* @name
|
|
6004
|
-
* @summary Get
|
|
6005
|
-
* @request POST:/
|
|
5984
|
+
* @description Returns logos for multiple symbol
|
|
5985
|
+
* @tags Logos
|
|
5986
|
+
* @name LogosMultipleSymbolLogos
|
|
5987
|
+
* @summary Get logos for multiple symbols
|
|
5988
|
+
* @request POST:/logos/multiple-symbol-logos
|
|
6006
5989
|
* @secure
|
|
6007
5990
|
*/
|
|
6008
|
-
|
|
5991
|
+
logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
|
|
6009
5992
|
/**
|
|
6010
|
-
* @description Returns
|
|
6011
|
-
* @tags
|
|
6012
|
-
* @name
|
|
6013
|
-
* @summary Get
|
|
6014
|
-
* @request
|
|
5993
|
+
* @description Returns links of socials logos for symbol
|
|
5994
|
+
* @tags Logos
|
|
5995
|
+
* @name LogosSocialSymbolLogos
|
|
5996
|
+
* @summary Get social logos for symbol
|
|
5997
|
+
* @request GET:/logos/social-symbol-logos
|
|
6015
5998
|
* @secure
|
|
6016
5999
|
*/
|
|
6017
|
-
|
|
6018
|
-
|
|
6019
|
-
|
|
6020
|
-
|
|
6021
|
-
* @name PassportNewsFeed
|
|
6022
|
-
* @summary Get news feed
|
|
6023
|
-
* @request POST:/passport/newsfeed
|
|
6024
|
-
* @secure
|
|
6025
|
-
*/
|
|
6026
|
-
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
|
|
6000
|
+
logosSocialSymbolLogos(query: {
|
|
6001
|
+
/** Company symbol */
|
|
6002
|
+
symbol: string;
|
|
6003
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
|
|
6027
6004
|
/**
|
|
6028
|
-
* @description Returns
|
|
6029
|
-
* @tags
|
|
6030
|
-
* @name
|
|
6031
|
-
* @summary
|
|
6032
|
-
* @request
|
|
6005
|
+
* @description Returns logos for company symbol
|
|
6006
|
+
* @tags Logos
|
|
6007
|
+
* @name LogosSymbolLogos
|
|
6008
|
+
* @summary Get symbol logos
|
|
6009
|
+
* @request GET:/logos/symbol-logos
|
|
6033
6010
|
* @secure
|
|
6034
6011
|
*/
|
|
6035
|
-
|
|
6012
|
+
logosSymbolLogos(query: {
|
|
6013
|
+
/** Company symbol */
|
|
6014
|
+
symbol: string;
|
|
6015
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
|
|
6036
6016
|
}
|
|
6037
|
-
export class
|
|
6017
|
+
export class MarketDates<HandleError extends boolean = boolean> {
|
|
6038
6018
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6039
6019
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6040
6020
|
/**
|
|
6041
|
-
* @description
|
|
6042
|
-
* @tags
|
|
6043
|
-
* @name
|
|
6044
|
-
* @summary
|
|
6045
|
-
* @request
|
|
6021
|
+
* @description Create or update market date
|
|
6022
|
+
* @tags MarketDates
|
|
6023
|
+
* @name CreateOrUpdateMarketDate
|
|
6024
|
+
* @summary Create or update market date
|
|
6025
|
+
* @request POST:/market-dates
|
|
6046
6026
|
* @secure
|
|
6047
6027
|
*/
|
|
6048
|
-
|
|
6049
|
-
/** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
6050
|
-
from?: string;
|
|
6051
|
-
/** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
6052
|
-
to?: string;
|
|
6053
|
-
/** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
|
|
6054
|
-
interval?: string;
|
|
6055
|
-
/** Limit the number of OHLC data points returned. Default is 100. */
|
|
6056
|
-
limit?: number;
|
|
6057
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
|
|
6058
|
-
close?: number;
|
|
6059
|
-
high?: number;
|
|
6060
|
-
low?: number;
|
|
6061
|
-
open?: number;
|
|
6062
|
-
time?: string;
|
|
6063
|
-
volume?: number;
|
|
6064
|
-
}[], HandleError>>;
|
|
6028
|
+
createOrUpdateMarketDate(market: InsightMarketDates[], config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate[], HandleError>>;
|
|
6065
6029
|
/**
|
|
6066
|
-
* @description
|
|
6067
|
-
* @tags
|
|
6068
|
-
* @name
|
|
6069
|
-
* @summary
|
|
6070
|
-
* @request
|
|
6030
|
+
* @description Remove market date
|
|
6031
|
+
* @tags MarketDates
|
|
6032
|
+
* @name RemoveMarketDate
|
|
6033
|
+
* @summary Remove market date
|
|
6034
|
+
* @request DELETE:/market-dates
|
|
6071
6035
|
* @secure
|
|
6072
6036
|
*/
|
|
6073
|
-
|
|
6037
|
+
removeMarketDate(input: InsightRemoveMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6074
6038
|
/**
|
|
6075
|
-
* @description
|
|
6076
|
-
* @tags
|
|
6077
|
-
* @name
|
|
6078
|
-
* @summary
|
|
6079
|
-
* @request
|
|
6039
|
+
* @description Get market dates history
|
|
6040
|
+
* @tags MarketDates
|
|
6041
|
+
* @name GetMarketDatesHistory
|
|
6042
|
+
* @summary Get market dates history
|
|
6043
|
+
* @request POST:/market-dates/history
|
|
6080
6044
|
* @secure
|
|
6081
6045
|
*/
|
|
6082
|
-
|
|
6083
|
-
/** search by company name */
|
|
6084
|
-
name?: string;
|
|
6085
|
-
/** search by categories */
|
|
6086
|
-
categories?: string;
|
|
6087
|
-
/** search by listing type */
|
|
6088
|
-
listing_type?: string;
|
|
6089
|
-
/** filter by active status */
|
|
6090
|
-
is_active?: InsightGetPreIpoCompaniesParamsIsActiveEnum;
|
|
6091
|
-
/** filter by minimum last valuation */
|
|
6092
|
-
min_last_valuation?: number;
|
|
6093
|
-
/** filter by maximum last valuation */
|
|
6094
|
-
max_last_valuation?: number;
|
|
6095
|
-
/** filter by minimum total funding */
|
|
6096
|
-
min_total_funding?: number;
|
|
6097
|
-
/** filter by maximum total funding */
|
|
6098
|
-
max_total_funding?: number;
|
|
6099
|
-
/** how many records to return. Max value is 50 */
|
|
6100
|
-
limit: number;
|
|
6101
|
-
/** how many records to skip */
|
|
6102
|
-
offset: number;
|
|
6103
|
-
/** sort field */
|
|
6104
|
-
order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
|
|
6105
|
-
/** sort direction */
|
|
6106
|
-
order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
|
|
6107
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
|
|
6046
|
+
getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
|
|
6108
6047
|
/**
|
|
6109
|
-
* @description
|
|
6110
|
-
* @tags
|
|
6111
|
-
* @name
|
|
6112
|
-
* @summary
|
|
6113
|
-
* @request GET:/
|
|
6114
|
-
* @originalName getPreIpoCompanies
|
|
6115
|
-
* @duplicate
|
|
6048
|
+
* @description Search locode data by search string and field
|
|
6049
|
+
* @tags MarketDates
|
|
6050
|
+
* @name SearchLocodeData
|
|
6051
|
+
* @summary Search locode data
|
|
6052
|
+
* @request GET:/market-dates/locode
|
|
6116
6053
|
* @secure
|
|
6117
6054
|
*/
|
|
6118
|
-
|
|
6055
|
+
searchLocodeData(query?: {
|
|
6056
|
+
/** Search string */
|
|
6057
|
+
search?: string;
|
|
6058
|
+
/** Search field */
|
|
6059
|
+
field?: InsightSearchLocodeDataParamsFieldEnum;
|
|
6060
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchLocodeDataResponse, HandleError>>;
|
|
6119
6061
|
/**
|
|
6120
|
-
* @description
|
|
6121
|
-
* @tags
|
|
6122
|
-
* @name
|
|
6123
|
-
* @summary
|
|
6124
|
-
* @request GET:/
|
|
6062
|
+
* @description Get markets
|
|
6063
|
+
* @tags MarketDates
|
|
6064
|
+
* @name GetMarkets
|
|
6065
|
+
* @summary Get markets
|
|
6066
|
+
* @request GET:/market-dates/markets
|
|
6125
6067
|
* @secure
|
|
6126
6068
|
*/
|
|
6127
|
-
|
|
6128
|
-
/** company id */
|
|
6129
|
-
pre_ipo_company_id?: string;
|
|
6130
|
-
/** search by round name */
|
|
6131
|
-
round_name?: string;
|
|
6132
|
-
/** how many records to return. Max value is 50 */
|
|
6133
|
-
limit: number;
|
|
6134
|
-
/** how many records to skip */
|
|
6135
|
-
offset: number;
|
|
6136
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
|
|
6069
|
+
getMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketsResponse, HandleError>>;
|
|
6137
6070
|
/**
|
|
6138
|
-
* @description
|
|
6139
|
-
* @tags
|
|
6140
|
-
* @name
|
|
6141
|
-
* @summary
|
|
6142
|
-
* @request
|
|
6143
|
-
* @originalName getPreIpoCompanyFundingRounds
|
|
6144
|
-
* @duplicate
|
|
6071
|
+
* @description Create or update market
|
|
6072
|
+
* @tags MarketDates
|
|
6073
|
+
* @name CreateOrUpdateMarket
|
|
6074
|
+
* @summary Create or update market
|
|
6075
|
+
* @request POST:/market-dates/markets
|
|
6145
6076
|
* @secure
|
|
6146
6077
|
*/
|
|
6147
|
-
|
|
6078
|
+
createOrUpdateMarket(market: InsightCreateOrUpdateMarketRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
|
|
6148
6079
|
/**
|
|
6149
|
-
* @description
|
|
6150
|
-
* @tags
|
|
6151
|
-
* @name
|
|
6152
|
-
* @summary
|
|
6153
|
-
* @request GET:/
|
|
6080
|
+
* @description Get market
|
|
6081
|
+
* @tags MarketDates
|
|
6082
|
+
* @name GetMarket
|
|
6083
|
+
* @summary Get market
|
|
6084
|
+
* @request GET:/market-dates/markets/{market}
|
|
6154
6085
|
* @secure
|
|
6155
6086
|
*/
|
|
6156
|
-
|
|
6157
|
-
/** company id */
|
|
6158
|
-
pre_ipo_company_id?: string;
|
|
6159
|
-
/** company name */
|
|
6160
|
-
company_name?: string;
|
|
6161
|
-
/** how many records to return. Max value is 50 */
|
|
6162
|
-
limit: number;
|
|
6163
|
-
/** how many records to skip */
|
|
6164
|
-
offset: number;
|
|
6165
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
|
|
6087
|
+
getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketWithSchedule, HandleError>>;
|
|
6166
6088
|
/**
|
|
6167
|
-
* @description
|
|
6168
|
-
* @tags
|
|
6169
|
-
* @name
|
|
6170
|
-
* @summary
|
|
6171
|
-
* @request
|
|
6172
|
-
* @originalName getPreIpoCompanyInvestments
|
|
6173
|
-
* @duplicate
|
|
6089
|
+
* @description Remove market
|
|
6090
|
+
* @tags MarketDates
|
|
6091
|
+
* @name RemoveMarket
|
|
6092
|
+
* @summary Remove market
|
|
6093
|
+
* @request DELETE:/market-dates/markets/{market}
|
|
6174
6094
|
* @secure
|
|
6175
6095
|
*/
|
|
6176
|
-
|
|
6096
|
+
removeMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6177
6097
|
/**
|
|
6178
|
-
* @description
|
|
6179
|
-
* @tags
|
|
6180
|
-
* @name
|
|
6181
|
-
* @summary
|
|
6182
|
-
* @request GET:/
|
|
6098
|
+
* @description Get market schedules
|
|
6099
|
+
* @tags MarketDates
|
|
6100
|
+
* @name GetMarketSchedules
|
|
6101
|
+
* @summary Get market schedules
|
|
6102
|
+
* @request GET:/market-dates/schedule
|
|
6183
6103
|
* @secure
|
|
6184
6104
|
*/
|
|
6185
|
-
|
|
6186
|
-
/**
|
|
6187
|
-
|
|
6188
|
-
|
|
6189
|
-
headline?: string;
|
|
6190
|
-
/** how many records to return. Max value is 50 */
|
|
6191
|
-
limit: number;
|
|
6192
|
-
/** how many records to skip */
|
|
6193
|
-
offset: number;
|
|
6194
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
|
|
6105
|
+
getMarketSchedules(query?: {
|
|
6106
|
+
/** Market codes, comma separated */
|
|
6107
|
+
market?: string;
|
|
6108
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError>>;
|
|
6195
6109
|
/**
|
|
6196
|
-
* @description
|
|
6197
|
-
* @tags
|
|
6198
|
-
* @name
|
|
6199
|
-
* @summary
|
|
6200
|
-
* @request
|
|
6201
|
-
* @originalName getPreIpoCompanyNews
|
|
6202
|
-
* @duplicate
|
|
6110
|
+
* @description CreateOrUpdateMarketSchedule market schedule
|
|
6111
|
+
* @tags MarketDates
|
|
6112
|
+
* @name CreateOrUpdateMarketSchedule
|
|
6113
|
+
* @summary CreateOrUpdateMarketSchedule market schedule
|
|
6114
|
+
* @request POST:/market-dates/schedule
|
|
6203
6115
|
* @secure
|
|
6204
6116
|
*/
|
|
6205
|
-
|
|
6117
|
+
createOrUpdateMarketSchedule(market: InsightCreateOrUpdateMarketScheduleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
|
|
6206
6118
|
/**
|
|
6207
|
-
* @description
|
|
6208
|
-
* @tags
|
|
6209
|
-
* @name
|
|
6210
|
-
* @summary
|
|
6211
|
-
* @request GET:/
|
|
6119
|
+
* @description Get market schedule
|
|
6120
|
+
* @tags MarketDates
|
|
6121
|
+
* @name GetMarketSchedule
|
|
6122
|
+
* @summary Get market schedule
|
|
6123
|
+
* @request GET:/market-dates/schedule/{market}
|
|
6212
6124
|
* @secure
|
|
6213
6125
|
*/
|
|
6214
|
-
|
|
6215
|
-
/** company id */
|
|
6216
|
-
pre_ipo_company_id?: string;
|
|
6217
|
-
/** search by title */
|
|
6218
|
-
title?: string;
|
|
6219
|
-
/** how many records to return. Max value is 50 */
|
|
6220
|
-
limit: number;
|
|
6221
|
-
/** how many records to skip */
|
|
6222
|
-
offset: number;
|
|
6223
|
-
/** search by research type */
|
|
6224
|
-
research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
|
|
6225
|
-
/** search by relation */
|
|
6226
|
-
relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
|
|
6227
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
|
|
6126
|
+
getMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
|
|
6228
6127
|
/**
|
|
6229
|
-
* @description
|
|
6230
|
-
* @tags
|
|
6231
|
-
* @name
|
|
6232
|
-
* @summary
|
|
6233
|
-
* @request
|
|
6234
|
-
* @originalName getPreIpoCompanyResearchDocuments
|
|
6235
|
-
* @duplicate
|
|
6128
|
+
* @description Remove market schedule
|
|
6129
|
+
* @tags MarketDates
|
|
6130
|
+
* @name RemoveMarketSchedule
|
|
6131
|
+
* @summary Remove market schedule
|
|
6132
|
+
* @request DELETE:/market-dates/schedule/{market}
|
|
6236
6133
|
* @secure
|
|
6237
6134
|
*/
|
|
6238
|
-
|
|
6135
|
+
removeMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6239
6136
|
/**
|
|
6240
|
-
* @description
|
|
6241
|
-
* @tags
|
|
6242
|
-
* @name
|
|
6243
|
-
* @summary
|
|
6244
|
-
* @request GET:/
|
|
6137
|
+
* @description Get todays market hours
|
|
6138
|
+
* @tags MarketDates
|
|
6139
|
+
* @name GetTodaysMarketHours
|
|
6140
|
+
* @summary Get todays market hours
|
|
6141
|
+
* @request GET:/market-dates/today
|
|
6245
6142
|
* @secure
|
|
6246
6143
|
*/
|
|
6247
|
-
|
|
6248
|
-
/**
|
|
6249
|
-
|
|
6250
|
-
|
|
6251
|
-
|
|
6252
|
-
|
|
6253
|
-
|
|
6254
|
-
|
|
6255
|
-
pre_ipo_company_id?: string;
|
|
6256
|
-
/** investment id */
|
|
6257
|
-
pre_ipo_company_investment_id?: string;
|
|
6258
|
-
/** page number */
|
|
6259
|
-
page: number;
|
|
6260
|
-
/** page size */
|
|
6261
|
-
page_size: number;
|
|
6262
|
-
/** sort direction */
|
|
6263
|
-
sort_order?: InsightGetInvestorParamsSortOrderEnum;
|
|
6264
|
-
/** sort field */
|
|
6265
|
-
sort_by?: InsightGetInvestorParamsSortByEnum;
|
|
6266
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
|
|
6144
|
+
getTodaysMarketHours(query: {
|
|
6145
|
+
/** Market */
|
|
6146
|
+
market: string;
|
|
6147
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
6148
|
+
}
|
|
6149
|
+
export class News<HandleError extends boolean = boolean> {
|
|
6150
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6151
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6267
6152
|
/**
|
|
6268
|
-
* @description
|
|
6269
|
-
* @tags
|
|
6270
|
-
* @name
|
|
6271
|
-
* @summary
|
|
6272
|
-
* @request
|
|
6273
|
-
* @originalName getInvestor
|
|
6274
|
-
* @duplicate
|
|
6153
|
+
* @description Returns available authors in DB
|
|
6154
|
+
* @tags News
|
|
6155
|
+
* @name NewsAvailableAuthors
|
|
6156
|
+
* @summary Get available authors in DB (for filters)
|
|
6157
|
+
* @request POST:/news/authors
|
|
6275
6158
|
* @secure
|
|
6276
6159
|
*/
|
|
6277
|
-
|
|
6278
|
-
/** default is false, if true documents will be included in the response */
|
|
6279
|
-
include_documents?: boolean;
|
|
6280
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
|
|
6160
|
+
newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6281
6161
|
/**
|
|
6282
|
-
* @description
|
|
6283
|
-
* @tags
|
|
6284
|
-
* @name
|
|
6285
|
-
* @summary
|
|
6286
|
-
* @request
|
|
6162
|
+
* @description Returns available channels in DB
|
|
6163
|
+
* @tags News
|
|
6164
|
+
* @name NewsAvailableChannels
|
|
6165
|
+
* @summary Get available channels in DB (for filters)
|
|
6166
|
+
* @request POST:/news/channels
|
|
6287
6167
|
* @secure
|
|
6288
6168
|
*/
|
|
6289
|
-
|
|
6290
|
-
|
|
6291
|
-
|
|
6292
|
-
|
|
6293
|
-
|
|
6294
|
-
|
|
6295
|
-
|
|
6296
|
-
|
|
6297
|
-
|
|
6298
|
-
|
|
6169
|
+
newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6170
|
+
/**
|
|
6171
|
+
* @description Get featured articles
|
|
6172
|
+
* @tags News
|
|
6173
|
+
* @name GetFeaturedArticles
|
|
6174
|
+
* @summary Get featured articles
|
|
6175
|
+
* @request GET:/news/featured-articles
|
|
6176
|
+
* @secure
|
|
6177
|
+
*/
|
|
6178
|
+
getFeaturedArticles(query: {
|
|
6179
|
+
/** Limit */
|
|
6299
6180
|
limit: number;
|
|
6300
|
-
/**
|
|
6181
|
+
/** Offset */
|
|
6301
6182
|
offset: number;
|
|
6302
|
-
/**
|
|
6303
|
-
|
|
6304
|
-
/**
|
|
6305
|
-
|
|
6306
|
-
|
|
6307
|
-
field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
|
|
6308
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
|
|
6183
|
+
/** Start date */
|
|
6184
|
+
start_date?: string;
|
|
6185
|
+
/** End date */
|
|
6186
|
+
end_date?: string;
|
|
6187
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
|
|
6309
6188
|
/**
|
|
6310
|
-
* @description
|
|
6311
|
-
* @tags
|
|
6312
|
-
* @name
|
|
6313
|
-
* @summary
|
|
6314
|
-
* @request
|
|
6315
|
-
* @originalName getPreIpoCompanySpvs
|
|
6316
|
-
* @duplicate
|
|
6189
|
+
* @description Update featured articles
|
|
6190
|
+
* @tags News
|
|
6191
|
+
* @name UpdateFeaturedArticles
|
|
6192
|
+
* @summary Update featured articles
|
|
6193
|
+
* @request PUT:/news/featured-articles
|
|
6317
6194
|
* @secure
|
|
6318
6195
|
*/
|
|
6319
|
-
|
|
6320
|
-
/** default is false, if true documents will be included in the response */
|
|
6321
|
-
include_documents?: boolean;
|
|
6322
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
|
|
6323
|
-
}
|
|
6324
|
-
export class Public<HandleError extends boolean = boolean> {
|
|
6325
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6326
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6196
|
+
updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6327
6197
|
/**
|
|
6328
|
-
* @description
|
|
6329
|
-
* @tags
|
|
6330
|
-
* @name
|
|
6331
|
-
* @summary
|
|
6332
|
-
* @request
|
|
6198
|
+
* @description Create featured articles
|
|
6199
|
+
* @tags News
|
|
6200
|
+
* @name CreateFeaturedArticles
|
|
6201
|
+
* @summary Create featured articles
|
|
6202
|
+
* @request POST:/news/featured-articles
|
|
6333
6203
|
* @secure
|
|
6334
6204
|
*/
|
|
6335
|
-
|
|
6336
|
-
/** Single symbol */
|
|
6337
|
-
symbol: string;
|
|
6338
|
-
/**
|
|
6339
|
-
* Non-zero amount
|
|
6340
|
-
* @format float64
|
|
6341
|
-
*/
|
|
6342
|
-
amount: number;
|
|
6343
|
-
/** Start date for calculations */
|
|
6344
|
-
start_date: string;
|
|
6345
|
-
/** End date for calculations */
|
|
6346
|
-
end_date: string;
|
|
6347
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
6205
|
+
createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6348
6206
|
/**
|
|
6349
|
-
* @description
|
|
6350
|
-
* @tags
|
|
6351
|
-
* @name
|
|
6352
|
-
* @summary
|
|
6353
|
-
* @request GET:/
|
|
6207
|
+
* @description Get active featured articles
|
|
6208
|
+
* @tags News
|
|
6209
|
+
* @name GetActiveFeaturedArticles
|
|
6210
|
+
* @summary Get active featured articles
|
|
6211
|
+
* @request GET:/news/featured-articles/active
|
|
6354
6212
|
* @secure
|
|
6355
6213
|
*/
|
|
6356
|
-
|
|
6357
|
-
/** Comma separated symbols */
|
|
6358
|
-
symbols: string;
|
|
6359
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
6214
|
+
getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
|
|
6360
6215
|
/**
|
|
6361
|
-
* @description
|
|
6362
|
-
* @tags
|
|
6363
|
-
* @name
|
|
6364
|
-
* @summary
|
|
6365
|
-
* @request
|
|
6216
|
+
* @description Set featured articles
|
|
6217
|
+
* @tags News
|
|
6218
|
+
* @name SetFeaturedArticles
|
|
6219
|
+
* @summary Set featured articles
|
|
6220
|
+
* @request POST:/news/featured-articles/set
|
|
6366
6221
|
* @secure
|
|
6367
6222
|
*/
|
|
6368
|
-
|
|
6369
|
-
/** Annual or quarterly */
|
|
6370
|
-
mode: string;
|
|
6371
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
6223
|
+
setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6372
6224
|
/**
|
|
6373
|
-
* @description
|
|
6374
|
-
* @tags
|
|
6375
|
-
* @name
|
|
6376
|
-
* @summary
|
|
6377
|
-
* @request GET:/
|
|
6225
|
+
* @description Get featured article
|
|
6226
|
+
* @tags News
|
|
6227
|
+
* @name GetFeaturedArticle
|
|
6228
|
+
* @summary Get featured article
|
|
6229
|
+
* @request GET:/news/featured-articles/{id}
|
|
6378
6230
|
* @secure
|
|
6379
6231
|
*/
|
|
6380
|
-
|
|
6381
|
-
/** Single symbol */
|
|
6382
|
-
symbol: string;
|
|
6383
|
-
/** Target date */
|
|
6384
|
-
date: string;
|
|
6385
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
6232
|
+
getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
|
|
6386
6233
|
/**
|
|
6387
|
-
* @description
|
|
6388
|
-
* @tags
|
|
6389
|
-
* @name
|
|
6390
|
-
* @summary
|
|
6391
|
-
* @request
|
|
6234
|
+
* @description Returns news by filters
|
|
6235
|
+
* @tags News
|
|
6236
|
+
* @name NewsFiltered
|
|
6237
|
+
* @summary Get filtered news
|
|
6238
|
+
* @request POST:/news/filter
|
|
6392
6239
|
* @secure
|
|
6393
6240
|
*/
|
|
6394
|
-
|
|
6241
|
+
newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
|
|
6395
6242
|
/**
|
|
6396
|
-
* @description
|
|
6397
|
-
* @tags
|
|
6398
|
-
* @name
|
|
6399
|
-
* @summary
|
|
6400
|
-
* @request
|
|
6243
|
+
* @description Returns news by id
|
|
6244
|
+
* @tags News
|
|
6245
|
+
* @name NewsById
|
|
6246
|
+
* @summary Get news by id
|
|
6247
|
+
* @request POST:/news/id
|
|
6401
6248
|
* @secure
|
|
6402
6249
|
*/
|
|
6403
|
-
|
|
6250
|
+
newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
|
|
6404
6251
|
/**
|
|
6405
|
-
* @description
|
|
6406
|
-
* @tags
|
|
6407
|
-
* @name
|
|
6408
|
-
* @summary
|
|
6409
|
-
* @request GET:/
|
|
6252
|
+
* @description Returns news previews
|
|
6253
|
+
* @tags News
|
|
6254
|
+
* @name NewsPreviewsFiltered
|
|
6255
|
+
* @summary Get news previews
|
|
6256
|
+
* @request GET:/news/previews
|
|
6410
6257
|
* @secure
|
|
6411
6258
|
*/
|
|
6412
|
-
|
|
6413
|
-
/**
|
|
6414
|
-
|
|
6259
|
+
newsPreviewsFiltered(query: {
|
|
6260
|
+
/** Start date */
|
|
6261
|
+
start_date?: string;
|
|
6262
|
+
/** End date */
|
|
6263
|
+
end_date?: string;
|
|
6264
|
+
/** Symbol */
|
|
6265
|
+
symbol?: string;
|
|
6415
6266
|
/** how many records to return. Max value is 50 */
|
|
6416
6267
|
limit: number;
|
|
6417
6268
|
/** how many records to skip */
|
|
6418
6269
|
offset: number;
|
|
6419
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
6270
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
|
|
6420
6271
|
/**
|
|
6421
|
-
* @description
|
|
6422
|
-
* @tags
|
|
6423
|
-
* @name
|
|
6424
|
-
* @summary
|
|
6425
|
-
* @request GET:/
|
|
6272
|
+
* @description Returns available stocks in DB
|
|
6273
|
+
* @tags News
|
|
6274
|
+
* @name NewsAvailableStocks
|
|
6275
|
+
* @summary Get available stocks in DB (for filters)
|
|
6276
|
+
* @request GET:/news/symbols
|
|
6426
6277
|
* @secure
|
|
6427
6278
|
*/
|
|
6428
|
-
|
|
6429
|
-
/**
|
|
6430
|
-
|
|
6431
|
-
/**
|
|
6432
|
-
|
|
6433
|
-
/**
|
|
6434
|
-
|
|
6435
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
6279
|
+
newsAvailableStocks(query?: {
|
|
6280
|
+
/** Limit */
|
|
6281
|
+
limit?: number;
|
|
6282
|
+
/** Offset */
|
|
6283
|
+
offset?: number;
|
|
6284
|
+
/** search query */
|
|
6285
|
+
search_query?: string;
|
|
6286
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6436
6287
|
/**
|
|
6437
|
-
* @description
|
|
6438
|
-
* @tags
|
|
6439
|
-
* @name
|
|
6440
|
-
* @summary
|
|
6441
|
-
* @request
|
|
6288
|
+
* @description Returns available tags in DB
|
|
6289
|
+
* @tags News
|
|
6290
|
+
* @name NewsAvailableTags
|
|
6291
|
+
* @summary Get available tags in DB (for filters)
|
|
6292
|
+
* @request POST:/news/tags
|
|
6442
6293
|
* @secure
|
|
6443
6294
|
*/
|
|
6444
|
-
|
|
6445
|
-
/** EQUITY|ETF|CRYPTO */
|
|
6446
|
-
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
6447
|
-
/** how many records to return. Max value is 50 */
|
|
6448
|
-
limit: number;
|
|
6449
|
-
/** how many records to skip */
|
|
6450
|
-
offset: number;
|
|
6451
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6295
|
+
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6452
6296
|
}
|
|
6453
|
-
export class
|
|
6297
|
+
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
6454
6298
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6455
6299
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6456
6300
|
/**
|
|
6457
|
-
* @description
|
|
6458
|
-
* @tags
|
|
6459
|
-
* @name
|
|
6460
|
-
* @summary
|
|
6461
|
-
* @request
|
|
6462
|
-
* @secure
|
|
6463
|
-
*/
|
|
6464
|
-
gitHistoricalQuote(query: {
|
|
6465
|
-
/** Symbol */
|
|
6466
|
-
symbol: string;
|
|
6467
|
-
/** Date */
|
|
6468
|
-
date: string;
|
|
6469
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
6470
|
-
/**
|
|
6471
|
-
* @description get quote history by symbol
|
|
6472
|
-
* @tags Quotes
|
|
6473
|
-
* @name GitQuoteHistory
|
|
6474
|
-
* @summary Get quote history
|
|
6475
|
-
* @request POST:/quote-history
|
|
6301
|
+
* @description Returns calculated matrix
|
|
6302
|
+
* @tags OptionGreeks
|
|
6303
|
+
* @name OgCalculateMatrix
|
|
6304
|
+
* @summary Calculate matrix
|
|
6305
|
+
* @request POST:/og/calculate-matrix
|
|
6476
6306
|
* @secure
|
|
6477
6307
|
*/
|
|
6478
|
-
|
|
6308
|
+
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
6479
6309
|
/**
|
|
6480
|
-
* @description Returns
|
|
6481
|
-
* @tags
|
|
6482
|
-
* @name
|
|
6483
|
-
* @summary
|
|
6484
|
-
* @request
|
|
6310
|
+
* @description Returns calculated params
|
|
6311
|
+
* @tags OptionGreeks
|
|
6312
|
+
* @name OgCalculateParams
|
|
6313
|
+
* @summary Calculate params
|
|
6314
|
+
* @request POST:/og/calculate-params
|
|
6485
6315
|
* @secure
|
|
6486
6316
|
*/
|
|
6487
|
-
|
|
6488
|
-
/** Comma separated symbols */
|
|
6489
|
-
symbols: string;
|
|
6490
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
6317
|
+
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
6491
6318
|
}
|
|
6492
|
-
export class
|
|
6319
|
+
export class Ownerships<HandleError extends boolean = boolean> {
|
|
6493
6320
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6494
6321
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6495
6322
|
/**
|
|
6496
|
-
* @description
|
|
6497
|
-
* @tags
|
|
6498
|
-
* @name
|
|
6499
|
-
* @summary
|
|
6500
|
-
* @request
|
|
6501
|
-
* @secure
|
|
6502
|
-
*/
|
|
6503
|
-
stockMarketHeatmap(query?: {
|
|
6504
|
-
/** Name of symbol list to fetch details for. Empty is default */
|
|
6505
|
-
heatmap_name?: string;
|
|
6506
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
6507
|
-
/**
|
|
6508
|
-
* @description create or update heat map preset
|
|
6509
|
-
* @tags StockScreener
|
|
6510
|
-
* @name CreateStockMarketHeatmapPreset
|
|
6511
|
-
* @summary create or update heat map preset
|
|
6512
|
-
* @request POST:/heatmaps
|
|
6323
|
+
* @description get ownerships by id datadata
|
|
6324
|
+
* @tags Ownerships
|
|
6325
|
+
* @name GetOwnershipsByIdData
|
|
6326
|
+
* @summary get ownerships by id data
|
|
6327
|
+
* @request POST:/ownerships
|
|
6513
6328
|
* @secure
|
|
6514
6329
|
*/
|
|
6515
|
-
|
|
6330
|
+
getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
6516
6331
|
/**
|
|
6517
|
-
* @description
|
|
6518
|
-
* @tags
|
|
6519
|
-
* @name
|
|
6520
|
-
* @summary get
|
|
6521
|
-
* @request POST:/
|
|
6332
|
+
* @description get ownerships by symbol data
|
|
6333
|
+
* @tags Ownerships
|
|
6334
|
+
* @name GetOwnershipsBySymbolData
|
|
6335
|
+
* @summary get ownerships by symbol data
|
|
6336
|
+
* @request POST:/symbol-ownerships
|
|
6522
6337
|
* @secure
|
|
6523
6338
|
*/
|
|
6524
|
-
|
|
6339
|
+
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
6340
|
+
}
|
|
6341
|
+
export class Passport<HandleError extends boolean = boolean> {
|
|
6342
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6343
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6525
6344
|
/**
|
|
6526
|
-
* @description
|
|
6527
|
-
* @tags
|
|
6528
|
-
* @name
|
|
6529
|
-
* @summary
|
|
6530
|
-
* @request POST:/
|
|
6345
|
+
* @description Returns article by id
|
|
6346
|
+
* @tags Passport
|
|
6347
|
+
* @name PassportArticleById
|
|
6348
|
+
* @summary Get article by id
|
|
6349
|
+
* @request POST:/passport/article-by-id
|
|
6531
6350
|
* @secure
|
|
6532
6351
|
*/
|
|
6533
|
-
|
|
6534
|
-
/** Authorization */
|
|
6535
|
-
Authorization?: string;
|
|
6536
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
6352
|
+
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
6537
6353
|
/**
|
|
6538
|
-
* @description
|
|
6539
|
-
* @tags
|
|
6540
|
-
* @name
|
|
6541
|
-
* @summary
|
|
6542
|
-
* @request
|
|
6354
|
+
* @description Returns articles
|
|
6355
|
+
* @tags Passport
|
|
6356
|
+
* @name PassportArticles
|
|
6357
|
+
* @summary Get articles
|
|
6358
|
+
* @request POST:/passport/articles
|
|
6543
6359
|
* @secure
|
|
6544
6360
|
*/
|
|
6545
|
-
|
|
6546
|
-
/** how many records to return */
|
|
6547
|
-
limit: number;
|
|
6548
|
-
/** how many records to skip */
|
|
6549
|
-
offset: number;
|
|
6550
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
6361
|
+
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
6551
6362
|
/**
|
|
6552
|
-
* @description
|
|
6553
|
-
* @tags
|
|
6554
|
-
* @name
|
|
6555
|
-
* @summary
|
|
6556
|
-
* @request
|
|
6363
|
+
* @description Returns author profile
|
|
6364
|
+
* @tags Passport
|
|
6365
|
+
* @name PassportAuthorProfile
|
|
6366
|
+
* @summary Get author profile
|
|
6367
|
+
* @request POST:/passport/author-profile
|
|
6557
6368
|
* @secure
|
|
6558
6369
|
*/
|
|
6559
|
-
|
|
6370
|
+
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
6560
6371
|
/**
|
|
6561
|
-
* @description
|
|
6562
|
-
* @tags
|
|
6563
|
-
* @name
|
|
6564
|
-
* @summary
|
|
6565
|
-
* @request POST:/
|
|
6372
|
+
* @description Returns most popular tags
|
|
6373
|
+
* @tags Passport
|
|
6374
|
+
* @name PassportMostPopularTags
|
|
6375
|
+
* @summary Get most popular tags
|
|
6376
|
+
* @request POST:/passport/most-popular-tags
|
|
6566
6377
|
* @secure
|
|
6567
6378
|
*/
|
|
6568
|
-
|
|
6379
|
+
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
6569
6380
|
/**
|
|
6570
|
-
* @description
|
|
6571
|
-
* @tags
|
|
6572
|
-
* @name
|
|
6573
|
-
* @summary
|
|
6574
|
-
* @request
|
|
6381
|
+
* @description Returns news feed
|
|
6382
|
+
* @tags Passport
|
|
6383
|
+
* @name PassportNewsFeed
|
|
6384
|
+
* @summary Get news feed
|
|
6385
|
+
* @request POST:/passport/newsfeed
|
|
6575
6386
|
* @secure
|
|
6576
6387
|
*/
|
|
6577
|
-
|
|
6388
|
+
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
|
|
6578
6389
|
/**
|
|
6579
|
-
* @description
|
|
6580
|
-
* @tags
|
|
6581
|
-
* @name
|
|
6582
|
-
* @summary
|
|
6583
|
-
* @request POST:/
|
|
6390
|
+
* @description Returns article by parameters
|
|
6391
|
+
* @tags Passport
|
|
6392
|
+
* @name PassportSearchArticle
|
|
6393
|
+
* @summary Search article by parameters
|
|
6394
|
+
* @request POST:/passport/search-article
|
|
6584
6395
|
* @secure
|
|
6585
6396
|
*/
|
|
6586
|
-
|
|
6397
|
+
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
6587
6398
|
}
|
|
6588
|
-
export class
|
|
6399
|
+
export class Public<HandleError extends boolean = boolean> {
|
|
6589
6400
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6590
6401
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6591
6402
|
/**
|
|
6592
|
-
* @description
|
|
6593
|
-
* @tags
|
|
6594
|
-
* @name
|
|
6595
|
-
* @summary
|
|
6596
|
-
* @request
|
|
6403
|
+
* @description Calculate estimated returns for selected symbols. Uses split adjusted prices
|
|
6404
|
+
* @tags Public
|
|
6405
|
+
* @name CalculateEstimatedReturns
|
|
6406
|
+
* @summary Calculate Estimated Returns
|
|
6407
|
+
* @request GET:/public/estimated-returns
|
|
6597
6408
|
* @secure
|
|
6598
6409
|
*/
|
|
6599
|
-
|
|
6410
|
+
calculateEstimatedReturns(query: {
|
|
6411
|
+
/** Single symbol */
|
|
6412
|
+
symbol: string;
|
|
6413
|
+
/**
|
|
6414
|
+
* Non-zero amount
|
|
6415
|
+
* @format float64
|
|
6416
|
+
*/
|
|
6417
|
+
amount: number;
|
|
6418
|
+
/** Start date for calculations */
|
|
6419
|
+
start_date: string;
|
|
6420
|
+
/** End date for calculations */
|
|
6421
|
+
end_date: string;
|
|
6422
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
6600
6423
|
/**
|
|
6601
|
-
* @description
|
|
6602
|
-
* @tags
|
|
6603
|
-
* @name
|
|
6604
|
-
* @summary
|
|
6605
|
-
* @request
|
|
6424
|
+
* @description Returns an expert forecast
|
|
6425
|
+
* @tags Public
|
|
6426
|
+
* @name ExpertForecast
|
|
6427
|
+
* @summary Expert forecast
|
|
6428
|
+
* @request GET:/public/expert-forecast
|
|
6606
6429
|
* @secure
|
|
6607
6430
|
*/
|
|
6608
|
-
|
|
6609
|
-
|
|
6610
|
-
|
|
6611
|
-
|
|
6612
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6431
|
+
expertForecast(query: {
|
|
6432
|
+
/** Comma separated symbols */
|
|
6433
|
+
symbols: string;
|
|
6434
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
6613
6435
|
/**
|
|
6614
|
-
* @description
|
|
6615
|
-
* @tags
|
|
6616
|
-
* @name
|
|
6617
|
-
* @summary
|
|
6618
|
-
* @request
|
|
6436
|
+
* @description get fundamentals by symbol data
|
|
6437
|
+
* @tags Public
|
|
6438
|
+
* @name GetPublicFundamentalsBySymbolData
|
|
6439
|
+
* @summary get fundamentals by symbol data
|
|
6440
|
+
* @request GET:/public/fundamentals/{symbol}
|
|
6441
|
+
* @secure
|
|
6442
|
+
*/
|
|
6443
|
+
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
6444
|
+
/** Annual or quarterly */
|
|
6445
|
+
mode: string;
|
|
6446
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
6447
|
+
/**
|
|
6448
|
+
* @description Daily price history
|
|
6449
|
+
* @tags Public
|
|
6450
|
+
* @name DailyPriceHistory
|
|
6451
|
+
* @summary Daily price history
|
|
6452
|
+
* @request GET:/public/price-history/daily
|
|
6453
|
+
* @secure
|
|
6454
|
+
*/
|
|
6455
|
+
dailyPriceHistory(query: {
|
|
6456
|
+
/** Single symbol */
|
|
6457
|
+
symbol: string;
|
|
6458
|
+
/** Target date */
|
|
6459
|
+
date: string;
|
|
6460
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
6461
|
+
/**
|
|
6462
|
+
* @description Public quote profile
|
|
6463
|
+
* @tags Public
|
|
6464
|
+
* @name PublicQuoteProfile
|
|
6465
|
+
* @summary Public quote profile
|
|
6466
|
+
* @request GET:/public/quote-profile/{symbol}
|
|
6467
|
+
* @secure
|
|
6468
|
+
*/
|
|
6469
|
+
publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
|
|
6470
|
+
/**
|
|
6471
|
+
* @description get ratios by symbol data
|
|
6472
|
+
* @tags Public
|
|
6473
|
+
* @name GetPublicRatiosBySymbolData
|
|
6474
|
+
* @summary get ratios by symbol data
|
|
6475
|
+
* @request GET:/public/ratios/{symbol}
|
|
6476
|
+
* @secure
|
|
6477
|
+
*/
|
|
6478
|
+
getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
|
|
6479
|
+
/**
|
|
6480
|
+
* @description find a symbol by name or description
|
|
6481
|
+
* @tags Public
|
|
6482
|
+
* @name QuoteFundamentalsSearch
|
|
6483
|
+
* @summary find a symbol by name or description
|
|
6484
|
+
* @request GET:/public/symbol-search
|
|
6485
|
+
* @secure
|
|
6486
|
+
*/
|
|
6487
|
+
quoteFundamentalsSearch(query: {
|
|
6488
|
+
/** Search query */
|
|
6489
|
+
search_query: string;
|
|
6490
|
+
/** how many records to return. Max value is 50 */
|
|
6491
|
+
limit: number;
|
|
6492
|
+
/** how many records to skip */
|
|
6493
|
+
offset: number;
|
|
6494
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
6495
|
+
/**
|
|
6496
|
+
* @description Get top gainers
|
|
6497
|
+
* @tags Public
|
|
6498
|
+
* @name TopGainers
|
|
6499
|
+
* @summary Top Gainers
|
|
6500
|
+
* @request GET:/public/top-gainers
|
|
6501
|
+
* @secure
|
|
6502
|
+
*/
|
|
6503
|
+
topGainers(query: {
|
|
6504
|
+
/** sort direction - asc or desc */
|
|
6505
|
+
order_direction?: string;
|
|
6506
|
+
/** how many records to return. Max value is 50 */
|
|
6507
|
+
limit: number;
|
|
6508
|
+
/** how many records to skip */
|
|
6509
|
+
offset: number;
|
|
6510
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6511
|
+
/**
|
|
6512
|
+
* @description Get top stocks
|
|
6513
|
+
* @tags Public
|
|
6514
|
+
* @name TopStocks
|
|
6515
|
+
* @summary Top Stocks
|
|
6516
|
+
* @request GET:/public/top-stocks
|
|
6517
|
+
* @secure
|
|
6518
|
+
*/
|
|
6519
|
+
topStocks(query: {
|
|
6520
|
+
/** EQUITY|ETF|CRYPTO */
|
|
6521
|
+
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
6522
|
+
/** how many records to return. Max value is 50 */
|
|
6523
|
+
limit: number;
|
|
6524
|
+
/** how many records to skip */
|
|
6525
|
+
offset: number;
|
|
6526
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6527
|
+
}
|
|
6528
|
+
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
6529
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6530
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6531
|
+
/**
|
|
6532
|
+
* @description get usage date per branch for a period
|
|
6533
|
+
* @tags UsageTracking
|
|
6534
|
+
* @name GetUsageData
|
|
6535
|
+
* @summary get insight usage data
|
|
6536
|
+
* @request POST:/tracking/usage
|
|
6537
|
+
* @secure
|
|
6538
|
+
*/
|
|
6539
|
+
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
6540
|
+
}
|
|
6541
|
+
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
6542
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6543
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6544
|
+
/**
|
|
6545
|
+
* @description get seasonlity data with comparison to benchmark
|
|
6546
|
+
* @tags AlphaTools
|
|
6547
|
+
* @name GetMomentumRatioGraph
|
|
6548
|
+
* @summary get seasonlity data
|
|
6549
|
+
* @request POST:/rst
|
|
6550
|
+
* @secure
|
|
6551
|
+
*/
|
|
6552
|
+
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
6553
|
+
/**
|
|
6554
|
+
* @description get seasonlity data with comparison to benchmark
|
|
6555
|
+
* @tags AlphaTools
|
|
6556
|
+
* @name GetSeasonality
|
|
6557
|
+
* @summary get seasonlity data
|
|
6558
|
+
* @request POST:/seasonality
|
|
6559
|
+
* @secure
|
|
6560
|
+
*/
|
|
6561
|
+
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
6562
|
+
}
|
|
6563
|
+
export class TipRank<HandleError extends boolean = boolean> {
|
|
6564
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6565
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6566
|
+
/**
|
|
6567
|
+
* @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
|
|
6568
|
+
* @tags TipRank
|
|
6569
|
+
* @name TiprankAnalystConsensus
|
|
6570
|
+
* @summary Get tiprank AnalystConsensus
|
|
6571
|
+
* @request POST:/tipranks/analyst-consensus
|
|
6619
6572
|
* @secure
|
|
6620
6573
|
*/
|
|
6621
6574
|
tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
|
|
@@ -6973,200 +6926,269 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6973
6926
|
Authorization?: string;
|
|
6974
6927
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
|
|
6975
6928
|
}
|
|
6976
|
-
export
|
|
6977
|
-
|
|
6978
|
-
|
|
6979
|
-
/**
|
|
6980
|
-
* @description get usage date per branch for a period
|
|
6981
|
-
* @tags UsageTracking
|
|
6982
|
-
* @name GetUsageData
|
|
6983
|
-
* @summary get insight usage data
|
|
6984
|
-
* @request POST:/tracking/usage
|
|
6985
|
-
* @secure
|
|
6986
|
-
*/
|
|
6987
|
-
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
6929
|
+
export interface InsightBeforeAndAfterV2 {
|
|
6930
|
+
after?: string;
|
|
6931
|
+
before?: string;
|
|
6988
6932
|
}
|
|
6989
|
-
export
|
|
6990
|
-
|
|
6991
|
-
|
|
6933
|
+
export interface InsightFixedIncomeV2 {
|
|
6934
|
+
a144: boolean;
|
|
6935
|
+
accrued_interest: number;
|
|
6936
|
+
bank_qualified: boolean;
|
|
6937
|
+
bond_warrant: boolean;
|
|
6938
|
+
call_type: string;
|
|
6939
|
+
callable: boolean;
|
|
6940
|
+
close_price: number;
|
|
6941
|
+
close_price_asof: string;
|
|
6942
|
+
close_ytw: number;
|
|
6943
|
+
convertible: boolean;
|
|
6944
|
+
country: string;
|
|
6945
|
+
country_code: string;
|
|
6946
|
+
country_domicile: string;
|
|
6947
|
+
country_issue: string;
|
|
6948
|
+
coupon: number;
|
|
6949
|
+
coupon_frequency: string;
|
|
6950
|
+
coupon_type: string;
|
|
6951
|
+
currency: string;
|
|
6952
|
+
cusip: string;
|
|
6953
|
+
dated_date: string;
|
|
6954
|
+
daycount: string;
|
|
6955
|
+
description: string;
|
|
6956
|
+
description_short: string;
|
|
6957
|
+
duration: number;
|
|
6958
|
+
first_coupon_date: string;
|
|
6959
|
+
insured: boolean;
|
|
6960
|
+
isin: string;
|
|
6961
|
+
issue_date: string;
|
|
6962
|
+
issue_minimum_denomination: number;
|
|
6963
|
+
issue_price: number;
|
|
6964
|
+
issue_size: number;
|
|
6965
|
+
issuer: string;
|
|
6966
|
+
last_coupon_date: string;
|
|
6967
|
+
liquidity_institutional_aggregate: number;
|
|
6968
|
+
liquidity_institutional_buy: number;
|
|
6969
|
+
liquidity_institutional_sell: number;
|
|
6970
|
+
liquidity_micro_aggregate: number;
|
|
6971
|
+
liquidity_micro_buy: number;
|
|
6972
|
+
liquidity_micro_sell: number;
|
|
6973
|
+
liquidity_retail_aggregate: number;
|
|
6974
|
+
liquidity_retail_buy: number;
|
|
6975
|
+
liquidity_retail_sell: number;
|
|
6976
|
+
maturity_date: string;
|
|
6977
|
+
municipal_state: string;
|
|
6978
|
+
municipal_taxable_federal: boolean;
|
|
6979
|
+
municipal_type: string;
|
|
6980
|
+
next_call_date: string;
|
|
6981
|
+
next_call_price: number;
|
|
6982
|
+
next_coupon_date: string;
|
|
6983
|
+
par_value: number;
|
|
6984
|
+
perpetual: boolean;
|
|
6985
|
+
private_placement: boolean;
|
|
6986
|
+
purpose: string;
|
|
6987
|
+
puttable: boolean;
|
|
6988
|
+
reg_s: boolean;
|
|
6989
|
+
sector: string;
|
|
6990
|
+
seniority: string;
|
|
6991
|
+
settlement_convention: string;
|
|
6992
|
+
sinking_fund: boolean;
|
|
6993
|
+
sp_creditwatch: string;
|
|
6994
|
+
sp_creditwatch_date: string;
|
|
6995
|
+
sp_outlook: string;
|
|
6996
|
+
sp_outlook_date: string;
|
|
6997
|
+
sp_rating: string;
|
|
6998
|
+
sp_rating_date: string;
|
|
6999
|
+
status: string;
|
|
7000
|
+
ticker: string;
|
|
7001
|
+
treasury_subtype: string;
|
|
7002
|
+
type: string;
|
|
7003
|
+
updated_at: string;
|
|
7004
|
+
}
|
|
7005
|
+
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
7006
|
+
count: number;
|
|
7007
|
+
data: InsightFixedIncomeV2[];
|
|
7008
|
+
}
|
|
7009
|
+
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
7010
|
+
/** @example true */
|
|
7011
|
+
bank_qualified?: boolean;
|
|
7012
|
+
/** @example true */
|
|
7013
|
+
callable?: boolean;
|
|
7014
|
+
/** @example true */
|
|
7015
|
+
convertible?: boolean;
|
|
7016
|
+
/** @example ["USA"] */
|
|
7017
|
+
country_codes?: string[];
|
|
7018
|
+
coupon?: InsightLessAndMoreV2;
|
|
7019
|
+
/** @example ["quarterly","zero"] */
|
|
7020
|
+
coupon_frequencies?: string[];
|
|
7021
|
+
/** @example ["655664AH3","9128286R6"] */
|
|
7022
|
+
cusip?: string[];
|
|
6992
7023
|
/**
|
|
6993
|
-
* @
|
|
6994
|
-
* @
|
|
6995
|
-
* @name ContinentGet
|
|
6996
|
-
* @summary Get continents
|
|
6997
|
-
* @request GET:/continents
|
|
6998
|
-
* @secure
|
|
7024
|
+
* @maxLength 100
|
|
7025
|
+
* @example "Donald's"
|
|
6999
7026
|
*/
|
|
7000
|
-
|
|
7001
|
-
|
|
7002
|
-
|
|
7003
|
-
|
|
7004
|
-
|
|
7005
|
-
|
|
7006
|
-
|
|
7007
|
-
|
|
7008
|
-
* @tags World Markets
|
|
7009
|
-
* @name ContinentEdit
|
|
7010
|
-
* @summary Edit continent
|
|
7011
|
-
* @request PUT:/continents
|
|
7012
|
-
* @secure
|
|
7013
|
-
*/
|
|
7014
|
-
continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7015
|
-
/**
|
|
7016
|
-
* @description Create continents
|
|
7017
|
-
* @tags World Markets
|
|
7018
|
-
* @name ContinentCreate
|
|
7019
|
-
* @summary Create continents
|
|
7020
|
-
* @request POST:/continents
|
|
7021
|
-
* @secure
|
|
7022
|
-
*/
|
|
7023
|
-
continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
7024
|
-
/**
|
|
7025
|
-
* @description Delete continent
|
|
7026
|
-
* @tags World Markets
|
|
7027
|
-
* @name ContinentDelete
|
|
7028
|
-
* @summary Delete continent
|
|
7029
|
-
* @request DELETE:/continents
|
|
7030
|
-
* @secure
|
|
7031
|
-
*/
|
|
7032
|
-
continentDelete(query: {
|
|
7033
|
-
/** continent id */
|
|
7034
|
-
id: string;
|
|
7035
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7036
|
-
/**
|
|
7037
|
-
* @description Get country codes
|
|
7038
|
-
* @tags World Markets
|
|
7039
|
-
* @name CountryCodeGet
|
|
7040
|
-
* @summary Get country codes
|
|
7041
|
-
* @request GET:/country-codes
|
|
7042
|
-
* @secure
|
|
7043
|
-
*/
|
|
7044
|
-
countryCodeGet(query: {
|
|
7045
|
-
/** Query limit */
|
|
7046
|
-
limit: number;
|
|
7047
|
-
/** Query offset */
|
|
7048
|
-
offset: number;
|
|
7049
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
7050
|
-
/**
|
|
7051
|
-
* @description Edit country code
|
|
7052
|
-
* @tags World Markets
|
|
7053
|
-
* @name CountryCodeEdit
|
|
7054
|
-
* @summary Edit country code
|
|
7055
|
-
* @request PUT:/country-codes
|
|
7056
|
-
* @secure
|
|
7057
|
-
*/
|
|
7058
|
-
countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7059
|
-
/**
|
|
7060
|
-
* @description Add country codes
|
|
7061
|
-
* @tags World Markets
|
|
7062
|
-
* @name CountryCodeAdd
|
|
7063
|
-
* @summary Add country codes
|
|
7064
|
-
* @request POST:/country-codes
|
|
7065
|
-
* @secure
|
|
7066
|
-
*/
|
|
7067
|
-
countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
7068
|
-
/**
|
|
7069
|
-
* @description Delete country code
|
|
7070
|
-
* @tags World Markets
|
|
7071
|
-
* @name CountryCodeDelete
|
|
7072
|
-
* @summary Delete country code
|
|
7073
|
-
* @request DELETE:/country-codes
|
|
7074
|
-
* @secure
|
|
7075
|
-
*/
|
|
7076
|
-
countryCodeDelete(query: {
|
|
7077
|
-
/** a3 code */
|
|
7078
|
-
a3code: string;
|
|
7079
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7027
|
+
description?: string;
|
|
7028
|
+
/** @example true */
|
|
7029
|
+
has_ticker?: boolean;
|
|
7030
|
+
/** @example true */
|
|
7031
|
+
insured?: boolean;
|
|
7032
|
+
/** @example ["US655664AH33","US9128286R69"] */
|
|
7033
|
+
isin?: string[];
|
|
7034
|
+
issue_date?: InsightBeforeAndAfterV2;
|
|
7080
7035
|
/**
|
|
7081
|
-
* @
|
|
7082
|
-
* @
|
|
7083
|
-
* @name GlobalIndexGet
|
|
7084
|
-
* @summary Get global indexes
|
|
7085
|
-
* @request GET:/global-indexes
|
|
7086
|
-
* @secure
|
|
7036
|
+
* @maxLength 100
|
|
7037
|
+
* @example "Donald's"
|
|
7087
7038
|
*/
|
|
7088
|
-
|
|
7089
|
-
|
|
7090
|
-
|
|
7091
|
-
|
|
7092
|
-
|
|
7093
|
-
|
|
7094
|
-
|
|
7095
|
-
|
|
7039
|
+
issuer?: string;
|
|
7040
|
+
maturity?: InsightBeforeAndAfterV2;
|
|
7041
|
+
/** @example ["NY"] */
|
|
7042
|
+
municipal_states?: string[];
|
|
7043
|
+
/** @example true */
|
|
7044
|
+
municipal_tax?: boolean;
|
|
7045
|
+
/** @example ["general_obligation"] */
|
|
7046
|
+
municipal_types?: string[];
|
|
7047
|
+
pagination: InsightPaginationV2;
|
|
7048
|
+
purposes?: string[];
|
|
7049
|
+
/** @example ["SOVEREIGN"] */
|
|
7050
|
+
sectors?: string[];
|
|
7051
|
+
sorts?: InsightOrderingV2[];
|
|
7052
|
+
/** @example ["AAA"] */
|
|
7053
|
+
sp_ratings?: string[];
|
|
7054
|
+
/** @example ["called","outstanding"] */
|
|
7055
|
+
statuses?: string[];
|
|
7056
|
+
tickers?: string[];
|
|
7057
|
+
/** @example ["corporate"] */
|
|
7058
|
+
types?: string[];
|
|
7059
|
+
}
|
|
7060
|
+
export interface InsightGetTopSymbolsRequestV2 {
|
|
7061
|
+
exchange?: string[];
|
|
7062
|
+
market_cap?: InsightLessAndMoreV2;
|
|
7063
|
+
pagination?: InsightPaginationV2;
|
|
7064
|
+
price?: InsightLessAndMoreV2;
|
|
7065
|
+
sorts?: InsightOrderingV2[];
|
|
7066
|
+
volume?: InsightLessAndMoreV2;
|
|
7067
|
+
}
|
|
7068
|
+
export interface InsightIncludeExcludeV2 {
|
|
7069
|
+
exclude?: string[];
|
|
7070
|
+
include?: string[];
|
|
7071
|
+
}
|
|
7072
|
+
export interface InsightLessAndMoreV2 {
|
|
7073
|
+
less_than?: number;
|
|
7074
|
+
more_than?: number;
|
|
7075
|
+
}
|
|
7076
|
+
export enum InsightOrderDirectionV2 {
|
|
7077
|
+
OrderASC = "asc",
|
|
7078
|
+
OrderDESC = "desc"
|
|
7079
|
+
}
|
|
7080
|
+
export interface InsightOrderingV2 {
|
|
7096
7081
|
/**
|
|
7097
|
-
* @
|
|
7098
|
-
* @
|
|
7099
|
-
* @name GlobalIndexEdit
|
|
7100
|
-
* @summary Edit global index
|
|
7101
|
-
* @request PUT:/global-indexes
|
|
7102
|
-
* @secure
|
|
7082
|
+
* @default "asc"
|
|
7083
|
+
* @example "asc"
|
|
7103
7084
|
*/
|
|
7104
|
-
|
|
7085
|
+
direction: InsightOrderingDirectionEnumV2;
|
|
7105
7086
|
/**
|
|
7106
|
-
*
|
|
7107
|
-
*
|
|
7108
|
-
*
|
|
7109
|
-
* @
|
|
7110
|
-
* @request POST:/global-indexes
|
|
7111
|
-
* @secure
|
|
7087
|
+
* Sort direction:
|
|
7088
|
+
* * asc - Ascending, from A to Z.
|
|
7089
|
+
* * desc - Descending, from Z to A.
|
|
7090
|
+
* @example "name"
|
|
7112
7091
|
*/
|
|
7113
|
-
|
|
7092
|
+
field: string;
|
|
7093
|
+
}
|
|
7094
|
+
export interface InsightPaginationV2 {
|
|
7114
7095
|
/**
|
|
7115
|
-
* @
|
|
7116
|
-
* @
|
|
7117
|
-
* @name GlobalIndexDelete
|
|
7118
|
-
* @summary Delete global index
|
|
7119
|
-
* @request DELETE:/global-indexes
|
|
7120
|
-
* @secure
|
|
7096
|
+
* @min 1
|
|
7097
|
+
* @example 1
|
|
7121
7098
|
*/
|
|
7122
|
-
|
|
7123
|
-
/** a3 code */
|
|
7124
|
-
a3code: string;
|
|
7125
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7099
|
+
page: number;
|
|
7126
7100
|
/**
|
|
7127
|
-
* @
|
|
7128
|
-
* @
|
|
7129
|
-
* @
|
|
7130
|
-
* @summary Get regions
|
|
7131
|
-
* @request GET:/regions
|
|
7132
|
-
* @secure
|
|
7101
|
+
* @min 1
|
|
7102
|
+
* @max 50
|
|
7103
|
+
* @example 10
|
|
7133
7104
|
*/
|
|
7134
|
-
|
|
7135
|
-
|
|
7136
|
-
|
|
7137
|
-
|
|
7138
|
-
|
|
7139
|
-
|
|
7105
|
+
size: number;
|
|
7106
|
+
}
|
|
7107
|
+
export interface InsightStockScreenerQuoteV2 {
|
|
7108
|
+
average_volume_30d: number;
|
|
7109
|
+
company_name: string;
|
|
7110
|
+
dividend_ex_date: string;
|
|
7111
|
+
dividend_pay_date: string;
|
|
7112
|
+
dividend_percent: number;
|
|
7113
|
+
exchange: string;
|
|
7114
|
+
exchange_name: string;
|
|
7115
|
+
gap: number;
|
|
7116
|
+
industry: string;
|
|
7117
|
+
industry_code: string;
|
|
7118
|
+
last_price: number;
|
|
7119
|
+
market_cap: number;
|
|
7120
|
+
pe_ratio: number;
|
|
7121
|
+
price_change: number;
|
|
7122
|
+
price_change_percent: number;
|
|
7123
|
+
symbol: string;
|
|
7124
|
+
volume: number;
|
|
7125
|
+
}
|
|
7126
|
+
export interface InsightStockScreenerRequestV2 {
|
|
7127
|
+
average_volume_30d?: InsightLessAndMoreV2;
|
|
7128
|
+
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
7129
|
+
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
7130
|
+
dividend_percent?: InsightLessAndMoreV2;
|
|
7131
|
+
exchange?: InsightIncludeExcludeV2;
|
|
7132
|
+
gap?: InsightLessAndMoreV2;
|
|
7133
|
+
industry?: InsightIncludeExcludeV2;
|
|
7134
|
+
market_cap?: InsightLessAndMoreV2;
|
|
7135
|
+
pagination: InsightPaginationV2;
|
|
7136
|
+
pe_ratio?: InsightLessAndMoreV2;
|
|
7137
|
+
price?: InsightLessAndMoreV2;
|
|
7138
|
+
sorts?: InsightOrderingV2[];
|
|
7139
|
+
/** @example "ADR" */
|
|
7140
|
+
stock_type?: string;
|
|
7141
|
+
volume?: InsightLessAndMoreV2;
|
|
7142
|
+
}
|
|
7143
|
+
export interface InsightStockScreenerResponseV2 {
|
|
7144
|
+
current_page: number;
|
|
7145
|
+
data: InsightStockScreenerQuoteV2[];
|
|
7146
|
+
page_count: number;
|
|
7147
|
+
status: number;
|
|
7148
|
+
total_records: number;
|
|
7149
|
+
}
|
|
7150
|
+
/**
|
|
7151
|
+
* @default "asc"
|
|
7152
|
+
* @example "asc"
|
|
7153
|
+
*/
|
|
7154
|
+
export enum InsightOrderingDirectionEnumV2 {
|
|
7155
|
+
Asc = "asc",
|
|
7156
|
+
Desc = "desc"
|
|
7157
|
+
}
|
|
7158
|
+
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
7159
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
7160
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
7140
7161
|
/**
|
|
7141
|
-
* @description
|
|
7142
|
-
* @tags
|
|
7143
|
-
* @name
|
|
7144
|
-
* @summary
|
|
7145
|
-
* @request
|
|
7162
|
+
* @description get fixed income entries
|
|
7163
|
+
* @tags FixedIncome
|
|
7164
|
+
* @name GetFixedIncomeEntries
|
|
7165
|
+
* @summary get fixed income entries
|
|
7166
|
+
* @request POST:/fixed-income
|
|
7146
7167
|
* @secure
|
|
7147
7168
|
*/
|
|
7148
|
-
|
|
7169
|
+
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
7170
|
+
}
|
|
7171
|
+
export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
7172
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
7173
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
7149
7174
|
/**
|
|
7150
|
-
* @description
|
|
7151
|
-
* @tags
|
|
7152
|
-
* @name
|
|
7153
|
-
* @summary
|
|
7154
|
-
* @request POST:/
|
|
7175
|
+
* @description filter stocks by params
|
|
7176
|
+
* @tags StockScreener
|
|
7177
|
+
* @name StockScreener
|
|
7178
|
+
* @summary filter stocks by params
|
|
7179
|
+
* @request POST:/stock-screener
|
|
7155
7180
|
* @secure
|
|
7156
7181
|
*/
|
|
7157
|
-
|
|
7182
|
+
stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
7158
7183
|
/**
|
|
7159
|
-
* @description
|
|
7160
|
-
* @tags
|
|
7161
|
-
* @name
|
|
7162
|
-
* @summary
|
|
7163
|
-
* @request
|
|
7184
|
+
* @description get top symbols
|
|
7185
|
+
* @tags StockScreener
|
|
7186
|
+
* @name GetTopSymbols
|
|
7187
|
+
* @summary get top symbols
|
|
7188
|
+
* @request POST:/stock-screener/top
|
|
7164
7189
|
* @secure
|
|
7165
7190
|
*/
|
|
7166
|
-
|
|
7167
|
-
/** region id */
|
|
7168
|
-
id: string;
|
|
7169
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7191
|
+
getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
7170
7192
|
}
|
|
7171
7193
|
export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
7172
7194
|
readonly config: JwtClientConfig<HandleError>;
|