@orbis-systems/orbis-api-clients 0.6.8 → 0.6.10
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 +104 -95
- package/dist/aesmidas/index.d.ts.map +1 -1
- package/dist/aesmidas/index.esm.js +1 -2806
- package/dist/aesmidas/index.esm.js.map +1 -1
- package/dist/aesmidas/index.js +1 -2811
- package/dist/aesmidas/index.js.map +1 -1
- package/dist/bridgewise/index.d.ts +169 -174
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +1 -1888
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +1 -1893
- package/dist/bridgewise/index.js.map +1 -1
- package/dist/index.d.ts +1 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.esm.js +1 -257
- package/dist/index.esm.js.map +1 -1
- package/dist/index.js +1 -280
- package/dist/index.js.map +1 -1
- package/dist/insight/index.d.ts +503 -305
- package/dist/insight/index.d.ts.map +1 -1
- package/dist/insight/index.esm.js +1 -3754
- package/dist/insight/index.esm.js.map +1 -1
- package/dist/insight/index.js +1 -3759
- package/dist/insight/index.js.map +1 -1
- package/dist/middleware/index.d.ts +1 -2
- package/dist/middleware/index.d.ts.map +1 -1
- package/dist/middleware/index.esm.js +1 -1066
- package/dist/middleware/index.esm.js.map +1 -1
- package/dist/middleware/index.js +1 -1071
- package/dist/middleware/index.js.map +1 -1
- package/dist/orbis/index.d.ts +1161 -1162
- package/dist/orbis/index.d.ts.map +1 -1
- package/dist/orbis/index.esm.js +1 -7009
- package/dist/orbis/index.esm.js.map +1 -1
- package/dist/orbis/index.js +1 -7014
- package/dist/orbis/index.js.map +1 -1
- package/dist/uma/index.d.ts +361 -349
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -3993
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -3998
- package/dist/uma/index.js.map +1 -1
- package/package.json +9 -1
package/dist/insight/index.d.ts
CHANGED
|
@@ -4,10 +4,9 @@ interface BaseClientConfig<HandleError extends boolean = boolean> {
|
|
|
4
4
|
baseUrl: string;
|
|
5
5
|
handleError?: HandleError;
|
|
6
6
|
storage?: Storage;
|
|
7
|
-
defaultHeaders?: Record<string, string>;
|
|
8
7
|
defaultSecure?: boolean;
|
|
9
8
|
authDataStorageKey?: string;
|
|
10
|
-
|
|
9
|
+
axiosConfig?: AxiosRequestConfig;
|
|
11
10
|
onAxiosError?: (error: AxiosError) => void;
|
|
12
11
|
onError?: (error: unknown) => void;
|
|
13
12
|
}
|
|
@@ -601,6 +600,13 @@ export interface InsightCreateOrUpdateFixedIncomePresetRequest {
|
|
|
601
600
|
preset_description?: string;
|
|
602
601
|
preset_name: string;
|
|
603
602
|
}
|
|
603
|
+
export interface InsightCreateOrUpdateFundScreenerPresetRequest {
|
|
604
|
+
id?: string;
|
|
605
|
+
preset?: InsightFundScreenerRequest;
|
|
606
|
+
preset_color: string;
|
|
607
|
+
preset_description?: string;
|
|
608
|
+
preset_name: string;
|
|
609
|
+
}
|
|
604
610
|
export interface InsightCreateOrUpdateScreenerPresetRequest {
|
|
605
611
|
id?: string;
|
|
606
612
|
preset?: InsightStockScreenerRequest;
|
|
@@ -892,15 +898,6 @@ export interface InsightFixedIncome {
|
|
|
892
898
|
type: string;
|
|
893
899
|
updated_at: string;
|
|
894
900
|
}
|
|
895
|
-
export interface InsightFixedIncomePreset {
|
|
896
|
-
created_at: string;
|
|
897
|
-
id: string;
|
|
898
|
-
preset: Record<string, any>;
|
|
899
|
-
preset_color: string;
|
|
900
|
-
preset_description: string;
|
|
901
|
-
preset_name: string;
|
|
902
|
-
updated_at: string;
|
|
903
|
-
}
|
|
904
901
|
export interface InsightFundFilterAsset {
|
|
905
902
|
asset_id?: string;
|
|
906
903
|
asset_name?: string;
|
|
@@ -1274,6 +1271,10 @@ export interface InsightGetPreIPOCompaniesResponse {
|
|
|
1274
1271
|
count: number;
|
|
1275
1272
|
details: InsightPreIPOCompany[];
|
|
1276
1273
|
}
|
|
1274
|
+
export interface InsightGetPreIPOCompanyFundingRoundsResponse {
|
|
1275
|
+
count: number;
|
|
1276
|
+
details: InsightPreIPOCompanyFundingRound[];
|
|
1277
|
+
}
|
|
1277
1278
|
export interface InsightGetPreIPOCompanyInvestmentsResponse {
|
|
1278
1279
|
count: number;
|
|
1279
1280
|
details: InsightPreIPOCompanyInvestment[];
|
|
@@ -1286,6 +1287,10 @@ export interface InsightGetPreIPOCompanyResearchDocumentsResponse {
|
|
|
1286
1287
|
count: number;
|
|
1287
1288
|
details: InsightPreIPOCompanyResearchDocument[];
|
|
1288
1289
|
}
|
|
1290
|
+
export interface InsightGetPreIPOCompanySPVsResponse {
|
|
1291
|
+
count: number;
|
|
1292
|
+
details: InsightPreIPOCompanySPV[];
|
|
1293
|
+
}
|
|
1289
1294
|
export interface InsightGetScreenerPresetsResponse {
|
|
1290
1295
|
count: number;
|
|
1291
1296
|
default_presets: InsightScreenerPreset[];
|
|
@@ -3262,6 +3267,28 @@ export interface InsightPreIPOCompanyArticle {
|
|
|
3262
3267
|
short_summary: string;
|
|
3263
3268
|
source: string;
|
|
3264
3269
|
}
|
|
3270
|
+
export interface InsightPreIPOCompanyFundingRound {
|
|
3271
|
+
citations: InsightPreIPOCompanyFundingRoundCitation[];
|
|
3272
|
+
id: string;
|
|
3273
|
+
issued_at: string;
|
|
3274
|
+
pre_ipo_company_id: string;
|
|
3275
|
+
round_name: string;
|
|
3276
|
+
share_details: InsightPreIPOCompanyFundingRoundShare[];
|
|
3277
|
+
source: string;
|
|
3278
|
+
}
|
|
3279
|
+
export interface InsightPreIPOCompanyFundingRoundCitation {
|
|
3280
|
+
funding_round_id: string;
|
|
3281
|
+
type: string;
|
|
3282
|
+
updated_at: string;
|
|
3283
|
+
url: string;
|
|
3284
|
+
}
|
|
3285
|
+
export interface InsightPreIPOCompanyFundingRoundShare {
|
|
3286
|
+
funding_round_id: string;
|
|
3287
|
+
issue_price: number;
|
|
3288
|
+
issued_at: string;
|
|
3289
|
+
name: string;
|
|
3290
|
+
updated_at: string;
|
|
3291
|
+
}
|
|
3265
3292
|
export interface InsightPreIPOCompanyInvestment {
|
|
3266
3293
|
carried_interest: number;
|
|
3267
3294
|
company_name: string;
|
|
@@ -3306,6 +3333,56 @@ export interface InsightPreIPOCompanyResearchDocument {
|
|
|
3306
3333
|
title: string;
|
|
3307
3334
|
type: string;
|
|
3308
3335
|
}
|
|
3336
|
+
export interface InsightPreIPOCompanySPV {
|
|
3337
|
+
all_in_price_per_share: number;
|
|
3338
|
+
close_date: string;
|
|
3339
|
+
cusip: string;
|
|
3340
|
+
demand_side_commission_split: number;
|
|
3341
|
+
description: string;
|
|
3342
|
+
documents: InsightPreIPOCompanySPVDocument[];
|
|
3343
|
+
exemptions_claimed: string[];
|
|
3344
|
+
funding_deadline: string;
|
|
3345
|
+
id: string;
|
|
3346
|
+
investor_fee_per_share: number;
|
|
3347
|
+
investor_price_per_share: number;
|
|
3348
|
+
management_fee: number;
|
|
3349
|
+
management_fee_years_payable: number;
|
|
3350
|
+
master_llc_name: string;
|
|
3351
|
+
min_commitment_amount: number;
|
|
3352
|
+
monark_commission_split: number;
|
|
3353
|
+
name: string;
|
|
3354
|
+
notable_investors: string[];
|
|
3355
|
+
number_of_seats_remaining: number;
|
|
3356
|
+
pre_funded_inventory: boolean;
|
|
3357
|
+
pre_ipo_company_id: string;
|
|
3358
|
+
pre_ipo_company_investment_id: string;
|
|
3359
|
+
pre_ipo_company_name: string;
|
|
3360
|
+
remaining_dollar_allocation: number;
|
|
3361
|
+
remaining_share_allocation: number;
|
|
3362
|
+
spv_account_id: number;
|
|
3363
|
+
spv_custodian: string;
|
|
3364
|
+
synopsis: string;
|
|
3365
|
+
total_commission: number;
|
|
3366
|
+
total_dollar_allocation: number;
|
|
3367
|
+
total_number_of_seats: number;
|
|
3368
|
+
total_share_allocation: number;
|
|
3369
|
+
trading_symbol: string;
|
|
3370
|
+
valuation: number;
|
|
3371
|
+
}
|
|
3372
|
+
export interface InsightPreIPOCompanySPVDocument {
|
|
3373
|
+
description: string;
|
|
3374
|
+
id: string;
|
|
3375
|
+
investor_id: string;
|
|
3376
|
+
investor_subscription_id: string;
|
|
3377
|
+
name: string;
|
|
3378
|
+
partner_id: string;
|
|
3379
|
+
pre_ipo_company_id: string;
|
|
3380
|
+
pre_ipo_company_investment_id: string;
|
|
3381
|
+
pre_ipo_company_spv_id: string;
|
|
3382
|
+
tax_year: number;
|
|
3383
|
+
template_document: boolean;
|
|
3384
|
+
type: string;
|
|
3385
|
+
}
|
|
3309
3386
|
export interface InsightPublicQuoteProfile {
|
|
3310
3387
|
average_volume_30d: number;
|
|
3311
3388
|
closing_price: number;
|
|
@@ -4160,6 +4237,20 @@ export enum InsightSymbolLogoConvertedRequestConversionEnum {
|
|
|
4160
4237
|
SquareStrictOrNormal = "square_strict_or_normal",
|
|
4161
4238
|
BestMatch = "best_match"
|
|
4162
4239
|
}
|
|
4240
|
+
/** sort direction */
|
|
4241
|
+
export enum InsightGetPreIpoCompanySpvsParamsDirectionEnum {
|
|
4242
|
+
ASC = "ASC",
|
|
4243
|
+
DESC = "DESC"
|
|
4244
|
+
}
|
|
4245
|
+
/** sort field */
|
|
4246
|
+
export enum InsightGetPreIpoCompanySpvsParamsFieldEnum {
|
|
4247
|
+
Name = "name",
|
|
4248
|
+
RemainingDollarAllocation = "remaining_dollar_allocation",
|
|
4249
|
+
RemainingShareAllocation = "remaining_share_allocation",
|
|
4250
|
+
NumberOfSeatsRemaining = "number_of_seats_remaining",
|
|
4251
|
+
Valuation = "valuation",
|
|
4252
|
+
MinCommitmentAmount = "min_commitment_amount"
|
|
4253
|
+
}
|
|
4163
4254
|
/** EQUITY|ETF|CRYPTO */
|
|
4164
4255
|
export enum InsightTopStocksParamsStockTypeEnum {
|
|
4165
4256
|
EQUITY = "EQUITY",
|
|
@@ -4227,6 +4318,90 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
|
4227
4318
|
*/
|
|
4228
4319
|
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
4229
4320
|
}
|
|
4321
|
+
export class CustomLists<HandleError extends boolean = boolean> {
|
|
4322
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4323
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4324
|
+
/**
|
|
4325
|
+
* @description get custom lists
|
|
4326
|
+
* @tags Custom Lists
|
|
4327
|
+
* @name GetCustomLists
|
|
4328
|
+
* @summary get custom lists
|
|
4329
|
+
* @request GET:/custom-lists
|
|
4330
|
+
* @secure
|
|
4331
|
+
*/
|
|
4332
|
+
getCustomLists(query: {
|
|
4333
|
+
/** how many records to return. Max value is 50 */
|
|
4334
|
+
limit: number;
|
|
4335
|
+
/** how many records to skip */
|
|
4336
|
+
offset: number;
|
|
4337
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4338
|
+
/**
|
|
4339
|
+
* @description update custom list
|
|
4340
|
+
* @tags Custom Lists
|
|
4341
|
+
* @name UpdateCustomList
|
|
4342
|
+
* @summary update custom list
|
|
4343
|
+
* @request PUT:/custom-lists
|
|
4344
|
+
* @secure
|
|
4345
|
+
*/
|
|
4346
|
+
updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
4347
|
+
/**
|
|
4348
|
+
* @description create custom list
|
|
4349
|
+
* @tags Custom Lists
|
|
4350
|
+
* @name CreateCustomList
|
|
4351
|
+
* @summary create custom list
|
|
4352
|
+
* @request POST:/custom-lists
|
|
4353
|
+
* @secure
|
|
4354
|
+
*/
|
|
4355
|
+
createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
4356
|
+
/**
|
|
4357
|
+
* @description remove custom list
|
|
4358
|
+
* @tags Custom Lists
|
|
4359
|
+
* @name RemoveCustomList
|
|
4360
|
+
* @summary remove custom list
|
|
4361
|
+
* @request DELETE:/custom-lists
|
|
4362
|
+
* @secure
|
|
4363
|
+
*/
|
|
4364
|
+
removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4365
|
+
/**
|
|
4366
|
+
* @description filter custom lists
|
|
4367
|
+
* @tags Custom Lists
|
|
4368
|
+
* @name FilterCustomLists
|
|
4369
|
+
* @summary filter custom lists
|
|
4370
|
+
* @request POST:/custom-lists/filter
|
|
4371
|
+
* @secure
|
|
4372
|
+
*/
|
|
4373
|
+
filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4374
|
+
/**
|
|
4375
|
+
* @description get custom list with quotes
|
|
4376
|
+
* @tags Custom Lists
|
|
4377
|
+
* @name GetCustomListWithQuotes
|
|
4378
|
+
* @summary get custom list with quotes
|
|
4379
|
+
* @request GET:/custom-lists/{id-or-slug}
|
|
4380
|
+
* @secure
|
|
4381
|
+
*/
|
|
4382
|
+
getCustomListWithQuotes(idOrSlug: string, query: {
|
|
4383
|
+
/** sort direction - asc or desc */
|
|
4384
|
+
order_direction: string;
|
|
4385
|
+
/** sort field - volume, symbol(alphabetical), market_cap, dividend_percent */
|
|
4386
|
+
order_field: string;
|
|
4387
|
+
/** how many equities records to return. Max value is 50 */
|
|
4388
|
+
limit: number;
|
|
4389
|
+
/** how many equities records to skip */
|
|
4390
|
+
offset: number;
|
|
4391
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4392
|
+
/**
|
|
4393
|
+
* @description filter custom list
|
|
4394
|
+
* @tags Custom Lists
|
|
4395
|
+
* @name FilterCustomList
|
|
4396
|
+
* @summary filter custom list
|
|
4397
|
+
* @request GET:/custom-lists/{id-or-slug}/filter
|
|
4398
|
+
* @secure
|
|
4399
|
+
*/
|
|
4400
|
+
filterCustomList(idOrSlug: string, query?: {
|
|
4401
|
+
/** symbols to check inclusion */
|
|
4402
|
+
symbols?: string[];
|
|
4403
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
|
|
4404
|
+
}
|
|
4230
4405
|
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
4231
4406
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4232
4407
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4409,90 +4584,6 @@ export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
|
4409
4584
|
id: string;
|
|
4410
4585
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4411
4586
|
}
|
|
4412
|
-
export class CustomLists<HandleError extends boolean = boolean> {
|
|
4413
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4414
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4415
|
-
/**
|
|
4416
|
-
* @description get custom lists
|
|
4417
|
-
* @tags Custom Lists
|
|
4418
|
-
* @name GetCustomLists
|
|
4419
|
-
* @summary get custom lists
|
|
4420
|
-
* @request GET:/custom-lists
|
|
4421
|
-
* @secure
|
|
4422
|
-
*/
|
|
4423
|
-
getCustomLists(query: {
|
|
4424
|
-
/** how many records to return. Max value is 50 */
|
|
4425
|
-
limit: number;
|
|
4426
|
-
/** how many records to skip */
|
|
4427
|
-
offset: number;
|
|
4428
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4429
|
-
/**
|
|
4430
|
-
* @description update custom list
|
|
4431
|
-
* @tags Custom Lists
|
|
4432
|
-
* @name UpdateCustomList
|
|
4433
|
-
* @summary update custom list
|
|
4434
|
-
* @request PUT:/custom-lists
|
|
4435
|
-
* @secure
|
|
4436
|
-
*/
|
|
4437
|
-
updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
4438
|
-
/**
|
|
4439
|
-
* @description create custom list
|
|
4440
|
-
* @tags Custom Lists
|
|
4441
|
-
* @name CreateCustomList
|
|
4442
|
-
* @summary create custom list
|
|
4443
|
-
* @request POST:/custom-lists
|
|
4444
|
-
* @secure
|
|
4445
|
-
*/
|
|
4446
|
-
createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
4447
|
-
/**
|
|
4448
|
-
* @description remove custom list
|
|
4449
|
-
* @tags Custom Lists
|
|
4450
|
-
* @name RemoveCustomList
|
|
4451
|
-
* @summary remove custom list
|
|
4452
|
-
* @request DELETE:/custom-lists
|
|
4453
|
-
* @secure
|
|
4454
|
-
*/
|
|
4455
|
-
removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4456
|
-
/**
|
|
4457
|
-
* @description filter custom lists
|
|
4458
|
-
* @tags Custom Lists
|
|
4459
|
-
* @name FilterCustomLists
|
|
4460
|
-
* @summary filter custom lists
|
|
4461
|
-
* @request POST:/custom-lists/filter
|
|
4462
|
-
* @secure
|
|
4463
|
-
*/
|
|
4464
|
-
filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4465
|
-
/**
|
|
4466
|
-
* @description get custom list with quotes
|
|
4467
|
-
* @tags Custom Lists
|
|
4468
|
-
* @name GetCustomListWithQuotes
|
|
4469
|
-
* @summary get custom list with quotes
|
|
4470
|
-
* @request GET:/custom-lists/{id-or-slug}
|
|
4471
|
-
* @secure
|
|
4472
|
-
*/
|
|
4473
|
-
getCustomListWithQuotes(idOrSlug: string, query: {
|
|
4474
|
-
/** sort direction - asc or desc */
|
|
4475
|
-
order_direction: string;
|
|
4476
|
-
/** sort field - volume, symbol(alphabetical), market_cap, dividend_percent */
|
|
4477
|
-
order_field: string;
|
|
4478
|
-
/** how many equities records to return. Max value is 50 */
|
|
4479
|
-
limit: number;
|
|
4480
|
-
/** how many equities records to skip */
|
|
4481
|
-
offset: number;
|
|
4482
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4483
|
-
/**
|
|
4484
|
-
* @description filter custom list
|
|
4485
|
-
* @tags Custom Lists
|
|
4486
|
-
* @name FilterCustomList
|
|
4487
|
-
* @summary filter custom list
|
|
4488
|
-
* @request GET:/custom-lists/{id-or-slug}/filter
|
|
4489
|
-
* @secure
|
|
4490
|
-
*/
|
|
4491
|
-
filterCustomList(idOrSlug: string, query?: {
|
|
4492
|
-
/** symbols to check inclusion */
|
|
4493
|
-
symbols?: string[];
|
|
4494
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
|
|
4495
|
-
}
|
|
4496
4587
|
export class Dashboard<HandleError extends boolean = boolean> {
|
|
4497
4588
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4498
4589
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4581,6 +4672,19 @@ export class Earnings<HandleError extends boolean = boolean> {
|
|
|
4581
4672
|
*/
|
|
4582
4673
|
getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
|
|
4583
4674
|
}
|
|
4675
|
+
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
4676
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4677
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4678
|
+
/**
|
|
4679
|
+
* @description get fundamentals by symbol data
|
|
4680
|
+
* @tags Fundamentals
|
|
4681
|
+
* @name GetFundamentalsBySymbolData
|
|
4682
|
+
* @summary get fundamentals by symbol data
|
|
4683
|
+
* @request POST:/fundamentals
|
|
4684
|
+
* @secure
|
|
4685
|
+
*/
|
|
4686
|
+
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
4687
|
+
}
|
|
4584
4688
|
export class FixedIncome<HandleError extends boolean = boolean> {
|
|
4585
4689
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4586
4690
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4624,16 +4728,16 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
4624
4728
|
* @request PUT:/fixed-income/presets
|
|
4625
4729
|
* @secure
|
|
4626
4730
|
*/
|
|
4627
|
-
updateFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4731
|
+
updateFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
4628
4732
|
/**
|
|
4629
4733
|
* @description create fixed-income preset
|
|
4630
4734
|
* @tags FixedIncome
|
|
4631
|
-
* @name
|
|
4735
|
+
* @name CreateFixedIncomePreset
|
|
4632
4736
|
* @summary create fixed-income preset
|
|
4633
4737
|
* @request POST:/fixed-income/presets
|
|
4634
4738
|
* @secure
|
|
4635
4739
|
*/
|
|
4636
|
-
|
|
4740
|
+
createFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
4637
4741
|
/**
|
|
4638
4742
|
* @description remove fixed-income preset
|
|
4639
4743
|
* @tags FixedIncome
|
|
@@ -4653,19 +4757,6 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
4653
4757
|
*/
|
|
4654
4758
|
getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
|
|
4655
4759
|
}
|
|
4656
|
-
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
4657
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4658
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4659
|
-
/**
|
|
4660
|
-
* @description get fundamentals by symbol data
|
|
4661
|
-
* @tags Fundamentals
|
|
4662
|
-
* @name GetFundamentalsBySymbolData
|
|
4663
|
-
* @summary get fundamentals by symbol data
|
|
4664
|
-
* @request POST:/fundamentals
|
|
4665
|
-
* @secure
|
|
4666
|
-
*/
|
|
4667
|
-
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
4668
|
-
}
|
|
4669
4760
|
export class Funds<HandleError extends boolean = boolean> {
|
|
4670
4761
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4671
4762
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4715,27 +4806,68 @@ export class Funds<HandleError extends boolean = boolean> {
|
|
|
4715
4806
|
*/
|
|
4716
4807
|
getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError>>;
|
|
4717
4808
|
/**
|
|
4718
|
-
* @description
|
|
4809
|
+
* @description get fund screener presets
|
|
4719
4810
|
* @tags Funds
|
|
4720
|
-
* @name
|
|
4721
|
-
* @summary
|
|
4722
|
-
* @request
|
|
4811
|
+
* @name GetFundScreenerPresets
|
|
4812
|
+
* @summary get fund screener presets
|
|
4813
|
+
* @request GET:/funds/screener/presets
|
|
4723
4814
|
* @secure
|
|
4724
4815
|
*/
|
|
4725
|
-
|
|
4726
|
-
/**
|
|
4727
|
-
|
|
4728
|
-
|
|
4816
|
+
getFundScreenerPresets(query: {
|
|
4817
|
+
/** how many records to return */
|
|
4818
|
+
limit: number;
|
|
4819
|
+
/** how many records to skip */
|
|
4820
|
+
offset: number;
|
|
4821
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
4729
4822
|
/**
|
|
4730
|
-
* @description
|
|
4823
|
+
* @description update fund screener preset
|
|
4731
4824
|
* @tags Funds
|
|
4732
|
-
* @name
|
|
4733
|
-
* @summary
|
|
4734
|
-
* @request
|
|
4825
|
+
* @name UpdateFundScreenerPreset
|
|
4826
|
+
* @summary update fund screener preset
|
|
4827
|
+
* @request PUT:/funds/screener/presets
|
|
4735
4828
|
* @secure
|
|
4736
4829
|
*/
|
|
4737
|
-
|
|
4738
|
-
|
|
4830
|
+
updateFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
4831
|
+
/**
|
|
4832
|
+
* @description create fund screener preset
|
|
4833
|
+
* @tags Funds
|
|
4834
|
+
* @name CreateFundScreenerPreset
|
|
4835
|
+
* @summary create fund screener preset
|
|
4836
|
+
* @request POST:/funds/screener/presets
|
|
4837
|
+
* @secure
|
|
4838
|
+
*/
|
|
4839
|
+
createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
4840
|
+
/**
|
|
4841
|
+
* @description remove fund screener preset
|
|
4842
|
+
* @tags Funds
|
|
4843
|
+
* @name RemoveFundScreenerPreset
|
|
4844
|
+
* @summary remove fund screener preset
|
|
4845
|
+
* @request DELETE:/funds/screener/presets
|
|
4846
|
+
* @secure
|
|
4847
|
+
*/
|
|
4848
|
+
removeFundScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4849
|
+
/**
|
|
4850
|
+
* @description filter funds by params
|
|
4851
|
+
* @tags Funds
|
|
4852
|
+
* @name FundSectorScreener
|
|
4853
|
+
* @summary filter funds by params
|
|
4854
|
+
* @request POST:/funds/sector-screener
|
|
4855
|
+
* @secure
|
|
4856
|
+
*/
|
|
4857
|
+
fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
|
|
4858
|
+
/** Authorization */
|
|
4859
|
+
Authorization?: string;
|
|
4860
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
4861
|
+
/**
|
|
4862
|
+
* @description get top funds
|
|
4863
|
+
* @tags Funds
|
|
4864
|
+
* @name GetTopFunds
|
|
4865
|
+
* @summary get top funds
|
|
4866
|
+
* @request POST:/funds/top
|
|
4867
|
+
* @secure
|
|
4868
|
+
*/
|
|
4869
|
+
getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
|
|
4870
|
+
/** Authorization */
|
|
4739
4871
|
Authorization?: string;
|
|
4740
4872
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
|
|
4741
4873
|
}
|
|
@@ -4887,6 +5019,33 @@ export class Intraday<HandleError extends boolean = boolean> {
|
|
|
4887
5019
|
*/
|
|
4888
5020
|
intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
|
|
4889
5021
|
}
|
|
5022
|
+
export class Ipos<HandleError extends boolean = boolean> {
|
|
5023
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5024
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5025
|
+
/**
|
|
5026
|
+
* @description get recent ipos info
|
|
5027
|
+
* @tags Ipos
|
|
5028
|
+
* @name PostRecent
|
|
5029
|
+
* @summary get recent ipos info
|
|
5030
|
+
* @request POST:/ipos/recent
|
|
5031
|
+
* @secure
|
|
5032
|
+
*/
|
|
5033
|
+
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5034
|
+
/**
|
|
5035
|
+
* @description get upcoming ipos info
|
|
5036
|
+
* @tags Ipos
|
|
5037
|
+
* @name GetUpcoming
|
|
5038
|
+
* @summary get upcoming ipos info
|
|
5039
|
+
* @request GET:/ipos/upcoming
|
|
5040
|
+
* @secure
|
|
5041
|
+
*/
|
|
5042
|
+
getUpcoming(query: {
|
|
5043
|
+
/** how many records to return. Max value is 50 */
|
|
5044
|
+
limit: number;
|
|
5045
|
+
/** how many records to skip */
|
|
5046
|
+
offset: number;
|
|
5047
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5048
|
+
}
|
|
4890
5049
|
export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
4891
5050
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4892
5051
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4909,14 +5068,43 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
4909
5068
|
/**
|
|
4910
5069
|
* @description get pre ipo company by id
|
|
4911
5070
|
* @tags PreIPOCompanies
|
|
4912
|
-
* @name
|
|
5071
|
+
* @name GetPreIpoCompaniesById
|
|
4913
5072
|
* @summary get pre ipo company by id
|
|
4914
5073
|
* @request GET:/ipos/pre-ipo-companies/{id}
|
|
4915
5074
|
* @originalName getPreIpoCompanies
|
|
4916
5075
|
* @duplicate
|
|
4917
5076
|
* @secure
|
|
4918
5077
|
*/
|
|
4919
|
-
|
|
5078
|
+
getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
|
|
5079
|
+
/**
|
|
5080
|
+
* @description get pre ipo company funding rounds
|
|
5081
|
+
* @tags PreIPOCompanies
|
|
5082
|
+
* @name GetPreIpoCompanyFundingRounds
|
|
5083
|
+
* @summary get pre ipo company funding rounds
|
|
5084
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds
|
|
5085
|
+
* @secure
|
|
5086
|
+
*/
|
|
5087
|
+
getPreIpoCompanyFundingRounds(query: {
|
|
5088
|
+
/** company id */
|
|
5089
|
+
pre_ipo_company_id?: string;
|
|
5090
|
+
/** search by round name */
|
|
5091
|
+
round_name?: string;
|
|
5092
|
+
/** how many records to return. Max value is 50 */
|
|
5093
|
+
limit: number;
|
|
5094
|
+
/** how many records to skip */
|
|
5095
|
+
offset: number;
|
|
5096
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
|
|
5097
|
+
/**
|
|
5098
|
+
* @description get pre ipo company funding round by id
|
|
5099
|
+
* @tags PreIPOCompanies
|
|
5100
|
+
* @name GetPreIpoCompanyFundingRoundsById
|
|
5101
|
+
* @summary get pre ipo company funding round by id
|
|
5102
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds/{id}
|
|
5103
|
+
* @originalName getPreIpoCompanyFundingRounds
|
|
5104
|
+
* @duplicate
|
|
5105
|
+
* @secure
|
|
5106
|
+
*/
|
|
5107
|
+
getPreIpoCompanyFundingRoundsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyFundingRound, HandleError>>;
|
|
4920
5108
|
/**
|
|
4921
5109
|
* @description get pre ipo company investments
|
|
4922
5110
|
* @tags PreIPOCompanies
|
|
@@ -4938,14 +5126,14 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
4938
5126
|
/**
|
|
4939
5127
|
* @description get pre ipo company investment by id
|
|
4940
5128
|
* @tags PreIPOCompanies
|
|
4941
|
-
* @name
|
|
5129
|
+
* @name GetPreIpoCompanyInvestmentsById
|
|
4942
5130
|
* @summary get pre ipo company investment by id
|
|
4943
5131
|
* @request GET:/ipos/pre-ipo-company-investments/{id}
|
|
4944
5132
|
* @originalName getPreIpoCompanyInvestments
|
|
4945
5133
|
* @duplicate
|
|
4946
5134
|
* @secure
|
|
4947
5135
|
*/
|
|
4948
|
-
|
|
5136
|
+
getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
|
|
4949
5137
|
/**
|
|
4950
5138
|
* @description get pre ipo company news
|
|
4951
5139
|
* @tags PreIPOCompanies
|
|
@@ -4967,14 +5155,14 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
4967
5155
|
/**
|
|
4968
5156
|
* @description get pre ipo company news by id
|
|
4969
5157
|
* @tags PreIPOCompanies
|
|
4970
|
-
* @name
|
|
5158
|
+
* @name GetPreIpoCompanyNewsById
|
|
4971
5159
|
* @summary get pre ipo company news by id
|
|
4972
5160
|
* @request GET:/ipos/pre-ipo-company-news/{id}
|
|
4973
5161
|
* @originalName getPreIpoCompanyNews
|
|
4974
5162
|
* @duplicate
|
|
4975
5163
|
* @secure
|
|
4976
5164
|
*/
|
|
4977
|
-
|
|
5165
|
+
getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
|
|
4978
5166
|
/**
|
|
4979
5167
|
* @description get pre ipo company research documents
|
|
4980
5168
|
* @tags PreIPOCompanies
|
|
@@ -4996,41 +5184,51 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
4996
5184
|
/**
|
|
4997
5185
|
* @description get pre ipo company research document by id
|
|
4998
5186
|
* @tags PreIPOCompanies
|
|
4999
|
-
* @name
|
|
5187
|
+
* @name GetPreIpoCompanyResearchDocumentsById
|
|
5000
5188
|
* @summary get pre ipo company research document by id
|
|
5001
5189
|
* @request GET:/ipos/pre-ipo-company-research-documents/{id}
|
|
5002
5190
|
* @originalName getPreIpoCompanyResearchDocuments
|
|
5003
5191
|
* @duplicate
|
|
5004
5192
|
* @secure
|
|
5005
5193
|
*/
|
|
5006
|
-
|
|
5007
|
-
}
|
|
5008
|
-
export class Ipos<HandleError extends boolean = boolean> {
|
|
5009
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5010
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5194
|
+
getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
|
|
5011
5195
|
/**
|
|
5012
|
-
* @description get
|
|
5013
|
-
* @tags
|
|
5014
|
-
* @name
|
|
5015
|
-
* @summary get
|
|
5016
|
-
* @request
|
|
5017
|
-
* @secure
|
|
5018
|
-
*/
|
|
5019
|
-
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5020
|
-
/**
|
|
5021
|
-
* @description get upcoming ipos info
|
|
5022
|
-
* @tags Ipos
|
|
5023
|
-
* @name GetUpcoming
|
|
5024
|
-
* @summary get upcoming ipos info
|
|
5025
|
-
* @request GET:/ipos/upcoming
|
|
5196
|
+
* @description get pre ipo company spvs
|
|
5197
|
+
* @tags PreIPOCompanies
|
|
5198
|
+
* @name GetPreIpoCompanySpvs
|
|
5199
|
+
* @summary get pre ipo company spvs
|
|
5200
|
+
* @request GET:/ipos/pre-ipo-company-spvs
|
|
5026
5201
|
* @secure
|
|
5027
5202
|
*/
|
|
5028
|
-
|
|
5203
|
+
getPreIpoCompanySpvs(query: {
|
|
5204
|
+
/** company id */
|
|
5205
|
+
pre_ipo_company_id?: string;
|
|
5206
|
+
/** investment id */
|
|
5207
|
+
investment_id?: string;
|
|
5208
|
+
/** search by name */
|
|
5209
|
+
name?: string;
|
|
5210
|
+
/** search by company name */
|
|
5211
|
+
company_name?: string;
|
|
5029
5212
|
/** how many records to return. Max value is 50 */
|
|
5030
5213
|
limit: number;
|
|
5031
5214
|
/** how many records to skip */
|
|
5032
5215
|
offset: number;
|
|
5033
|
-
|
|
5216
|
+
/** sort direction */
|
|
5217
|
+
direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
|
|
5218
|
+
/** sort field */
|
|
5219
|
+
field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
|
|
5220
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
|
|
5221
|
+
/**
|
|
5222
|
+
* @description get pre ipo company spv by id
|
|
5223
|
+
* @tags PreIPOCompanies
|
|
5224
|
+
* @name GetPreIpoCompanySpvsById
|
|
5225
|
+
* @summary get pre ipo company spv by id
|
|
5226
|
+
* @request GET:/ipos/pre-ipo-company-spvs/{id}
|
|
5227
|
+
* @originalName getPreIpoCompanySpvs
|
|
5228
|
+
* @duplicate
|
|
5229
|
+
* @secure
|
|
5230
|
+
*/
|
|
5231
|
+
getPreIpoCompanySpvsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
|
|
5034
5232
|
}
|
|
5035
5233
|
export class Logos<HandleError extends boolean = boolean> {
|
|
5036
5234
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5298,6 +5496,132 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
5298
5496
|
*/
|
|
5299
5497
|
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5300
5498
|
}
|
|
5499
|
+
export class Public<HandleError extends boolean = boolean> {
|
|
5500
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5501
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5502
|
+
/**
|
|
5503
|
+
* @description Calculate estimated returns for selected symbols. Uses split adjusted prices
|
|
5504
|
+
* @tags Public
|
|
5505
|
+
* @name CalculateEstimatedReturns
|
|
5506
|
+
* @summary Calculate Estimated Returns
|
|
5507
|
+
* @request GET:/public/estimated-returns
|
|
5508
|
+
* @secure
|
|
5509
|
+
*/
|
|
5510
|
+
calculateEstimatedReturns(query: {
|
|
5511
|
+
/** Single symbol */
|
|
5512
|
+
symbol: string;
|
|
5513
|
+
/** Non-zero amount */
|
|
5514
|
+
amount: number;
|
|
5515
|
+
/** Start date for calculations */
|
|
5516
|
+
start_date: string;
|
|
5517
|
+
/** End date for calculations */
|
|
5518
|
+
end_date: string;
|
|
5519
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
5520
|
+
/**
|
|
5521
|
+
* @description Returns an expert forecast
|
|
5522
|
+
* @tags Public
|
|
5523
|
+
* @name ExpertForecast
|
|
5524
|
+
* @summary Expert forecast
|
|
5525
|
+
* @request GET:/public/expert-forecast
|
|
5526
|
+
* @secure
|
|
5527
|
+
*/
|
|
5528
|
+
expertForecast(query: {
|
|
5529
|
+
/** Comma separated symbols */
|
|
5530
|
+
symbols: string;
|
|
5531
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
5532
|
+
/**
|
|
5533
|
+
* @description get fundamentals by symbol data
|
|
5534
|
+
* @tags Public
|
|
5535
|
+
* @name GetPublicFundamentalsBySymbolData
|
|
5536
|
+
* @summary get fundamentals by symbol data
|
|
5537
|
+
* @request GET:/public/fundamentals/{symbol}
|
|
5538
|
+
* @secure
|
|
5539
|
+
*/
|
|
5540
|
+
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
5541
|
+
/** Annual or quarterly */
|
|
5542
|
+
mode: string;
|
|
5543
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5544
|
+
/**
|
|
5545
|
+
* @description Daily price history
|
|
5546
|
+
* @tags Public
|
|
5547
|
+
* @name DailyPriceHistory
|
|
5548
|
+
* @summary Daily price history
|
|
5549
|
+
* @request GET:/public/price-history/daily
|
|
5550
|
+
* @secure
|
|
5551
|
+
*/
|
|
5552
|
+
dailyPriceHistory(query: {
|
|
5553
|
+
/** Single symbol */
|
|
5554
|
+
symbol: string;
|
|
5555
|
+
/** Target date */
|
|
5556
|
+
date: string;
|
|
5557
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
5558
|
+
/**
|
|
5559
|
+
* @description Public quote profile
|
|
5560
|
+
* @tags Public
|
|
5561
|
+
* @name PublicQuoteProfile
|
|
5562
|
+
* @summary Public quote profile
|
|
5563
|
+
* @request GET:/public/quote-profile/{symbol}
|
|
5564
|
+
* @secure
|
|
5565
|
+
*/
|
|
5566
|
+
publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
|
|
5567
|
+
/**
|
|
5568
|
+
* @description get ratios by symbol data
|
|
5569
|
+
* @tags Public
|
|
5570
|
+
* @name GetPublicRatiosBySymbolData
|
|
5571
|
+
* @summary get ratios by symbol data
|
|
5572
|
+
* @request GET:/public/ratios/{symbol}
|
|
5573
|
+
* @secure
|
|
5574
|
+
*/
|
|
5575
|
+
getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
|
|
5576
|
+
/**
|
|
5577
|
+
* @description find a symbol by name or description
|
|
5578
|
+
* @tags Public
|
|
5579
|
+
* @name QuoteFundamentalsSearch
|
|
5580
|
+
* @summary find a symbol by name or description
|
|
5581
|
+
* @request GET:/public/symbol-search
|
|
5582
|
+
* @secure
|
|
5583
|
+
*/
|
|
5584
|
+
quoteFundamentalsSearch(query: {
|
|
5585
|
+
/** Search query */
|
|
5586
|
+
search_query: string;
|
|
5587
|
+
/** how many records to return. Max value is 50 */
|
|
5588
|
+
limit: number;
|
|
5589
|
+
/** how many records to skip */
|
|
5590
|
+
offset: number;
|
|
5591
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
5592
|
+
/**
|
|
5593
|
+
* @description Get top gainers
|
|
5594
|
+
* @tags Public
|
|
5595
|
+
* @name TopGainers
|
|
5596
|
+
* @summary Top Gainers
|
|
5597
|
+
* @request GET:/public/top-gainers
|
|
5598
|
+
* @secure
|
|
5599
|
+
*/
|
|
5600
|
+
topGainers(query: {
|
|
5601
|
+
/** sort direction - asc or desc */
|
|
5602
|
+
order_direction?: string;
|
|
5603
|
+
/** how many records to return. Max value is 50 */
|
|
5604
|
+
limit: number;
|
|
5605
|
+
/** how many records to skip */
|
|
5606
|
+
offset: number;
|
|
5607
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
5608
|
+
/**
|
|
5609
|
+
* @description Get top stocks
|
|
5610
|
+
* @tags Public
|
|
5611
|
+
* @name TopStocks
|
|
5612
|
+
* @summary Top Stocks
|
|
5613
|
+
* @request GET:/public/top-stocks
|
|
5614
|
+
* @secure
|
|
5615
|
+
*/
|
|
5616
|
+
topStocks(query: {
|
|
5617
|
+
/** EQUITY|ETF|CRYPTO */
|
|
5618
|
+
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
5619
|
+
/** how many records to return. Max value is 50 */
|
|
5620
|
+
limit: number;
|
|
5621
|
+
/** how many records to skip */
|
|
5622
|
+
offset: number;
|
|
5623
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
5624
|
+
}
|
|
5301
5625
|
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
5302
5626
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5303
5627
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5320,27 +5644,27 @@ export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
|
5320
5644
|
*/
|
|
5321
5645
|
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
5322
5646
|
}
|
|
5323
|
-
export class
|
|
5647
|
+
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
5324
5648
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5325
5649
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5326
5650
|
/**
|
|
5327
|
-
* @description get
|
|
5328
|
-
* @tags
|
|
5329
|
-
* @name
|
|
5330
|
-
* @summary get
|
|
5331
|
-
* @request POST:/
|
|
5651
|
+
* @description get seasonlity data with comparison to benchmark
|
|
5652
|
+
* @tags AlphaTools
|
|
5653
|
+
* @name GetMomentumRatioGraph
|
|
5654
|
+
* @summary get seasonlity data
|
|
5655
|
+
* @request POST:/rst
|
|
5332
5656
|
* @secure
|
|
5333
5657
|
*/
|
|
5334
|
-
|
|
5658
|
+
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
5335
5659
|
/**
|
|
5336
|
-
* @description get
|
|
5337
|
-
* @tags
|
|
5338
|
-
* @name
|
|
5339
|
-
* @summary get
|
|
5340
|
-
* @request POST:/
|
|
5660
|
+
* @description get seasonlity data with comparison to benchmark
|
|
5661
|
+
* @tags AlphaTools
|
|
5662
|
+
* @name GetSeasonality
|
|
5663
|
+
* @summary get seasonlity data
|
|
5664
|
+
* @request POST:/seasonality
|
|
5341
5665
|
* @secure
|
|
5342
5666
|
*/
|
|
5343
|
-
|
|
5667
|
+
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
5344
5668
|
}
|
|
5345
5669
|
export class TipRank<HandleError extends boolean = boolean> {
|
|
5346
5670
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5721,153 +6045,27 @@ export class UsageTracking<HandleError extends boolean = boolean> {
|
|
|
5721
6045
|
*/
|
|
5722
6046
|
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
5723
6047
|
}
|
|
5724
|
-
export class
|
|
5725
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5726
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5727
|
-
/**
|
|
5728
|
-
* @description Calculate estimated returns for selected symbols. Uses split adjusted prices
|
|
5729
|
-
* @tags Public
|
|
5730
|
-
* @name CalculateEstimatedReturns
|
|
5731
|
-
* @summary Calculate Estimated Returns
|
|
5732
|
-
* @request GET:/public/estimated-returns
|
|
5733
|
-
* @secure
|
|
5734
|
-
*/
|
|
5735
|
-
calculateEstimatedReturns(query: {
|
|
5736
|
-
/** Single symbol */
|
|
5737
|
-
symbol: string;
|
|
5738
|
-
/** Non-zero amount */
|
|
5739
|
-
amount: number;
|
|
5740
|
-
/** Start date for calculations */
|
|
5741
|
-
start_date: string;
|
|
5742
|
-
/** End date for calculations */
|
|
5743
|
-
end_date: string;
|
|
5744
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
5745
|
-
/**
|
|
5746
|
-
* @description Returns an expert forecast
|
|
5747
|
-
* @tags Public
|
|
5748
|
-
* @name ExpertForecast
|
|
5749
|
-
* @summary Expert forecast
|
|
5750
|
-
* @request GET:/public/expert-forecast
|
|
5751
|
-
* @secure
|
|
5752
|
-
*/
|
|
5753
|
-
expertForecast(query: {
|
|
5754
|
-
/** Comma separated symbols */
|
|
5755
|
-
symbols: string;
|
|
5756
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
5757
|
-
/**
|
|
5758
|
-
* @description get fundamentals by symbol data
|
|
5759
|
-
* @tags Public
|
|
5760
|
-
* @name GetPublicFundamentalsBySymbolData
|
|
5761
|
-
* @summary get fundamentals by symbol data
|
|
5762
|
-
* @request GET:/public/fundamentals/{symbol}
|
|
5763
|
-
* @secure
|
|
5764
|
-
*/
|
|
5765
|
-
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
5766
|
-
/** Annual or quarterly */
|
|
5767
|
-
mode: string;
|
|
5768
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5769
|
-
/**
|
|
5770
|
-
* @description Daily price history
|
|
5771
|
-
* @tags Public
|
|
5772
|
-
* @name DailyPriceHistory
|
|
5773
|
-
* @summary Daily price history
|
|
5774
|
-
* @request GET:/public/price-history/daily
|
|
5775
|
-
* @secure
|
|
5776
|
-
*/
|
|
5777
|
-
dailyPriceHistory(query: {
|
|
5778
|
-
/** Single symbol */
|
|
5779
|
-
symbol: string;
|
|
5780
|
-
/** Target date */
|
|
5781
|
-
date: string;
|
|
5782
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
5783
|
-
/**
|
|
5784
|
-
* @description Public quote profile
|
|
5785
|
-
* @tags Public
|
|
5786
|
-
* @name PublicQuoteProfile
|
|
5787
|
-
* @summary Public quote profile
|
|
5788
|
-
* @request GET:/public/quote-profile/{symbol}
|
|
5789
|
-
* @secure
|
|
5790
|
-
*/
|
|
5791
|
-
publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
|
|
5792
|
-
/**
|
|
5793
|
-
* @description get ratios by symbol data
|
|
5794
|
-
* @tags Public
|
|
5795
|
-
* @name GetPublicRatiosBySymbolData
|
|
5796
|
-
* @summary get ratios by symbol data
|
|
5797
|
-
* @request GET:/public/ratios/{symbol}
|
|
5798
|
-
* @secure
|
|
5799
|
-
*/
|
|
5800
|
-
getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
|
|
5801
|
-
/**
|
|
5802
|
-
* @description find a symbol by name or description
|
|
5803
|
-
* @tags Public
|
|
5804
|
-
* @name QuoteFundamentalsSearch
|
|
5805
|
-
* @summary find a symbol by name or description
|
|
5806
|
-
* @request GET:/public/symbol-search
|
|
5807
|
-
* @secure
|
|
5808
|
-
*/
|
|
5809
|
-
quoteFundamentalsSearch(query: {
|
|
5810
|
-
/** Search query */
|
|
5811
|
-
search_query: string;
|
|
5812
|
-
/** how many records to return. Max value is 50 */
|
|
5813
|
-
limit: number;
|
|
5814
|
-
/** how many records to skip */
|
|
5815
|
-
offset: number;
|
|
5816
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
5817
|
-
/**
|
|
5818
|
-
* @description Get top gainers
|
|
5819
|
-
* @tags Public
|
|
5820
|
-
* @name TopGainers
|
|
5821
|
-
* @summary Top Gainers
|
|
5822
|
-
* @request GET:/public/top-gainers
|
|
5823
|
-
* @secure
|
|
5824
|
-
*/
|
|
5825
|
-
topGainers(query: {
|
|
5826
|
-
/** sort direction - asc or desc */
|
|
5827
|
-
order_direction?: string;
|
|
5828
|
-
/** how many records to return. Max value is 50 */
|
|
5829
|
-
limit: number;
|
|
5830
|
-
/** how many records to skip */
|
|
5831
|
-
offset: number;
|
|
5832
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
5833
|
-
/**
|
|
5834
|
-
* @description Get top stocks
|
|
5835
|
-
* @tags Public
|
|
5836
|
-
* @name TopStocks
|
|
5837
|
-
* @summary Top Stocks
|
|
5838
|
-
* @request GET:/public/top-stocks
|
|
5839
|
-
* @secure
|
|
5840
|
-
*/
|
|
5841
|
-
topStocks(query: {
|
|
5842
|
-
/** EQUITY|ETF|CRYPTO */
|
|
5843
|
-
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
5844
|
-
/** how many records to return. Max value is 50 */
|
|
5845
|
-
limit: number;
|
|
5846
|
-
/** how many records to skip */
|
|
5847
|
-
offset: number;
|
|
5848
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
5849
|
-
}
|
|
5850
|
-
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
6048
|
+
export class Ownerships<HandleError extends boolean = boolean> {
|
|
5851
6049
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5852
6050
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5853
6051
|
/**
|
|
5854
|
-
* @description get
|
|
5855
|
-
* @tags
|
|
5856
|
-
* @name
|
|
5857
|
-
* @summary get
|
|
5858
|
-
* @request POST:/
|
|
6052
|
+
* @description get ownerships by id datadata
|
|
6053
|
+
* @tags Ownerships
|
|
6054
|
+
* @name GetOwnershipsByIdData
|
|
6055
|
+
* @summary get ownerships by id data
|
|
6056
|
+
* @request POST:/ownerships
|
|
5859
6057
|
* @secure
|
|
5860
6058
|
*/
|
|
5861
|
-
|
|
6059
|
+
getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
5862
6060
|
/**
|
|
5863
|
-
* @description get
|
|
5864
|
-
* @tags
|
|
5865
|
-
* @name
|
|
5866
|
-
* @summary get
|
|
5867
|
-
* @request POST:/
|
|
6061
|
+
* @description get ownerships by symbol data
|
|
6062
|
+
* @tags Ownerships
|
|
6063
|
+
* @name GetOwnershipsBySymbolData
|
|
6064
|
+
* @summary get ownerships by symbol data
|
|
6065
|
+
* @request POST:/symbol-ownerships
|
|
5868
6066
|
* @secure
|
|
5869
6067
|
*/
|
|
5870
|
-
|
|
6068
|
+
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
5871
6069
|
}
|
|
5872
6070
|
export class Passport<HandleError extends boolean = boolean> {
|
|
5873
6071
|
protected readonly apiClient: JwtClient<HandleError>;
|