@orbis-systems/orbis-api-clients 0.6.4 → 0.6.6
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 +156 -138
- package/dist/aesmidas/index.d.ts.map +1 -1
- package/dist/aesmidas/index.esm.js +248 -248
- package/dist/aesmidas/index.esm.js.map +1 -1
- package/dist/aesmidas/index.js +247 -247
- package/dist/aesmidas/index.js.map +1 -1
- package/dist/bridgewise/index.d.ts +408 -409
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +826 -826
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +825 -825
- package/dist/bridgewise/index.js.map +1 -1
- package/dist/insight/index.d.ts +912 -691
- package/dist/insight/index.d.ts.map +1 -1
- package/dist/insight/index.esm.js +1434 -1272
- package/dist/insight/index.esm.js.map +1 -1
- package/dist/insight/index.js +1433 -1271
- package/dist/insight/index.js.map +1 -1
- package/dist/middleware/index.d.ts +144 -144
- package/dist/middleware/index.d.ts.map +1 -1
- package/dist/middleware/index.esm.js +317 -317
- package/dist/middleware/index.esm.js.map +1 -1
- package/dist/middleware/index.js +316 -316
- package/dist/middleware/index.js.map +1 -1
- package/dist/orbis/index.d.ts +4068 -4068
- package/dist/orbis/index.d.ts.map +1 -1
- package/dist/orbis/index.esm.js +3394 -3394
- package/dist/orbis/index.esm.js.map +1 -1
- package/dist/orbis/index.js +3393 -3393
- package/dist/orbis/index.js.map +1 -1
- package/dist/uma/index.d.ts +654 -654
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +2973 -2973
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +2972 -2972
- package/dist/uma/index.js.map +1 -1
- package/package.json +1 -1
package/dist/insight/index.d.ts
CHANGED
|
@@ -401,7 +401,7 @@ export interface InsightClassificationResponse {
|
|
|
401
401
|
id: number;
|
|
402
402
|
name: string;
|
|
403
403
|
}
|
|
404
|
-
export interface
|
|
404
|
+
export interface InsightCombinedProfileResponse {
|
|
405
405
|
/** @example "One Apple Park Way" */
|
|
406
406
|
address: string;
|
|
407
407
|
/** @example "Miscellaneous" */
|
|
@@ -438,7 +438,7 @@ export interface InsightCombainedProfileResponse {
|
|
|
438
438
|
/** @example 36.403 */
|
|
439
439
|
fund_ownership_percent: number;
|
|
440
440
|
/** @example "EQUITY" */
|
|
441
|
-
fund_type:
|
|
441
|
+
fund_type: InsightCombinedProfileResponseFundTypeEnum;
|
|
442
442
|
/** @example 0.392 */
|
|
443
443
|
insider_ownership_percent: number;
|
|
444
444
|
/** @example 39.768 */
|
|
@@ -953,11 +953,11 @@ export interface InsightFundScreenerRequest {
|
|
|
953
953
|
assets?: string[];
|
|
954
954
|
categories?: string[];
|
|
955
955
|
/** @example "ETF" */
|
|
956
|
-
fund_type
|
|
956
|
+
fund_type?: InsightFundScreenerRequestFundTypeEnum;
|
|
957
957
|
/** @example "ANY" */
|
|
958
|
-
inverse
|
|
958
|
+
inverse?: InsightFundScreenerRequestInverseEnum;
|
|
959
959
|
/** @example "ANY" */
|
|
960
|
-
leverage
|
|
960
|
+
leverage?: InsightFundScreenerRequestLeverageEnum;
|
|
961
961
|
market_cap?: InsightLessAndMore;
|
|
962
962
|
paging: InsightPaging;
|
|
963
963
|
sectors?: InsightSectorFilter[];
|
|
@@ -1270,6 +1270,22 @@ export interface InsightGetOwnershipsBySymbolWithoutSearchQueryRequest {
|
|
|
1270
1270
|
/** @example ["AAPL","GOOGL"] */
|
|
1271
1271
|
symbols: string[];
|
|
1272
1272
|
}
|
|
1273
|
+
export interface InsightGetPreIPOCompaniesResponse {
|
|
1274
|
+
count: number;
|
|
1275
|
+
details: InsightPreIPOCompany[];
|
|
1276
|
+
}
|
|
1277
|
+
export interface InsightGetPreIPOCompanyInvestmentsResponse {
|
|
1278
|
+
count: number;
|
|
1279
|
+
details: InsightPreIPOCompanyInvestment[];
|
|
1280
|
+
}
|
|
1281
|
+
export interface InsightGetPreIPOCompanyNewsResponse {
|
|
1282
|
+
count: number;
|
|
1283
|
+
details: InsightPreIPOCompanyNews[];
|
|
1284
|
+
}
|
|
1285
|
+
export interface InsightGetPreIPOCompanyResearchDocumentsResponse {
|
|
1286
|
+
count: number;
|
|
1287
|
+
details: InsightPreIPOCompanyResearchDocument[];
|
|
1288
|
+
}
|
|
1273
1289
|
export interface InsightGetScreenerPresetsResponse {
|
|
1274
1290
|
count: number;
|
|
1275
1291
|
default_presets: InsightScreenerPreset[];
|
|
@@ -3205,6 +3221,91 @@ export interface InsightPortfoliosResponse {
|
|
|
3205
3221
|
status: string;
|
|
3206
3222
|
stock_ticker: string;
|
|
3207
3223
|
}
|
|
3224
|
+
export interface InsightPreIPOCompany {
|
|
3225
|
+
address: string;
|
|
3226
|
+
country: string;
|
|
3227
|
+
description: string;
|
|
3228
|
+
domain: string;
|
|
3229
|
+
executive_team: string[];
|
|
3230
|
+
facebook: string;
|
|
3231
|
+
founder: string;
|
|
3232
|
+
id: string;
|
|
3233
|
+
last_funding_date: string;
|
|
3234
|
+
last_funding_series: string;
|
|
3235
|
+
last_funding_total: number;
|
|
3236
|
+
last_funding_type: string;
|
|
3237
|
+
last_share_price: number;
|
|
3238
|
+
last_valuation: number;
|
|
3239
|
+
linkedin: string;
|
|
3240
|
+
logo_url: string;
|
|
3241
|
+
name: string;
|
|
3242
|
+
notable_investors_logos: string[];
|
|
3243
|
+
num_customers: number;
|
|
3244
|
+
num_investors: number;
|
|
3245
|
+
num_jobs: number;
|
|
3246
|
+
num_shares_outstanding: number;
|
|
3247
|
+
total_funding: number;
|
|
3248
|
+
total_funding_rounds: number;
|
|
3249
|
+
twelve_month_trailing_revenue: number;
|
|
3250
|
+
type: string;
|
|
3251
|
+
x: string;
|
|
3252
|
+
year_est: string;
|
|
3253
|
+
}
|
|
3254
|
+
export interface InsightPreIPOCompanyArticle {
|
|
3255
|
+
article_id: string;
|
|
3256
|
+
date_published: string;
|
|
3257
|
+
headline: string;
|
|
3258
|
+
id: string;
|
|
3259
|
+
link: string;
|
|
3260
|
+
pre_ipo_company_news_id: string;
|
|
3261
|
+
publication: string;
|
|
3262
|
+
short_summary: string;
|
|
3263
|
+
source: string;
|
|
3264
|
+
}
|
|
3265
|
+
export interface InsightPreIPOCompanyInvestment {
|
|
3266
|
+
carried_interest: number;
|
|
3267
|
+
company_name: string;
|
|
3268
|
+
created_at: string;
|
|
3269
|
+
fund_structure: string;
|
|
3270
|
+
gp_name: string;
|
|
3271
|
+
id: string;
|
|
3272
|
+
investment_size: number;
|
|
3273
|
+
lp_stake_percentage: number;
|
|
3274
|
+
lp_stake_share_count: number;
|
|
3275
|
+
management_fee: number;
|
|
3276
|
+
management_fee_frequency: string;
|
|
3277
|
+
number_of_shares: number;
|
|
3278
|
+
pre_ipo_company_id: string;
|
|
3279
|
+
price_per_share: number;
|
|
3280
|
+
share_class: string;
|
|
3281
|
+
share_type: string;
|
|
3282
|
+
spv_outstanding_share_count: number;
|
|
3283
|
+
total_capital_raise: number;
|
|
3284
|
+
transaction_type: string;
|
|
3285
|
+
updated_at: string;
|
|
3286
|
+
}
|
|
3287
|
+
export interface InsightPreIPOCompanyNews {
|
|
3288
|
+
articles: InsightPreIPOCompanyArticle[];
|
|
3289
|
+
description: string;
|
|
3290
|
+
headline: string;
|
|
3291
|
+
id: string;
|
|
3292
|
+
link: string;
|
|
3293
|
+
news_id: string;
|
|
3294
|
+
pre_ipo_company_id: string;
|
|
3295
|
+
release_date: string;
|
|
3296
|
+
source: string;
|
|
3297
|
+
}
|
|
3298
|
+
export interface InsightPreIPOCompanyResearchDocument {
|
|
3299
|
+
id: string;
|
|
3300
|
+
link: string;
|
|
3301
|
+
pre_ipo_company_id: string;
|
|
3302
|
+
preview_meta: string;
|
|
3303
|
+
relation: string;
|
|
3304
|
+
research_document_id: string;
|
|
3305
|
+
source: string;
|
|
3306
|
+
title: string;
|
|
3307
|
+
type: string;
|
|
3308
|
+
}
|
|
3208
3309
|
export interface InsightPublicQuoteProfile {
|
|
3209
3310
|
average_volume_30d: number;
|
|
3210
3311
|
closing_price: number;
|
|
@@ -3928,9 +4029,10 @@ export enum InsightCalculateParamsRequestOptionTypeEnum {
|
|
|
3928
4029
|
P = "p"
|
|
3929
4030
|
}
|
|
3930
4031
|
/** @example "EQUITY" */
|
|
3931
|
-
export enum
|
|
4032
|
+
export enum InsightCombinedProfileResponseFundTypeEnum {
|
|
3932
4033
|
EQUITY = "EQUITY",
|
|
3933
|
-
|
|
4034
|
+
ETF = "ETF",
|
|
4035
|
+
MF = "MF",
|
|
3934
4036
|
INDEX = "INDEX"
|
|
3935
4037
|
}
|
|
3936
4038
|
/** @example "normal" */
|
|
@@ -3959,6 +4061,7 @@ export enum InsightFundScreenerRequestInverseEnum {
|
|
|
3959
4061
|
/** @example "ANY" */
|
|
3960
4062
|
export enum InsightFundScreenerRequestLeverageEnum {
|
|
3961
4063
|
ANY = "ANY",
|
|
4064
|
+
ALL = "ALL",
|
|
3962
4065
|
LEVERAGE_I = "LEVERAGE_I",
|
|
3963
4066
|
LEVERAGE_II = "LEVERAGE_II",
|
|
3964
4067
|
LEVERAGE_III = "LEVERAGE_III"
|
|
@@ -4085,27 +4188,187 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
|
|
|
4085
4188
|
Date = "date",
|
|
4086
4189
|
Rank = "rank"
|
|
4087
4190
|
}
|
|
4088
|
-
export class
|
|
4191
|
+
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
4089
4192
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4090
4193
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4091
4194
|
/**
|
|
4092
|
-
* @description
|
|
4093
|
-
* @tags
|
|
4094
|
-
* @name
|
|
4095
|
-
* @summary
|
|
4096
|
-
* @request
|
|
4195
|
+
* @description Get continents
|
|
4196
|
+
* @tags World Markets
|
|
4197
|
+
* @name ContinentGet
|
|
4198
|
+
* @summary Get continents
|
|
4199
|
+
* @request GET:/continents
|
|
4097
4200
|
* @secure
|
|
4098
4201
|
*/
|
|
4099
|
-
|
|
4202
|
+
continentGet(query: {
|
|
4203
|
+
/** Query limit */
|
|
4204
|
+
limit: number;
|
|
4205
|
+
/** Query offset */
|
|
4206
|
+
offset: number;
|
|
4207
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4100
4208
|
/**
|
|
4101
|
-
* @description
|
|
4102
|
-
* @tags
|
|
4103
|
-
* @name
|
|
4104
|
-
* @summary
|
|
4105
|
-
* @request
|
|
4209
|
+
* @description Edit continent
|
|
4210
|
+
* @tags World Markets
|
|
4211
|
+
* @name ContinentEdit
|
|
4212
|
+
* @summary Edit continent
|
|
4213
|
+
* @request PUT:/continents
|
|
4106
4214
|
* @secure
|
|
4107
4215
|
*/
|
|
4108
|
-
|
|
4216
|
+
continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4217
|
+
/**
|
|
4218
|
+
* @description Create continents
|
|
4219
|
+
* @tags World Markets
|
|
4220
|
+
* @name ContinentCreate
|
|
4221
|
+
* @summary Create continents
|
|
4222
|
+
* @request POST:/continents
|
|
4223
|
+
* @secure
|
|
4224
|
+
*/
|
|
4225
|
+
continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4226
|
+
/**
|
|
4227
|
+
* @description Delete continent
|
|
4228
|
+
* @tags World Markets
|
|
4229
|
+
* @name ContinentDelete
|
|
4230
|
+
* @summary Delete continent
|
|
4231
|
+
* @request DELETE:/continents
|
|
4232
|
+
* @secure
|
|
4233
|
+
*/
|
|
4234
|
+
continentDelete(query: {
|
|
4235
|
+
/** continent id */
|
|
4236
|
+
id: string;
|
|
4237
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4238
|
+
/**
|
|
4239
|
+
* @description Get country codes
|
|
4240
|
+
* @tags World Markets
|
|
4241
|
+
* @name CountryCodeGet
|
|
4242
|
+
* @summary Get country codes
|
|
4243
|
+
* @request GET:/country-codes
|
|
4244
|
+
* @secure
|
|
4245
|
+
*/
|
|
4246
|
+
countryCodeGet(query: {
|
|
4247
|
+
/** Query limit */
|
|
4248
|
+
limit: number;
|
|
4249
|
+
/** Query offset */
|
|
4250
|
+
offset: number;
|
|
4251
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4252
|
+
/**
|
|
4253
|
+
* @description Edit country code
|
|
4254
|
+
* @tags World Markets
|
|
4255
|
+
* @name CountryCodeEdit
|
|
4256
|
+
* @summary Edit country code
|
|
4257
|
+
* @request PUT:/country-codes
|
|
4258
|
+
* @secure
|
|
4259
|
+
*/
|
|
4260
|
+
countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4261
|
+
/**
|
|
4262
|
+
* @description Add country codes
|
|
4263
|
+
* @tags World Markets
|
|
4264
|
+
* @name CountryCodeAdd
|
|
4265
|
+
* @summary Add country codes
|
|
4266
|
+
* @request POST:/country-codes
|
|
4267
|
+
* @secure
|
|
4268
|
+
*/
|
|
4269
|
+
countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4270
|
+
/**
|
|
4271
|
+
* @description Delete country code
|
|
4272
|
+
* @tags World Markets
|
|
4273
|
+
* @name CountryCodeDelete
|
|
4274
|
+
* @summary Delete country code
|
|
4275
|
+
* @request DELETE:/country-codes
|
|
4276
|
+
* @secure
|
|
4277
|
+
*/
|
|
4278
|
+
countryCodeDelete(query: {
|
|
4279
|
+
/** a3 code */
|
|
4280
|
+
a3code: string;
|
|
4281
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4282
|
+
/**
|
|
4283
|
+
* @description Get global indexes
|
|
4284
|
+
* @tags World Markets
|
|
4285
|
+
* @name GlobalIndexGet
|
|
4286
|
+
* @summary Get global indexes
|
|
4287
|
+
* @request GET:/global-indexes
|
|
4288
|
+
* @secure
|
|
4289
|
+
*/
|
|
4290
|
+
globalIndexGet(query: {
|
|
4291
|
+
/** Query limit */
|
|
4292
|
+
limit: number;
|
|
4293
|
+
/** Query offset */
|
|
4294
|
+
offset: number;
|
|
4295
|
+
/** Continent code for filtering */
|
|
4296
|
+
continent?: string;
|
|
4297
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4298
|
+
/**
|
|
4299
|
+
* @description Edit global index
|
|
4300
|
+
* @tags World Markets
|
|
4301
|
+
* @name GlobalIndexEdit
|
|
4302
|
+
* @summary Edit global index
|
|
4303
|
+
* @request PUT:/global-indexes
|
|
4304
|
+
* @secure
|
|
4305
|
+
*/
|
|
4306
|
+
globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4307
|
+
/**
|
|
4308
|
+
* @description Add global indexes
|
|
4309
|
+
* @tags World Markets
|
|
4310
|
+
* @name GlobalIndexAdd
|
|
4311
|
+
* @summary Add global indexes
|
|
4312
|
+
* @request POST:/global-indexes
|
|
4313
|
+
* @secure
|
|
4314
|
+
*/
|
|
4315
|
+
globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4316
|
+
/**
|
|
4317
|
+
* @description Edit global index
|
|
4318
|
+
* @tags World Markets
|
|
4319
|
+
* @name GlobalIndexDelete
|
|
4320
|
+
* @summary Delete global index
|
|
4321
|
+
* @request DELETE:/global-indexes
|
|
4322
|
+
* @secure
|
|
4323
|
+
*/
|
|
4324
|
+
globalIndexDelete(query: {
|
|
4325
|
+
/** a3 code */
|
|
4326
|
+
a3code: string;
|
|
4327
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4328
|
+
/**
|
|
4329
|
+
* @description Get regions
|
|
4330
|
+
* @tags World Markets
|
|
4331
|
+
* @name RegionGet
|
|
4332
|
+
* @summary Get regions
|
|
4333
|
+
* @request GET:/regions
|
|
4334
|
+
* @secure
|
|
4335
|
+
*/
|
|
4336
|
+
regionGet(query: {
|
|
4337
|
+
/** Query limit */
|
|
4338
|
+
limit: number;
|
|
4339
|
+
/** Query offset */
|
|
4340
|
+
offset: number;
|
|
4341
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
4342
|
+
/**
|
|
4343
|
+
* @description Edit region
|
|
4344
|
+
* @tags World Markets
|
|
4345
|
+
* @name RegionEdit
|
|
4346
|
+
* @summary Edit region
|
|
4347
|
+
* @request PUT:/regions
|
|
4348
|
+
* @secure
|
|
4349
|
+
*/
|
|
4350
|
+
regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4351
|
+
/**
|
|
4352
|
+
* @description Create regions
|
|
4353
|
+
* @tags World Markets
|
|
4354
|
+
* @name RegionCreate
|
|
4355
|
+
* @summary Create regions
|
|
4356
|
+
* @request POST:/regions
|
|
4357
|
+
* @secure
|
|
4358
|
+
*/
|
|
4359
|
+
regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
4360
|
+
/**
|
|
4361
|
+
* @description Delete region
|
|
4362
|
+
* @tags World Markets
|
|
4363
|
+
* @name RegionDelete
|
|
4364
|
+
* @summary Delete region
|
|
4365
|
+
* @request DELETE:/regions
|
|
4366
|
+
* @secure
|
|
4367
|
+
*/
|
|
4368
|
+
regionDelete(query: {
|
|
4369
|
+
/** region id */
|
|
4370
|
+
id: string;
|
|
4371
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4109
4372
|
}
|
|
4110
4373
|
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4111
4374
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4135,7 +4398,7 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
|
4135
4398
|
symbol: string;
|
|
4136
4399
|
/** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
|
|
4137
4400
|
symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
|
|
4138
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4401
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
|
|
4139
4402
|
/**
|
|
4140
4403
|
* @description sort input array of symbols by type
|
|
4141
4404
|
* @tags CompanyProfile
|
|
@@ -4390,256 +4653,18 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
4390
4653
|
*/
|
|
4391
4654
|
getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
|
|
4392
4655
|
}
|
|
4393
|
-
export
|
|
4394
|
-
|
|
4395
|
-
|
|
4396
|
-
|
|
4397
|
-
|
|
4398
|
-
|
|
4399
|
-
|
|
4400
|
-
|
|
4401
|
-
|
|
4402
|
-
|
|
4403
|
-
|
|
4404
|
-
|
|
4405
|
-
close_price_asof: string;
|
|
4406
|
-
close_ytw: number;
|
|
4407
|
-
convertible: boolean;
|
|
4408
|
-
country: string;
|
|
4409
|
-
country_code: string;
|
|
4410
|
-
country_domicile: string;
|
|
4411
|
-
country_issue: string;
|
|
4412
|
-
coupon: number;
|
|
4413
|
-
coupon_frequency: string;
|
|
4414
|
-
coupon_type: string;
|
|
4415
|
-
currency: string;
|
|
4416
|
-
cusip: string;
|
|
4417
|
-
dated_date: string;
|
|
4418
|
-
daycount: string;
|
|
4419
|
-
description: string;
|
|
4420
|
-
description_short: string;
|
|
4421
|
-
duration: number;
|
|
4422
|
-
first_coupon_date: string;
|
|
4423
|
-
insured: boolean;
|
|
4424
|
-
isin: string;
|
|
4425
|
-
issue_date: string;
|
|
4426
|
-
issue_minimum_denomination: number;
|
|
4427
|
-
issue_price: number;
|
|
4428
|
-
issue_size: number;
|
|
4429
|
-
issuer: string;
|
|
4430
|
-
last_coupon_date: string;
|
|
4431
|
-
liquidity_institutional_aggregate: number;
|
|
4432
|
-
liquidity_institutional_buy: number;
|
|
4433
|
-
liquidity_institutional_sell: number;
|
|
4434
|
-
liquidity_micro_aggregate: number;
|
|
4435
|
-
liquidity_micro_buy: number;
|
|
4436
|
-
liquidity_micro_sell: number;
|
|
4437
|
-
liquidity_retail_aggregate: number;
|
|
4438
|
-
liquidity_retail_buy: number;
|
|
4439
|
-
liquidity_retail_sell: number;
|
|
4440
|
-
maturity_date: string;
|
|
4441
|
-
municipal_state: string;
|
|
4442
|
-
municipal_taxable_federal: boolean;
|
|
4443
|
-
municipal_type: string;
|
|
4444
|
-
next_call_date: string;
|
|
4445
|
-
next_call_price: number;
|
|
4446
|
-
next_coupon_date: string;
|
|
4447
|
-
par_value: number;
|
|
4448
|
-
perpetual: boolean;
|
|
4449
|
-
private_placement: boolean;
|
|
4450
|
-
purpose: string;
|
|
4451
|
-
puttable: boolean;
|
|
4452
|
-
reg_s: boolean;
|
|
4453
|
-
sector: string;
|
|
4454
|
-
seniority: string;
|
|
4455
|
-
settlement_convention: string;
|
|
4456
|
-
sinking_fund: boolean;
|
|
4457
|
-
sp_creditwatch: string;
|
|
4458
|
-
sp_creditwatch_date: string;
|
|
4459
|
-
sp_outlook: string;
|
|
4460
|
-
sp_outlook_date: string;
|
|
4461
|
-
sp_rating: string;
|
|
4462
|
-
sp_rating_date: string;
|
|
4463
|
-
status: string;
|
|
4464
|
-
ticker: string;
|
|
4465
|
-
treasury_subtype: string;
|
|
4466
|
-
type: string;
|
|
4467
|
-
updated_at: string;
|
|
4468
|
-
}
|
|
4469
|
-
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
4470
|
-
count: number;
|
|
4471
|
-
data: InsightFixedIncomeV2[];
|
|
4472
|
-
}
|
|
4473
|
-
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
4474
|
-
/** @example true */
|
|
4475
|
-
bank_qualified?: boolean;
|
|
4476
|
-
/** @example true */
|
|
4477
|
-
callable?: boolean;
|
|
4478
|
-
/** @example true */
|
|
4479
|
-
convertible?: boolean;
|
|
4480
|
-
/** @example ["USA"] */
|
|
4481
|
-
country_codes?: string[];
|
|
4482
|
-
coupon?: InsightLessAndMoreV2;
|
|
4483
|
-
/** @example ["quarterly","zero"] */
|
|
4484
|
-
coupon_frequencies?: string[];
|
|
4485
|
-
/** @example ["655664AH3","9128286R6"] */
|
|
4486
|
-
cusip?: string[];
|
|
4487
|
-
/**
|
|
4488
|
-
* @maxLength 100
|
|
4489
|
-
* @example "Donald's"
|
|
4490
|
-
*/
|
|
4491
|
-
description?: string;
|
|
4492
|
-
/** @example true */
|
|
4493
|
-
has_ticker?: boolean;
|
|
4494
|
-
/** @example true */
|
|
4495
|
-
insured?: boolean;
|
|
4496
|
-
/** @example ["US655664AH33","US9128286R69"] */
|
|
4497
|
-
isin?: string[];
|
|
4498
|
-
issue_date?: InsightBeforeAndAfterV2;
|
|
4499
|
-
/**
|
|
4500
|
-
* @maxLength 100
|
|
4501
|
-
* @example "Donald's"
|
|
4502
|
-
*/
|
|
4503
|
-
issuer?: string;
|
|
4504
|
-
maturity?: InsightBeforeAndAfterV2;
|
|
4505
|
-
/** @example ["NY"] */
|
|
4506
|
-
municipal_states?: string[];
|
|
4507
|
-
/** @example true */
|
|
4508
|
-
municipal_tax?: boolean;
|
|
4509
|
-
/** @example ["general_obligation"] */
|
|
4510
|
-
municipal_types?: string[];
|
|
4511
|
-
pagination: InsightPaginationV2;
|
|
4512
|
-
purposes?: string[];
|
|
4513
|
-
/** @example ["SOVEREIGN"] */
|
|
4514
|
-
sectors?: string[];
|
|
4515
|
-
sorts?: InsightOrderingV2[];
|
|
4516
|
-
/** @example ["AAA"] */
|
|
4517
|
-
sp_ratings?: string[];
|
|
4518
|
-
/** @example ["called","outstanding"] */
|
|
4519
|
-
statuses?: string[];
|
|
4520
|
-
tickers?: string[];
|
|
4521
|
-
/** @example ["corporate"] */
|
|
4522
|
-
types?: string[];
|
|
4523
|
-
}
|
|
4524
|
-
export interface InsightGetTopSymbolsRequestV2 {
|
|
4525
|
-
exchange?: string[];
|
|
4526
|
-
market_cap?: InsightLessAndMoreV2;
|
|
4527
|
-
pagination?: InsightPaginationV2;
|
|
4528
|
-
price?: InsightLessAndMoreV2;
|
|
4529
|
-
sorts?: InsightOrderingV2[];
|
|
4530
|
-
volume?: InsightLessAndMoreV2;
|
|
4531
|
-
}
|
|
4532
|
-
export interface InsightIncludeExcludeV2 {
|
|
4533
|
-
exclude?: string[];
|
|
4534
|
-
include?: string[];
|
|
4535
|
-
}
|
|
4536
|
-
export interface InsightLessAndMoreV2 {
|
|
4537
|
-
less_than?: number;
|
|
4538
|
-
more_than?: number;
|
|
4539
|
-
}
|
|
4540
|
-
export interface InsightOrderingV2 {
|
|
4541
|
-
/**
|
|
4542
|
-
* @default "asc"
|
|
4543
|
-
* @example "asc"
|
|
4544
|
-
*/
|
|
4545
|
-
direction: InsightOrderingDirectionEnumV2;
|
|
4546
|
-
/**
|
|
4547
|
-
* Sort direction:
|
|
4548
|
-
* * asc - Ascending, from A to Z.
|
|
4549
|
-
* * desc - Descending, from Z to A.
|
|
4550
|
-
* @example "name"
|
|
4551
|
-
*/
|
|
4552
|
-
field: string;
|
|
4553
|
-
}
|
|
4554
|
-
export interface InsightPaginationV2 {
|
|
4555
|
-
/**
|
|
4556
|
-
* @min 1
|
|
4557
|
-
* @example 1
|
|
4558
|
-
*/
|
|
4559
|
-
page: number;
|
|
4560
|
-
/**
|
|
4561
|
-
* @min 1
|
|
4562
|
-
* @max 50
|
|
4563
|
-
* @example 10
|
|
4564
|
-
*/
|
|
4565
|
-
size: number;
|
|
4566
|
-
}
|
|
4567
|
-
export interface InsightStockScreenerQuoteV2 {
|
|
4568
|
-
average_volume_30d: number;
|
|
4569
|
-
company_name: string;
|
|
4570
|
-
dividend_ex_date: string;
|
|
4571
|
-
dividend_pay_date: string;
|
|
4572
|
-
dividend_percent: number;
|
|
4573
|
-
exchange: string;
|
|
4574
|
-
exchange_name: string;
|
|
4575
|
-
gap: number;
|
|
4576
|
-
industry: string;
|
|
4577
|
-
industry_code: string;
|
|
4578
|
-
last_price: number;
|
|
4579
|
-
market_cap: number;
|
|
4580
|
-
pe_ratio: number;
|
|
4581
|
-
price_change: number;
|
|
4582
|
-
price_change_percent: number;
|
|
4583
|
-
symbol: string;
|
|
4584
|
-
volume: number;
|
|
4585
|
-
}
|
|
4586
|
-
export interface InsightStockScreenerRequestV2 {
|
|
4587
|
-
average_volume_30d?: InsightLessAndMoreV2;
|
|
4588
|
-
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
4589
|
-
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
4590
|
-
dividend_percent?: InsightLessAndMoreV2;
|
|
4591
|
-
exchange?: InsightIncludeExcludeV2;
|
|
4592
|
-
gap?: InsightLessAndMoreV2;
|
|
4593
|
-
industry?: InsightIncludeExcludeV2;
|
|
4594
|
-
market_cap?: InsightLessAndMoreV2;
|
|
4595
|
-
pagination: InsightPaginationV2;
|
|
4596
|
-
pe_ratio?: InsightLessAndMoreV2;
|
|
4597
|
-
price?: InsightLessAndMoreV2;
|
|
4598
|
-
sorts?: InsightOrderingV2[];
|
|
4599
|
-
/** @example "ADR" */
|
|
4600
|
-
stock_type?: string;
|
|
4601
|
-
volume?: InsightLessAndMoreV2;
|
|
4602
|
-
}
|
|
4603
|
-
export interface InsightStockScreenerResponseV2 {
|
|
4604
|
-
current_page: number;
|
|
4605
|
-
data: InsightStockScreenerQuoteV2[];
|
|
4606
|
-
page_count: number;
|
|
4607
|
-
status: number;
|
|
4608
|
-
total_records: number;
|
|
4609
|
-
}
|
|
4610
|
-
/**
|
|
4611
|
-
* @default "asc"
|
|
4612
|
-
* @example "asc"
|
|
4613
|
-
*/
|
|
4614
|
-
export enum InsightOrderingDirectionEnumV2 {
|
|
4615
|
-
Asc = "asc",
|
|
4616
|
-
Desc = "desc"
|
|
4617
|
-
}
|
|
4618
|
-
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
4619
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4620
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4621
|
-
/**
|
|
4622
|
-
* @description get fixed income entries
|
|
4623
|
-
* @tags FixedIncome
|
|
4624
|
-
* @name GetFixedIncomeEntries
|
|
4625
|
-
* @summary get fixed income entries
|
|
4626
|
-
* @request POST:/fixed-income
|
|
4627
|
-
* @secure
|
|
4628
|
-
*/
|
|
4629
|
-
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
4630
|
-
}
|
|
4631
|
-
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
4632
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4633
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4634
|
-
/**
|
|
4635
|
-
* @description get fundamentals by symbol data
|
|
4636
|
-
* @tags Fundamentals
|
|
4637
|
-
* @name GetFundamentalsBySymbolData
|
|
4638
|
-
* @summary get fundamentals by symbol data
|
|
4639
|
-
* @request POST:/fundamentals
|
|
4640
|
-
* @secure
|
|
4641
|
-
*/
|
|
4642
|
-
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
4656
|
+
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
4657
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4658
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4659
|
+
/**
|
|
4660
|
+
* @description get fundamentals by symbol data
|
|
4661
|
+
* @tags Fundamentals
|
|
4662
|
+
* @name GetFundamentalsBySymbolData
|
|
4663
|
+
* @summary get fundamentals by symbol data
|
|
4664
|
+
* @request POST:/fundamentals
|
|
4665
|
+
* @secure
|
|
4666
|
+
*/
|
|
4667
|
+
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
4643
4668
|
}
|
|
4644
4669
|
export class Funds<HandleError extends boolean = boolean> {
|
|
4645
4670
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4714,28 +4739,281 @@ export class Funds<HandleError extends boolean = boolean> {
|
|
|
4714
4739
|
Authorization?: string;
|
|
4715
4740
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
|
|
4716
4741
|
}
|
|
4717
|
-
export class
|
|
4742
|
+
export class StockScreener<HandleError extends boolean = boolean> {
|
|
4718
4743
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4719
4744
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4720
4745
|
/**
|
|
4721
|
-
* @description
|
|
4722
|
-
* @tags
|
|
4723
|
-
* @name
|
|
4724
|
-
* @summary
|
|
4725
|
-
* @request
|
|
4746
|
+
* @description data for visual heat map
|
|
4747
|
+
* @tags StockScreener
|
|
4748
|
+
* @name StockMarketHeatmap
|
|
4749
|
+
* @summary data for visual heat map
|
|
4750
|
+
* @request GET:/heatmaps
|
|
4726
4751
|
* @secure
|
|
4727
4752
|
*/
|
|
4728
|
-
|
|
4729
|
-
|
|
4730
|
-
|
|
4731
|
-
|
|
4732
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4753
|
+
stockMarketHeatmap(query?: {
|
|
4754
|
+
/** Name of symbol list to fetch details for. Empty is default */
|
|
4755
|
+
heatmap_name?: string;
|
|
4756
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
4733
4757
|
/**
|
|
4734
|
-
* @description
|
|
4735
|
-
* @tags
|
|
4736
|
-
* @name
|
|
4737
|
-
* @summary
|
|
4738
|
-
* @request POST:/
|
|
4758
|
+
* @description create or update heat map preset
|
|
4759
|
+
* @tags StockScreener
|
|
4760
|
+
* @name CreateStockMarketHeatmapPreset
|
|
4761
|
+
* @summary create or update heat map preset
|
|
4762
|
+
* @request POST:/heatmaps
|
|
4763
|
+
* @secure
|
|
4764
|
+
*/
|
|
4765
|
+
createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4766
|
+
/**
|
|
4767
|
+
* @description Sector and Industry Group performance
|
|
4768
|
+
* @tags StockScreener
|
|
4769
|
+
* @name IndustriesPerformance
|
|
4770
|
+
* @summary get industries performance
|
|
4771
|
+
* @request POST:/industries-performance
|
|
4772
|
+
* @secure
|
|
4773
|
+
*/
|
|
4774
|
+
industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
|
|
4775
|
+
/**
|
|
4776
|
+
* @description filter stocks by params
|
|
4777
|
+
* @tags StockScreener
|
|
4778
|
+
* @name StockScreener
|
|
4779
|
+
* @summary filter stocks by params
|
|
4780
|
+
* @request POST:/stock-screener
|
|
4781
|
+
* @secure
|
|
4782
|
+
*/
|
|
4783
|
+
stockScreener(filter: InsightStockScreenerV1Request, headers?: {
|
|
4784
|
+
/** Authorization */
|
|
4785
|
+
Authorization?: string;
|
|
4786
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
4787
|
+
/**
|
|
4788
|
+
* @description get screener presets
|
|
4789
|
+
* @tags StockScreener
|
|
4790
|
+
* @name GetScreenerPresets
|
|
4791
|
+
* @summary get screener presets
|
|
4792
|
+
* @request GET:/stock-screener/presets
|
|
4793
|
+
* @secure
|
|
4794
|
+
*/
|
|
4795
|
+
getScreenerPresets(query: {
|
|
4796
|
+
/** how many records to return */
|
|
4797
|
+
limit: number;
|
|
4798
|
+
/** how many records to skip */
|
|
4799
|
+
offset: number;
|
|
4800
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
4801
|
+
/**
|
|
4802
|
+
* @description update screener preset
|
|
4803
|
+
* @tags StockScreener
|
|
4804
|
+
* @name UpdateScreenerPreset
|
|
4805
|
+
* @summary update screener preset
|
|
4806
|
+
* @request PUT:/stock-screener/presets
|
|
4807
|
+
* @secure
|
|
4808
|
+
*/
|
|
4809
|
+
updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
4810
|
+
/**
|
|
4811
|
+
* @description create screener preset
|
|
4812
|
+
* @tags StockScreener
|
|
4813
|
+
* @name CreateOrScreenerPreset
|
|
4814
|
+
* @summary create screener preset
|
|
4815
|
+
* @request POST:/stock-screener/presets
|
|
4816
|
+
* @secure
|
|
4817
|
+
*/
|
|
4818
|
+
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
4819
|
+
/**
|
|
4820
|
+
* @description remove screener preset
|
|
4821
|
+
* @tags StockScreener
|
|
4822
|
+
* @name RemoveScreenerPreset
|
|
4823
|
+
* @summary remove screener preset
|
|
4824
|
+
* @request DELETE:/stock-screener/presets
|
|
4825
|
+
* @secure
|
|
4826
|
+
*/
|
|
4827
|
+
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4828
|
+
/**
|
|
4829
|
+
* @description get top symbols
|
|
4830
|
+
* @tags StockScreener
|
|
4831
|
+
* @name GetTopSymbols
|
|
4832
|
+
* @summary get top symbols
|
|
4833
|
+
* @request POST:/stock-screener/top
|
|
4834
|
+
* @secure
|
|
4835
|
+
*/
|
|
4836
|
+
getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
4837
|
+
}
|
|
4838
|
+
export class Quotes<HandleError extends boolean = boolean> {
|
|
4839
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4840
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4841
|
+
/**
|
|
4842
|
+
* @description Get single historical quote
|
|
4843
|
+
* @tags Quotes
|
|
4844
|
+
* @name GitHistoricalQuote
|
|
4845
|
+
* @summary Get single historical quote
|
|
4846
|
+
* @request GET:/historical/quote
|
|
4847
|
+
* @secure
|
|
4848
|
+
*/
|
|
4849
|
+
gitHistoricalQuote(query: {
|
|
4850
|
+
/** Symbol */
|
|
4851
|
+
symbol: string;
|
|
4852
|
+
/** Date */
|
|
4853
|
+
date: string;
|
|
4854
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
4855
|
+
/**
|
|
4856
|
+
* @description get quote history by symbol
|
|
4857
|
+
* @tags Quotes
|
|
4858
|
+
* @name GitQuoteHistory
|
|
4859
|
+
* @summary Get quote history
|
|
4860
|
+
* @request POST:/quote-history
|
|
4861
|
+
* @secure
|
|
4862
|
+
*/
|
|
4863
|
+
gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
|
|
4864
|
+
/**
|
|
4865
|
+
* @description Returns a list of quotes equity info for specified symbols.
|
|
4866
|
+
* @tags Quotes
|
|
4867
|
+
* @name GetQuotesEquityData
|
|
4868
|
+
* @summary Get Quotes Equity data
|
|
4869
|
+
* @request GET:/quotes/equity
|
|
4870
|
+
* @secure
|
|
4871
|
+
*/
|
|
4872
|
+
getQuotesEquityData(query: {
|
|
4873
|
+
/** Comma separated symbols */
|
|
4874
|
+
symbols: string;
|
|
4875
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
4876
|
+
}
|
|
4877
|
+
export class Intraday<HandleError extends boolean = boolean> {
|
|
4878
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4879
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4880
|
+
/**
|
|
4881
|
+
* @description Returns an array of intraday chart data values for the given ticker.
|
|
4882
|
+
* @tags Intraday
|
|
4883
|
+
* @name IntradayQuotes
|
|
4884
|
+
* @summary Get an array of intraday chart data values for the given ticker
|
|
4885
|
+
* @request POST:/intraday/quotes
|
|
4886
|
+
* @secure
|
|
4887
|
+
*/
|
|
4888
|
+
intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
|
|
4889
|
+
}
|
|
4890
|
+
export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
4891
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4892
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4893
|
+
/**
|
|
4894
|
+
* @description get pre ipo companies
|
|
4895
|
+
* @tags PreIPOCompanies
|
|
4896
|
+
* @name GetPreIpoCompanies
|
|
4897
|
+
* @summary get pre ipo companies
|
|
4898
|
+
* @request GET:/ipos/pre-ipo-companies
|
|
4899
|
+
* @secure
|
|
4900
|
+
*/
|
|
4901
|
+
getPreIpoCompanies(query: {
|
|
4902
|
+
/** search by company name */
|
|
4903
|
+
name?: string;
|
|
4904
|
+
/** how many records to return. Max value is 50 */
|
|
4905
|
+
limit: number;
|
|
4906
|
+
/** how many records to skip */
|
|
4907
|
+
offset: number;
|
|
4908
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
|
|
4909
|
+
/**
|
|
4910
|
+
* @description get pre ipo company by id
|
|
4911
|
+
* @tags PreIPOCompanies
|
|
4912
|
+
* @name GetPreIpoCompanies2
|
|
4913
|
+
* @summary get pre ipo company by id
|
|
4914
|
+
* @request GET:/ipos/pre-ipo-companies/{id}
|
|
4915
|
+
* @originalName getPreIpoCompanies
|
|
4916
|
+
* @duplicate
|
|
4917
|
+
* @secure
|
|
4918
|
+
*/
|
|
4919
|
+
getPreIpoCompanies2(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
|
|
4920
|
+
/**
|
|
4921
|
+
* @description get pre ipo company investments
|
|
4922
|
+
* @tags PreIPOCompanies
|
|
4923
|
+
* @name GetPreIpoCompanyInvestments
|
|
4924
|
+
* @summary get pre ipo company investments
|
|
4925
|
+
* @request GET:/ipos/pre-ipo-company-investments
|
|
4926
|
+
* @secure
|
|
4927
|
+
*/
|
|
4928
|
+
getPreIpoCompanyInvestments(query: {
|
|
4929
|
+
/** company id */
|
|
4930
|
+
pre_ipo_company_id?: string;
|
|
4931
|
+
/** company name */
|
|
4932
|
+
company_name?: string;
|
|
4933
|
+
/** how many records to return. Max value is 50 */
|
|
4934
|
+
limit: number;
|
|
4935
|
+
/** how many records to skip */
|
|
4936
|
+
offset: number;
|
|
4937
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
|
|
4938
|
+
/**
|
|
4939
|
+
* @description get pre ipo company investment by id
|
|
4940
|
+
* @tags PreIPOCompanies
|
|
4941
|
+
* @name GetPreIpoCompanyInvestments2
|
|
4942
|
+
* @summary get pre ipo company investment by id
|
|
4943
|
+
* @request GET:/ipos/pre-ipo-company-investments/{id}
|
|
4944
|
+
* @originalName getPreIpoCompanyInvestments
|
|
4945
|
+
* @duplicate
|
|
4946
|
+
* @secure
|
|
4947
|
+
*/
|
|
4948
|
+
getPreIpoCompanyInvestments2(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
|
|
4949
|
+
/**
|
|
4950
|
+
* @description get pre ipo company news
|
|
4951
|
+
* @tags PreIPOCompanies
|
|
4952
|
+
* @name GetPreIpoCompanyNews
|
|
4953
|
+
* @summary get pre ipo company news
|
|
4954
|
+
* @request GET:/ipos/pre-ipo-company-news
|
|
4955
|
+
* @secure
|
|
4956
|
+
*/
|
|
4957
|
+
getPreIpoCompanyNews(query: {
|
|
4958
|
+
/** company id */
|
|
4959
|
+
pre_ipo_company_id?: string;
|
|
4960
|
+
/** search by headline */
|
|
4961
|
+
headline?: string;
|
|
4962
|
+
/** how many records to return. Max value is 50 */
|
|
4963
|
+
limit: number;
|
|
4964
|
+
/** how many records to skip */
|
|
4965
|
+
offset: number;
|
|
4966
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
|
|
4967
|
+
/**
|
|
4968
|
+
* @description get pre ipo company news by id
|
|
4969
|
+
* @tags PreIPOCompanies
|
|
4970
|
+
* @name GetPreIpoCompanyNews2
|
|
4971
|
+
* @summary get pre ipo company news by id
|
|
4972
|
+
* @request GET:/ipos/pre-ipo-company-news/{id}
|
|
4973
|
+
* @originalName getPreIpoCompanyNews
|
|
4974
|
+
* @duplicate
|
|
4975
|
+
* @secure
|
|
4976
|
+
*/
|
|
4977
|
+
getPreIpoCompanyNews2(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
|
|
4978
|
+
/**
|
|
4979
|
+
* @description get pre ipo company research documents
|
|
4980
|
+
* @tags PreIPOCompanies
|
|
4981
|
+
* @name GetPreIpoCompanyResearchDocuments
|
|
4982
|
+
* @summary get pre ipo company research documents
|
|
4983
|
+
* @request GET:/ipos/pre-ipo-company-research-documents
|
|
4984
|
+
* @secure
|
|
4985
|
+
*/
|
|
4986
|
+
getPreIpoCompanyResearchDocuments(query: {
|
|
4987
|
+
/** company id */
|
|
4988
|
+
pre_ipo_company_id?: string;
|
|
4989
|
+
/** search by title */
|
|
4990
|
+
title?: string;
|
|
4991
|
+
/** how many records to return. Max value is 50 */
|
|
4992
|
+
limit: number;
|
|
4993
|
+
/** how many records to skip */
|
|
4994
|
+
offset: number;
|
|
4995
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
|
|
4996
|
+
/**
|
|
4997
|
+
* @description get pre ipo company research document by id
|
|
4998
|
+
* @tags PreIPOCompanies
|
|
4999
|
+
* @name GetPreIpoCompanyResearchDocuments2
|
|
5000
|
+
* @summary get pre ipo company research document by id
|
|
5001
|
+
* @request GET:/ipos/pre-ipo-company-research-documents/{id}
|
|
5002
|
+
* @originalName getPreIpoCompanyResearchDocuments
|
|
5003
|
+
* @duplicate
|
|
5004
|
+
* @secure
|
|
5005
|
+
*/
|
|
5006
|
+
getPreIpoCompanyResearchDocuments2(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
|
|
5007
|
+
}
|
|
5008
|
+
export class Ipos<HandleError extends boolean = boolean> {
|
|
5009
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5010
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5011
|
+
/**
|
|
5012
|
+
* @description get recent ipos info
|
|
5013
|
+
* @tags Ipos
|
|
5014
|
+
* @name PostRecent
|
|
5015
|
+
* @summary get recent ipos info
|
|
5016
|
+
* @request POST:/ipos/recent
|
|
4739
5017
|
* @secure
|
|
4740
5018
|
*/
|
|
4741
5019
|
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
@@ -4854,31 +5132,6 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
4854
5132
|
symbol: string;
|
|
4855
5133
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
|
|
4856
5134
|
}
|
|
4857
|
-
export class MarketDates<HandleError extends boolean = boolean> {
|
|
4858
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4859
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4860
|
-
/**
|
|
4861
|
-
* @description get market dates history
|
|
4862
|
-
* @tags MarketDates
|
|
4863
|
-
* @name GetMarketDatesHistory
|
|
4864
|
-
* @summary get market dates history
|
|
4865
|
-
* @request POST:/market-dates/history
|
|
4866
|
-
* @secure
|
|
4867
|
-
*/
|
|
4868
|
-
getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
|
|
4869
|
-
/**
|
|
4870
|
-
* @description get todays market hours
|
|
4871
|
-
* @tags MarketDates
|
|
4872
|
-
* @name GetTodaysMarketHours
|
|
4873
|
-
* @summary get todays market hours
|
|
4874
|
-
* @request GET:/market-dates/today
|
|
4875
|
-
* @secure
|
|
4876
|
-
*/
|
|
4877
|
-
getTodaysMarketHours(query: {
|
|
4878
|
-
/** Market */
|
|
4879
|
-
market: string;
|
|
4880
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
4881
|
-
}
|
|
4882
5135
|
export class News<HandleError extends boolean = boolean> {
|
|
4883
5136
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4884
5137
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5020,6 +5273,31 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
5020
5273
|
*/
|
|
5021
5274
|
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5022
5275
|
}
|
|
5276
|
+
export class MarketDates<HandleError extends boolean = boolean> {
|
|
5277
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5278
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5279
|
+
/**
|
|
5280
|
+
* @description get market dates history
|
|
5281
|
+
* @tags MarketDates
|
|
5282
|
+
* @name GetMarketDatesHistory
|
|
5283
|
+
* @summary get market dates history
|
|
5284
|
+
* @request POST:/market-dates/history
|
|
5285
|
+
* @secure
|
|
5286
|
+
*/
|
|
5287
|
+
getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
|
|
5288
|
+
/**
|
|
5289
|
+
* @description get todays market hours
|
|
5290
|
+
* @tags MarketDates
|
|
5291
|
+
* @name GetTodaysMarketHours
|
|
5292
|
+
* @summary get todays market hours
|
|
5293
|
+
* @request GET:/market-dates/today
|
|
5294
|
+
* @secure
|
|
5295
|
+
*/
|
|
5296
|
+
getTodaysMarketHours(query: {
|
|
5297
|
+
/** Market */
|
|
5298
|
+
market: string;
|
|
5299
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
5300
|
+
}
|
|
5023
5301
|
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
5024
5302
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5025
5303
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5042,95 +5320,15 @@ export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
|
5042
5320
|
*/
|
|
5043
5321
|
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
5044
5322
|
}
|
|
5045
|
-
export class
|
|
5323
|
+
export class Public<HandleError extends boolean = boolean> {
|
|
5046
5324
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5047
5325
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5048
5326
|
/**
|
|
5049
|
-
* @description
|
|
5050
|
-
* @tags
|
|
5051
|
-
* @name
|
|
5052
|
-
* @summary
|
|
5053
|
-
* @request
|
|
5054
|
-
* @secure
|
|
5055
|
-
*/
|
|
5056
|
-
getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
5057
|
-
/**
|
|
5058
|
-
* @description get ownerships by symbol data
|
|
5059
|
-
* @tags Ownerships
|
|
5060
|
-
* @name GetOwnershipsBySymbolData
|
|
5061
|
-
* @summary get ownerships by symbol data
|
|
5062
|
-
* @request POST:/symbol-ownerships
|
|
5063
|
-
* @secure
|
|
5064
|
-
*/
|
|
5065
|
-
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
5066
|
-
}
|
|
5067
|
-
export class Passport<HandleError extends boolean = boolean> {
|
|
5068
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5069
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5070
|
-
/**
|
|
5071
|
-
* @description Returns article by id
|
|
5072
|
-
* @tags Passport
|
|
5073
|
-
* @name PassportArticleById
|
|
5074
|
-
* @summary Get article by id
|
|
5075
|
-
* @request POST:/passport/article-by-id
|
|
5076
|
-
* @secure
|
|
5077
|
-
*/
|
|
5078
|
-
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
5079
|
-
/**
|
|
5080
|
-
* @description Returns articles
|
|
5081
|
-
* @tags Passport
|
|
5082
|
-
* @name PassportArticles
|
|
5083
|
-
* @summary Get articles
|
|
5084
|
-
* @request POST:/passport/articles
|
|
5085
|
-
* @secure
|
|
5086
|
-
*/
|
|
5087
|
-
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5088
|
-
/**
|
|
5089
|
-
* @description Returns author profile
|
|
5090
|
-
* @tags Passport
|
|
5091
|
-
* @name PassportAuthorProfile
|
|
5092
|
-
* @summary Get author profile
|
|
5093
|
-
* @request POST:/passport/author-profile
|
|
5094
|
-
* @secure
|
|
5095
|
-
*/
|
|
5096
|
-
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
5097
|
-
/**
|
|
5098
|
-
* @description Returns most popular tags
|
|
5099
|
-
* @tags Passport
|
|
5100
|
-
* @name PassportMostPopularTags
|
|
5101
|
-
* @summary Get most popular tags
|
|
5102
|
-
* @request POST:/passport/most-popular-tags
|
|
5103
|
-
* @secure
|
|
5104
|
-
*/
|
|
5105
|
-
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
5106
|
-
/**
|
|
5107
|
-
* @description Returns news feed
|
|
5108
|
-
* @tags Passport
|
|
5109
|
-
* @name PassportNewsFeed
|
|
5110
|
-
* @summary Get news feed
|
|
5111
|
-
* @request POST:/passport/newsfeed
|
|
5112
|
-
* @secure
|
|
5113
|
-
*/
|
|
5114
|
-
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
|
|
5115
|
-
/**
|
|
5116
|
-
* @description Returns article by parameters
|
|
5117
|
-
* @tags Passport
|
|
5118
|
-
* @name PassportSearchArticle
|
|
5119
|
-
* @summary Search article by parameters
|
|
5120
|
-
* @request POST:/passport/search-article
|
|
5121
|
-
* @secure
|
|
5122
|
-
*/
|
|
5123
|
-
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5124
|
-
}
|
|
5125
|
-
export class Public<HandleError extends boolean = boolean> {
|
|
5126
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5127
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5128
|
-
/**
|
|
5129
|
-
* @description Calculate estimated returns for selected symbols. Uses split adjusted prices
|
|
5130
|
-
* @tags Public
|
|
5131
|
-
* @name CalculateEstimatedReturns
|
|
5132
|
-
* @summary Calculate Estimated Returns
|
|
5133
|
-
* @request GET:/public/estimated-returns
|
|
5327
|
+
* @description Calculate estimated returns for selected symbols. Uses split adjusted prices
|
|
5328
|
+
* @tags Public
|
|
5329
|
+
* @name CalculateEstimatedReturns
|
|
5330
|
+
* @summary Calculate Estimated Returns
|
|
5331
|
+
* @request GET:/public/estimated-returns
|
|
5134
5332
|
* @secure
|
|
5135
5333
|
*/
|
|
5136
5334
|
calculateEstimatedReturns(query: {
|
|
@@ -5248,163 +5446,6 @@ export class Public<HandleError extends boolean = boolean> {
|
|
|
5248
5446
|
offset: number;
|
|
5249
5447
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
5250
5448
|
}
|
|
5251
|
-
export class Quotes<HandleError extends boolean = boolean> {
|
|
5252
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5253
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5254
|
-
/**
|
|
5255
|
-
* @description Get single historical quote
|
|
5256
|
-
* @tags Quotes
|
|
5257
|
-
* @name GitHistoricalQuote
|
|
5258
|
-
* @summary Get single historical quote
|
|
5259
|
-
* @request GET:/historical/quote
|
|
5260
|
-
* @secure
|
|
5261
|
-
*/
|
|
5262
|
-
gitHistoricalQuote(query: {
|
|
5263
|
-
/** Symbol */
|
|
5264
|
-
symbol: string;
|
|
5265
|
-
/** Date */
|
|
5266
|
-
date: string;
|
|
5267
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
5268
|
-
/**
|
|
5269
|
-
* @description get quote history by symbol
|
|
5270
|
-
* @tags Quotes
|
|
5271
|
-
* @name GitQuoteHistory
|
|
5272
|
-
* @summary Get quote history
|
|
5273
|
-
* @request POST:/quote-history
|
|
5274
|
-
* @secure
|
|
5275
|
-
*/
|
|
5276
|
-
gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
|
|
5277
|
-
/**
|
|
5278
|
-
* @description Returns a list of quotes equity info for specified symbols.
|
|
5279
|
-
* @tags Quotes
|
|
5280
|
-
* @name GetQuotesEquityData
|
|
5281
|
-
* @summary Get Quotes Equity data
|
|
5282
|
-
* @request GET:/quotes/equity
|
|
5283
|
-
* @secure
|
|
5284
|
-
*/
|
|
5285
|
-
getQuotesEquityData(query: {
|
|
5286
|
-
/** Comma separated symbols */
|
|
5287
|
-
symbols: string;
|
|
5288
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
5289
|
-
}
|
|
5290
|
-
export class StockScreener<HandleError extends boolean = boolean> {
|
|
5291
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5292
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5293
|
-
/**
|
|
5294
|
-
* @description data for visual heat map
|
|
5295
|
-
* @tags StockScreener
|
|
5296
|
-
* @name StockMarketHeatmap
|
|
5297
|
-
* @summary data for visual heat map
|
|
5298
|
-
* @request GET:/heatmaps
|
|
5299
|
-
* @secure
|
|
5300
|
-
*/
|
|
5301
|
-
stockMarketHeatmap(query?: {
|
|
5302
|
-
/** Name of symbol list to fetch details for. Empty is default */
|
|
5303
|
-
heatmap_name?: string;
|
|
5304
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
5305
|
-
/**
|
|
5306
|
-
* @description create or update heat map preset
|
|
5307
|
-
* @tags StockScreener
|
|
5308
|
-
* @name CreateStockMarketHeatmapPreset
|
|
5309
|
-
* @summary create or update heat map preset
|
|
5310
|
-
* @request POST:/heatmaps
|
|
5311
|
-
* @secure
|
|
5312
|
-
*/
|
|
5313
|
-
createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5314
|
-
/**
|
|
5315
|
-
* @description Sector and Industry Group performance
|
|
5316
|
-
* @tags StockScreener
|
|
5317
|
-
* @name IndustriesPerformance
|
|
5318
|
-
* @summary get industries performance
|
|
5319
|
-
* @request POST:/industries-performance
|
|
5320
|
-
* @secure
|
|
5321
|
-
*/
|
|
5322
|
-
industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
|
|
5323
|
-
/**
|
|
5324
|
-
* @description filter stocks by params
|
|
5325
|
-
* @tags StockScreener
|
|
5326
|
-
* @name StockScreener
|
|
5327
|
-
* @summary filter stocks by params
|
|
5328
|
-
* @request POST:/stock-screener
|
|
5329
|
-
* @secure
|
|
5330
|
-
*/
|
|
5331
|
-
stockScreener(filter: InsightStockScreenerV1Request, headers?: {
|
|
5332
|
-
/** Authorization */
|
|
5333
|
-
Authorization?: string;
|
|
5334
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
5335
|
-
/**
|
|
5336
|
-
* @description get screener presets
|
|
5337
|
-
* @tags StockScreener
|
|
5338
|
-
* @name GetScreenerPresets
|
|
5339
|
-
* @summary get screener presets
|
|
5340
|
-
* @request GET:/stock-screener/presets
|
|
5341
|
-
* @secure
|
|
5342
|
-
*/
|
|
5343
|
-
getScreenerPresets(query: {
|
|
5344
|
-
/** how many records to return */
|
|
5345
|
-
limit: number;
|
|
5346
|
-
/** how many records to skip */
|
|
5347
|
-
offset: number;
|
|
5348
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
5349
|
-
/**
|
|
5350
|
-
* @description update screener preset
|
|
5351
|
-
* @tags StockScreener
|
|
5352
|
-
* @name UpdateScreenerPreset
|
|
5353
|
-
* @summary update screener preset
|
|
5354
|
-
* @request PUT:/stock-screener/presets
|
|
5355
|
-
* @secure
|
|
5356
|
-
*/
|
|
5357
|
-
updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5358
|
-
/**
|
|
5359
|
-
* @description create screener preset
|
|
5360
|
-
* @tags StockScreener
|
|
5361
|
-
* @name CreateOrScreenerPreset
|
|
5362
|
-
* @summary create screener preset
|
|
5363
|
-
* @request POST:/stock-screener/presets
|
|
5364
|
-
* @secure
|
|
5365
|
-
*/
|
|
5366
|
-
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5367
|
-
/**
|
|
5368
|
-
* @description remove screener preset
|
|
5369
|
-
* @tags StockScreener
|
|
5370
|
-
* @name RemoveScreenerPreset
|
|
5371
|
-
* @summary remove screener preset
|
|
5372
|
-
* @request DELETE:/stock-screener/presets
|
|
5373
|
-
* @secure
|
|
5374
|
-
*/
|
|
5375
|
-
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5376
|
-
/**
|
|
5377
|
-
* @description get top symbols
|
|
5378
|
-
* @tags StockScreener
|
|
5379
|
-
* @name GetTopSymbols
|
|
5380
|
-
* @summary get top symbols
|
|
5381
|
-
* @request POST:/stock-screener/top
|
|
5382
|
-
* @secure
|
|
5383
|
-
*/
|
|
5384
|
-
getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
5385
|
-
}
|
|
5386
|
-
export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
5387
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5388
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5389
|
-
/**
|
|
5390
|
-
* @description filter stocks by params
|
|
5391
|
-
* @tags StockScreener
|
|
5392
|
-
* @name StockScreener
|
|
5393
|
-
* @summary filter stocks by params
|
|
5394
|
-
* @request POST:/stock-screener
|
|
5395
|
-
* @secure
|
|
5396
|
-
*/
|
|
5397
|
-
stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
5398
|
-
/**
|
|
5399
|
-
* @description get top symbols
|
|
5400
|
-
* @tags StockScreener
|
|
5401
|
-
* @name GetTopSymbols
|
|
5402
|
-
* @summary get top symbols
|
|
5403
|
-
* @request POST:/stock-screener/top
|
|
5404
|
-
* @secure
|
|
5405
|
-
*/
|
|
5406
|
-
getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
5407
|
-
}
|
|
5408
5449
|
export class TipRank<HandleError extends boolean = boolean> {
|
|
5409
5450
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5410
5451
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5771,6 +5812,28 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
5771
5812
|
Authorization?: string;
|
|
5772
5813
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
|
|
5773
5814
|
}
|
|
5815
|
+
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
5816
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5817
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5818
|
+
/**
|
|
5819
|
+
* @description get seasonlity data with comparison to benchmark
|
|
5820
|
+
* @tags AlphaTools
|
|
5821
|
+
* @name GetMomentumRatioGraph
|
|
5822
|
+
* @summary get seasonlity data
|
|
5823
|
+
* @request POST:/rst
|
|
5824
|
+
* @secure
|
|
5825
|
+
*/
|
|
5826
|
+
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
5827
|
+
/**
|
|
5828
|
+
* @description get seasonlity data with comparison to benchmark
|
|
5829
|
+
* @tags AlphaTools
|
|
5830
|
+
* @name GetSeasonality
|
|
5831
|
+
* @summary get seasonlity data
|
|
5832
|
+
* @request POST:/seasonality
|
|
5833
|
+
* @secure
|
|
5834
|
+
*/
|
|
5835
|
+
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
5836
|
+
}
|
|
5774
5837
|
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
5775
5838
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5776
5839
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5784,187 +5847,345 @@ export class UsageTracking<HandleError extends boolean = boolean> {
|
|
|
5784
5847
|
*/
|
|
5785
5848
|
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
5786
5849
|
}
|
|
5787
|
-
export class
|
|
5850
|
+
export class Passport<HandleError extends boolean = boolean> {
|
|
5788
5851
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5789
5852
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5790
5853
|
/**
|
|
5791
|
-
* @description
|
|
5792
|
-
* @tags
|
|
5793
|
-
* @name
|
|
5794
|
-
* @summary Get
|
|
5795
|
-
* @request
|
|
5854
|
+
* @description Returns article by id
|
|
5855
|
+
* @tags Passport
|
|
5856
|
+
* @name PassportArticleById
|
|
5857
|
+
* @summary Get article by id
|
|
5858
|
+
* @request POST:/passport/article-by-id
|
|
5796
5859
|
* @secure
|
|
5797
5860
|
*/
|
|
5798
|
-
|
|
5799
|
-
/** Query limit */
|
|
5800
|
-
limit: number;
|
|
5801
|
-
/** Query offset */
|
|
5802
|
-
offset: number;
|
|
5803
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
5861
|
+
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
5804
5862
|
/**
|
|
5805
|
-
* @description
|
|
5806
|
-
* @tags
|
|
5807
|
-
* @name
|
|
5808
|
-
* @summary
|
|
5809
|
-
* @request
|
|
5863
|
+
* @description Returns articles
|
|
5864
|
+
* @tags Passport
|
|
5865
|
+
* @name PassportArticles
|
|
5866
|
+
* @summary Get articles
|
|
5867
|
+
* @request POST:/passport/articles
|
|
5810
5868
|
* @secure
|
|
5811
5869
|
*/
|
|
5812
|
-
|
|
5870
|
+
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5813
5871
|
/**
|
|
5814
|
-
* @description
|
|
5815
|
-
* @tags
|
|
5816
|
-
* @name
|
|
5817
|
-
* @summary
|
|
5818
|
-
* @request POST:/
|
|
5872
|
+
* @description Returns author profile
|
|
5873
|
+
* @tags Passport
|
|
5874
|
+
* @name PassportAuthorProfile
|
|
5875
|
+
* @summary Get author profile
|
|
5876
|
+
* @request POST:/passport/author-profile
|
|
5819
5877
|
* @secure
|
|
5820
5878
|
*/
|
|
5821
|
-
|
|
5879
|
+
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
5822
5880
|
/**
|
|
5823
|
-
* @description
|
|
5824
|
-
* @tags
|
|
5825
|
-
* @name
|
|
5826
|
-
* @summary
|
|
5827
|
-
* @request
|
|
5881
|
+
* @description Returns most popular tags
|
|
5882
|
+
* @tags Passport
|
|
5883
|
+
* @name PassportMostPopularTags
|
|
5884
|
+
* @summary Get most popular tags
|
|
5885
|
+
* @request POST:/passport/most-popular-tags
|
|
5828
5886
|
* @secure
|
|
5829
5887
|
*/
|
|
5830
|
-
|
|
5831
|
-
/** continent id */
|
|
5832
|
-
id: string;
|
|
5833
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5888
|
+
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
5834
5889
|
/**
|
|
5835
|
-
* @description
|
|
5836
|
-
* @tags
|
|
5837
|
-
* @name
|
|
5838
|
-
* @summary Get
|
|
5839
|
-
* @request
|
|
5890
|
+
* @description Returns news feed
|
|
5891
|
+
* @tags Passport
|
|
5892
|
+
* @name PassportNewsFeed
|
|
5893
|
+
* @summary Get news feed
|
|
5894
|
+
* @request POST:/passport/newsfeed
|
|
5840
5895
|
* @secure
|
|
5841
5896
|
*/
|
|
5842
|
-
|
|
5843
|
-
/** Query limit */
|
|
5844
|
-
limit: number;
|
|
5845
|
-
/** Query offset */
|
|
5846
|
-
offset: number;
|
|
5847
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
5897
|
+
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
|
|
5848
5898
|
/**
|
|
5849
|
-
* @description
|
|
5850
|
-
* @tags
|
|
5851
|
-
* @name
|
|
5852
|
-
* @summary
|
|
5853
|
-
* @request
|
|
5899
|
+
* @description Returns article by parameters
|
|
5900
|
+
* @tags Passport
|
|
5901
|
+
* @name PassportSearchArticle
|
|
5902
|
+
* @summary Search article by parameters
|
|
5903
|
+
* @request POST:/passport/search-article
|
|
5854
5904
|
* @secure
|
|
5855
5905
|
*/
|
|
5856
|
-
|
|
5906
|
+
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5907
|
+
}
|
|
5908
|
+
export class Ownerships<HandleError extends boolean = boolean> {
|
|
5909
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5910
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5857
5911
|
/**
|
|
5858
|
-
* @description
|
|
5859
|
-
* @tags
|
|
5860
|
-
* @name
|
|
5861
|
-
* @summary
|
|
5862
|
-
* @request POST:/
|
|
5912
|
+
* @description get ownerships by id datadata
|
|
5913
|
+
* @tags Ownerships
|
|
5914
|
+
* @name GetOwnershipsByIdData
|
|
5915
|
+
* @summary get ownerships by id data
|
|
5916
|
+
* @request POST:/ownerships
|
|
5863
5917
|
* @secure
|
|
5864
5918
|
*/
|
|
5865
|
-
|
|
5919
|
+
getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
5866
5920
|
/**
|
|
5867
|
-
* @description
|
|
5868
|
-
* @tags
|
|
5869
|
-
* @name
|
|
5870
|
-
* @summary
|
|
5871
|
-
* @request
|
|
5921
|
+
* @description get ownerships by symbol data
|
|
5922
|
+
* @tags Ownerships
|
|
5923
|
+
* @name GetOwnershipsBySymbolData
|
|
5924
|
+
* @summary get ownerships by symbol data
|
|
5925
|
+
* @request POST:/symbol-ownerships
|
|
5872
5926
|
* @secure
|
|
5873
5927
|
*/
|
|
5874
|
-
|
|
5875
|
-
|
|
5876
|
-
|
|
5877
|
-
|
|
5928
|
+
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
5929
|
+
}
|
|
5930
|
+
export interface InsightBeforeAndAfterV2 {
|
|
5931
|
+
after?: string;
|
|
5932
|
+
before?: string;
|
|
5933
|
+
}
|
|
5934
|
+
export interface InsightFixedIncomeV2 {
|
|
5935
|
+
a144: boolean;
|
|
5936
|
+
accrued_interest: number;
|
|
5937
|
+
bank_qualified: boolean;
|
|
5938
|
+
bond_warrant: boolean;
|
|
5939
|
+
call_type: string;
|
|
5940
|
+
callable: boolean;
|
|
5941
|
+
close_price: number;
|
|
5942
|
+
close_price_asof: string;
|
|
5943
|
+
close_ytw: number;
|
|
5944
|
+
convertible: boolean;
|
|
5945
|
+
country: string;
|
|
5946
|
+
country_code: string;
|
|
5947
|
+
country_domicile: string;
|
|
5948
|
+
country_issue: string;
|
|
5949
|
+
coupon: number;
|
|
5950
|
+
coupon_frequency: string;
|
|
5951
|
+
coupon_type: string;
|
|
5952
|
+
currency: string;
|
|
5953
|
+
cusip: string;
|
|
5954
|
+
dated_date: string;
|
|
5955
|
+
daycount: string;
|
|
5956
|
+
description: string;
|
|
5957
|
+
description_short: string;
|
|
5958
|
+
duration: number;
|
|
5959
|
+
first_coupon_date: string;
|
|
5960
|
+
insured: boolean;
|
|
5961
|
+
isin: string;
|
|
5962
|
+
issue_date: string;
|
|
5963
|
+
issue_minimum_denomination: number;
|
|
5964
|
+
issue_price: number;
|
|
5965
|
+
issue_size: number;
|
|
5966
|
+
issuer: string;
|
|
5967
|
+
last_coupon_date: string;
|
|
5968
|
+
liquidity_institutional_aggregate: number;
|
|
5969
|
+
liquidity_institutional_buy: number;
|
|
5970
|
+
liquidity_institutional_sell: number;
|
|
5971
|
+
liquidity_micro_aggregate: number;
|
|
5972
|
+
liquidity_micro_buy: number;
|
|
5973
|
+
liquidity_micro_sell: number;
|
|
5974
|
+
liquidity_retail_aggregate: number;
|
|
5975
|
+
liquidity_retail_buy: number;
|
|
5976
|
+
liquidity_retail_sell: number;
|
|
5977
|
+
maturity_date: string;
|
|
5978
|
+
municipal_state: string;
|
|
5979
|
+
municipal_taxable_federal: boolean;
|
|
5980
|
+
municipal_type: string;
|
|
5981
|
+
next_call_date: string;
|
|
5982
|
+
next_call_price: number;
|
|
5983
|
+
next_coupon_date: string;
|
|
5984
|
+
par_value: number;
|
|
5985
|
+
perpetual: boolean;
|
|
5986
|
+
private_placement: boolean;
|
|
5987
|
+
purpose: string;
|
|
5988
|
+
puttable: boolean;
|
|
5989
|
+
reg_s: boolean;
|
|
5990
|
+
sector: string;
|
|
5991
|
+
seniority: string;
|
|
5992
|
+
settlement_convention: string;
|
|
5993
|
+
sinking_fund: boolean;
|
|
5994
|
+
sp_creditwatch: string;
|
|
5995
|
+
sp_creditwatch_date: string;
|
|
5996
|
+
sp_outlook: string;
|
|
5997
|
+
sp_outlook_date: string;
|
|
5998
|
+
sp_rating: string;
|
|
5999
|
+
sp_rating_date: string;
|
|
6000
|
+
status: string;
|
|
6001
|
+
ticker: string;
|
|
6002
|
+
treasury_subtype: string;
|
|
6003
|
+
type: string;
|
|
6004
|
+
updated_at: string;
|
|
6005
|
+
}
|
|
6006
|
+
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
6007
|
+
count: number;
|
|
6008
|
+
data: InsightFixedIncomeV2[];
|
|
6009
|
+
}
|
|
6010
|
+
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
6011
|
+
/** @example true */
|
|
6012
|
+
bank_qualified?: boolean;
|
|
6013
|
+
/** @example true */
|
|
6014
|
+
callable?: boolean;
|
|
6015
|
+
/** @example true */
|
|
6016
|
+
convertible?: boolean;
|
|
6017
|
+
/** @example ["USA"] */
|
|
6018
|
+
country_codes?: string[];
|
|
6019
|
+
coupon?: InsightLessAndMoreV2;
|
|
6020
|
+
/** @example ["quarterly","zero"] */
|
|
6021
|
+
coupon_frequencies?: string[];
|
|
6022
|
+
/** @example ["655664AH3","9128286R6"] */
|
|
6023
|
+
cusip?: string[];
|
|
5878
6024
|
/**
|
|
5879
|
-
* @
|
|
5880
|
-
* @
|
|
5881
|
-
* @name GlobalIndexGet
|
|
5882
|
-
* @summary Get global indexes
|
|
5883
|
-
* @request GET:/global-indexes
|
|
5884
|
-
* @secure
|
|
6025
|
+
* @maxLength 100
|
|
6026
|
+
* @example "Donald's"
|
|
5885
6027
|
*/
|
|
5886
|
-
|
|
5887
|
-
|
|
5888
|
-
|
|
5889
|
-
|
|
5890
|
-
|
|
5891
|
-
|
|
5892
|
-
|
|
5893
|
-
|
|
6028
|
+
description?: string;
|
|
6029
|
+
/** @example true */
|
|
6030
|
+
has_ticker?: boolean;
|
|
6031
|
+
/** @example true */
|
|
6032
|
+
insured?: boolean;
|
|
6033
|
+
/** @example ["US655664AH33","US9128286R69"] */
|
|
6034
|
+
isin?: string[];
|
|
6035
|
+
issue_date?: InsightBeforeAndAfterV2;
|
|
5894
6036
|
/**
|
|
5895
|
-
* @
|
|
5896
|
-
* @
|
|
5897
|
-
* @name GlobalIndexEdit
|
|
5898
|
-
* @summary Edit global index
|
|
5899
|
-
* @request PUT:/global-indexes
|
|
5900
|
-
* @secure
|
|
6037
|
+
* @maxLength 100
|
|
6038
|
+
* @example "Donald's"
|
|
5901
6039
|
*/
|
|
5902
|
-
|
|
6040
|
+
issuer?: string;
|
|
6041
|
+
maturity?: InsightBeforeAndAfterV2;
|
|
6042
|
+
/** @example ["NY"] */
|
|
6043
|
+
municipal_states?: string[];
|
|
6044
|
+
/** @example true */
|
|
6045
|
+
municipal_tax?: boolean;
|
|
6046
|
+
/** @example ["general_obligation"] */
|
|
6047
|
+
municipal_types?: string[];
|
|
6048
|
+
pagination: InsightPaginationV2;
|
|
6049
|
+
purposes?: string[];
|
|
6050
|
+
/** @example ["SOVEREIGN"] */
|
|
6051
|
+
sectors?: string[];
|
|
6052
|
+
sorts?: InsightOrderingV2[];
|
|
6053
|
+
/** @example ["AAA"] */
|
|
6054
|
+
sp_ratings?: string[];
|
|
6055
|
+
/** @example ["called","outstanding"] */
|
|
6056
|
+
statuses?: string[];
|
|
6057
|
+
tickers?: string[];
|
|
6058
|
+
/** @example ["corporate"] */
|
|
6059
|
+
types?: string[];
|
|
6060
|
+
}
|
|
6061
|
+
export interface InsightGetTopSymbolsRequestV2 {
|
|
6062
|
+
exchange?: string[];
|
|
6063
|
+
market_cap?: InsightLessAndMoreV2;
|
|
6064
|
+
pagination?: InsightPaginationV2;
|
|
6065
|
+
price?: InsightLessAndMoreV2;
|
|
6066
|
+
sorts?: InsightOrderingV2[];
|
|
6067
|
+
volume?: InsightLessAndMoreV2;
|
|
6068
|
+
}
|
|
6069
|
+
export interface InsightIncludeExcludeV2 {
|
|
6070
|
+
exclude?: string[];
|
|
6071
|
+
include?: string[];
|
|
6072
|
+
}
|
|
6073
|
+
export interface InsightLessAndMoreV2 {
|
|
6074
|
+
less_than?: number;
|
|
6075
|
+
more_than?: number;
|
|
6076
|
+
}
|
|
6077
|
+
export interface InsightOrderingV2 {
|
|
5903
6078
|
/**
|
|
5904
|
-
* @
|
|
5905
|
-
* @
|
|
5906
|
-
* @name GlobalIndexAdd
|
|
5907
|
-
* @summary Add global indexes
|
|
5908
|
-
* @request POST:/global-indexes
|
|
5909
|
-
* @secure
|
|
6079
|
+
* @default "asc"
|
|
6080
|
+
* @example "asc"
|
|
5910
6081
|
*/
|
|
5911
|
-
|
|
6082
|
+
direction: InsightOrderingDirectionEnumV2;
|
|
5912
6083
|
/**
|
|
5913
|
-
*
|
|
5914
|
-
*
|
|
5915
|
-
*
|
|
5916
|
-
* @
|
|
5917
|
-
* @request DELETE:/global-indexes
|
|
5918
|
-
* @secure
|
|
6084
|
+
* Sort direction:
|
|
6085
|
+
* * asc - Ascending, from A to Z.
|
|
6086
|
+
* * desc - Descending, from Z to A.
|
|
6087
|
+
* @example "name"
|
|
5919
6088
|
*/
|
|
5920
|
-
|
|
5921
|
-
|
|
5922
|
-
|
|
5923
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6089
|
+
field: string;
|
|
6090
|
+
}
|
|
6091
|
+
export interface InsightPaginationV2 {
|
|
5924
6092
|
/**
|
|
5925
|
-
* @
|
|
5926
|
-
* @
|
|
5927
|
-
* @name RegionGet
|
|
5928
|
-
* @summary Get regions
|
|
5929
|
-
* @request GET:/regions
|
|
5930
|
-
* @secure
|
|
6093
|
+
* @min 1
|
|
6094
|
+
* @example 1
|
|
5931
6095
|
*/
|
|
5932
|
-
|
|
5933
|
-
/** Query limit */
|
|
5934
|
-
limit: number;
|
|
5935
|
-
/** Query offset */
|
|
5936
|
-
offset: number;
|
|
5937
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
6096
|
+
page: number;
|
|
5938
6097
|
/**
|
|
5939
|
-
* @
|
|
5940
|
-
* @
|
|
5941
|
-
* @
|
|
5942
|
-
|
|
5943
|
-
|
|
6098
|
+
* @min 1
|
|
6099
|
+
* @max 50
|
|
6100
|
+
* @example 10
|
|
6101
|
+
*/
|
|
6102
|
+
size: number;
|
|
6103
|
+
}
|
|
6104
|
+
export interface InsightStockScreenerQuoteV2 {
|
|
6105
|
+
average_volume_30d: number;
|
|
6106
|
+
company_name: string;
|
|
6107
|
+
dividend_ex_date: string;
|
|
6108
|
+
dividend_pay_date: string;
|
|
6109
|
+
dividend_percent: number;
|
|
6110
|
+
exchange: string;
|
|
6111
|
+
exchange_name: string;
|
|
6112
|
+
gap: number;
|
|
6113
|
+
industry: string;
|
|
6114
|
+
industry_code: string;
|
|
6115
|
+
last_price: number;
|
|
6116
|
+
market_cap: number;
|
|
6117
|
+
pe_ratio: number;
|
|
6118
|
+
price_change: number;
|
|
6119
|
+
price_change_percent: number;
|
|
6120
|
+
symbol: string;
|
|
6121
|
+
volume: number;
|
|
6122
|
+
}
|
|
6123
|
+
export interface InsightStockScreenerRequestV2 {
|
|
6124
|
+
average_volume_30d?: InsightLessAndMoreV2;
|
|
6125
|
+
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
6126
|
+
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
6127
|
+
dividend_percent?: InsightLessAndMoreV2;
|
|
6128
|
+
exchange?: InsightIncludeExcludeV2;
|
|
6129
|
+
gap?: InsightLessAndMoreV2;
|
|
6130
|
+
industry?: InsightIncludeExcludeV2;
|
|
6131
|
+
market_cap?: InsightLessAndMoreV2;
|
|
6132
|
+
pagination: InsightPaginationV2;
|
|
6133
|
+
pe_ratio?: InsightLessAndMoreV2;
|
|
6134
|
+
price?: InsightLessAndMoreV2;
|
|
6135
|
+
sorts?: InsightOrderingV2[];
|
|
6136
|
+
/** @example "ADR" */
|
|
6137
|
+
stock_type?: string;
|
|
6138
|
+
volume?: InsightLessAndMoreV2;
|
|
6139
|
+
}
|
|
6140
|
+
export interface InsightStockScreenerResponseV2 {
|
|
6141
|
+
current_page: number;
|
|
6142
|
+
data: InsightStockScreenerQuoteV2[];
|
|
6143
|
+
page_count: number;
|
|
6144
|
+
status: number;
|
|
6145
|
+
total_records: number;
|
|
6146
|
+
}
|
|
6147
|
+
/**
|
|
6148
|
+
* @default "asc"
|
|
6149
|
+
* @example "asc"
|
|
6150
|
+
*/
|
|
6151
|
+
export enum InsightOrderingDirectionEnumV2 {
|
|
6152
|
+
Asc = "asc",
|
|
6153
|
+
Desc = "desc"
|
|
6154
|
+
}
|
|
6155
|
+
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
6156
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6157
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6158
|
+
/**
|
|
6159
|
+
* @description get fixed income entries
|
|
6160
|
+
* @tags FixedIncome
|
|
6161
|
+
* @name GetFixedIncomeEntries
|
|
6162
|
+
* @summary get fixed income entries
|
|
6163
|
+
* @request POST:/fixed-income
|
|
5944
6164
|
* @secure
|
|
5945
6165
|
*/
|
|
5946
|
-
|
|
6166
|
+
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
6167
|
+
}
|
|
6168
|
+
export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
6169
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6170
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5947
6171
|
/**
|
|
5948
|
-
* @description
|
|
5949
|
-
* @tags
|
|
5950
|
-
* @name
|
|
5951
|
-
* @summary
|
|
5952
|
-
* @request POST:/
|
|
6172
|
+
* @description filter stocks by params
|
|
6173
|
+
* @tags StockScreener
|
|
6174
|
+
* @name StockScreener
|
|
6175
|
+
* @summary filter stocks by params
|
|
6176
|
+
* @request POST:/stock-screener
|
|
5953
6177
|
* @secure
|
|
5954
6178
|
*/
|
|
5955
|
-
|
|
6179
|
+
stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
5956
6180
|
/**
|
|
5957
|
-
* @description
|
|
5958
|
-
* @tags
|
|
5959
|
-
* @name
|
|
5960
|
-
* @summary
|
|
5961
|
-
* @request
|
|
6181
|
+
* @description get top symbols
|
|
6182
|
+
* @tags StockScreener
|
|
6183
|
+
* @name GetTopSymbols
|
|
6184
|
+
* @summary get top symbols
|
|
6185
|
+
* @request POST:/stock-screener/top
|
|
5962
6186
|
* @secure
|
|
5963
6187
|
*/
|
|
5964
|
-
|
|
5965
|
-
/** region id */
|
|
5966
|
-
id: string;
|
|
5967
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6188
|
+
getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
5968
6189
|
}
|
|
5969
6190
|
export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
5970
6191
|
readonly config: JwtClientConfig<HandleError>;
|