@orbis-systems/orbis-api-clients 0.6.10 → 0.6.11
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 +672 -775
- 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 +238 -77
- 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 +315 -298
- 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 +34 -34
- 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 +383 -363
- 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 +364 -328
- 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
|
@@ -3228,6 +3228,7 @@ export interface InsightPortfoliosResponse {
|
|
|
3228
3228
|
}
|
|
3229
3229
|
export interface InsightPreIPOCompany {
|
|
3230
3230
|
address: string;
|
|
3231
|
+
categories: string[];
|
|
3231
3232
|
country: string;
|
|
3232
3233
|
description: string;
|
|
3233
3234
|
domain: string;
|
|
@@ -4279,129 +4280,6 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
|
|
|
4279
4280
|
Date = "date",
|
|
4280
4281
|
Rank = "rank"
|
|
4281
4282
|
}
|
|
4282
|
-
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4283
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4284
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4285
|
-
/**
|
|
4286
|
-
* @description get company profile, industries classification and closest earning release
|
|
4287
|
-
* @tags CompanyProfile
|
|
4288
|
-
* @name GetCompanyProfile
|
|
4289
|
-
* @summary get company profile
|
|
4290
|
-
* @request GET:/company-profile
|
|
4291
|
-
* @secure
|
|
4292
|
-
*/
|
|
4293
|
-
getCompanyProfile(query: {
|
|
4294
|
-
/** Company symbol */
|
|
4295
|
-
symbol: string;
|
|
4296
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
|
|
4297
|
-
/**
|
|
4298
|
-
* @description get combined profile, equities and funds
|
|
4299
|
-
* @tags CompanyProfile
|
|
4300
|
-
* @name GetCombinedProfile
|
|
4301
|
-
* @summary get company profile
|
|
4302
|
-
* @request GET:/quote-profile
|
|
4303
|
-
* @secure
|
|
4304
|
-
*/
|
|
4305
|
-
getCombinedProfile(query: {
|
|
4306
|
-
/** Company symbol */
|
|
4307
|
-
symbol: string;
|
|
4308
|
-
/** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
|
|
4309
|
-
symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
|
|
4310
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
|
|
4311
|
-
/**
|
|
4312
|
-
* @description sort input array of symbols by type
|
|
4313
|
-
* @tags CompanyProfile
|
|
4314
|
-
* @name GetSymbolsPerSymbolType
|
|
4315
|
-
* @summary sort input array of symbols by type
|
|
4316
|
-
* @request POST:/symbols-per-type
|
|
4317
|
-
* @secure
|
|
4318
|
-
*/
|
|
4319
|
-
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
4320
|
-
}
|
|
4321
|
-
export class CustomLists<HandleError extends boolean = boolean> {
|
|
4322
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4323
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4324
|
-
/**
|
|
4325
|
-
* @description get custom lists
|
|
4326
|
-
* @tags Custom Lists
|
|
4327
|
-
* @name GetCustomLists
|
|
4328
|
-
* @summary get custom lists
|
|
4329
|
-
* @request GET:/custom-lists
|
|
4330
|
-
* @secure
|
|
4331
|
-
*/
|
|
4332
|
-
getCustomLists(query: {
|
|
4333
|
-
/** how many records to return. Max value is 50 */
|
|
4334
|
-
limit: number;
|
|
4335
|
-
/** how many records to skip */
|
|
4336
|
-
offset: number;
|
|
4337
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4338
|
-
/**
|
|
4339
|
-
* @description update custom list
|
|
4340
|
-
* @tags Custom Lists
|
|
4341
|
-
* @name UpdateCustomList
|
|
4342
|
-
* @summary update custom list
|
|
4343
|
-
* @request PUT:/custom-lists
|
|
4344
|
-
* @secure
|
|
4345
|
-
*/
|
|
4346
|
-
updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
4347
|
-
/**
|
|
4348
|
-
* @description create custom list
|
|
4349
|
-
* @tags Custom Lists
|
|
4350
|
-
* @name CreateCustomList
|
|
4351
|
-
* @summary create custom list
|
|
4352
|
-
* @request POST:/custom-lists
|
|
4353
|
-
* @secure
|
|
4354
|
-
*/
|
|
4355
|
-
createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
4356
|
-
/**
|
|
4357
|
-
* @description remove custom list
|
|
4358
|
-
* @tags Custom Lists
|
|
4359
|
-
* @name RemoveCustomList
|
|
4360
|
-
* @summary remove custom list
|
|
4361
|
-
* @request DELETE:/custom-lists
|
|
4362
|
-
* @secure
|
|
4363
|
-
*/
|
|
4364
|
-
removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4365
|
-
/**
|
|
4366
|
-
* @description filter custom lists
|
|
4367
|
-
* @tags Custom Lists
|
|
4368
|
-
* @name FilterCustomLists
|
|
4369
|
-
* @summary filter custom lists
|
|
4370
|
-
* @request POST:/custom-lists/filter
|
|
4371
|
-
* @secure
|
|
4372
|
-
*/
|
|
4373
|
-
filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4374
|
-
/**
|
|
4375
|
-
* @description get custom list with quotes
|
|
4376
|
-
* @tags Custom Lists
|
|
4377
|
-
* @name GetCustomListWithQuotes
|
|
4378
|
-
* @summary get custom list with quotes
|
|
4379
|
-
* @request GET:/custom-lists/{id-or-slug}
|
|
4380
|
-
* @secure
|
|
4381
|
-
*/
|
|
4382
|
-
getCustomListWithQuotes(idOrSlug: string, query: {
|
|
4383
|
-
/** sort direction - asc or desc */
|
|
4384
|
-
order_direction: string;
|
|
4385
|
-
/** sort field - volume, symbol(alphabetical), market_cap, dividend_percent */
|
|
4386
|
-
order_field: string;
|
|
4387
|
-
/** how many equities records to return. Max value is 50 */
|
|
4388
|
-
limit: number;
|
|
4389
|
-
/** how many equities records to skip */
|
|
4390
|
-
offset: number;
|
|
4391
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4392
|
-
/**
|
|
4393
|
-
* @description filter custom list
|
|
4394
|
-
* @tags Custom Lists
|
|
4395
|
-
* @name FilterCustomList
|
|
4396
|
-
* @summary filter custom list
|
|
4397
|
-
* @request GET:/custom-lists/{id-or-slug}/filter
|
|
4398
|
-
* @secure
|
|
4399
|
-
*/
|
|
4400
|
-
filterCustomList(idOrSlug: string, query?: {
|
|
4401
|
-
/** symbols to check inclusion */
|
|
4402
|
-
symbols?: string[];
|
|
4403
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
|
|
4404
|
-
}
|
|
4405
4283
|
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
4406
4284
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4407
4285
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4584,6 +4462,129 @@ export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
|
4584
4462
|
id: string;
|
|
4585
4463
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4586
4464
|
}
|
|
4465
|
+
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4466
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4467
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4468
|
+
/**
|
|
4469
|
+
* @description get company profile, industries classification and closest earning release
|
|
4470
|
+
* @tags CompanyProfile
|
|
4471
|
+
* @name GetCompanyProfile
|
|
4472
|
+
* @summary get company profile
|
|
4473
|
+
* @request GET:/company-profile
|
|
4474
|
+
* @secure
|
|
4475
|
+
*/
|
|
4476
|
+
getCompanyProfile(query: {
|
|
4477
|
+
/** Company symbol */
|
|
4478
|
+
symbol: string;
|
|
4479
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
|
|
4480
|
+
/**
|
|
4481
|
+
* @description get combined profile, equities and funds
|
|
4482
|
+
* @tags CompanyProfile
|
|
4483
|
+
* @name GetCombinedProfile
|
|
4484
|
+
* @summary get company profile
|
|
4485
|
+
* @request GET:/quote-profile
|
|
4486
|
+
* @secure
|
|
4487
|
+
*/
|
|
4488
|
+
getCombinedProfile(query: {
|
|
4489
|
+
/** Company symbol */
|
|
4490
|
+
symbol: string;
|
|
4491
|
+
/** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
|
|
4492
|
+
symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
|
|
4493
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
|
|
4494
|
+
/**
|
|
4495
|
+
* @description sort input array of symbols by type
|
|
4496
|
+
* @tags CompanyProfile
|
|
4497
|
+
* @name GetSymbolsPerSymbolType
|
|
4498
|
+
* @summary sort input array of symbols by type
|
|
4499
|
+
* @request POST:/symbols-per-type
|
|
4500
|
+
* @secure
|
|
4501
|
+
*/
|
|
4502
|
+
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
4503
|
+
}
|
|
4504
|
+
export class CustomLists<HandleError extends boolean = boolean> {
|
|
4505
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4506
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4507
|
+
/**
|
|
4508
|
+
* @description get custom lists
|
|
4509
|
+
* @tags Custom Lists
|
|
4510
|
+
* @name GetCustomLists
|
|
4511
|
+
* @summary get custom lists
|
|
4512
|
+
* @request GET:/custom-lists
|
|
4513
|
+
* @secure
|
|
4514
|
+
*/
|
|
4515
|
+
getCustomLists(query: {
|
|
4516
|
+
/** how many records to return. Max value is 50 */
|
|
4517
|
+
limit: number;
|
|
4518
|
+
/** how many records to skip */
|
|
4519
|
+
offset: number;
|
|
4520
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4521
|
+
/**
|
|
4522
|
+
* @description update custom list
|
|
4523
|
+
* @tags Custom Lists
|
|
4524
|
+
* @name UpdateCustomList
|
|
4525
|
+
* @summary update custom list
|
|
4526
|
+
* @request PUT:/custom-lists
|
|
4527
|
+
* @secure
|
|
4528
|
+
*/
|
|
4529
|
+
updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
4530
|
+
/**
|
|
4531
|
+
* @description create custom list
|
|
4532
|
+
* @tags Custom Lists
|
|
4533
|
+
* @name CreateCustomList
|
|
4534
|
+
* @summary create custom list
|
|
4535
|
+
* @request POST:/custom-lists
|
|
4536
|
+
* @secure
|
|
4537
|
+
*/
|
|
4538
|
+
createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
4539
|
+
/**
|
|
4540
|
+
* @description remove custom list
|
|
4541
|
+
* @tags Custom Lists
|
|
4542
|
+
* @name RemoveCustomList
|
|
4543
|
+
* @summary remove custom list
|
|
4544
|
+
* @request DELETE:/custom-lists
|
|
4545
|
+
* @secure
|
|
4546
|
+
*/
|
|
4547
|
+
removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4548
|
+
/**
|
|
4549
|
+
* @description filter custom lists
|
|
4550
|
+
* @tags Custom Lists
|
|
4551
|
+
* @name FilterCustomLists
|
|
4552
|
+
* @summary filter custom lists
|
|
4553
|
+
* @request POST:/custom-lists/filter
|
|
4554
|
+
* @secure
|
|
4555
|
+
*/
|
|
4556
|
+
filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4557
|
+
/**
|
|
4558
|
+
* @description get custom list with quotes
|
|
4559
|
+
* @tags Custom Lists
|
|
4560
|
+
* @name GetCustomListWithQuotes
|
|
4561
|
+
* @summary get custom list with quotes
|
|
4562
|
+
* @request GET:/custom-lists/{id-or-slug}
|
|
4563
|
+
* @secure
|
|
4564
|
+
*/
|
|
4565
|
+
getCustomListWithQuotes(idOrSlug: string, query: {
|
|
4566
|
+
/** sort direction - asc or desc */
|
|
4567
|
+
order_direction: string;
|
|
4568
|
+
/** sort field - volume, symbol(alphabetical), market_cap, dividend_percent */
|
|
4569
|
+
order_field: string;
|
|
4570
|
+
/** how many equities records to return. Max value is 50 */
|
|
4571
|
+
limit: number;
|
|
4572
|
+
/** how many equities records to skip */
|
|
4573
|
+
offset: number;
|
|
4574
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4575
|
+
/**
|
|
4576
|
+
* @description filter custom list
|
|
4577
|
+
* @tags Custom Lists
|
|
4578
|
+
* @name FilterCustomList
|
|
4579
|
+
* @summary filter custom list
|
|
4580
|
+
* @request GET:/custom-lists/{id-or-slug}/filter
|
|
4581
|
+
* @secure
|
|
4582
|
+
*/
|
|
4583
|
+
filterCustomList(idOrSlug: string, query?: {
|
|
4584
|
+
/** symbols to check inclusion */
|
|
4585
|
+
symbols?: string[];
|
|
4586
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
|
|
4587
|
+
}
|
|
4587
4588
|
export class Dashboard<HandleError extends boolean = boolean> {
|
|
4588
4589
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4589
4590
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5019,38 +5020,11 @@ export class Intraday<HandleError extends boolean = boolean> {
|
|
|
5019
5020
|
*/
|
|
5020
5021
|
intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
|
|
5021
5022
|
}
|
|
5022
|
-
export class Ipos<HandleError extends boolean = boolean> {
|
|
5023
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5024
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5025
|
-
/**
|
|
5026
|
-
* @description get recent ipos info
|
|
5027
|
-
* @tags Ipos
|
|
5028
|
-
* @name PostRecent
|
|
5029
|
-
* @summary get recent ipos info
|
|
5030
|
-
* @request POST:/ipos/recent
|
|
5031
|
-
* @secure
|
|
5032
|
-
*/
|
|
5033
|
-
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5034
|
-
/**
|
|
5035
|
-
* @description get upcoming ipos info
|
|
5036
|
-
* @tags Ipos
|
|
5037
|
-
* @name GetUpcoming
|
|
5038
|
-
* @summary get upcoming ipos info
|
|
5039
|
-
* @request GET:/ipos/upcoming
|
|
5040
|
-
* @secure
|
|
5041
|
-
*/
|
|
5042
|
-
getUpcoming(query: {
|
|
5043
|
-
/** how many records to return. Max value is 50 */
|
|
5044
|
-
limit: number;
|
|
5045
|
-
/** how many records to skip */
|
|
5046
|
-
offset: number;
|
|
5047
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5048
|
-
}
|
|
5049
5023
|
export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
5050
5024
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5051
5025
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5052
5026
|
/**
|
|
5053
|
-
* @description get pre ipo companies
|
|
5027
|
+
* @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
|
|
5054
5028
|
* @tags PreIPOCompanies
|
|
5055
5029
|
* @name GetPreIpoCompanies
|
|
5056
5030
|
* @summary get pre ipo companies
|
|
@@ -5060,6 +5034,8 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
5060
5034
|
getPreIpoCompanies(query: {
|
|
5061
5035
|
/** search by company name */
|
|
5062
5036
|
name?: string;
|
|
5037
|
+
/** search by categories */
|
|
5038
|
+
categories?: string;
|
|
5063
5039
|
/** how many records to return. Max value is 50 */
|
|
5064
5040
|
limit: number;
|
|
5065
5041
|
/** how many records to skip */
|
|
@@ -5200,35 +5176,101 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
5200
5176
|
* @request GET:/ipos/pre-ipo-company-spvs
|
|
5201
5177
|
* @secure
|
|
5202
5178
|
*/
|
|
5203
|
-
getPreIpoCompanySpvs(query: {
|
|
5204
|
-
/** company id */
|
|
5205
|
-
pre_ipo_company_id?: string;
|
|
5206
|
-
/** investment id */
|
|
5207
|
-
investment_id?: string;
|
|
5208
|
-
/** search by name */
|
|
5209
|
-
name?: string;
|
|
5210
|
-
/** search by company name */
|
|
5211
|
-
company_name?: string;
|
|
5179
|
+
getPreIpoCompanySpvs(query: {
|
|
5180
|
+
/** company id */
|
|
5181
|
+
pre_ipo_company_id?: string;
|
|
5182
|
+
/** investment id */
|
|
5183
|
+
investment_id?: string;
|
|
5184
|
+
/** search by name */
|
|
5185
|
+
name?: string;
|
|
5186
|
+
/** search by company name */
|
|
5187
|
+
company_name?: string;
|
|
5188
|
+
/** how many records to return. Max value is 50 */
|
|
5189
|
+
limit: number;
|
|
5190
|
+
/** how many records to skip */
|
|
5191
|
+
offset: number;
|
|
5192
|
+
/** sort direction */
|
|
5193
|
+
direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
|
|
5194
|
+
/** sort field */
|
|
5195
|
+
field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
|
|
5196
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
|
|
5197
|
+
/**
|
|
5198
|
+
* @description get pre ipo company spv by id
|
|
5199
|
+
* @tags PreIPOCompanies
|
|
5200
|
+
* @name GetPreIpoCompanySpvsById
|
|
5201
|
+
* @summary get pre ipo company spv by id
|
|
5202
|
+
* @request GET:/ipos/pre-ipo-company-spvs/{id}
|
|
5203
|
+
* @originalName getPreIpoCompanySpvs
|
|
5204
|
+
* @duplicate
|
|
5205
|
+
* @secure
|
|
5206
|
+
*/
|
|
5207
|
+
getPreIpoCompanySpvsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
|
|
5208
|
+
}
|
|
5209
|
+
export class MarketDates<HandleError extends boolean = boolean> {
|
|
5210
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5211
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5212
|
+
/**
|
|
5213
|
+
* @description get market dates history
|
|
5214
|
+
* @tags MarketDates
|
|
5215
|
+
* @name GetMarketDatesHistory
|
|
5216
|
+
* @summary get market dates history
|
|
5217
|
+
* @request POST:/market-dates/history
|
|
5218
|
+
* @secure
|
|
5219
|
+
*/
|
|
5220
|
+
getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
|
|
5221
|
+
/**
|
|
5222
|
+
* @description get todays market hours
|
|
5223
|
+
* @tags MarketDates
|
|
5224
|
+
* @name GetTodaysMarketHours
|
|
5225
|
+
* @summary get todays market hours
|
|
5226
|
+
* @request GET:/market-dates/today
|
|
5227
|
+
* @secure
|
|
5228
|
+
*/
|
|
5229
|
+
getTodaysMarketHours(query: {
|
|
5230
|
+
/** Market */
|
|
5231
|
+
market: string;
|
|
5232
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
5233
|
+
}
|
|
5234
|
+
export class Ipos<HandleError extends boolean = boolean> {
|
|
5235
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5236
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5237
|
+
/**
|
|
5238
|
+
* @description get recent ipos info
|
|
5239
|
+
* @tags Ipos
|
|
5240
|
+
* @name PostRecent
|
|
5241
|
+
* @summary get recent ipos info
|
|
5242
|
+
* @request POST:/ipos/recent
|
|
5243
|
+
* @secure
|
|
5244
|
+
*/
|
|
5245
|
+
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5246
|
+
/**
|
|
5247
|
+
* @description get upcoming ipos info
|
|
5248
|
+
* @tags Ipos
|
|
5249
|
+
* @name GetUpcoming
|
|
5250
|
+
* @summary get upcoming ipos info
|
|
5251
|
+
* @request GET:/ipos/upcoming
|
|
5252
|
+
* @secure
|
|
5253
|
+
*/
|
|
5254
|
+
getUpcoming(query: {
|
|
5212
5255
|
/** how many records to return. Max value is 50 */
|
|
5213
5256
|
limit: number;
|
|
5214
5257
|
/** how many records to skip */
|
|
5215
5258
|
offset: number;
|
|
5216
|
-
|
|
5217
|
-
direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
|
|
5218
|
-
/** sort field */
|
|
5219
|
-
field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
|
|
5220
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
|
|
5259
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5221
5260
|
/**
|
|
5222
|
-
* @description get
|
|
5223
|
-
* @tags
|
|
5224
|
-
* @name
|
|
5225
|
-
* @summary get
|
|
5226
|
-
* @request GET:/ipos/
|
|
5227
|
-
* @originalName getPreIpoCompanySpvs
|
|
5228
|
-
* @duplicate
|
|
5261
|
+
* @description get ipo info by symbol
|
|
5262
|
+
* @tags Ipos
|
|
5263
|
+
* @name GetIpos
|
|
5264
|
+
* @summary get ipo info by symbol
|
|
5265
|
+
* @request GET:/ipos/{symbol}
|
|
5229
5266
|
* @secure
|
|
5230
5267
|
*/
|
|
5231
|
-
|
|
5268
|
+
getIpos(symbol: string, query?: {
|
|
5269
|
+
/** load quotes */
|
|
5270
|
+
load_quotes?: boolean;
|
|
5271
|
+
/** statuses */
|
|
5272
|
+
statuses?: string[];
|
|
5273
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
|
|
5232
5274
|
}
|
|
5233
5275
|
export class Logos<HandleError extends boolean = boolean> {
|
|
5234
5276
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5330,31 +5372,6 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5330
5372
|
symbol: string;
|
|
5331
5373
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
|
|
5332
5374
|
}
|
|
5333
|
-
export class MarketDates<HandleError extends boolean = boolean> {
|
|
5334
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5335
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5336
|
-
/**
|
|
5337
|
-
* @description get market dates history
|
|
5338
|
-
* @tags MarketDates
|
|
5339
|
-
* @name GetMarketDatesHistory
|
|
5340
|
-
* @summary get market dates history
|
|
5341
|
-
* @request POST:/market-dates/history
|
|
5342
|
-
* @secure
|
|
5343
|
-
*/
|
|
5344
|
-
getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
|
|
5345
|
-
/**
|
|
5346
|
-
* @description get todays market hours
|
|
5347
|
-
* @tags MarketDates
|
|
5348
|
-
* @name GetTodaysMarketHours
|
|
5349
|
-
* @summary get todays market hours
|
|
5350
|
-
* @request GET:/market-dates/today
|
|
5351
|
-
* @secure
|
|
5352
|
-
*/
|
|
5353
|
-
getTodaysMarketHours(query: {
|
|
5354
|
-
/** Market */
|
|
5355
|
-
market: string;
|
|
5356
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
5357
|
-
}
|
|
5358
5375
|
export class News<HandleError extends boolean = boolean> {
|
|
5359
5376
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5360
5377
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5496,6 +5513,86 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
5496
5513
|
*/
|
|
5497
5514
|
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5498
5515
|
}
|
|
5516
|
+
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
5517
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5518
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5519
|
+
/**
|
|
5520
|
+
* @description Returns calculated matrix
|
|
5521
|
+
* @tags OptionGreeks
|
|
5522
|
+
* @name OgCalculateMatrix
|
|
5523
|
+
* @summary Calculate matrix
|
|
5524
|
+
* @request POST:/og/calculate-matrix
|
|
5525
|
+
* @secure
|
|
5526
|
+
*/
|
|
5527
|
+
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
5528
|
+
/**
|
|
5529
|
+
* @description Returns calculated params
|
|
5530
|
+
* @tags OptionGreeks
|
|
5531
|
+
* @name OgCalculateParams
|
|
5532
|
+
* @summary Calculate params
|
|
5533
|
+
* @request POST:/og/calculate-params
|
|
5534
|
+
* @secure
|
|
5535
|
+
*/
|
|
5536
|
+
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
5537
|
+
}
|
|
5538
|
+
export class Passport<HandleError extends boolean = boolean> {
|
|
5539
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5540
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5541
|
+
/**
|
|
5542
|
+
* @description Returns article by id
|
|
5543
|
+
* @tags Passport
|
|
5544
|
+
* @name PassportArticleById
|
|
5545
|
+
* @summary Get article by id
|
|
5546
|
+
* @request POST:/passport/article-by-id
|
|
5547
|
+
* @secure
|
|
5548
|
+
*/
|
|
5549
|
+
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
5550
|
+
/**
|
|
5551
|
+
* @description Returns articles
|
|
5552
|
+
* @tags Passport
|
|
5553
|
+
* @name PassportArticles
|
|
5554
|
+
* @summary Get articles
|
|
5555
|
+
* @request POST:/passport/articles
|
|
5556
|
+
* @secure
|
|
5557
|
+
*/
|
|
5558
|
+
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5559
|
+
/**
|
|
5560
|
+
* @description Returns author profile
|
|
5561
|
+
* @tags Passport
|
|
5562
|
+
* @name PassportAuthorProfile
|
|
5563
|
+
* @summary Get author profile
|
|
5564
|
+
* @request POST:/passport/author-profile
|
|
5565
|
+
* @secure
|
|
5566
|
+
*/
|
|
5567
|
+
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
5568
|
+
/**
|
|
5569
|
+
* @description Returns most popular tags
|
|
5570
|
+
* @tags Passport
|
|
5571
|
+
* @name PassportMostPopularTags
|
|
5572
|
+
* @summary Get most popular tags
|
|
5573
|
+
* @request POST:/passport/most-popular-tags
|
|
5574
|
+
* @secure
|
|
5575
|
+
*/
|
|
5576
|
+
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
5577
|
+
/**
|
|
5578
|
+
* @description Returns news feed
|
|
5579
|
+
* @tags Passport
|
|
5580
|
+
* @name PassportNewsFeed
|
|
5581
|
+
* @summary Get news feed
|
|
5582
|
+
* @request POST:/passport/newsfeed
|
|
5583
|
+
* @secure
|
|
5584
|
+
*/
|
|
5585
|
+
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
|
|
5586
|
+
/**
|
|
5587
|
+
* @description Returns article by parameters
|
|
5588
|
+
* @tags Passport
|
|
5589
|
+
* @name PassportSearchArticle
|
|
5590
|
+
* @summary Search article by parameters
|
|
5591
|
+
* @request POST:/passport/search-article
|
|
5592
|
+
* @secure
|
|
5593
|
+
*/
|
|
5594
|
+
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5595
|
+
}
|
|
5499
5596
|
export class Public<HandleError extends boolean = boolean> {
|
|
5500
5597
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5501
5598
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5622,49 +5719,18 @@ export class Public<HandleError extends boolean = boolean> {
|
|
|
5622
5719
|
offset: number;
|
|
5623
5720
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
5624
5721
|
}
|
|
5625
|
-
export class
|
|
5626
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5627
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5628
|
-
/**
|
|
5629
|
-
* @description Returns calculated matrix
|
|
5630
|
-
* @tags OptionGreeks
|
|
5631
|
-
* @name OgCalculateMatrix
|
|
5632
|
-
* @summary Calculate matrix
|
|
5633
|
-
* @request POST:/og/calculate-matrix
|
|
5634
|
-
* @secure
|
|
5635
|
-
*/
|
|
5636
|
-
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
5637
|
-
/**
|
|
5638
|
-
* @description Returns calculated params
|
|
5639
|
-
* @tags OptionGreeks
|
|
5640
|
-
* @name OgCalculateParams
|
|
5641
|
-
* @summary Calculate params
|
|
5642
|
-
* @request POST:/og/calculate-params
|
|
5643
|
-
* @secure
|
|
5644
|
-
*/
|
|
5645
|
-
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
5646
|
-
}
|
|
5647
|
-
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
5722
|
+
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
5648
5723
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5649
5724
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5650
5725
|
/**
|
|
5651
|
-
* @description get
|
|
5652
|
-
* @tags
|
|
5653
|
-
* @name
|
|
5654
|
-
* @summary get
|
|
5655
|
-
* @request POST:/
|
|
5656
|
-
* @secure
|
|
5657
|
-
*/
|
|
5658
|
-
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
5659
|
-
/**
|
|
5660
|
-
* @description get seasonlity data with comparison to benchmark
|
|
5661
|
-
* @tags AlphaTools
|
|
5662
|
-
* @name GetSeasonality
|
|
5663
|
-
* @summary get seasonlity data
|
|
5664
|
-
* @request POST:/seasonality
|
|
5726
|
+
* @description get usage date per branch for a period
|
|
5727
|
+
* @tags UsageTracking
|
|
5728
|
+
* @name GetUsageData
|
|
5729
|
+
* @summary get insight usage data
|
|
5730
|
+
* @request POST:/tracking/usage
|
|
5665
5731
|
* @secure
|
|
5666
5732
|
*/
|
|
5667
|
-
|
|
5733
|
+
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
5668
5734
|
}
|
|
5669
5735
|
export class TipRank<HandleError extends boolean = boolean> {
|
|
5670
5736
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -6032,19 +6098,6 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6032
6098
|
Authorization?: string;
|
|
6033
6099
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
|
|
6034
6100
|
}
|
|
6035
|
-
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
6036
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6037
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6038
|
-
/**
|
|
6039
|
-
* @description get usage date per branch for a period
|
|
6040
|
-
* @tags UsageTracking
|
|
6041
|
-
* @name GetUsageData
|
|
6042
|
-
* @summary get insight usage data
|
|
6043
|
-
* @request POST:/tracking/usage
|
|
6044
|
-
* @secure
|
|
6045
|
-
*/
|
|
6046
|
-
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
6047
|
-
}
|
|
6048
6101
|
export class Ownerships<HandleError extends boolean = boolean> {
|
|
6049
6102
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6050
6103
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -6067,63 +6120,27 @@ export class Ownerships<HandleError extends boolean = boolean> {
|
|
|
6067
6120
|
*/
|
|
6068
6121
|
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
6069
6122
|
}
|
|
6070
|
-
export class
|
|
6123
|
+
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
6071
6124
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6072
6125
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6073
6126
|
/**
|
|
6074
|
-
* @description
|
|
6075
|
-
* @tags
|
|
6076
|
-
* @name
|
|
6077
|
-
* @summary
|
|
6078
|
-
* @request POST:/
|
|
6079
|
-
* @secure
|
|
6080
|
-
*/
|
|
6081
|
-
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
6082
|
-
/**
|
|
6083
|
-
* @description Returns articles
|
|
6084
|
-
* @tags Passport
|
|
6085
|
-
* @name PassportArticles
|
|
6086
|
-
* @summary Get articles
|
|
6087
|
-
* @request POST:/passport/articles
|
|
6088
|
-
* @secure
|
|
6089
|
-
*/
|
|
6090
|
-
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
6091
|
-
/**
|
|
6092
|
-
* @description Returns author profile
|
|
6093
|
-
* @tags Passport
|
|
6094
|
-
* @name PassportAuthorProfile
|
|
6095
|
-
* @summary Get author profile
|
|
6096
|
-
* @request POST:/passport/author-profile
|
|
6097
|
-
* @secure
|
|
6098
|
-
*/
|
|
6099
|
-
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
6100
|
-
/**
|
|
6101
|
-
* @description Returns most popular tags
|
|
6102
|
-
* @tags Passport
|
|
6103
|
-
* @name PassportMostPopularTags
|
|
6104
|
-
* @summary Get most popular tags
|
|
6105
|
-
* @request POST:/passport/most-popular-tags
|
|
6106
|
-
* @secure
|
|
6107
|
-
*/
|
|
6108
|
-
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
6109
|
-
/**
|
|
6110
|
-
* @description Returns news feed
|
|
6111
|
-
* @tags Passport
|
|
6112
|
-
* @name PassportNewsFeed
|
|
6113
|
-
* @summary Get news feed
|
|
6114
|
-
* @request POST:/passport/newsfeed
|
|
6127
|
+
* @description get seasonlity data with comparison to benchmark
|
|
6128
|
+
* @tags AlphaTools
|
|
6129
|
+
* @name GetMomentumRatioGraph
|
|
6130
|
+
* @summary get seasonlity data
|
|
6131
|
+
* @request POST:/rst
|
|
6115
6132
|
* @secure
|
|
6116
6133
|
*/
|
|
6117
|
-
|
|
6134
|
+
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
6118
6135
|
/**
|
|
6119
|
-
* @description
|
|
6120
|
-
* @tags
|
|
6121
|
-
* @name
|
|
6122
|
-
* @summary
|
|
6123
|
-
* @request POST:/
|
|
6136
|
+
* @description get seasonlity data with comparison to benchmark
|
|
6137
|
+
* @tags AlphaTools
|
|
6138
|
+
* @name GetSeasonality
|
|
6139
|
+
* @summary get seasonlity data
|
|
6140
|
+
* @request POST:/seasonality
|
|
6124
6141
|
* @secure
|
|
6125
6142
|
*/
|
|
6126
|
-
|
|
6143
|
+
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
6127
6144
|
}
|
|
6128
6145
|
export interface InsightBeforeAndAfterV2 {
|
|
6129
6146
|
after?: string;
|