@orbis-systems/orbis-api-clients 0.7.2 → 0.7.4
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 +223 -51
- 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 +659 -538
- 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 +1039 -1018
- 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 +107 -107
- 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 +4105 -4062
- 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 +638 -638
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -1
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -1
- package/dist/uma/index.js.map +1 -1
- package/dist/zerohash/index.d.ts +811 -811
- package/dist/zerohash/index.d.ts.map +1 -1
- package/dist/zerohash/index.esm.js +1 -1
- package/dist/zerohash/index.esm.js.map +1 -1
- package/dist/zerohash/index.js +1 -1
- package/dist/zerohash/index.js.map +1 -1
- package/package.json +1 -1
package/dist/insight/index.d.ts
CHANGED
|
@@ -2572,6 +2572,7 @@ export interface InsightHedgeFundsResponse {
|
|
|
2572
2572
|
total_num_hedge_funds: number;
|
|
2573
2573
|
}
|
|
2574
2574
|
export interface InsightHelpRequestWithSymbol {
|
|
2575
|
+
paging?: InsightPaging;
|
|
2575
2576
|
symbol?: string;
|
|
2576
2577
|
}
|
|
2577
2578
|
export interface InsightHistoricalIPO {
|
|
@@ -4238,6 +4239,17 @@ export enum InsightSymbolLogoConvertedRequestConversionEnum {
|
|
|
4238
4239
|
SquareStrictOrNormal = "square_strict_or_normal",
|
|
4239
4240
|
BestMatch = "best_match"
|
|
4240
4241
|
}
|
|
4242
|
+
/** search by research type */
|
|
4243
|
+
export enum InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum {
|
|
4244
|
+
INTERVIEW = "INTERVIEW",
|
|
4245
|
+
MARKET = "MARKET",
|
|
4246
|
+
COMPANY = "COMPANY"
|
|
4247
|
+
}
|
|
4248
|
+
/** search by relation */
|
|
4249
|
+
export enum InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum {
|
|
4250
|
+
SUBJECT = "SUBJECT",
|
|
4251
|
+
CONNECTED = "CONNECTED"
|
|
4252
|
+
}
|
|
4241
4253
|
/** sort direction */
|
|
4242
4254
|
export enum InsightGetPreIpoCompanySpvsParamsDirectionEnum {
|
|
4243
4255
|
ASC = "ASC",
|
|
@@ -4280,28 +4292,6 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
|
|
|
4280
4292
|
Date = "date",
|
|
4281
4293
|
Rank = "rank"
|
|
4282
4294
|
}
|
|
4283
|
-
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
4284
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4285
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4286
|
-
/**
|
|
4287
|
-
* @description get seasonlity data with comparison to benchmark
|
|
4288
|
-
* @tags AlphaTools
|
|
4289
|
-
* @name GetMomentumRatioGraph
|
|
4290
|
-
* @summary get seasonlity data
|
|
4291
|
-
* @request POST:/rst
|
|
4292
|
-
* @secure
|
|
4293
|
-
*/
|
|
4294
|
-
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
4295
|
-
/**
|
|
4296
|
-
* @description get seasonlity data with comparison to benchmark
|
|
4297
|
-
* @tags AlphaTools
|
|
4298
|
-
* @name GetSeasonality
|
|
4299
|
-
* @summary get seasonlity data
|
|
4300
|
-
* @request POST:/seasonality
|
|
4301
|
-
* @secure
|
|
4302
|
-
*/
|
|
4303
|
-
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
4304
|
-
}
|
|
4305
4295
|
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4306
4296
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4307
4297
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4341,6 +4331,188 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
|
4341
4331
|
*/
|
|
4342
4332
|
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
4343
4333
|
}
|
|
4334
|
+
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
4335
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4336
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4337
|
+
/**
|
|
4338
|
+
* @description Get continents
|
|
4339
|
+
* @tags World Markets
|
|
4340
|
+
* @name ContinentGet
|
|
4341
|
+
* @summary Get continents
|
|
4342
|
+
* @request GET:/continents
|
|
4343
|
+
* @secure
|
|
4344
|
+
*/
|
|
4345
|
+
continentGet(query: {
|
|
4346
|
+
/** Query limit */
|
|
4347
|
+
limit: number;
|
|
4348
|
+
/** Query offset */
|
|
4349
|
+
offset: number;
|
|
4350
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4351
|
+
/**
|
|
4352
|
+
* @description Edit continent
|
|
4353
|
+
* @tags World Markets
|
|
4354
|
+
* @name ContinentEdit
|
|
4355
|
+
* @summary Edit continent
|
|
4356
|
+
* @request PUT:/continents
|
|
4357
|
+
* @secure
|
|
4358
|
+
*/
|
|
4359
|
+
continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4360
|
+
/**
|
|
4361
|
+
* @description Create continents
|
|
4362
|
+
* @tags World Markets
|
|
4363
|
+
* @name ContinentCreate
|
|
4364
|
+
* @summary Create continents
|
|
4365
|
+
* @request POST:/continents
|
|
4366
|
+
* @secure
|
|
4367
|
+
*/
|
|
4368
|
+
continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4369
|
+
/**
|
|
4370
|
+
* @description Delete continent
|
|
4371
|
+
* @tags World Markets
|
|
4372
|
+
* @name ContinentDelete
|
|
4373
|
+
* @summary Delete continent
|
|
4374
|
+
* @request DELETE:/continents
|
|
4375
|
+
* @secure
|
|
4376
|
+
*/
|
|
4377
|
+
continentDelete(query: {
|
|
4378
|
+
/** continent id */
|
|
4379
|
+
id: string;
|
|
4380
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4381
|
+
/**
|
|
4382
|
+
* @description Get country codes
|
|
4383
|
+
* @tags World Markets
|
|
4384
|
+
* @name CountryCodeGet
|
|
4385
|
+
* @summary Get country codes
|
|
4386
|
+
* @request GET:/country-codes
|
|
4387
|
+
* @secure
|
|
4388
|
+
*/
|
|
4389
|
+
countryCodeGet(query: {
|
|
4390
|
+
/** Query limit */
|
|
4391
|
+
limit: number;
|
|
4392
|
+
/** Query offset */
|
|
4393
|
+
offset: number;
|
|
4394
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4395
|
+
/**
|
|
4396
|
+
* @description Edit country code
|
|
4397
|
+
* @tags World Markets
|
|
4398
|
+
* @name CountryCodeEdit
|
|
4399
|
+
* @summary Edit country code
|
|
4400
|
+
* @request PUT:/country-codes
|
|
4401
|
+
* @secure
|
|
4402
|
+
*/
|
|
4403
|
+
countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4404
|
+
/**
|
|
4405
|
+
* @description Add country codes
|
|
4406
|
+
* @tags World Markets
|
|
4407
|
+
* @name CountryCodeAdd
|
|
4408
|
+
* @summary Add country codes
|
|
4409
|
+
* @request POST:/country-codes
|
|
4410
|
+
* @secure
|
|
4411
|
+
*/
|
|
4412
|
+
countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4413
|
+
/**
|
|
4414
|
+
* @description Delete country code
|
|
4415
|
+
* @tags World Markets
|
|
4416
|
+
* @name CountryCodeDelete
|
|
4417
|
+
* @summary Delete country code
|
|
4418
|
+
* @request DELETE:/country-codes
|
|
4419
|
+
* @secure
|
|
4420
|
+
*/
|
|
4421
|
+
countryCodeDelete(query: {
|
|
4422
|
+
/** a3 code */
|
|
4423
|
+
a3code: string;
|
|
4424
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4425
|
+
/**
|
|
4426
|
+
* @description Get global indexes
|
|
4427
|
+
* @tags World Markets
|
|
4428
|
+
* @name GlobalIndexGet
|
|
4429
|
+
* @summary Get global indexes
|
|
4430
|
+
* @request GET:/global-indexes
|
|
4431
|
+
* @secure
|
|
4432
|
+
*/
|
|
4433
|
+
globalIndexGet(query: {
|
|
4434
|
+
/** Query limit */
|
|
4435
|
+
limit: number;
|
|
4436
|
+
/** Query offset */
|
|
4437
|
+
offset: number;
|
|
4438
|
+
/** Continent code for filtering */
|
|
4439
|
+
continent?: string;
|
|
4440
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4441
|
+
/**
|
|
4442
|
+
* @description Edit global index
|
|
4443
|
+
* @tags World Markets
|
|
4444
|
+
* @name GlobalIndexEdit
|
|
4445
|
+
* @summary Edit global index
|
|
4446
|
+
* @request PUT:/global-indexes
|
|
4447
|
+
* @secure
|
|
4448
|
+
*/
|
|
4449
|
+
globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4450
|
+
/**
|
|
4451
|
+
* @description Add global indexes
|
|
4452
|
+
* @tags World Markets
|
|
4453
|
+
* @name GlobalIndexAdd
|
|
4454
|
+
* @summary Add global indexes
|
|
4455
|
+
* @request POST:/global-indexes
|
|
4456
|
+
* @secure
|
|
4457
|
+
*/
|
|
4458
|
+
globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4459
|
+
/**
|
|
4460
|
+
* @description Edit global index
|
|
4461
|
+
* @tags World Markets
|
|
4462
|
+
* @name GlobalIndexDelete
|
|
4463
|
+
* @summary Delete global index
|
|
4464
|
+
* @request DELETE:/global-indexes
|
|
4465
|
+
* @secure
|
|
4466
|
+
*/
|
|
4467
|
+
globalIndexDelete(query: {
|
|
4468
|
+
/** a3 code */
|
|
4469
|
+
a3code: string;
|
|
4470
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4471
|
+
/**
|
|
4472
|
+
* @description Get regions
|
|
4473
|
+
* @tags World Markets
|
|
4474
|
+
* @name RegionGet
|
|
4475
|
+
* @summary Get regions
|
|
4476
|
+
* @request GET:/regions
|
|
4477
|
+
* @secure
|
|
4478
|
+
*/
|
|
4479
|
+
regionGet(query: {
|
|
4480
|
+
/** Query limit */
|
|
4481
|
+
limit: number;
|
|
4482
|
+
/** Query offset */
|
|
4483
|
+
offset: number;
|
|
4484
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
4485
|
+
/**
|
|
4486
|
+
* @description Edit region
|
|
4487
|
+
* @tags World Markets
|
|
4488
|
+
* @name RegionEdit
|
|
4489
|
+
* @summary Edit region
|
|
4490
|
+
* @request PUT:/regions
|
|
4491
|
+
* @secure
|
|
4492
|
+
*/
|
|
4493
|
+
regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4494
|
+
/**
|
|
4495
|
+
* @description Create regions
|
|
4496
|
+
* @tags World Markets
|
|
4497
|
+
* @name RegionCreate
|
|
4498
|
+
* @summary Create regions
|
|
4499
|
+
* @request POST:/regions
|
|
4500
|
+
* @secure
|
|
4501
|
+
*/
|
|
4502
|
+
regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
4503
|
+
/**
|
|
4504
|
+
* @description Delete region
|
|
4505
|
+
* @tags World Markets
|
|
4506
|
+
* @name RegionDelete
|
|
4507
|
+
* @summary Delete region
|
|
4508
|
+
* @request DELETE:/regions
|
|
4509
|
+
* @secure
|
|
4510
|
+
*/
|
|
4511
|
+
regionDelete(query: {
|
|
4512
|
+
/** region id */
|
|
4513
|
+
id: string;
|
|
4514
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4515
|
+
}
|
|
4344
4516
|
export class CustomLists<HandleError extends boolean = boolean> {
|
|
4345
4517
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4346
4518
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4585,256 +4757,18 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
4585
4757
|
*/
|
|
4586
4758
|
getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
|
|
4587
4759
|
}
|
|
4588
|
-
export
|
|
4589
|
-
|
|
4590
|
-
|
|
4591
|
-
|
|
4592
|
-
|
|
4593
|
-
|
|
4594
|
-
|
|
4595
|
-
|
|
4596
|
-
|
|
4597
|
-
|
|
4598
|
-
|
|
4599
|
-
|
|
4600
|
-
close_price_asof: string;
|
|
4601
|
-
close_ytw: number;
|
|
4602
|
-
convertible: boolean;
|
|
4603
|
-
country: string;
|
|
4604
|
-
country_code: string;
|
|
4605
|
-
country_domicile: string;
|
|
4606
|
-
country_issue: string;
|
|
4607
|
-
coupon: number;
|
|
4608
|
-
coupon_frequency: string;
|
|
4609
|
-
coupon_type: string;
|
|
4610
|
-
currency: string;
|
|
4611
|
-
cusip: string;
|
|
4612
|
-
dated_date: string;
|
|
4613
|
-
daycount: string;
|
|
4614
|
-
description: string;
|
|
4615
|
-
description_short: string;
|
|
4616
|
-
duration: number;
|
|
4617
|
-
first_coupon_date: string;
|
|
4618
|
-
insured: boolean;
|
|
4619
|
-
isin: string;
|
|
4620
|
-
issue_date: string;
|
|
4621
|
-
issue_minimum_denomination: number;
|
|
4622
|
-
issue_price: number;
|
|
4623
|
-
issue_size: number;
|
|
4624
|
-
issuer: string;
|
|
4625
|
-
last_coupon_date: string;
|
|
4626
|
-
liquidity_institutional_aggregate: number;
|
|
4627
|
-
liquidity_institutional_buy: number;
|
|
4628
|
-
liquidity_institutional_sell: number;
|
|
4629
|
-
liquidity_micro_aggregate: number;
|
|
4630
|
-
liquidity_micro_buy: number;
|
|
4631
|
-
liquidity_micro_sell: number;
|
|
4632
|
-
liquidity_retail_aggregate: number;
|
|
4633
|
-
liquidity_retail_buy: number;
|
|
4634
|
-
liquidity_retail_sell: number;
|
|
4635
|
-
maturity_date: string;
|
|
4636
|
-
municipal_state: string;
|
|
4637
|
-
municipal_taxable_federal: boolean;
|
|
4638
|
-
municipal_type: string;
|
|
4639
|
-
next_call_date: string;
|
|
4640
|
-
next_call_price: number;
|
|
4641
|
-
next_coupon_date: string;
|
|
4642
|
-
par_value: number;
|
|
4643
|
-
perpetual: boolean;
|
|
4644
|
-
private_placement: boolean;
|
|
4645
|
-
purpose: string;
|
|
4646
|
-
puttable: boolean;
|
|
4647
|
-
reg_s: boolean;
|
|
4648
|
-
sector: string;
|
|
4649
|
-
seniority: string;
|
|
4650
|
-
settlement_convention: string;
|
|
4651
|
-
sinking_fund: boolean;
|
|
4652
|
-
sp_creditwatch: string;
|
|
4653
|
-
sp_creditwatch_date: string;
|
|
4654
|
-
sp_outlook: string;
|
|
4655
|
-
sp_outlook_date: string;
|
|
4656
|
-
sp_rating: string;
|
|
4657
|
-
sp_rating_date: string;
|
|
4658
|
-
status: string;
|
|
4659
|
-
ticker: string;
|
|
4660
|
-
treasury_subtype: string;
|
|
4661
|
-
type: string;
|
|
4662
|
-
updated_at: string;
|
|
4663
|
-
}
|
|
4664
|
-
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
4665
|
-
count: number;
|
|
4666
|
-
data: InsightFixedIncomeV2[];
|
|
4667
|
-
}
|
|
4668
|
-
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
4669
|
-
/** @example true */
|
|
4670
|
-
bank_qualified?: boolean;
|
|
4671
|
-
/** @example true */
|
|
4672
|
-
callable?: boolean;
|
|
4673
|
-
/** @example true */
|
|
4674
|
-
convertible?: boolean;
|
|
4675
|
-
/** @example ["USA"] */
|
|
4676
|
-
country_codes?: string[];
|
|
4677
|
-
coupon?: InsightLessAndMoreV2;
|
|
4678
|
-
/** @example ["quarterly","zero"] */
|
|
4679
|
-
coupon_frequencies?: string[];
|
|
4680
|
-
/** @example ["655664AH3","9128286R6"] */
|
|
4681
|
-
cusip?: string[];
|
|
4682
|
-
/**
|
|
4683
|
-
* @maxLength 100
|
|
4684
|
-
* @example "Donald's"
|
|
4685
|
-
*/
|
|
4686
|
-
description?: string;
|
|
4687
|
-
/** @example true */
|
|
4688
|
-
has_ticker?: boolean;
|
|
4689
|
-
/** @example true */
|
|
4690
|
-
insured?: boolean;
|
|
4691
|
-
/** @example ["US655664AH33","US9128286R69"] */
|
|
4692
|
-
isin?: string[];
|
|
4693
|
-
issue_date?: InsightBeforeAndAfterV2;
|
|
4694
|
-
/**
|
|
4695
|
-
* @maxLength 100
|
|
4696
|
-
* @example "Donald's"
|
|
4697
|
-
*/
|
|
4698
|
-
issuer?: string;
|
|
4699
|
-
maturity?: InsightBeforeAndAfterV2;
|
|
4700
|
-
/** @example ["NY"] */
|
|
4701
|
-
municipal_states?: string[];
|
|
4702
|
-
/** @example true */
|
|
4703
|
-
municipal_tax?: boolean;
|
|
4704
|
-
/** @example ["general_obligation"] */
|
|
4705
|
-
municipal_types?: string[];
|
|
4706
|
-
pagination: InsightPaginationV2;
|
|
4707
|
-
purposes?: string[];
|
|
4708
|
-
/** @example ["SOVEREIGN"] */
|
|
4709
|
-
sectors?: string[];
|
|
4710
|
-
sorts?: InsightOrderingV2[];
|
|
4711
|
-
/** @example ["AAA"] */
|
|
4712
|
-
sp_ratings?: string[];
|
|
4713
|
-
/** @example ["called","outstanding"] */
|
|
4714
|
-
statuses?: string[];
|
|
4715
|
-
tickers?: string[];
|
|
4716
|
-
/** @example ["corporate"] */
|
|
4717
|
-
types?: string[];
|
|
4718
|
-
}
|
|
4719
|
-
export interface InsightGetTopSymbolsRequestV2 {
|
|
4720
|
-
exchange?: string[];
|
|
4721
|
-
market_cap?: InsightLessAndMoreV2;
|
|
4722
|
-
pagination?: InsightPaginationV2;
|
|
4723
|
-
price?: InsightLessAndMoreV2;
|
|
4724
|
-
sorts?: InsightOrderingV2[];
|
|
4725
|
-
volume?: InsightLessAndMoreV2;
|
|
4726
|
-
}
|
|
4727
|
-
export interface InsightIncludeExcludeV2 {
|
|
4728
|
-
exclude?: string[];
|
|
4729
|
-
include?: string[];
|
|
4730
|
-
}
|
|
4731
|
-
export interface InsightLessAndMoreV2 {
|
|
4732
|
-
less_than?: number;
|
|
4733
|
-
more_than?: number;
|
|
4734
|
-
}
|
|
4735
|
-
export interface InsightOrderingV2 {
|
|
4736
|
-
/**
|
|
4737
|
-
* @default "asc"
|
|
4738
|
-
* @example "asc"
|
|
4739
|
-
*/
|
|
4740
|
-
direction: InsightOrderingDirectionEnumV2;
|
|
4741
|
-
/**
|
|
4742
|
-
* Sort direction:
|
|
4743
|
-
* * asc - Ascending, from A to Z.
|
|
4744
|
-
* * desc - Descending, from Z to A.
|
|
4745
|
-
* @example "name"
|
|
4746
|
-
*/
|
|
4747
|
-
field: string;
|
|
4748
|
-
}
|
|
4749
|
-
export interface InsightPaginationV2 {
|
|
4750
|
-
/**
|
|
4751
|
-
* @min 1
|
|
4752
|
-
* @example 1
|
|
4753
|
-
*/
|
|
4754
|
-
page: number;
|
|
4755
|
-
/**
|
|
4756
|
-
* @min 1
|
|
4757
|
-
* @max 50
|
|
4758
|
-
* @example 10
|
|
4759
|
-
*/
|
|
4760
|
-
size: number;
|
|
4761
|
-
}
|
|
4762
|
-
export interface InsightStockScreenerQuoteV2 {
|
|
4763
|
-
average_volume_30d: number;
|
|
4764
|
-
company_name: string;
|
|
4765
|
-
dividend_ex_date: string;
|
|
4766
|
-
dividend_pay_date: string;
|
|
4767
|
-
dividend_percent: number;
|
|
4768
|
-
exchange: string;
|
|
4769
|
-
exchange_name: string;
|
|
4770
|
-
gap: number;
|
|
4771
|
-
industry: string;
|
|
4772
|
-
industry_code: string;
|
|
4773
|
-
last_price: number;
|
|
4774
|
-
market_cap: number;
|
|
4775
|
-
pe_ratio: number;
|
|
4776
|
-
price_change: number;
|
|
4777
|
-
price_change_percent: number;
|
|
4778
|
-
symbol: string;
|
|
4779
|
-
volume: number;
|
|
4780
|
-
}
|
|
4781
|
-
export interface InsightStockScreenerRequestV2 {
|
|
4782
|
-
average_volume_30d?: InsightLessAndMoreV2;
|
|
4783
|
-
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
4784
|
-
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
4785
|
-
dividend_percent?: InsightLessAndMoreV2;
|
|
4786
|
-
exchange?: InsightIncludeExcludeV2;
|
|
4787
|
-
gap?: InsightLessAndMoreV2;
|
|
4788
|
-
industry?: InsightIncludeExcludeV2;
|
|
4789
|
-
market_cap?: InsightLessAndMoreV2;
|
|
4790
|
-
pagination: InsightPaginationV2;
|
|
4791
|
-
pe_ratio?: InsightLessAndMoreV2;
|
|
4792
|
-
price?: InsightLessAndMoreV2;
|
|
4793
|
-
sorts?: InsightOrderingV2[];
|
|
4794
|
-
/** @example "ADR" */
|
|
4795
|
-
stock_type?: string;
|
|
4796
|
-
volume?: InsightLessAndMoreV2;
|
|
4797
|
-
}
|
|
4798
|
-
export interface InsightStockScreenerResponseV2 {
|
|
4799
|
-
current_page: number;
|
|
4800
|
-
data: InsightStockScreenerQuoteV2[];
|
|
4801
|
-
page_count: number;
|
|
4802
|
-
status: number;
|
|
4803
|
-
total_records: number;
|
|
4804
|
-
}
|
|
4805
|
-
/**
|
|
4806
|
-
* @default "asc"
|
|
4807
|
-
* @example "asc"
|
|
4808
|
-
*/
|
|
4809
|
-
export enum InsightOrderingDirectionEnumV2 {
|
|
4810
|
-
Asc = "asc",
|
|
4811
|
-
Desc = "desc"
|
|
4812
|
-
}
|
|
4813
|
-
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
4814
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4815
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4816
|
-
/**
|
|
4817
|
-
* @description get fixed income entries
|
|
4818
|
-
* @tags FixedIncome
|
|
4819
|
-
* @name GetFixedIncomeEntries
|
|
4820
|
-
* @summary get fixed income entries
|
|
4821
|
-
* @request POST:/fixed-income
|
|
4822
|
-
* @secure
|
|
4823
|
-
*/
|
|
4824
|
-
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
4825
|
-
}
|
|
4826
|
-
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
4827
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4828
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4829
|
-
/**
|
|
4830
|
-
* @description get fundamentals by symbol data
|
|
4831
|
-
* @tags Fundamentals
|
|
4832
|
-
* @name GetFundamentalsBySymbolData
|
|
4833
|
-
* @summary get fundamentals by symbol data
|
|
4834
|
-
* @request POST:/fundamentals
|
|
4835
|
-
* @secure
|
|
4836
|
-
*/
|
|
4837
|
-
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
4760
|
+
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
4761
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4762
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4763
|
+
/**
|
|
4764
|
+
* @description get fundamentals by symbol data
|
|
4765
|
+
* @tags Fundamentals
|
|
4766
|
+
* @name GetFundamentalsBySymbolData
|
|
4767
|
+
* @summary get fundamentals by symbol data
|
|
4768
|
+
* @request POST:/fundamentals
|
|
4769
|
+
* @secure
|
|
4770
|
+
*/
|
|
4771
|
+
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
4838
4772
|
}
|
|
4839
4773
|
export class Funds<HandleError extends boolean = boolean> {
|
|
4840
4774
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4950,476 +4884,202 @@ export class Funds<HandleError extends boolean = boolean> {
|
|
|
4950
4884
|
Authorization?: string;
|
|
4951
4885
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
|
|
4952
4886
|
}
|
|
4953
|
-
export class
|
|
4887
|
+
export class StockScreener<HandleError extends boolean = boolean> {
|
|
4954
4888
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4955
4889
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4956
4890
|
/**
|
|
4957
|
-
* @description
|
|
4958
|
-
* @tags
|
|
4959
|
-
* @name
|
|
4960
|
-
* @summary
|
|
4961
|
-
* @request
|
|
4891
|
+
* @description data for visual heat map
|
|
4892
|
+
* @tags StockScreener
|
|
4893
|
+
* @name StockMarketHeatmap
|
|
4894
|
+
* @summary data for visual heat map
|
|
4895
|
+
* @request GET:/heatmaps
|
|
4962
4896
|
* @secure
|
|
4963
4897
|
*/
|
|
4964
|
-
|
|
4965
|
-
|
|
4966
|
-
|
|
4967
|
-
|
|
4968
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4898
|
+
stockMarketHeatmap(query?: {
|
|
4899
|
+
/** Name of symbol list to fetch details for. Empty is default */
|
|
4900
|
+
heatmap_name?: string;
|
|
4901
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
4969
4902
|
/**
|
|
4970
|
-
* @description
|
|
4971
|
-
* @tags
|
|
4972
|
-
* @name
|
|
4973
|
-
* @summary
|
|
4974
|
-
* @request POST:/
|
|
4903
|
+
* @description create or update heat map preset
|
|
4904
|
+
* @tags StockScreener
|
|
4905
|
+
* @name CreateStockMarketHeatmapPreset
|
|
4906
|
+
* @summary create or update heat map preset
|
|
4907
|
+
* @request POST:/heatmaps
|
|
4975
4908
|
* @secure
|
|
4976
4909
|
*/
|
|
4977
|
-
|
|
4910
|
+
createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4978
4911
|
/**
|
|
4979
|
-
* @description
|
|
4980
|
-
* @tags
|
|
4981
|
-
* @name
|
|
4982
|
-
* @summary get
|
|
4983
|
-
* @request
|
|
4912
|
+
* @description Sector and Industry Group performance
|
|
4913
|
+
* @tags StockScreener
|
|
4914
|
+
* @name IndustriesPerformance
|
|
4915
|
+
* @summary get industries performance
|
|
4916
|
+
* @request POST:/industries-performance
|
|
4984
4917
|
* @secure
|
|
4985
4918
|
*/
|
|
4986
|
-
|
|
4987
|
-
/** how many records to return. Max value is 50 */
|
|
4988
|
-
limit: number;
|
|
4989
|
-
/** how many records to skip */
|
|
4990
|
-
offset: number;
|
|
4991
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
4992
|
-
/**
|
|
4993
|
-
* @description get ipo info by symbol
|
|
4994
|
-
* @tags Ipos
|
|
4995
|
-
* @name GetIpos
|
|
4996
|
-
* @summary get ipo info by symbol
|
|
4997
|
-
* @request GET:/ipos/{symbol}
|
|
4998
|
-
* @secure
|
|
4999
|
-
*/
|
|
5000
|
-
getIpos(symbol: string, query?: {
|
|
5001
|
-
/** load quotes */
|
|
5002
|
-
load_quotes?: boolean;
|
|
5003
|
-
/** statuses */
|
|
5004
|
-
statuses?: string[];
|
|
5005
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
|
|
5006
|
-
}
|
|
5007
|
-
export class Logos<HandleError extends boolean = boolean> {
|
|
5008
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5009
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4919
|
+
industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
|
|
5010
4920
|
/**
|
|
5011
|
-
* @description
|
|
5012
|
-
* @tags
|
|
5013
|
-
* @name
|
|
5014
|
-
* @summary
|
|
5015
|
-
* @request POST:/
|
|
4921
|
+
* @description filter stocks by params
|
|
4922
|
+
* @tags StockScreener
|
|
4923
|
+
* @name StockScreener
|
|
4924
|
+
* @summary filter stocks by params
|
|
4925
|
+
* @request POST:/stock-screener
|
|
5016
4926
|
* @secure
|
|
5017
4927
|
*/
|
|
5018
|
-
|
|
4928
|
+
stockScreener(filter: InsightStockScreenerV1Request, headers?: {
|
|
4929
|
+
/** Authorization */
|
|
4930
|
+
Authorization?: string;
|
|
4931
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
5019
4932
|
/**
|
|
5020
|
-
* @description
|
|
5021
|
-
* @tags
|
|
5022
|
-
* @name
|
|
5023
|
-
* @summary
|
|
5024
|
-
* @request
|
|
4933
|
+
* @description get screener presets
|
|
4934
|
+
* @tags StockScreener
|
|
4935
|
+
* @name GetScreenerPresets
|
|
4936
|
+
* @summary get screener presets
|
|
4937
|
+
* @request GET:/stock-screener/presets
|
|
5025
4938
|
* @secure
|
|
5026
4939
|
*/
|
|
5027
|
-
|
|
4940
|
+
getScreenerPresets(query: {
|
|
4941
|
+
/** how many records to return */
|
|
4942
|
+
limit: number;
|
|
4943
|
+
/** how many records to skip */
|
|
4944
|
+
offset: number;
|
|
4945
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
5028
4946
|
/**
|
|
5029
|
-
* @description
|
|
5030
|
-
* @tags
|
|
5031
|
-
* @name
|
|
5032
|
-
* @summary
|
|
5033
|
-
* @request
|
|
4947
|
+
* @description update screener preset
|
|
4948
|
+
* @tags StockScreener
|
|
4949
|
+
* @name UpdateScreenerPreset
|
|
4950
|
+
* @summary update screener preset
|
|
4951
|
+
* @request PUT:/stock-screener/presets
|
|
5034
4952
|
* @secure
|
|
5035
4953
|
*/
|
|
5036
|
-
|
|
5037
|
-
/** Company symbol */
|
|
5038
|
-
symbol: string;
|
|
5039
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
|
|
4954
|
+
updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5040
4955
|
/**
|
|
5041
|
-
* @description
|
|
5042
|
-
* @tags
|
|
5043
|
-
* @name
|
|
5044
|
-
* @summary
|
|
5045
|
-
* @request
|
|
4956
|
+
* @description create screener preset
|
|
4957
|
+
* @tags StockScreener
|
|
4958
|
+
* @name CreateOrScreenerPreset
|
|
4959
|
+
* @summary create screener preset
|
|
4960
|
+
* @request POST:/stock-screener/presets
|
|
5046
4961
|
* @secure
|
|
5047
4962
|
*/
|
|
5048
|
-
|
|
5049
|
-
/** Company symbol */
|
|
5050
|
-
symbol: string;
|
|
5051
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
4963
|
+
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5052
4964
|
/**
|
|
5053
|
-
* @description
|
|
5054
|
-
* @tags
|
|
5055
|
-
* @name
|
|
5056
|
-
* @summary
|
|
5057
|
-
* @request
|
|
4965
|
+
* @description remove screener preset
|
|
4966
|
+
* @tags StockScreener
|
|
4967
|
+
* @name RemoveScreenerPreset
|
|
4968
|
+
* @summary remove screener preset
|
|
4969
|
+
* @request DELETE:/stock-screener/presets
|
|
5058
4970
|
* @secure
|
|
5059
4971
|
*/
|
|
5060
|
-
|
|
5061
|
-
/** Company symbol */
|
|
5062
|
-
symbol: string;
|
|
5063
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
4972
|
+
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5064
4973
|
/**
|
|
5065
|
-
* @description
|
|
5066
|
-
* @tags
|
|
5067
|
-
* @name
|
|
5068
|
-
* @summary
|
|
5069
|
-
* @request POST:/
|
|
4974
|
+
* @description get top symbols
|
|
4975
|
+
* @tags StockScreener
|
|
4976
|
+
* @name GetTopSymbols
|
|
4977
|
+
* @summary get top symbols
|
|
4978
|
+
* @request POST:/stock-screener/top
|
|
5070
4979
|
* @secure
|
|
5071
4980
|
*/
|
|
5072
|
-
|
|
4981
|
+
getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
4982
|
+
}
|
|
4983
|
+
export class Quotes<HandleError extends boolean = boolean> {
|
|
4984
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4985
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5073
4986
|
/**
|
|
5074
|
-
* @description
|
|
5075
|
-
* @tags
|
|
5076
|
-
* @name
|
|
5077
|
-
* @summary Get
|
|
5078
|
-
* @request
|
|
4987
|
+
* @description Get single historical quote
|
|
4988
|
+
* @tags Quotes
|
|
4989
|
+
* @name GitHistoricalQuote
|
|
4990
|
+
* @summary Get single historical quote
|
|
4991
|
+
* @request GET:/historical/quote
|
|
5079
4992
|
* @secure
|
|
5080
4993
|
*/
|
|
5081
|
-
|
|
4994
|
+
gitHistoricalQuote(query: {
|
|
4995
|
+
/** Symbol */
|
|
4996
|
+
symbol: string;
|
|
4997
|
+
/** Date */
|
|
4998
|
+
date: string;
|
|
4999
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
5082
5000
|
/**
|
|
5083
|
-
* @description
|
|
5084
|
-
* @tags
|
|
5085
|
-
* @name
|
|
5086
|
-
* @summary Get
|
|
5087
|
-
* @request
|
|
5001
|
+
* @description get quote history by symbol
|
|
5002
|
+
* @tags Quotes
|
|
5003
|
+
* @name GitQuoteHistory
|
|
5004
|
+
* @summary Get quote history
|
|
5005
|
+
* @request POST:/quote-history
|
|
5088
5006
|
* @secure
|
|
5089
5007
|
*/
|
|
5090
|
-
|
|
5091
|
-
/** Company symbol */
|
|
5092
|
-
symbol: string;
|
|
5093
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
|
|
5008
|
+
gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
|
|
5094
5009
|
/**
|
|
5095
|
-
* @description Returns
|
|
5096
|
-
* @tags
|
|
5097
|
-
* @name
|
|
5098
|
-
* @summary Get
|
|
5099
|
-
* @request GET:/
|
|
5010
|
+
* @description Returns a list of quotes equity info for specified symbols.
|
|
5011
|
+
* @tags Quotes
|
|
5012
|
+
* @name GetQuotesEquityData
|
|
5013
|
+
* @summary Get Quotes Equity data
|
|
5014
|
+
* @request GET:/quotes/equity
|
|
5100
5015
|
* @secure
|
|
5101
5016
|
*/
|
|
5102
|
-
|
|
5103
|
-
/**
|
|
5104
|
-
|
|
5105
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5017
|
+
getQuotesEquityData(query: {
|
|
5018
|
+
/** Comma separated symbols */
|
|
5019
|
+
symbols: string;
|
|
5020
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
5106
5021
|
}
|
|
5107
|
-
export class
|
|
5022
|
+
export class Intraday<HandleError extends boolean = boolean> {
|
|
5108
5023
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5109
5024
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5110
5025
|
/**
|
|
5111
|
-
* @description
|
|
5112
|
-
* @tags
|
|
5113
|
-
* @name
|
|
5114
|
-
* @summary
|
|
5115
|
-
* @request POST:/
|
|
5116
|
-
* @secure
|
|
5117
|
-
*/
|
|
5118
|
-
getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
|
|
5119
|
-
/**
|
|
5120
|
-
* @description get todays market hours
|
|
5121
|
-
* @tags MarketDates
|
|
5122
|
-
* @name GetTodaysMarketHours
|
|
5123
|
-
* @summary get todays market hours
|
|
5124
|
-
* @request GET:/market-dates/today
|
|
5026
|
+
* @description Returns an array of intraday chart data values for the given ticker.
|
|
5027
|
+
* @tags Intraday
|
|
5028
|
+
* @name IntradayQuotes
|
|
5029
|
+
* @summary Get an array of intraday chart data values for the given ticker
|
|
5030
|
+
* @request POST:/intraday/quotes
|
|
5125
5031
|
* @secure
|
|
5126
5032
|
*/
|
|
5127
|
-
|
|
5128
|
-
/** Market */
|
|
5129
|
-
market: string;
|
|
5130
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
5033
|
+
intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
|
|
5131
5034
|
}
|
|
5132
|
-
export class
|
|
5035
|
+
export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
5133
5036
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5134
5037
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5135
5038
|
/**
|
|
5136
|
-
* @description
|
|
5137
|
-
* @tags
|
|
5138
|
-
* @name
|
|
5139
|
-
* @summary
|
|
5140
|
-
* @request
|
|
5039
|
+
* @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
|
|
5040
|
+
* @tags PreIPOCompanies
|
|
5041
|
+
* @name GetPreIpoCompanies
|
|
5042
|
+
* @summary get pre ipo companies
|
|
5043
|
+
* @request GET:/ipos/pre-ipo-companies
|
|
5141
5044
|
* @secure
|
|
5142
5045
|
*/
|
|
5143
|
-
|
|
5046
|
+
getPreIpoCompanies(query: {
|
|
5047
|
+
/** search by company name */
|
|
5048
|
+
name?: string;
|
|
5049
|
+
/** search by categories */
|
|
5050
|
+
categories?: string;
|
|
5051
|
+
/** how many records to return. Max value is 50 */
|
|
5052
|
+
limit: number;
|
|
5053
|
+
/** how many records to skip */
|
|
5054
|
+
offset: number;
|
|
5055
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
|
|
5144
5056
|
/**
|
|
5145
|
-
* @description
|
|
5146
|
-
* @tags
|
|
5147
|
-
* @name
|
|
5148
|
-
* @summary
|
|
5149
|
-
* @request
|
|
5057
|
+
* @description get pre ipo company by id
|
|
5058
|
+
* @tags PreIPOCompanies
|
|
5059
|
+
* @name GetPreIpoCompaniesById
|
|
5060
|
+
* @summary get pre ipo company by id
|
|
5061
|
+
* @request GET:/ipos/pre-ipo-companies/{id}
|
|
5062
|
+
* @originalName getPreIpoCompanies
|
|
5063
|
+
* @duplicate
|
|
5150
5064
|
* @secure
|
|
5151
5065
|
*/
|
|
5152
|
-
|
|
5066
|
+
getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
|
|
5153
5067
|
/**
|
|
5154
|
-
* @description
|
|
5155
|
-
* @tags
|
|
5156
|
-
* @name
|
|
5157
|
-
* @summary
|
|
5158
|
-
* @request GET:/
|
|
5068
|
+
* @description get pre ipo company funding rounds
|
|
5069
|
+
* @tags PreIPOCompanies
|
|
5070
|
+
* @name GetPreIpoCompanyFundingRounds
|
|
5071
|
+
* @summary get pre ipo company funding rounds
|
|
5072
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds
|
|
5159
5073
|
* @secure
|
|
5160
5074
|
*/
|
|
5161
|
-
|
|
5162
|
-
/**
|
|
5075
|
+
getPreIpoCompanyFundingRounds(query: {
|
|
5076
|
+
/** company id */
|
|
5077
|
+
pre_ipo_company_id?: string;
|
|
5078
|
+
/** search by round name */
|
|
5079
|
+
round_name?: string;
|
|
5080
|
+
/** how many records to return. Max value is 50 */
|
|
5163
5081
|
limit: number;
|
|
5164
|
-
/**
|
|
5165
|
-
offset: number;
|
|
5166
|
-
/** Start date */
|
|
5167
|
-
start_date?: string;
|
|
5168
|
-
/** End date */
|
|
5169
|
-
end_date?: string;
|
|
5170
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
|
|
5171
|
-
/**
|
|
5172
|
-
* @description Update featured articles
|
|
5173
|
-
* @tags News
|
|
5174
|
-
* @name UpdateFeaturedArticles
|
|
5175
|
-
* @summary Update featured articles
|
|
5176
|
-
* @request PUT:/news/featured-articles
|
|
5177
|
-
* @secure
|
|
5178
|
-
*/
|
|
5179
|
-
updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5180
|
-
/**
|
|
5181
|
-
* @description Create featured articles
|
|
5182
|
-
* @tags News
|
|
5183
|
-
* @name CreateFeaturedArticles
|
|
5184
|
-
* @summary Create featured articles
|
|
5185
|
-
* @request POST:/news/featured-articles
|
|
5186
|
-
* @secure
|
|
5187
|
-
*/
|
|
5188
|
-
createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5189
|
-
/**
|
|
5190
|
-
* @description Get active featured articles
|
|
5191
|
-
* @tags News
|
|
5192
|
-
* @name GetActiveFeaturedArticles
|
|
5193
|
-
* @summary Get active featured articles
|
|
5194
|
-
* @request GET:/news/featured-articles/active
|
|
5195
|
-
* @secure
|
|
5196
|
-
*/
|
|
5197
|
-
getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
|
|
5198
|
-
/**
|
|
5199
|
-
* @description Set featured articles
|
|
5200
|
-
* @tags News
|
|
5201
|
-
* @name SetFeaturedArticles
|
|
5202
|
-
* @summary Set featured articles
|
|
5203
|
-
* @request POST:/news/featured-articles/set
|
|
5204
|
-
* @secure
|
|
5205
|
-
*/
|
|
5206
|
-
setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5207
|
-
/**
|
|
5208
|
-
* @description Get featured article
|
|
5209
|
-
* @tags News
|
|
5210
|
-
* @name GetFeaturedArticle
|
|
5211
|
-
* @summary Get featured article
|
|
5212
|
-
* @request GET:/news/featured-articles/{id}
|
|
5213
|
-
* @secure
|
|
5214
|
-
*/
|
|
5215
|
-
getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
|
|
5216
|
-
/**
|
|
5217
|
-
* @description Returns news by filters
|
|
5218
|
-
* @tags News
|
|
5219
|
-
* @name NewsFiltered
|
|
5220
|
-
* @summary Get filtered news
|
|
5221
|
-
* @request POST:/news/filter
|
|
5222
|
-
* @secure
|
|
5223
|
-
*/
|
|
5224
|
-
newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
|
|
5225
|
-
/**
|
|
5226
|
-
* @description Returns news by id
|
|
5227
|
-
* @tags News
|
|
5228
|
-
* @name NewsById
|
|
5229
|
-
* @summary Get news by id
|
|
5230
|
-
* @request POST:/news/id
|
|
5231
|
-
* @secure
|
|
5232
|
-
*/
|
|
5233
|
-
newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
|
|
5234
|
-
/**
|
|
5235
|
-
* @description Returns news previews
|
|
5236
|
-
* @tags News
|
|
5237
|
-
* @name NewsPreviewsFiltered
|
|
5238
|
-
* @summary Get news previews
|
|
5239
|
-
* @request GET:/news/previews
|
|
5240
|
-
* @secure
|
|
5241
|
-
*/
|
|
5242
|
-
newsPreviewsFiltered(query: {
|
|
5243
|
-
/** Start date */
|
|
5244
|
-
start_date?: string;
|
|
5245
|
-
/** End date */
|
|
5246
|
-
end_date?: string;
|
|
5247
|
-
/** Symbol */
|
|
5248
|
-
symbol?: string;
|
|
5249
|
-
/** how many records to return. Max value is 50 */
|
|
5250
|
-
limit: number;
|
|
5251
|
-
/** how many records to skip */
|
|
5252
|
-
offset: number;
|
|
5253
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
|
|
5254
|
-
/**
|
|
5255
|
-
* @description Returns available stocks in DB
|
|
5256
|
-
* @tags News
|
|
5257
|
-
* @name NewsAvailableStocks
|
|
5258
|
-
* @summary Get available stocks in DB (for filters)
|
|
5259
|
-
* @request GET:/news/symbols
|
|
5260
|
-
* @secure
|
|
5261
|
-
*/
|
|
5262
|
-
newsAvailableStocks(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5263
|
-
/**
|
|
5264
|
-
* @description Returns available tags in DB
|
|
5265
|
-
* @tags News
|
|
5266
|
-
* @name NewsAvailableTags
|
|
5267
|
-
* @summary Get available tags in DB (for filters)
|
|
5268
|
-
* @request POST:/news/tags
|
|
5269
|
-
* @secure
|
|
5270
|
-
*/
|
|
5271
|
-
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5272
|
-
}
|
|
5273
|
-
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
5274
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5275
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5276
|
-
/**
|
|
5277
|
-
* @description Returns calculated matrix
|
|
5278
|
-
* @tags OptionGreeks
|
|
5279
|
-
* @name OgCalculateMatrix
|
|
5280
|
-
* @summary Calculate matrix
|
|
5281
|
-
* @request POST:/og/calculate-matrix
|
|
5282
|
-
* @secure
|
|
5283
|
-
*/
|
|
5284
|
-
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
5285
|
-
/**
|
|
5286
|
-
* @description Returns calculated params
|
|
5287
|
-
* @tags OptionGreeks
|
|
5288
|
-
* @name OgCalculateParams
|
|
5289
|
-
* @summary Calculate params
|
|
5290
|
-
* @request POST:/og/calculate-params
|
|
5291
|
-
* @secure
|
|
5292
|
-
*/
|
|
5293
|
-
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
5294
|
-
}
|
|
5295
|
-
export class Ownerships<HandleError extends boolean = boolean> {
|
|
5296
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5297
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5298
|
-
/**
|
|
5299
|
-
* @description get ownerships by id datadata
|
|
5300
|
-
* @tags Ownerships
|
|
5301
|
-
* @name GetOwnershipsByIdData
|
|
5302
|
-
* @summary get ownerships by id data
|
|
5303
|
-
* @request POST:/ownerships
|
|
5304
|
-
* @secure
|
|
5305
|
-
*/
|
|
5306
|
-
getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
5307
|
-
/**
|
|
5308
|
-
* @description get ownerships by symbol data
|
|
5309
|
-
* @tags Ownerships
|
|
5310
|
-
* @name GetOwnershipsBySymbolData
|
|
5311
|
-
* @summary get ownerships by symbol data
|
|
5312
|
-
* @request POST:/symbol-ownerships
|
|
5313
|
-
* @secure
|
|
5314
|
-
*/
|
|
5315
|
-
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
5316
|
-
}
|
|
5317
|
-
export class Passport<HandleError extends boolean = boolean> {
|
|
5318
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5319
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5320
|
-
/**
|
|
5321
|
-
* @description Returns article by id
|
|
5322
|
-
* @tags Passport
|
|
5323
|
-
* @name PassportArticleById
|
|
5324
|
-
* @summary Get article by id
|
|
5325
|
-
* @request POST:/passport/article-by-id
|
|
5326
|
-
* @secure
|
|
5327
|
-
*/
|
|
5328
|
-
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
5329
|
-
/**
|
|
5330
|
-
* @description Returns articles
|
|
5331
|
-
* @tags Passport
|
|
5332
|
-
* @name PassportArticles
|
|
5333
|
-
* @summary Get articles
|
|
5334
|
-
* @request POST:/passport/articles
|
|
5335
|
-
* @secure
|
|
5336
|
-
*/
|
|
5337
|
-
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5338
|
-
/**
|
|
5339
|
-
* @description Returns author profile
|
|
5340
|
-
* @tags Passport
|
|
5341
|
-
* @name PassportAuthorProfile
|
|
5342
|
-
* @summary Get author profile
|
|
5343
|
-
* @request POST:/passport/author-profile
|
|
5344
|
-
* @secure
|
|
5345
|
-
*/
|
|
5346
|
-
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
5347
|
-
/**
|
|
5348
|
-
* @description Returns most popular tags
|
|
5349
|
-
* @tags Passport
|
|
5350
|
-
* @name PassportMostPopularTags
|
|
5351
|
-
* @summary Get most popular tags
|
|
5352
|
-
* @request POST:/passport/most-popular-tags
|
|
5353
|
-
* @secure
|
|
5354
|
-
*/
|
|
5355
|
-
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
5356
|
-
/**
|
|
5357
|
-
* @description Returns news feed
|
|
5358
|
-
* @tags Passport
|
|
5359
|
-
* @name PassportNewsFeed
|
|
5360
|
-
* @summary Get news feed
|
|
5361
|
-
* @request POST:/passport/newsfeed
|
|
5362
|
-
* @secure
|
|
5363
|
-
*/
|
|
5364
|
-
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
|
|
5365
|
-
/**
|
|
5366
|
-
* @description Returns article by parameters
|
|
5367
|
-
* @tags Passport
|
|
5368
|
-
* @name PassportSearchArticle
|
|
5369
|
-
* @summary Search article by parameters
|
|
5370
|
-
* @request POST:/passport/search-article
|
|
5371
|
-
* @secure
|
|
5372
|
-
*/
|
|
5373
|
-
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5374
|
-
}
|
|
5375
|
-
export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
5376
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5377
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5378
|
-
/**
|
|
5379
|
-
* @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
|
|
5380
|
-
* @tags PreIPOCompanies
|
|
5381
|
-
* @name GetPreIpoCompanies
|
|
5382
|
-
* @summary get pre ipo companies
|
|
5383
|
-
* @request GET:/ipos/pre-ipo-companies
|
|
5384
|
-
* @secure
|
|
5385
|
-
*/
|
|
5386
|
-
getPreIpoCompanies(query: {
|
|
5387
|
-
/** search by company name */
|
|
5388
|
-
name?: string;
|
|
5389
|
-
/** search by categories */
|
|
5390
|
-
categories?: string;
|
|
5391
|
-
/** how many records to return. Max value is 50 */
|
|
5392
|
-
limit: number;
|
|
5393
|
-
/** how many records to skip */
|
|
5394
|
-
offset: number;
|
|
5395
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
|
|
5396
|
-
/**
|
|
5397
|
-
* @description get pre ipo company by id
|
|
5398
|
-
* @tags PreIPOCompanies
|
|
5399
|
-
* @name GetPreIpoCompaniesById
|
|
5400
|
-
* @summary get pre ipo company by id
|
|
5401
|
-
* @request GET:/ipos/pre-ipo-companies/{id}
|
|
5402
|
-
* @originalName getPreIpoCompanies
|
|
5403
|
-
* @duplicate
|
|
5404
|
-
* @secure
|
|
5405
|
-
*/
|
|
5406
|
-
getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
|
|
5407
|
-
/**
|
|
5408
|
-
* @description get pre ipo company funding rounds
|
|
5409
|
-
* @tags PreIPOCompanies
|
|
5410
|
-
* @name GetPreIpoCompanyFundingRounds
|
|
5411
|
-
* @summary get pre ipo company funding rounds
|
|
5412
|
-
* @request GET:/ipos/pre-ipo-company-funding-rounds
|
|
5413
|
-
* @secure
|
|
5414
|
-
*/
|
|
5415
|
-
getPreIpoCompanyFundingRounds(query: {
|
|
5416
|
-
/** company id */
|
|
5417
|
-
pre_ipo_company_id?: string;
|
|
5418
|
-
/** search by round name */
|
|
5419
|
-
round_name?: string;
|
|
5420
|
-
/** how many records to return. Max value is 50 */
|
|
5421
|
-
limit: number;
|
|
5422
|
-
/** how many records to skip */
|
|
5082
|
+
/** how many records to skip */
|
|
5423
5083
|
offset: number;
|
|
5424
5084
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
|
|
5425
5085
|
/**
|
|
@@ -5508,6 +5168,10 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
5508
5168
|
limit: number;
|
|
5509
5169
|
/** how many records to skip */
|
|
5510
5170
|
offset: number;
|
|
5171
|
+
/** search by research type */
|
|
5172
|
+
research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
|
|
5173
|
+
/** search by relation */
|
|
5174
|
+
relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
|
|
5511
5175
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
|
|
5512
5176
|
/**
|
|
5513
5177
|
* @description get pre ipo company research document by id
|
|
@@ -5558,288 +5222,361 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
5558
5222
|
*/
|
|
5559
5223
|
getPreIpoCompanySpvsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
|
|
5560
5224
|
}
|
|
5561
|
-
export class
|
|
5225
|
+
export class Ipos<HandleError extends boolean = boolean> {
|
|
5562
5226
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5563
5227
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5564
5228
|
/**
|
|
5565
|
-
* @description
|
|
5566
|
-
* @tags
|
|
5567
|
-
* @name
|
|
5568
|
-
* @summary
|
|
5569
|
-
* @request
|
|
5229
|
+
* @description get recent ipos info
|
|
5230
|
+
* @tags Ipos
|
|
5231
|
+
* @name PostRecent
|
|
5232
|
+
* @summary get recent ipos info
|
|
5233
|
+
* @request POST:/ipos/recent
|
|
5570
5234
|
* @secure
|
|
5571
5235
|
*/
|
|
5572
|
-
|
|
5573
|
-
/** Single symbol */
|
|
5574
|
-
symbol: string;
|
|
5575
|
-
/** Non-zero amount */
|
|
5576
|
-
amount: number;
|
|
5577
|
-
/** Start date for calculations */
|
|
5578
|
-
start_date: string;
|
|
5579
|
-
/** End date for calculations */
|
|
5580
|
-
end_date: string;
|
|
5581
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
5236
|
+
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5582
5237
|
/**
|
|
5583
|
-
* @description
|
|
5584
|
-
* @tags
|
|
5585
|
-
* @name
|
|
5586
|
-
* @summary
|
|
5587
|
-
* @request GET:/
|
|
5238
|
+
* @description get upcoming ipos info
|
|
5239
|
+
* @tags Ipos
|
|
5240
|
+
* @name GetUpcoming
|
|
5241
|
+
* @summary get upcoming ipos info
|
|
5242
|
+
* @request GET:/ipos/upcoming
|
|
5588
5243
|
* @secure
|
|
5589
5244
|
*/
|
|
5590
|
-
|
|
5591
|
-
/**
|
|
5592
|
-
|
|
5593
|
-
|
|
5245
|
+
getUpcoming(query: {
|
|
5246
|
+
/** how many records to return. Max value is 50 */
|
|
5247
|
+
limit: number;
|
|
5248
|
+
/** how many records to skip */
|
|
5249
|
+
offset: number;
|
|
5250
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5594
5251
|
/**
|
|
5595
|
-
* @description get
|
|
5596
|
-
* @tags
|
|
5597
|
-
* @name
|
|
5598
|
-
* @summary get
|
|
5599
|
-
* @request GET:/
|
|
5252
|
+
* @description get ipo info by symbol
|
|
5253
|
+
* @tags Ipos
|
|
5254
|
+
* @name GetIpos
|
|
5255
|
+
* @summary get ipo info by symbol
|
|
5256
|
+
* @request GET:/ipos/{symbol}
|
|
5600
5257
|
* @secure
|
|
5601
5258
|
*/
|
|
5602
|
-
|
|
5603
|
-
/**
|
|
5604
|
-
|
|
5605
|
-
|
|
5259
|
+
getIpos(symbol: string, query?: {
|
|
5260
|
+
/** load quotes */
|
|
5261
|
+
load_quotes?: boolean;
|
|
5262
|
+
/** statuses */
|
|
5263
|
+
statuses?: string[];
|
|
5264
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
|
|
5265
|
+
}
|
|
5266
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
5267
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5268
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5606
5269
|
/**
|
|
5607
|
-
* @description
|
|
5608
|
-
* @tags
|
|
5609
|
-
* @name
|
|
5610
|
-
* @summary
|
|
5611
|
-
* @request
|
|
5270
|
+
* @description Returns converted logo for crypto symbol
|
|
5271
|
+
* @tags Logos
|
|
5272
|
+
* @name LogosConvertedCryptoSymbolLogo
|
|
5273
|
+
* @summary Get converted logo for crypto symbol
|
|
5274
|
+
* @request POST:/logos/converted-crypto-symbol-logo
|
|
5612
5275
|
* @secure
|
|
5613
5276
|
*/
|
|
5614
|
-
|
|
5615
|
-
/** Single symbol */
|
|
5616
|
-
symbol: string;
|
|
5617
|
-
/** Target date */
|
|
5618
|
-
date: string;
|
|
5619
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
5277
|
+
logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5620
5278
|
/**
|
|
5621
|
-
* @description
|
|
5622
|
-
* @tags
|
|
5623
|
-
* @name
|
|
5624
|
-
* @summary
|
|
5625
|
-
* @request
|
|
5279
|
+
* @description Returns converted logo for symbol
|
|
5280
|
+
* @tags Logos
|
|
5281
|
+
* @name LogosConvertedSymbolLogo
|
|
5282
|
+
* @summary Get converted logo for symbol
|
|
5283
|
+
* @request POST:/logos/converted-symbol-logo
|
|
5626
5284
|
* @secure
|
|
5627
5285
|
*/
|
|
5628
|
-
|
|
5286
|
+
logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5629
5287
|
/**
|
|
5630
|
-
* @description
|
|
5631
|
-
* @tags
|
|
5632
|
-
* @name
|
|
5633
|
-
* @summary
|
|
5634
|
-
* @request GET:/
|
|
5288
|
+
* @description Returns logo for crypto symbol
|
|
5289
|
+
* @tags Logos
|
|
5290
|
+
* @name LogosCryptoSymbolLogo
|
|
5291
|
+
* @summary Get logo for crypto symbol
|
|
5292
|
+
* @request GET:/logos/crypto-symbol-logo
|
|
5635
5293
|
* @secure
|
|
5636
5294
|
*/
|
|
5637
|
-
|
|
5295
|
+
logosCryptoSymbolLogo(query: {
|
|
5296
|
+
/** Company symbol */
|
|
5297
|
+
symbol: string;
|
|
5298
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
|
|
5638
5299
|
/**
|
|
5639
|
-
* @description
|
|
5640
|
-
* @tags
|
|
5641
|
-
* @name
|
|
5642
|
-
* @summary
|
|
5643
|
-
* @request GET:/
|
|
5300
|
+
* @description Returns direct logo for crypto symbol
|
|
5301
|
+
* @tags Logos
|
|
5302
|
+
* @name LogosDirectCryptoSymbolLogo
|
|
5303
|
+
* @summary Get direct logo for crypto symbol
|
|
5304
|
+
* @request GET:/logos/direct-crypto-symbol-logo
|
|
5644
5305
|
* @secure
|
|
5645
5306
|
*/
|
|
5646
|
-
|
|
5647
|
-
/**
|
|
5648
|
-
|
|
5649
|
-
|
|
5650
|
-
limit: number;
|
|
5651
|
-
/** how many records to skip */
|
|
5652
|
-
offset: number;
|
|
5653
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
5307
|
+
logosDirectCryptoSymbolLogo(query: {
|
|
5308
|
+
/** Company symbol */
|
|
5309
|
+
symbol: string;
|
|
5310
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5654
5311
|
/**
|
|
5655
|
-
* @description
|
|
5656
|
-
* @tags
|
|
5657
|
-
* @name
|
|
5658
|
-
* @summary
|
|
5659
|
-
* @request GET:/
|
|
5312
|
+
* @description Returns direct logo for symbol
|
|
5313
|
+
* @tags Logos
|
|
5314
|
+
* @name LogosDirectSymbolLogo
|
|
5315
|
+
* @summary Get direct logo for symbol
|
|
5316
|
+
* @request GET:/logos/direct-symbol-logo
|
|
5660
5317
|
* @secure
|
|
5661
5318
|
*/
|
|
5662
|
-
|
|
5663
|
-
/**
|
|
5664
|
-
|
|
5665
|
-
|
|
5666
|
-
limit: number;
|
|
5667
|
-
/** how many records to skip */
|
|
5668
|
-
offset: number;
|
|
5669
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
5319
|
+
logosDirectSymbolLogo(query: {
|
|
5320
|
+
/** Company symbol */
|
|
5321
|
+
symbol: string;
|
|
5322
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5670
5323
|
/**
|
|
5671
|
-
* @description
|
|
5672
|
-
* @tags
|
|
5673
|
-
* @name
|
|
5674
|
-
* @summary
|
|
5675
|
-
* @request
|
|
5324
|
+
* @description Returns logos for multiple symbols
|
|
5325
|
+
* @tags Logos
|
|
5326
|
+
* @name LogosMultipleCryptoSymbolLogo
|
|
5327
|
+
* @summary Get logos for multiple symbols
|
|
5328
|
+
* @request POST:/logos/multiple-crypto-symbol-logo
|
|
5676
5329
|
* @secure
|
|
5677
5330
|
*/
|
|
5678
|
-
|
|
5679
|
-
/** EQUITY|ETF|CRYPTO */
|
|
5680
|
-
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
5681
|
-
/** how many records to return. Max value is 50 */
|
|
5682
|
-
limit: number;
|
|
5683
|
-
/** how many records to skip */
|
|
5684
|
-
offset: number;
|
|
5685
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
5686
|
-
}
|
|
5687
|
-
export class Quotes<HandleError extends boolean = boolean> {
|
|
5688
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5689
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5331
|
+
logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
|
|
5690
5332
|
/**
|
|
5691
|
-
* @description
|
|
5692
|
-
* @tags
|
|
5693
|
-
* @name
|
|
5694
|
-
* @summary Get
|
|
5695
|
-
* @request
|
|
5333
|
+
* @description Returns logos for multiple symbol
|
|
5334
|
+
* @tags Logos
|
|
5335
|
+
* @name LogosMultipleSymbolLogos
|
|
5336
|
+
* @summary Get logos for multiple symbols
|
|
5337
|
+
* @request POST:/logos/multiple-symbol-logos
|
|
5696
5338
|
* @secure
|
|
5697
5339
|
*/
|
|
5698
|
-
|
|
5699
|
-
/** Symbol */
|
|
5700
|
-
symbol: string;
|
|
5701
|
-
/** Date */
|
|
5702
|
-
date: string;
|
|
5703
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
5340
|
+
logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
|
|
5704
5341
|
/**
|
|
5705
|
-
* @description
|
|
5706
|
-
* @tags
|
|
5707
|
-
* @name
|
|
5708
|
-
* @summary Get
|
|
5709
|
-
* @request
|
|
5342
|
+
* @description Returns links of socials logos for symbol
|
|
5343
|
+
* @tags Logos
|
|
5344
|
+
* @name LogosSocialSymbolLogos
|
|
5345
|
+
* @summary Get social logos for symbol
|
|
5346
|
+
* @request GET:/logos/social-symbol-logos
|
|
5710
5347
|
* @secure
|
|
5711
5348
|
*/
|
|
5712
|
-
|
|
5349
|
+
logosSocialSymbolLogos(query: {
|
|
5350
|
+
/** Company symbol */
|
|
5351
|
+
symbol: string;
|
|
5352
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
|
|
5713
5353
|
/**
|
|
5714
|
-
* @description Returns
|
|
5715
|
-
* @tags
|
|
5716
|
-
* @name
|
|
5717
|
-
* @summary Get
|
|
5718
|
-
* @request GET:/
|
|
5354
|
+
* @description Returns logos for company symbol
|
|
5355
|
+
* @tags Logos
|
|
5356
|
+
* @name LogosSymbolLogos
|
|
5357
|
+
* @summary Get symbol logos
|
|
5358
|
+
* @request GET:/logos/symbol-logos
|
|
5719
5359
|
* @secure
|
|
5720
5360
|
*/
|
|
5721
|
-
|
|
5722
|
-
/**
|
|
5723
|
-
|
|
5724
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5361
|
+
logosSymbolLogos(query: {
|
|
5362
|
+
/** Company symbol */
|
|
5363
|
+
symbol: string;
|
|
5364
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
|
|
5725
5365
|
}
|
|
5726
|
-
export class
|
|
5366
|
+
export class MarketDates<HandleError extends boolean = boolean> {
|
|
5727
5367
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5728
5368
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5729
5369
|
/**
|
|
5730
|
-
* @description
|
|
5731
|
-
* @tags
|
|
5732
|
-
* @name
|
|
5733
|
-
* @summary
|
|
5734
|
-
* @request
|
|
5370
|
+
* @description get market dates history
|
|
5371
|
+
* @tags MarketDates
|
|
5372
|
+
* @name GetMarketDatesHistory
|
|
5373
|
+
* @summary get market dates history
|
|
5374
|
+
* @request POST:/market-dates/history
|
|
5735
5375
|
* @secure
|
|
5736
5376
|
*/
|
|
5737
|
-
|
|
5738
|
-
/** Name of symbol list to fetch details for. Empty is default */
|
|
5739
|
-
heatmap_name?: string;
|
|
5740
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
5377
|
+
getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
|
|
5741
5378
|
/**
|
|
5742
|
-
* @description
|
|
5743
|
-
* @tags
|
|
5744
|
-
* @name
|
|
5745
|
-
* @summary
|
|
5746
|
-
* @request
|
|
5379
|
+
* @description get todays market hours
|
|
5380
|
+
* @tags MarketDates
|
|
5381
|
+
* @name GetTodaysMarketHours
|
|
5382
|
+
* @summary get todays market hours
|
|
5383
|
+
* @request GET:/market-dates/today
|
|
5747
5384
|
* @secure
|
|
5748
5385
|
*/
|
|
5749
|
-
|
|
5750
|
-
|
|
5751
|
-
|
|
5752
|
-
|
|
5753
|
-
|
|
5754
|
-
|
|
5755
|
-
|
|
5386
|
+
getTodaysMarketHours(query: {
|
|
5387
|
+
/** Market */
|
|
5388
|
+
market: string;
|
|
5389
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
5390
|
+
}
|
|
5391
|
+
export class News<HandleError extends boolean = boolean> {
|
|
5392
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5393
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5394
|
+
/**
|
|
5395
|
+
* @description Returns available authors in DB
|
|
5396
|
+
* @tags News
|
|
5397
|
+
* @name NewsAvailableAuthors
|
|
5398
|
+
* @summary Get available authors in DB (for filters)
|
|
5399
|
+
* @request POST:/news/authors
|
|
5756
5400
|
* @secure
|
|
5757
5401
|
*/
|
|
5758
|
-
|
|
5402
|
+
newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5759
5403
|
/**
|
|
5760
|
-
* @description
|
|
5761
|
-
* @tags
|
|
5762
|
-
* @name
|
|
5763
|
-
* @summary
|
|
5764
|
-
* @request POST:/
|
|
5404
|
+
* @description Returns available channels in DB
|
|
5405
|
+
* @tags News
|
|
5406
|
+
* @name NewsAvailableChannels
|
|
5407
|
+
* @summary Get available channels in DB (for filters)
|
|
5408
|
+
* @request POST:/news/channels
|
|
5765
5409
|
* @secure
|
|
5766
5410
|
*/
|
|
5767
|
-
|
|
5768
|
-
/** Authorization */
|
|
5769
|
-
Authorization?: string;
|
|
5770
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
5411
|
+
newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5771
5412
|
/**
|
|
5772
|
-
* @description
|
|
5773
|
-
* @tags
|
|
5774
|
-
* @name
|
|
5775
|
-
* @summary
|
|
5776
|
-
* @request GET:/
|
|
5413
|
+
* @description Get featured articles
|
|
5414
|
+
* @tags News
|
|
5415
|
+
* @name GetFeaturedArticles
|
|
5416
|
+
* @summary Get featured articles
|
|
5417
|
+
* @request GET:/news/featured-articles
|
|
5777
5418
|
* @secure
|
|
5778
5419
|
*/
|
|
5779
|
-
|
|
5780
|
-
/**
|
|
5420
|
+
getFeaturedArticles(query: {
|
|
5421
|
+
/** Limit */
|
|
5422
|
+
limit: number;
|
|
5423
|
+
/** Offset */
|
|
5424
|
+
offset: number;
|
|
5425
|
+
/** Start date */
|
|
5426
|
+
start_date?: string;
|
|
5427
|
+
/** End date */
|
|
5428
|
+
end_date?: string;
|
|
5429
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
|
|
5430
|
+
/**
|
|
5431
|
+
* @description Update featured articles
|
|
5432
|
+
* @tags News
|
|
5433
|
+
* @name UpdateFeaturedArticles
|
|
5434
|
+
* @summary Update featured articles
|
|
5435
|
+
* @request PUT:/news/featured-articles
|
|
5436
|
+
* @secure
|
|
5437
|
+
*/
|
|
5438
|
+
updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5439
|
+
/**
|
|
5440
|
+
* @description Create featured articles
|
|
5441
|
+
* @tags News
|
|
5442
|
+
* @name CreateFeaturedArticles
|
|
5443
|
+
* @summary Create featured articles
|
|
5444
|
+
* @request POST:/news/featured-articles
|
|
5445
|
+
* @secure
|
|
5446
|
+
*/
|
|
5447
|
+
createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5448
|
+
/**
|
|
5449
|
+
* @description Get active featured articles
|
|
5450
|
+
* @tags News
|
|
5451
|
+
* @name GetActiveFeaturedArticles
|
|
5452
|
+
* @summary Get active featured articles
|
|
5453
|
+
* @request GET:/news/featured-articles/active
|
|
5454
|
+
* @secure
|
|
5455
|
+
*/
|
|
5456
|
+
getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
|
|
5457
|
+
/**
|
|
5458
|
+
* @description Set featured articles
|
|
5459
|
+
* @tags News
|
|
5460
|
+
* @name SetFeaturedArticles
|
|
5461
|
+
* @summary Set featured articles
|
|
5462
|
+
* @request POST:/news/featured-articles/set
|
|
5463
|
+
* @secure
|
|
5464
|
+
*/
|
|
5465
|
+
setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5466
|
+
/**
|
|
5467
|
+
* @description Get featured article
|
|
5468
|
+
* @tags News
|
|
5469
|
+
* @name GetFeaturedArticle
|
|
5470
|
+
* @summary Get featured article
|
|
5471
|
+
* @request GET:/news/featured-articles/{id}
|
|
5472
|
+
* @secure
|
|
5473
|
+
*/
|
|
5474
|
+
getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
|
|
5475
|
+
/**
|
|
5476
|
+
* @description Returns news by filters
|
|
5477
|
+
* @tags News
|
|
5478
|
+
* @name NewsFiltered
|
|
5479
|
+
* @summary Get filtered news
|
|
5480
|
+
* @request POST:/news/filter
|
|
5481
|
+
* @secure
|
|
5482
|
+
*/
|
|
5483
|
+
newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
|
|
5484
|
+
/**
|
|
5485
|
+
* @description Returns news by id
|
|
5486
|
+
* @tags News
|
|
5487
|
+
* @name NewsById
|
|
5488
|
+
* @summary Get news by id
|
|
5489
|
+
* @request POST:/news/id
|
|
5490
|
+
* @secure
|
|
5491
|
+
*/
|
|
5492
|
+
newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
|
|
5493
|
+
/**
|
|
5494
|
+
* @description Returns news previews
|
|
5495
|
+
* @tags News
|
|
5496
|
+
* @name NewsPreviewsFiltered
|
|
5497
|
+
* @summary Get news previews
|
|
5498
|
+
* @request GET:/news/previews
|
|
5499
|
+
* @secure
|
|
5500
|
+
*/
|
|
5501
|
+
newsPreviewsFiltered(query: {
|
|
5502
|
+
/** Start date */
|
|
5503
|
+
start_date?: string;
|
|
5504
|
+
/** End date */
|
|
5505
|
+
end_date?: string;
|
|
5506
|
+
/** Symbol */
|
|
5507
|
+
symbol?: string;
|
|
5508
|
+
/** how many records to return. Max value is 50 */
|
|
5781
5509
|
limit: number;
|
|
5782
5510
|
/** how many records to skip */
|
|
5783
5511
|
offset: number;
|
|
5784
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5512
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
|
|
5785
5513
|
/**
|
|
5786
|
-
* @description
|
|
5787
|
-
* @tags
|
|
5788
|
-
* @name
|
|
5789
|
-
* @summary
|
|
5790
|
-
* @request
|
|
5514
|
+
* @description Returns available stocks in DB
|
|
5515
|
+
* @tags News
|
|
5516
|
+
* @name NewsAvailableStocks
|
|
5517
|
+
* @summary Get available stocks in DB (for filters)
|
|
5518
|
+
* @request GET:/news/symbols
|
|
5791
5519
|
* @secure
|
|
5792
5520
|
*/
|
|
5793
|
-
|
|
5521
|
+
newsAvailableStocks(query?: {
|
|
5522
|
+
/** Limit */
|
|
5523
|
+
limit?: number;
|
|
5524
|
+
/** Offset */
|
|
5525
|
+
offset?: number;
|
|
5526
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5794
5527
|
/**
|
|
5795
|
-
* @description
|
|
5796
|
-
* @tags
|
|
5797
|
-
* @name
|
|
5798
|
-
* @summary
|
|
5799
|
-
* @request POST:/
|
|
5528
|
+
* @description Returns available tags in DB
|
|
5529
|
+
* @tags News
|
|
5530
|
+
* @name NewsAvailableTags
|
|
5531
|
+
* @summary Get available tags in DB (for filters)
|
|
5532
|
+
* @request POST:/news/tags
|
|
5800
5533
|
* @secure
|
|
5801
5534
|
*/
|
|
5802
|
-
|
|
5535
|
+
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5536
|
+
}
|
|
5537
|
+
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
5538
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5539
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5803
5540
|
/**
|
|
5804
|
-
* @description
|
|
5805
|
-
* @tags
|
|
5806
|
-
* @name
|
|
5807
|
-
* @summary
|
|
5808
|
-
* @request
|
|
5541
|
+
* @description Returns calculated matrix
|
|
5542
|
+
* @tags OptionGreeks
|
|
5543
|
+
* @name OgCalculateMatrix
|
|
5544
|
+
* @summary Calculate matrix
|
|
5545
|
+
* @request POST:/og/calculate-matrix
|
|
5809
5546
|
* @secure
|
|
5810
5547
|
*/
|
|
5811
|
-
|
|
5548
|
+
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
5812
5549
|
/**
|
|
5813
|
-
* @description
|
|
5814
|
-
* @tags
|
|
5815
|
-
* @name
|
|
5816
|
-
* @summary
|
|
5817
|
-
* @request POST:/
|
|
5550
|
+
* @description Returns calculated params
|
|
5551
|
+
* @tags OptionGreeks
|
|
5552
|
+
* @name OgCalculateParams
|
|
5553
|
+
* @summary Calculate params
|
|
5554
|
+
* @request POST:/og/calculate-params
|
|
5818
5555
|
* @secure
|
|
5819
5556
|
*/
|
|
5820
|
-
|
|
5557
|
+
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
5821
5558
|
}
|
|
5822
|
-
export class
|
|
5559
|
+
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
5823
5560
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5824
5561
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5825
5562
|
/**
|
|
5826
|
-
* @description
|
|
5827
|
-
* @tags
|
|
5828
|
-
* @name
|
|
5829
|
-
* @summary
|
|
5830
|
-
* @request POST:/
|
|
5563
|
+
* @description get seasonlity data with comparison to benchmark
|
|
5564
|
+
* @tags AlphaTools
|
|
5565
|
+
* @name GetMomentumRatioGraph
|
|
5566
|
+
* @summary get seasonlity data
|
|
5567
|
+
* @request POST:/rst
|
|
5831
5568
|
* @secure
|
|
5832
5569
|
*/
|
|
5833
|
-
|
|
5570
|
+
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
5834
5571
|
/**
|
|
5835
|
-
* @description get
|
|
5836
|
-
* @tags
|
|
5837
|
-
* @name
|
|
5838
|
-
* @summary get
|
|
5839
|
-
* @request POST:/
|
|
5572
|
+
* @description get seasonlity data with comparison to benchmark
|
|
5573
|
+
* @tags AlphaTools
|
|
5574
|
+
* @name GetSeasonality
|
|
5575
|
+
* @summary get seasonlity data
|
|
5576
|
+
* @request POST:/seasonality
|
|
5840
5577
|
* @secure
|
|
5841
5578
|
*/
|
|
5842
|
-
|
|
5579
|
+
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
5843
5580
|
}
|
|
5844
5581
|
export class TipRank<HandleError extends boolean = boolean> {
|
|
5845
5582
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -6220,187 +5957,471 @@ export class UsageTracking<HandleError extends boolean = boolean> {
|
|
|
6220
5957
|
*/
|
|
6221
5958
|
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
6222
5959
|
}
|
|
6223
|
-
export class
|
|
5960
|
+
export class Public<HandleError extends boolean = boolean> {
|
|
6224
5961
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6225
5962
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6226
5963
|
/**
|
|
6227
|
-
* @description
|
|
6228
|
-
* @tags
|
|
6229
|
-
* @name
|
|
6230
|
-
* @summary
|
|
6231
|
-
* @request GET:/
|
|
5964
|
+
* @description Calculate estimated returns for selected symbols. Uses split adjusted prices
|
|
5965
|
+
* @tags Public
|
|
5966
|
+
* @name CalculateEstimatedReturns
|
|
5967
|
+
* @summary Calculate Estimated Returns
|
|
5968
|
+
* @request GET:/public/estimated-returns
|
|
6232
5969
|
* @secure
|
|
6233
5970
|
*/
|
|
6234
|
-
|
|
6235
|
-
/**
|
|
6236
|
-
|
|
6237
|
-
/**
|
|
6238
|
-
|
|
6239
|
-
|
|
5971
|
+
calculateEstimatedReturns(query: {
|
|
5972
|
+
/** Single symbol */
|
|
5973
|
+
symbol: string;
|
|
5974
|
+
/** Non-zero amount */
|
|
5975
|
+
amount: number;
|
|
5976
|
+
/** Start date for calculations */
|
|
5977
|
+
start_date: string;
|
|
5978
|
+
/** End date for calculations */
|
|
5979
|
+
end_date: string;
|
|
5980
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
6240
5981
|
/**
|
|
6241
|
-
* @description
|
|
6242
|
-
* @tags
|
|
6243
|
-
* @name
|
|
6244
|
-
* @summary
|
|
6245
|
-
* @request
|
|
5982
|
+
* @description Returns an expert forecast
|
|
5983
|
+
* @tags Public
|
|
5984
|
+
* @name ExpertForecast
|
|
5985
|
+
* @summary Expert forecast
|
|
5986
|
+
* @request GET:/public/expert-forecast
|
|
6246
5987
|
* @secure
|
|
6247
5988
|
*/
|
|
6248
|
-
|
|
6249
|
-
|
|
6250
|
-
|
|
6251
|
-
|
|
6252
|
-
|
|
6253
|
-
* @
|
|
6254
|
-
* @
|
|
5989
|
+
expertForecast(query: {
|
|
5990
|
+
/** Comma separated symbols */
|
|
5991
|
+
symbols: string;
|
|
5992
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
5993
|
+
/**
|
|
5994
|
+
* @description get fundamentals by symbol data
|
|
5995
|
+
* @tags Public
|
|
5996
|
+
* @name GetPublicFundamentalsBySymbolData
|
|
5997
|
+
* @summary get fundamentals by symbol data
|
|
5998
|
+
* @request GET:/public/fundamentals/{symbol}
|
|
6255
5999
|
* @secure
|
|
6256
6000
|
*/
|
|
6257
|
-
|
|
6001
|
+
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
6002
|
+
/** Annual or quarterly */
|
|
6003
|
+
mode: string;
|
|
6004
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
6258
6005
|
/**
|
|
6259
|
-
* @description
|
|
6260
|
-
* @tags
|
|
6261
|
-
* @name
|
|
6262
|
-
* @summary
|
|
6263
|
-
* @request
|
|
6006
|
+
* @description Daily price history
|
|
6007
|
+
* @tags Public
|
|
6008
|
+
* @name DailyPriceHistory
|
|
6009
|
+
* @summary Daily price history
|
|
6010
|
+
* @request GET:/public/price-history/daily
|
|
6264
6011
|
* @secure
|
|
6265
6012
|
*/
|
|
6266
|
-
|
|
6267
|
-
/**
|
|
6268
|
-
|
|
6269
|
-
|
|
6013
|
+
dailyPriceHistory(query: {
|
|
6014
|
+
/** Single symbol */
|
|
6015
|
+
symbol: string;
|
|
6016
|
+
/** Target date */
|
|
6017
|
+
date: string;
|
|
6018
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
6270
6019
|
/**
|
|
6271
|
-
* @description
|
|
6272
|
-
* @tags
|
|
6273
|
-
* @name
|
|
6274
|
-
* @summary
|
|
6275
|
-
* @request GET:/
|
|
6020
|
+
* @description Public quote profile
|
|
6021
|
+
* @tags Public
|
|
6022
|
+
* @name PublicQuoteProfile
|
|
6023
|
+
* @summary Public quote profile
|
|
6024
|
+
* @request GET:/public/quote-profile/{symbol}
|
|
6276
6025
|
* @secure
|
|
6277
6026
|
*/
|
|
6278
|
-
|
|
6279
|
-
/** Query limit */
|
|
6280
|
-
limit: number;
|
|
6281
|
-
/** Query offset */
|
|
6282
|
-
offset: number;
|
|
6283
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
6027
|
+
publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
|
|
6284
6028
|
/**
|
|
6285
|
-
* @description
|
|
6286
|
-
* @tags
|
|
6287
|
-
* @name
|
|
6288
|
-
* @summary
|
|
6289
|
-
* @request
|
|
6029
|
+
* @description get ratios by symbol data
|
|
6030
|
+
* @tags Public
|
|
6031
|
+
* @name GetPublicRatiosBySymbolData
|
|
6032
|
+
* @summary get ratios by symbol data
|
|
6033
|
+
* @request GET:/public/ratios/{symbol}
|
|
6290
6034
|
* @secure
|
|
6291
6035
|
*/
|
|
6292
|
-
|
|
6036
|
+
getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
|
|
6293
6037
|
/**
|
|
6294
|
-
* @description
|
|
6295
|
-
* @tags
|
|
6296
|
-
* @name
|
|
6297
|
-
* @summary
|
|
6298
|
-
* @request
|
|
6038
|
+
* @description find a symbol by name or description
|
|
6039
|
+
* @tags Public
|
|
6040
|
+
* @name QuoteFundamentalsSearch
|
|
6041
|
+
* @summary find a symbol by name or description
|
|
6042
|
+
* @request GET:/public/symbol-search
|
|
6299
6043
|
* @secure
|
|
6300
6044
|
*/
|
|
6301
|
-
|
|
6045
|
+
quoteFundamentalsSearch(query: {
|
|
6046
|
+
/** Search query */
|
|
6047
|
+
search_query: string;
|
|
6048
|
+
/** how many records to return. Max value is 50 */
|
|
6049
|
+
limit: number;
|
|
6050
|
+
/** how many records to skip */
|
|
6051
|
+
offset: number;
|
|
6052
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
6302
6053
|
/**
|
|
6303
|
-
* @description
|
|
6304
|
-
* @tags
|
|
6305
|
-
* @name
|
|
6306
|
-
* @summary
|
|
6307
|
-
* @request
|
|
6054
|
+
* @description Get top gainers
|
|
6055
|
+
* @tags Public
|
|
6056
|
+
* @name TopGainers
|
|
6057
|
+
* @summary Top Gainers
|
|
6058
|
+
* @request GET:/public/top-gainers
|
|
6308
6059
|
* @secure
|
|
6309
6060
|
*/
|
|
6310
|
-
|
|
6311
|
-
/**
|
|
6312
|
-
|
|
6313
|
-
|
|
6061
|
+
topGainers(query: {
|
|
6062
|
+
/** sort direction - asc or desc */
|
|
6063
|
+
order_direction?: string;
|
|
6064
|
+
/** how many records to return. Max value is 50 */
|
|
6065
|
+
limit: number;
|
|
6066
|
+
/** how many records to skip */
|
|
6067
|
+
offset: number;
|
|
6068
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6314
6069
|
/**
|
|
6315
|
-
* @description Get
|
|
6316
|
-
* @tags
|
|
6317
|
-
* @name
|
|
6318
|
-
* @summary
|
|
6319
|
-
* @request GET:/
|
|
6070
|
+
* @description Get top stocks
|
|
6071
|
+
* @tags Public
|
|
6072
|
+
* @name TopStocks
|
|
6073
|
+
* @summary Top Stocks
|
|
6074
|
+
* @request GET:/public/top-stocks
|
|
6320
6075
|
* @secure
|
|
6321
6076
|
*/
|
|
6322
|
-
|
|
6323
|
-
/**
|
|
6077
|
+
topStocks(query: {
|
|
6078
|
+
/** EQUITY|ETF|CRYPTO */
|
|
6079
|
+
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
6080
|
+
/** how many records to return. Max value is 50 */
|
|
6324
6081
|
limit: number;
|
|
6325
|
-
/**
|
|
6082
|
+
/** how many records to skip */
|
|
6326
6083
|
offset: number;
|
|
6327
|
-
|
|
6328
|
-
|
|
6329
|
-
|
|
6084
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6085
|
+
}
|
|
6086
|
+
export class Passport<HandleError extends boolean = boolean> {
|
|
6087
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6088
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6330
6089
|
/**
|
|
6331
|
-
* @description
|
|
6332
|
-
* @tags
|
|
6333
|
-
* @name
|
|
6334
|
-
* @summary
|
|
6335
|
-
* @request
|
|
6090
|
+
* @description Returns article by id
|
|
6091
|
+
* @tags Passport
|
|
6092
|
+
* @name PassportArticleById
|
|
6093
|
+
* @summary Get article by id
|
|
6094
|
+
* @request POST:/passport/article-by-id
|
|
6336
6095
|
* @secure
|
|
6337
6096
|
*/
|
|
6338
|
-
|
|
6097
|
+
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
6339
6098
|
/**
|
|
6340
|
-
* @description
|
|
6341
|
-
* @tags
|
|
6342
|
-
* @name
|
|
6343
|
-
* @summary
|
|
6344
|
-
* @request POST:/
|
|
6099
|
+
* @description Returns articles
|
|
6100
|
+
* @tags Passport
|
|
6101
|
+
* @name PassportArticles
|
|
6102
|
+
* @summary Get articles
|
|
6103
|
+
* @request POST:/passport/articles
|
|
6345
6104
|
* @secure
|
|
6346
6105
|
*/
|
|
6347
|
-
|
|
6106
|
+
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
6348
6107
|
/**
|
|
6349
|
-
* @description
|
|
6350
|
-
* @tags
|
|
6351
|
-
* @name
|
|
6352
|
-
* @summary
|
|
6353
|
-
* @request
|
|
6108
|
+
* @description Returns author profile
|
|
6109
|
+
* @tags Passport
|
|
6110
|
+
* @name PassportAuthorProfile
|
|
6111
|
+
* @summary Get author profile
|
|
6112
|
+
* @request POST:/passport/author-profile
|
|
6354
6113
|
* @secure
|
|
6355
6114
|
*/
|
|
6356
|
-
|
|
6357
|
-
/** a3 code */
|
|
6358
|
-
a3code: string;
|
|
6359
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6115
|
+
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
6360
6116
|
/**
|
|
6361
|
-
* @description
|
|
6362
|
-
* @tags
|
|
6363
|
-
* @name
|
|
6364
|
-
* @summary Get
|
|
6365
|
-
* @request
|
|
6117
|
+
* @description Returns most popular tags
|
|
6118
|
+
* @tags Passport
|
|
6119
|
+
* @name PassportMostPopularTags
|
|
6120
|
+
* @summary Get most popular tags
|
|
6121
|
+
* @request POST:/passport/most-popular-tags
|
|
6366
6122
|
* @secure
|
|
6367
6123
|
*/
|
|
6368
|
-
|
|
6369
|
-
/** Query limit */
|
|
6370
|
-
limit: number;
|
|
6371
|
-
/** Query offset */
|
|
6372
|
-
offset: number;
|
|
6373
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
6124
|
+
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
6374
6125
|
/**
|
|
6375
|
-
* @description
|
|
6376
|
-
* @tags
|
|
6377
|
-
* @name
|
|
6378
|
-
* @summary
|
|
6379
|
-
* @request
|
|
6126
|
+
* @description Returns news feed
|
|
6127
|
+
* @tags Passport
|
|
6128
|
+
* @name PassportNewsFeed
|
|
6129
|
+
* @summary Get news feed
|
|
6130
|
+
* @request POST:/passport/newsfeed
|
|
6380
6131
|
* @secure
|
|
6381
6132
|
*/
|
|
6382
|
-
|
|
6133
|
+
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
|
|
6383
6134
|
/**
|
|
6384
|
-
* @description
|
|
6385
|
-
* @tags
|
|
6386
|
-
* @name
|
|
6387
|
-
* @summary
|
|
6388
|
-
* @request POST:/
|
|
6135
|
+
* @description Returns article by parameters
|
|
6136
|
+
* @tags Passport
|
|
6137
|
+
* @name PassportSearchArticle
|
|
6138
|
+
* @summary Search article by parameters
|
|
6139
|
+
* @request POST:/passport/search-article
|
|
6389
6140
|
* @secure
|
|
6390
6141
|
*/
|
|
6391
|
-
|
|
6142
|
+
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
6143
|
+
}
|
|
6144
|
+
export class Ownerships<HandleError extends boolean = boolean> {
|
|
6145
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6146
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6392
6147
|
/**
|
|
6393
|
-
* @description
|
|
6394
|
-
* @tags
|
|
6395
|
-
* @name
|
|
6396
|
-
* @summary
|
|
6397
|
-
* @request
|
|
6148
|
+
* @description get ownerships by id datadata
|
|
6149
|
+
* @tags Ownerships
|
|
6150
|
+
* @name GetOwnershipsByIdData
|
|
6151
|
+
* @summary get ownerships by id data
|
|
6152
|
+
* @request POST:/ownerships
|
|
6398
6153
|
* @secure
|
|
6399
6154
|
*/
|
|
6400
|
-
|
|
6401
|
-
|
|
6402
|
-
|
|
6403
|
-
|
|
6155
|
+
getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
6156
|
+
/**
|
|
6157
|
+
* @description get ownerships by symbol data
|
|
6158
|
+
* @tags Ownerships
|
|
6159
|
+
* @name GetOwnershipsBySymbolData
|
|
6160
|
+
* @summary get ownerships by symbol data
|
|
6161
|
+
* @request POST:/symbol-ownerships
|
|
6162
|
+
* @secure
|
|
6163
|
+
*/
|
|
6164
|
+
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
6165
|
+
}
|
|
6166
|
+
export interface InsightBeforeAndAfterV2 {
|
|
6167
|
+
after?: string;
|
|
6168
|
+
before?: string;
|
|
6169
|
+
}
|
|
6170
|
+
export interface InsightFixedIncomeV2 {
|
|
6171
|
+
a144: boolean;
|
|
6172
|
+
accrued_interest: number;
|
|
6173
|
+
bank_qualified: boolean;
|
|
6174
|
+
bond_warrant: boolean;
|
|
6175
|
+
call_type: string;
|
|
6176
|
+
callable: boolean;
|
|
6177
|
+
close_price: number;
|
|
6178
|
+
close_price_asof: string;
|
|
6179
|
+
close_ytw: number;
|
|
6180
|
+
convertible: boolean;
|
|
6181
|
+
country: string;
|
|
6182
|
+
country_code: string;
|
|
6183
|
+
country_domicile: string;
|
|
6184
|
+
country_issue: string;
|
|
6185
|
+
coupon: number;
|
|
6186
|
+
coupon_frequency: string;
|
|
6187
|
+
coupon_type: string;
|
|
6188
|
+
currency: string;
|
|
6189
|
+
cusip: string;
|
|
6190
|
+
dated_date: string;
|
|
6191
|
+
daycount: string;
|
|
6192
|
+
description: string;
|
|
6193
|
+
description_short: string;
|
|
6194
|
+
duration: number;
|
|
6195
|
+
first_coupon_date: string;
|
|
6196
|
+
insured: boolean;
|
|
6197
|
+
isin: string;
|
|
6198
|
+
issue_date: string;
|
|
6199
|
+
issue_minimum_denomination: number;
|
|
6200
|
+
issue_price: number;
|
|
6201
|
+
issue_size: number;
|
|
6202
|
+
issuer: string;
|
|
6203
|
+
last_coupon_date: string;
|
|
6204
|
+
liquidity_institutional_aggregate: number;
|
|
6205
|
+
liquidity_institutional_buy: number;
|
|
6206
|
+
liquidity_institutional_sell: number;
|
|
6207
|
+
liquidity_micro_aggregate: number;
|
|
6208
|
+
liquidity_micro_buy: number;
|
|
6209
|
+
liquidity_micro_sell: number;
|
|
6210
|
+
liquidity_retail_aggregate: number;
|
|
6211
|
+
liquidity_retail_buy: number;
|
|
6212
|
+
liquidity_retail_sell: number;
|
|
6213
|
+
maturity_date: string;
|
|
6214
|
+
municipal_state: string;
|
|
6215
|
+
municipal_taxable_federal: boolean;
|
|
6216
|
+
municipal_type: string;
|
|
6217
|
+
next_call_date: string;
|
|
6218
|
+
next_call_price: number;
|
|
6219
|
+
next_coupon_date: string;
|
|
6220
|
+
par_value: number;
|
|
6221
|
+
perpetual: boolean;
|
|
6222
|
+
private_placement: boolean;
|
|
6223
|
+
purpose: string;
|
|
6224
|
+
puttable: boolean;
|
|
6225
|
+
reg_s: boolean;
|
|
6226
|
+
sector: string;
|
|
6227
|
+
seniority: string;
|
|
6228
|
+
settlement_convention: string;
|
|
6229
|
+
sinking_fund: boolean;
|
|
6230
|
+
sp_creditwatch: string;
|
|
6231
|
+
sp_creditwatch_date: string;
|
|
6232
|
+
sp_outlook: string;
|
|
6233
|
+
sp_outlook_date: string;
|
|
6234
|
+
sp_rating: string;
|
|
6235
|
+
sp_rating_date: string;
|
|
6236
|
+
status: string;
|
|
6237
|
+
ticker: string;
|
|
6238
|
+
treasury_subtype: string;
|
|
6239
|
+
type: string;
|
|
6240
|
+
updated_at: string;
|
|
6241
|
+
}
|
|
6242
|
+
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
6243
|
+
count: number;
|
|
6244
|
+
data: InsightFixedIncomeV2[];
|
|
6245
|
+
}
|
|
6246
|
+
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
6247
|
+
/** @example true */
|
|
6248
|
+
bank_qualified?: boolean;
|
|
6249
|
+
/** @example true */
|
|
6250
|
+
callable?: boolean;
|
|
6251
|
+
/** @example true */
|
|
6252
|
+
convertible?: boolean;
|
|
6253
|
+
/** @example ["USA"] */
|
|
6254
|
+
country_codes?: string[];
|
|
6255
|
+
coupon?: InsightLessAndMoreV2;
|
|
6256
|
+
/** @example ["quarterly","zero"] */
|
|
6257
|
+
coupon_frequencies?: string[];
|
|
6258
|
+
/** @example ["655664AH3","9128286R6"] */
|
|
6259
|
+
cusip?: string[];
|
|
6260
|
+
/**
|
|
6261
|
+
* @maxLength 100
|
|
6262
|
+
* @example "Donald's"
|
|
6263
|
+
*/
|
|
6264
|
+
description?: string;
|
|
6265
|
+
/** @example true */
|
|
6266
|
+
has_ticker?: boolean;
|
|
6267
|
+
/** @example true */
|
|
6268
|
+
insured?: boolean;
|
|
6269
|
+
/** @example ["US655664AH33","US9128286R69"] */
|
|
6270
|
+
isin?: string[];
|
|
6271
|
+
issue_date?: InsightBeforeAndAfterV2;
|
|
6272
|
+
/**
|
|
6273
|
+
* @maxLength 100
|
|
6274
|
+
* @example "Donald's"
|
|
6275
|
+
*/
|
|
6276
|
+
issuer?: string;
|
|
6277
|
+
maturity?: InsightBeforeAndAfterV2;
|
|
6278
|
+
/** @example ["NY"] */
|
|
6279
|
+
municipal_states?: string[];
|
|
6280
|
+
/** @example true */
|
|
6281
|
+
municipal_tax?: boolean;
|
|
6282
|
+
/** @example ["general_obligation"] */
|
|
6283
|
+
municipal_types?: string[];
|
|
6284
|
+
pagination: InsightPaginationV2;
|
|
6285
|
+
purposes?: string[];
|
|
6286
|
+
/** @example ["SOVEREIGN"] */
|
|
6287
|
+
sectors?: string[];
|
|
6288
|
+
sorts?: InsightOrderingV2[];
|
|
6289
|
+
/** @example ["AAA"] */
|
|
6290
|
+
sp_ratings?: string[];
|
|
6291
|
+
/** @example ["called","outstanding"] */
|
|
6292
|
+
statuses?: string[];
|
|
6293
|
+
tickers?: string[];
|
|
6294
|
+
/** @example ["corporate"] */
|
|
6295
|
+
types?: string[];
|
|
6296
|
+
}
|
|
6297
|
+
export interface InsightGetTopSymbolsRequestV2 {
|
|
6298
|
+
exchange?: string[];
|
|
6299
|
+
market_cap?: InsightLessAndMoreV2;
|
|
6300
|
+
pagination?: InsightPaginationV2;
|
|
6301
|
+
price?: InsightLessAndMoreV2;
|
|
6302
|
+
sorts?: InsightOrderingV2[];
|
|
6303
|
+
volume?: InsightLessAndMoreV2;
|
|
6304
|
+
}
|
|
6305
|
+
export interface InsightIncludeExcludeV2 {
|
|
6306
|
+
exclude?: string[];
|
|
6307
|
+
include?: string[];
|
|
6308
|
+
}
|
|
6309
|
+
export interface InsightLessAndMoreV2 {
|
|
6310
|
+
less_than?: number;
|
|
6311
|
+
more_than?: number;
|
|
6312
|
+
}
|
|
6313
|
+
export interface InsightOrderingV2 {
|
|
6314
|
+
/**
|
|
6315
|
+
* @default "asc"
|
|
6316
|
+
* @example "asc"
|
|
6317
|
+
*/
|
|
6318
|
+
direction: InsightOrderingDirectionEnumV2;
|
|
6319
|
+
/**
|
|
6320
|
+
* Sort direction:
|
|
6321
|
+
* * asc - Ascending, from A to Z.
|
|
6322
|
+
* * desc - Descending, from Z to A.
|
|
6323
|
+
* @example "name"
|
|
6324
|
+
*/
|
|
6325
|
+
field: string;
|
|
6326
|
+
}
|
|
6327
|
+
export interface InsightPaginationV2 {
|
|
6328
|
+
/**
|
|
6329
|
+
* @min 1
|
|
6330
|
+
* @example 1
|
|
6331
|
+
*/
|
|
6332
|
+
page: number;
|
|
6333
|
+
/**
|
|
6334
|
+
* @min 1
|
|
6335
|
+
* @max 50
|
|
6336
|
+
* @example 10
|
|
6337
|
+
*/
|
|
6338
|
+
size: number;
|
|
6339
|
+
}
|
|
6340
|
+
export interface InsightStockScreenerQuoteV2 {
|
|
6341
|
+
average_volume_30d: number;
|
|
6342
|
+
company_name: string;
|
|
6343
|
+
dividend_ex_date: string;
|
|
6344
|
+
dividend_pay_date: string;
|
|
6345
|
+
dividend_percent: number;
|
|
6346
|
+
exchange: string;
|
|
6347
|
+
exchange_name: string;
|
|
6348
|
+
gap: number;
|
|
6349
|
+
industry: string;
|
|
6350
|
+
industry_code: string;
|
|
6351
|
+
last_price: number;
|
|
6352
|
+
market_cap: number;
|
|
6353
|
+
pe_ratio: number;
|
|
6354
|
+
price_change: number;
|
|
6355
|
+
price_change_percent: number;
|
|
6356
|
+
symbol: string;
|
|
6357
|
+
volume: number;
|
|
6358
|
+
}
|
|
6359
|
+
export interface InsightStockScreenerRequestV2 {
|
|
6360
|
+
average_volume_30d?: InsightLessAndMoreV2;
|
|
6361
|
+
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
6362
|
+
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
6363
|
+
dividend_percent?: InsightLessAndMoreV2;
|
|
6364
|
+
exchange?: InsightIncludeExcludeV2;
|
|
6365
|
+
gap?: InsightLessAndMoreV2;
|
|
6366
|
+
industry?: InsightIncludeExcludeV2;
|
|
6367
|
+
market_cap?: InsightLessAndMoreV2;
|
|
6368
|
+
pagination: InsightPaginationV2;
|
|
6369
|
+
pe_ratio?: InsightLessAndMoreV2;
|
|
6370
|
+
price?: InsightLessAndMoreV2;
|
|
6371
|
+
sorts?: InsightOrderingV2[];
|
|
6372
|
+
/** @example "ADR" */
|
|
6373
|
+
stock_type?: string;
|
|
6374
|
+
volume?: InsightLessAndMoreV2;
|
|
6375
|
+
}
|
|
6376
|
+
export interface InsightStockScreenerResponseV2 {
|
|
6377
|
+
current_page: number;
|
|
6378
|
+
data: InsightStockScreenerQuoteV2[];
|
|
6379
|
+
page_count: number;
|
|
6380
|
+
status: number;
|
|
6381
|
+
total_records: number;
|
|
6382
|
+
}
|
|
6383
|
+
/**
|
|
6384
|
+
* @default "asc"
|
|
6385
|
+
* @example "asc"
|
|
6386
|
+
*/
|
|
6387
|
+
export enum InsightOrderingDirectionEnumV2 {
|
|
6388
|
+
Asc = "asc",
|
|
6389
|
+
Desc = "desc"
|
|
6390
|
+
}
|
|
6391
|
+
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
6392
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6393
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6394
|
+
/**
|
|
6395
|
+
* @description get fixed income entries
|
|
6396
|
+
* @tags FixedIncome
|
|
6397
|
+
* @name GetFixedIncomeEntries
|
|
6398
|
+
* @summary get fixed income entries
|
|
6399
|
+
* @request POST:/fixed-income
|
|
6400
|
+
* @secure
|
|
6401
|
+
*/
|
|
6402
|
+
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
6403
|
+
}
|
|
6404
|
+
export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
6405
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6406
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6407
|
+
/**
|
|
6408
|
+
* @description filter stocks by params
|
|
6409
|
+
* @tags StockScreener
|
|
6410
|
+
* @name StockScreener
|
|
6411
|
+
* @summary filter stocks by params
|
|
6412
|
+
* @request POST:/stock-screener
|
|
6413
|
+
* @secure
|
|
6414
|
+
*/
|
|
6415
|
+
stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
6416
|
+
/**
|
|
6417
|
+
* @description get top symbols
|
|
6418
|
+
* @tags StockScreener
|
|
6419
|
+
* @name GetTopSymbols
|
|
6420
|
+
* @summary get top symbols
|
|
6421
|
+
* @request POST:/stock-screener/top
|
|
6422
|
+
* @secure
|
|
6423
|
+
*/
|
|
6424
|
+
getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
6404
6425
|
}
|
|
6405
6426
|
export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
6406
6427
|
readonly config: JwtClientConfig<HandleError>;
|