@orbis-systems/orbis-api-clients 0.7.11 → 0.7.12
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 +103 -103
- 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 +497 -497
- 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 +659 -484
- 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 +30 -30
- 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 +1344 -1344
- 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 +288 -288
- 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 +406 -406
- 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
|
@@ -690,6 +690,7 @@ export interface InsightEarningRelease {
|
|
|
690
690
|
time: string;
|
|
691
691
|
}
|
|
692
692
|
export interface InsightEarningReleasesRequest {
|
|
693
|
+
date?: InsightBeforeAndAfter;
|
|
693
694
|
/**
|
|
694
695
|
* @min 0
|
|
695
696
|
* @example 7
|
|
@@ -1293,6 +1294,179 @@ export interface InsightGetPreIPOCompanySPVsResponse {
|
|
|
1293
1294
|
count: number;
|
|
1294
1295
|
details: InsightPreIPOCompanySPV[];
|
|
1295
1296
|
}
|
|
1297
|
+
export interface InsightGetPreIPOCompanySPVsWithInvestorIDResponse {
|
|
1298
|
+
items: {
|
|
1299
|
+
all_in_price_per_share?: number;
|
|
1300
|
+
close_date?: string;
|
|
1301
|
+
co_managers?: {
|
|
1302
|
+
aum?: number;
|
|
1303
|
+
country_code?: string;
|
|
1304
|
+
dba_name?: string;
|
|
1305
|
+
description?: string;
|
|
1306
|
+
executive_team?: string[];
|
|
1307
|
+
founding_date?: string;
|
|
1308
|
+
id?: string;
|
|
1309
|
+
legal_entity_name?: string;
|
|
1310
|
+
logo_url?: string;
|
|
1311
|
+
manager_crd?: string[];
|
|
1312
|
+
name?: string;
|
|
1313
|
+
partner_type?: string;
|
|
1314
|
+
registration?: string;
|
|
1315
|
+
secondary_location?: string;
|
|
1316
|
+
website?: string;
|
|
1317
|
+
}[];
|
|
1318
|
+
cusip?: string;
|
|
1319
|
+
description?: string;
|
|
1320
|
+
documents?: {
|
|
1321
|
+
description?: string;
|
|
1322
|
+
id?: string;
|
|
1323
|
+
investor_id?: string;
|
|
1324
|
+
investor_subscription_id?: string;
|
|
1325
|
+
name?: string;
|
|
1326
|
+
partner_id?: string;
|
|
1327
|
+
pre_ipo_company_id?: string;
|
|
1328
|
+
pre_ipo_company_investment_id?: string;
|
|
1329
|
+
pre_ipo_company_spv_id?: string;
|
|
1330
|
+
registered_fund_id?: string;
|
|
1331
|
+
tax_year?: number;
|
|
1332
|
+
template_document?: boolean;
|
|
1333
|
+
type?: string;
|
|
1334
|
+
url?: string;
|
|
1335
|
+
}[];
|
|
1336
|
+
exemptions_claimed?: string[];
|
|
1337
|
+
funding_deadline?: string;
|
|
1338
|
+
id?: string;
|
|
1339
|
+
investor_fee_per_share?: number;
|
|
1340
|
+
investor_price_per_share?: number;
|
|
1341
|
+
management_fee?: number;
|
|
1342
|
+
management_fee_years_payable?: number;
|
|
1343
|
+
manager?: {
|
|
1344
|
+
aum?: number;
|
|
1345
|
+
country_code?: string;
|
|
1346
|
+
dba_name?: string;
|
|
1347
|
+
description?: string;
|
|
1348
|
+
executive_team?: string[];
|
|
1349
|
+
founding_date?: string;
|
|
1350
|
+
id?: string;
|
|
1351
|
+
legal_entity_name?: string;
|
|
1352
|
+
logo_url?: string;
|
|
1353
|
+
manager_crd?: string[];
|
|
1354
|
+
name?: string;
|
|
1355
|
+
partner_type?: string;
|
|
1356
|
+
registration?: string;
|
|
1357
|
+
secondary_location?: string;
|
|
1358
|
+
website?: string;
|
|
1359
|
+
};
|
|
1360
|
+
master_llc_name?: string;
|
|
1361
|
+
min_commitment_amount?: number;
|
|
1362
|
+
monark_stage?: string;
|
|
1363
|
+
name?: string;
|
|
1364
|
+
notable_investors?: string[];
|
|
1365
|
+
number_of_seats_remaining?: number;
|
|
1366
|
+
pre_funded_inventory?: boolean;
|
|
1367
|
+
pre_ipo_company_id?: string;
|
|
1368
|
+
pre_ipo_company_investment_id?: string;
|
|
1369
|
+
pre_ipo_company_name?: string;
|
|
1370
|
+
remaining_dollar_allocation?: number;
|
|
1371
|
+
remaining_share_allocation?: number;
|
|
1372
|
+
spv_account_id?: number;
|
|
1373
|
+
spv_custodian?: string;
|
|
1374
|
+
synopsis?: string;
|
|
1375
|
+
total_dollar_allocation?: number;
|
|
1376
|
+
total_number_of_seats?: number;
|
|
1377
|
+
total_share_allocation?: number;
|
|
1378
|
+
trading_symbol?: string;
|
|
1379
|
+
valuation?: number;
|
|
1380
|
+
}[];
|
|
1381
|
+
pagination: {
|
|
1382
|
+
current_page: number;
|
|
1383
|
+
total_pages: number;
|
|
1384
|
+
total_records: number;
|
|
1385
|
+
};
|
|
1386
|
+
}
|
|
1387
|
+
export interface InsightGetProIPOCompabySPVWithInvestorIDResponse {
|
|
1388
|
+
all_in_price_per_share: number;
|
|
1389
|
+
close_date: string;
|
|
1390
|
+
co_managers: {
|
|
1391
|
+
aum?: number;
|
|
1392
|
+
country_code?: string;
|
|
1393
|
+
dba_name?: string;
|
|
1394
|
+
description?: string;
|
|
1395
|
+
executive_team?: string[];
|
|
1396
|
+
founding_date?: string;
|
|
1397
|
+
id?: string;
|
|
1398
|
+
legal_entity_name?: string;
|
|
1399
|
+
logo_url?: string;
|
|
1400
|
+
manager_crd?: string[];
|
|
1401
|
+
name?: string;
|
|
1402
|
+
partner_type?: string;
|
|
1403
|
+
registration?: string;
|
|
1404
|
+
secondary_location?: string;
|
|
1405
|
+
website?: string;
|
|
1406
|
+
}[];
|
|
1407
|
+
cusip: string;
|
|
1408
|
+
description: string;
|
|
1409
|
+
documents: {
|
|
1410
|
+
description?: string;
|
|
1411
|
+
id?: string;
|
|
1412
|
+
investor_id?: string;
|
|
1413
|
+
investor_subscription_id?: string;
|
|
1414
|
+
name?: string;
|
|
1415
|
+
partner_id?: string;
|
|
1416
|
+
pre_ipo_company_id?: string;
|
|
1417
|
+
pre_ipo_company_investment_id?: string;
|
|
1418
|
+
pre_ipo_company_spv_id?: string;
|
|
1419
|
+
registered_fund_id?: string;
|
|
1420
|
+
tax_year?: number;
|
|
1421
|
+
template_document?: boolean;
|
|
1422
|
+
type?: string;
|
|
1423
|
+
url?: string;
|
|
1424
|
+
}[];
|
|
1425
|
+
exemptions_claimed: string[];
|
|
1426
|
+
funding_deadline: string;
|
|
1427
|
+
id: string;
|
|
1428
|
+
investor_fee_per_share: number;
|
|
1429
|
+
investor_price_per_share: number;
|
|
1430
|
+
management_fee: number;
|
|
1431
|
+
management_fee_years_payable: number;
|
|
1432
|
+
manager: {
|
|
1433
|
+
aum: number;
|
|
1434
|
+
country_code: string;
|
|
1435
|
+
dba_name: string;
|
|
1436
|
+
description: string;
|
|
1437
|
+
executive_team: string[];
|
|
1438
|
+
founding_date: string;
|
|
1439
|
+
id: string;
|
|
1440
|
+
legal_entity_name: string;
|
|
1441
|
+
logo_url: string;
|
|
1442
|
+
manager_crd: string[];
|
|
1443
|
+
name: string;
|
|
1444
|
+
partner_type: string;
|
|
1445
|
+
registration: string;
|
|
1446
|
+
secondary_location: string;
|
|
1447
|
+
website: string;
|
|
1448
|
+
};
|
|
1449
|
+
master_llc_name: string;
|
|
1450
|
+
min_commitment_amount: number;
|
|
1451
|
+
monark_stage: string;
|
|
1452
|
+
name: string;
|
|
1453
|
+
notable_investors: string[];
|
|
1454
|
+
number_of_seats_remaining: number;
|
|
1455
|
+
pre_funded_inventory: boolean;
|
|
1456
|
+
pre_ipo_company_id: string;
|
|
1457
|
+
pre_ipo_company_investment_id: string;
|
|
1458
|
+
pre_ipo_company_name: string;
|
|
1459
|
+
remaining_dollar_allocation: number;
|
|
1460
|
+
remaining_share_allocation: number;
|
|
1461
|
+
spv_account_id: number;
|
|
1462
|
+
spv_custodian: string;
|
|
1463
|
+
synopsis: string;
|
|
1464
|
+
total_dollar_allocation: number;
|
|
1465
|
+
total_number_of_seats: number;
|
|
1466
|
+
total_share_allocation: number;
|
|
1467
|
+
trading_symbol: string;
|
|
1468
|
+
valuation: number;
|
|
1469
|
+
}
|
|
1296
1470
|
export interface InsightGetScreenerPresetsResponse {
|
|
1297
1471
|
count: number;
|
|
1298
1472
|
default_presets: InsightScreenerPreset[];
|
|
@@ -3116,6 +3290,7 @@ export interface InsightNewsfeedRequest {
|
|
|
3116
3290
|
export interface InsightOptionData {
|
|
3117
3291
|
expiry_date: InsightDate;
|
|
3118
3292
|
greeks: InsightOptionGreeks;
|
|
3293
|
+
implied_volatility: number;
|
|
3119
3294
|
strike_price: number;
|
|
3120
3295
|
theoretical_price: number;
|
|
3121
3296
|
ticker: string;
|
|
@@ -4374,177 +4549,44 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
|
|
|
4374
4549
|
Date = "date",
|
|
4375
4550
|
Rank = "rank"
|
|
4376
4551
|
}
|
|
4377
|
-
export class
|
|
4378
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4379
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4380
|
-
/**
|
|
4381
|
-
* @description get custom lists
|
|
4382
|
-
* @tags Custom Lists
|
|
4383
|
-
* @name GetCustomLists
|
|
4384
|
-
* @summary get custom lists
|
|
4385
|
-
* @request GET:/custom-lists
|
|
4386
|
-
* @secure
|
|
4387
|
-
*/
|
|
4388
|
-
getCustomLists(query: {
|
|
4389
|
-
/** how many records to return. Max value is 50 */
|
|
4390
|
-
limit: number;
|
|
4391
|
-
/** how many records to skip */
|
|
4392
|
-
offset: number;
|
|
4393
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4394
|
-
/**
|
|
4395
|
-
* @description update custom list
|
|
4396
|
-
* @tags Custom Lists
|
|
4397
|
-
* @name UpdateCustomList
|
|
4398
|
-
* @summary update custom list
|
|
4399
|
-
* @request PUT:/custom-lists
|
|
4400
|
-
* @secure
|
|
4401
|
-
*/
|
|
4402
|
-
updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
4403
|
-
/**
|
|
4404
|
-
* @description create custom list
|
|
4405
|
-
* @tags Custom Lists
|
|
4406
|
-
* @name CreateCustomList
|
|
4407
|
-
* @summary create custom list
|
|
4408
|
-
* @request POST:/custom-lists
|
|
4409
|
-
* @secure
|
|
4410
|
-
*/
|
|
4411
|
-
createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
4412
|
-
/**
|
|
4413
|
-
* @description remove custom list
|
|
4414
|
-
* @tags Custom Lists
|
|
4415
|
-
* @name RemoveCustomList
|
|
4416
|
-
* @summary remove custom list
|
|
4417
|
-
* @request DELETE:/custom-lists
|
|
4418
|
-
* @secure
|
|
4419
|
-
*/
|
|
4420
|
-
removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4421
|
-
/**
|
|
4422
|
-
* @description filter custom lists
|
|
4423
|
-
* @tags Custom Lists
|
|
4424
|
-
* @name FilterCustomLists
|
|
4425
|
-
* @summary filter custom lists
|
|
4426
|
-
* @request POST:/custom-lists/filter
|
|
4427
|
-
* @secure
|
|
4428
|
-
*/
|
|
4429
|
-
filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4430
|
-
/**
|
|
4431
|
-
* @description get custom list with quotes
|
|
4432
|
-
* @tags Custom Lists
|
|
4433
|
-
* @name GetCustomListWithQuotes
|
|
4434
|
-
* @summary get custom list with quotes
|
|
4435
|
-
* @request GET:/custom-lists/{id-or-slug}
|
|
4436
|
-
* @secure
|
|
4437
|
-
*/
|
|
4438
|
-
getCustomListWithQuotes(idOrSlug: string, query: {
|
|
4439
|
-
/** sort direction - asc or desc */
|
|
4440
|
-
order_direction: string;
|
|
4441
|
-
/** sort field - volume, symbol(alphabetical), market_cap, dividend_percent */
|
|
4442
|
-
order_field: string;
|
|
4443
|
-
/** how many equities records to return. Max value is 50 */
|
|
4444
|
-
limit: number;
|
|
4445
|
-
/** how many equities records to skip */
|
|
4446
|
-
offset: number;
|
|
4447
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4448
|
-
/**
|
|
4449
|
-
* @description filter custom list
|
|
4450
|
-
* @tags Custom Lists
|
|
4451
|
-
* @name FilterCustomList
|
|
4452
|
-
* @summary filter custom list
|
|
4453
|
-
* @request GET:/custom-lists/{id-or-slug}/filter
|
|
4454
|
-
* @secure
|
|
4455
|
-
*/
|
|
4456
|
-
filterCustomList(idOrSlug: string, query?: {
|
|
4457
|
-
/** symbols to check inclusion */
|
|
4458
|
-
symbols?: string[];
|
|
4459
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
|
|
4460
|
-
}
|
|
4461
|
-
export class Earnings<HandleError extends boolean = boolean> {
|
|
4462
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4463
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4464
|
-
/**
|
|
4465
|
-
* @description get earnings release dates for symbols
|
|
4466
|
-
* @tags Earnings
|
|
4467
|
-
* @name GetEarningsCalendar
|
|
4468
|
-
* @summary get earnings calendar data
|
|
4469
|
-
* @request POST:/earnings-calendar
|
|
4470
|
-
* @secure
|
|
4471
|
-
*/
|
|
4472
|
-
getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
|
|
4473
|
-
}
|
|
4474
|
-
export class Dashboard<HandleError extends boolean = boolean> {
|
|
4552
|
+
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4475
4553
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4476
4554
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4477
4555
|
/**
|
|
4478
|
-
* @description get
|
|
4479
|
-
* @tags
|
|
4480
|
-
* @name
|
|
4481
|
-
* @summary get
|
|
4482
|
-
* @request
|
|
4483
|
-
* @secure
|
|
4484
|
-
*/
|
|
4485
|
-
dashboardGetOwnershipsBySymbol(filter: InsightGetOwnershipsBySymbolRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolAsDashboardFieldsResponse, HandleError>>;
|
|
4486
|
-
/**
|
|
4487
|
-
* @description rewrite field value
|
|
4488
|
-
* @tags Dashboard
|
|
4489
|
-
* @name RewriteFieldValue
|
|
4490
|
-
* @summary rewrite field value
|
|
4491
|
-
* @request POST:/rewrite-field
|
|
4492
|
-
* @secure
|
|
4493
|
-
*/
|
|
4494
|
-
rewriteFieldValue(input: InsightRewriteFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4495
|
-
/**
|
|
4496
|
-
* @description remove rewritten value
|
|
4497
|
-
* @tags Dashboard
|
|
4498
|
-
* @name CreateRewriteField
|
|
4499
|
-
* @summary remove rewritten value
|
|
4500
|
-
* @request DELETE:/rewrite-field
|
|
4501
|
-
* @secure
|
|
4502
|
-
*/
|
|
4503
|
-
createRewriteField(input: InsightRemoveRewrittenFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4504
|
-
/**
|
|
4505
|
-
* @description Get rewritten field action log
|
|
4506
|
-
* @tags Dashboard
|
|
4507
|
-
* @name GetRewrittenFieldActionLog
|
|
4508
|
-
* @summary get rewritten field action log
|
|
4509
|
-
* @request GET:/rewritten-field-action-log
|
|
4556
|
+
* @description get company profile, industries classification and closest earning release
|
|
4557
|
+
* @tags CompanyProfile
|
|
4558
|
+
* @name GetCompanyProfile
|
|
4559
|
+
* @summary get company profile
|
|
4560
|
+
* @request GET:/company-profile
|
|
4510
4561
|
* @secure
|
|
4511
4562
|
*/
|
|
4512
|
-
|
|
4513
|
-
/**
|
|
4514
|
-
|
|
4515
|
-
|
|
4516
|
-
field_id: string;
|
|
4517
|
-
/** how many records to return. Max value is 50 */
|
|
4518
|
-
limit: number;
|
|
4519
|
-
/** how many records to skip */
|
|
4520
|
-
offset: number;
|
|
4521
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4563
|
+
getCompanyProfile(query: {
|
|
4564
|
+
/** Company symbol */
|
|
4565
|
+
symbol: string;
|
|
4566
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
|
|
4522
4567
|
/**
|
|
4523
|
-
* @description
|
|
4524
|
-
* @tags
|
|
4525
|
-
* @name
|
|
4526
|
-
* @summary get
|
|
4527
|
-
* @request GET:/
|
|
4568
|
+
* @description get combined profile, equities and funds
|
|
4569
|
+
* @tags CompanyProfile
|
|
4570
|
+
* @name GetCombinedProfile
|
|
4571
|
+
* @summary get company profile
|
|
4572
|
+
* @request GET:/quote-profile
|
|
4528
4573
|
* @secure
|
|
4529
4574
|
*/
|
|
4530
|
-
|
|
4531
|
-
/**
|
|
4532
|
-
|
|
4533
|
-
/**
|
|
4534
|
-
|
|
4535
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4575
|
+
getCombinedProfile(query: {
|
|
4576
|
+
/** Company symbol */
|
|
4577
|
+
symbol: string;
|
|
4578
|
+
/** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
|
|
4579
|
+
symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
|
|
4580
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
|
|
4536
4581
|
/**
|
|
4537
|
-
* @description
|
|
4538
|
-
* @tags
|
|
4539
|
-
* @name
|
|
4540
|
-
* @summary
|
|
4541
|
-
* @request
|
|
4582
|
+
* @description sort input array of symbols by type
|
|
4583
|
+
* @tags CompanyProfile
|
|
4584
|
+
* @name GetSymbolsPerSymbolType
|
|
4585
|
+
* @summary sort input array of symbols by type
|
|
4586
|
+
* @request POST:/symbols-per-type
|
|
4542
4587
|
* @secure
|
|
4543
4588
|
*/
|
|
4544
|
-
|
|
4545
|
-
/** Symbol */
|
|
4546
|
-
symbol: string;
|
|
4547
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolRelatedFieldsResponse, HandleError>>;
|
|
4589
|
+
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
4548
4590
|
}
|
|
4549
4591
|
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
4550
4592
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4728,21 +4770,193 @@ export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
|
4728
4770
|
id: string;
|
|
4729
4771
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4730
4772
|
}
|
|
4731
|
-
export class
|
|
4773
|
+
export class CustomLists<HandleError extends boolean = boolean> {
|
|
4732
4774
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4733
4775
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4734
4776
|
/**
|
|
4735
|
-
* @description get
|
|
4736
|
-
* @tags
|
|
4737
|
-
* @name
|
|
4738
|
-
* @summary get
|
|
4739
|
-
* @request
|
|
4777
|
+
* @description get custom lists
|
|
4778
|
+
* @tags Custom Lists
|
|
4779
|
+
* @name GetCustomLists
|
|
4780
|
+
* @summary get custom lists
|
|
4781
|
+
* @request GET:/custom-lists
|
|
4740
4782
|
* @secure
|
|
4741
4783
|
*/
|
|
4742
|
-
|
|
4784
|
+
getCustomLists(query: {
|
|
4785
|
+
/** how many records to return. Max value is 50 */
|
|
4786
|
+
limit: number;
|
|
4787
|
+
/** how many records to skip */
|
|
4788
|
+
offset: number;
|
|
4789
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4743
4790
|
/**
|
|
4744
|
-
* @description
|
|
4745
|
-
* @tags
|
|
4791
|
+
* @description update custom list
|
|
4792
|
+
* @tags Custom Lists
|
|
4793
|
+
* @name UpdateCustomList
|
|
4794
|
+
* @summary update custom list
|
|
4795
|
+
* @request PUT:/custom-lists
|
|
4796
|
+
* @secure
|
|
4797
|
+
*/
|
|
4798
|
+
updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
4799
|
+
/**
|
|
4800
|
+
* @description create custom list
|
|
4801
|
+
* @tags Custom Lists
|
|
4802
|
+
* @name CreateCustomList
|
|
4803
|
+
* @summary create custom list
|
|
4804
|
+
* @request POST:/custom-lists
|
|
4805
|
+
* @secure
|
|
4806
|
+
*/
|
|
4807
|
+
createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
4808
|
+
/**
|
|
4809
|
+
* @description remove custom list
|
|
4810
|
+
* @tags Custom Lists
|
|
4811
|
+
* @name RemoveCustomList
|
|
4812
|
+
* @summary remove custom list
|
|
4813
|
+
* @request DELETE:/custom-lists
|
|
4814
|
+
* @secure
|
|
4815
|
+
*/
|
|
4816
|
+
removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4817
|
+
/**
|
|
4818
|
+
* @description filter custom lists
|
|
4819
|
+
* @tags Custom Lists
|
|
4820
|
+
* @name FilterCustomLists
|
|
4821
|
+
* @summary filter custom lists
|
|
4822
|
+
* @request POST:/custom-lists/filter
|
|
4823
|
+
* @secure
|
|
4824
|
+
*/
|
|
4825
|
+
filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4826
|
+
/**
|
|
4827
|
+
* @description get custom list with quotes
|
|
4828
|
+
* @tags Custom Lists
|
|
4829
|
+
* @name GetCustomListWithQuotes
|
|
4830
|
+
* @summary get custom list with quotes
|
|
4831
|
+
* @request GET:/custom-lists/{id-or-slug}
|
|
4832
|
+
* @secure
|
|
4833
|
+
*/
|
|
4834
|
+
getCustomListWithQuotes(idOrSlug: string, query: {
|
|
4835
|
+
/** sort direction - asc or desc */
|
|
4836
|
+
order_direction: string;
|
|
4837
|
+
/** sort field - volume, symbol(alphabetical), market_cap, dividend_percent */
|
|
4838
|
+
order_field: string;
|
|
4839
|
+
/** how many equities records to return. Max value is 50 */
|
|
4840
|
+
limit: number;
|
|
4841
|
+
/** how many equities records to skip */
|
|
4842
|
+
offset: number;
|
|
4843
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4844
|
+
/**
|
|
4845
|
+
* @description filter custom list
|
|
4846
|
+
* @tags Custom Lists
|
|
4847
|
+
* @name FilterCustomList
|
|
4848
|
+
* @summary filter custom list
|
|
4849
|
+
* @request GET:/custom-lists/{id-or-slug}/filter
|
|
4850
|
+
* @secure
|
|
4851
|
+
*/
|
|
4852
|
+
filterCustomList(idOrSlug: string, query?: {
|
|
4853
|
+
/** symbols to check inclusion */
|
|
4854
|
+
symbols?: string[];
|
|
4855
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
|
|
4856
|
+
}
|
|
4857
|
+
export class Dashboard<HandleError extends boolean = boolean> {
|
|
4858
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4859
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4860
|
+
/**
|
|
4861
|
+
* @description get ownerships by symbol
|
|
4862
|
+
* @tags Dashboard
|
|
4863
|
+
* @name DashboardGetOwnershipsBySymbol
|
|
4864
|
+
* @summary get ownerships by symbol
|
|
4865
|
+
* @request POST:/dashboard/ownerships
|
|
4866
|
+
* @secure
|
|
4867
|
+
*/
|
|
4868
|
+
dashboardGetOwnershipsBySymbol(filter: InsightGetOwnershipsBySymbolRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolAsDashboardFieldsResponse, HandleError>>;
|
|
4869
|
+
/**
|
|
4870
|
+
* @description rewrite field value
|
|
4871
|
+
* @tags Dashboard
|
|
4872
|
+
* @name RewriteFieldValue
|
|
4873
|
+
* @summary rewrite field value
|
|
4874
|
+
* @request POST:/rewrite-field
|
|
4875
|
+
* @secure
|
|
4876
|
+
*/
|
|
4877
|
+
rewriteFieldValue(input: InsightRewriteFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4878
|
+
/**
|
|
4879
|
+
* @description remove rewritten value
|
|
4880
|
+
* @tags Dashboard
|
|
4881
|
+
* @name CreateRewriteField
|
|
4882
|
+
* @summary remove rewritten value
|
|
4883
|
+
* @request DELETE:/rewrite-field
|
|
4884
|
+
* @secure
|
|
4885
|
+
*/
|
|
4886
|
+
createRewriteField(input: InsightRemoveRewrittenFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4887
|
+
/**
|
|
4888
|
+
* @description Get rewritten field action log
|
|
4889
|
+
* @tags Dashboard
|
|
4890
|
+
* @name GetRewrittenFieldActionLog
|
|
4891
|
+
* @summary get rewritten field action log
|
|
4892
|
+
* @request GET:/rewritten-field-action-log
|
|
4893
|
+
* @secure
|
|
4894
|
+
*/
|
|
4895
|
+
getRewrittenFieldActionLog(query: {
|
|
4896
|
+
/** Internal UUID */
|
|
4897
|
+
internal_id: string;
|
|
4898
|
+
/** Field ID */
|
|
4899
|
+
field_id: string;
|
|
4900
|
+
/** how many records to return. Max value is 50 */
|
|
4901
|
+
limit: number;
|
|
4902
|
+
/** how many records to skip */
|
|
4903
|
+
offset: number;
|
|
4904
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4905
|
+
/**
|
|
4906
|
+
* @description Get rewritten values
|
|
4907
|
+
* @tags Dashboard
|
|
4908
|
+
* @name GetRewrittenValues
|
|
4909
|
+
* @summary get rewritten values
|
|
4910
|
+
* @request GET:/rewritten-fields
|
|
4911
|
+
* @secure
|
|
4912
|
+
*/
|
|
4913
|
+
getRewrittenValues(query: {
|
|
4914
|
+
/** how many records to return. Max value is 50 */
|
|
4915
|
+
limit: number;
|
|
4916
|
+
/** how many records to skip */
|
|
4917
|
+
offset: number;
|
|
4918
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4919
|
+
/**
|
|
4920
|
+
* @description get symbol-related fields
|
|
4921
|
+
* @tags Dashboard
|
|
4922
|
+
* @name GetSymbolRelatedFields
|
|
4923
|
+
* @summary get symbol-related fields
|
|
4924
|
+
* @request GET:/symbol-related-fields
|
|
4925
|
+
* @secure
|
|
4926
|
+
*/
|
|
4927
|
+
getSymbolRelatedFields(query: {
|
|
4928
|
+
/** Symbol */
|
|
4929
|
+
symbol: string;
|
|
4930
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolRelatedFieldsResponse, HandleError>>;
|
|
4931
|
+
}
|
|
4932
|
+
export class Earnings<HandleError extends boolean = boolean> {
|
|
4933
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4934
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4935
|
+
/**
|
|
4936
|
+
* @description get earnings release dates for symbols
|
|
4937
|
+
* @tags Earnings
|
|
4938
|
+
* @name GetEarningsCalendar
|
|
4939
|
+
* @summary get earnings calendar data
|
|
4940
|
+
* @request POST:/earnings-calendar
|
|
4941
|
+
* @secure
|
|
4942
|
+
*/
|
|
4943
|
+
getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
|
|
4944
|
+
}
|
|
4945
|
+
export class FixedIncome<HandleError extends boolean = boolean> {
|
|
4946
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4947
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4948
|
+
/**
|
|
4949
|
+
* @description get fixed income entries
|
|
4950
|
+
* @tags FixedIncome
|
|
4951
|
+
* @name GetFixedIncomeEntries
|
|
4952
|
+
* @summary get fixed income entries
|
|
4953
|
+
* @request POST:/fixed-income
|
|
4954
|
+
* @secure
|
|
4955
|
+
*/
|
|
4956
|
+
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponse, HandleError>>;
|
|
4957
|
+
/**
|
|
4958
|
+
* @description Returns historical fixed income
|
|
4959
|
+
* @tags FixedIncome
|
|
4746
4960
|
* @name FixedIncomeHistorical
|
|
4747
4961
|
* @summary Get historical fixed income
|
|
4748
4962
|
* @request POST:/fixed-income/historical
|
|
@@ -4800,45 +5014,6 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
4800
5014
|
*/
|
|
4801
5015
|
getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
|
|
4802
5016
|
}
|
|
4803
|
-
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4804
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4805
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4806
|
-
/**
|
|
4807
|
-
* @description get company profile, industries classification and closest earning release
|
|
4808
|
-
* @tags CompanyProfile
|
|
4809
|
-
* @name GetCompanyProfile
|
|
4810
|
-
* @summary get company profile
|
|
4811
|
-
* @request GET:/company-profile
|
|
4812
|
-
* @secure
|
|
4813
|
-
*/
|
|
4814
|
-
getCompanyProfile(query: {
|
|
4815
|
-
/** Company symbol */
|
|
4816
|
-
symbol: string;
|
|
4817
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
|
|
4818
|
-
/**
|
|
4819
|
-
* @description get combined profile, equities and funds
|
|
4820
|
-
* @tags CompanyProfile
|
|
4821
|
-
* @name GetCombinedProfile
|
|
4822
|
-
* @summary get company profile
|
|
4823
|
-
* @request GET:/quote-profile
|
|
4824
|
-
* @secure
|
|
4825
|
-
*/
|
|
4826
|
-
getCombinedProfile(query: {
|
|
4827
|
-
/** Company symbol */
|
|
4828
|
-
symbol: string;
|
|
4829
|
-
/** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
|
|
4830
|
-
symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
|
|
4831
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
|
|
4832
|
-
/**
|
|
4833
|
-
* @description sort input array of symbols by type
|
|
4834
|
-
* @tags CompanyProfile
|
|
4835
|
-
* @name GetSymbolsPerSymbolType
|
|
4836
|
-
* @summary sort input array of symbols by type
|
|
4837
|
-
* @request POST:/symbols-per-type
|
|
4838
|
-
* @secure
|
|
4839
|
-
*/
|
|
4840
|
-
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
4841
|
-
}
|
|
4842
5017
|
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
4843
5018
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4844
5019
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5331,7 +5506,7 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
5331
5506
|
sort_order?: InsightGetInvestorParamsSortOrderEnum;
|
|
5332
5507
|
/** sort field */
|
|
5333
5508
|
sort_by?: InsightGetInvestorParamsSortByEnum;
|
|
5334
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5509
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
|
|
5335
5510
|
/**
|
|
5336
5511
|
* @description get pre ipo company spv by id
|
|
5337
5512
|
* @tags PreIPOCompanies
|
|
@@ -5345,7 +5520,7 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
5345
5520
|
getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
|
|
5346
5521
|
/** default is false, if true documents will be included in the response */
|
|
5347
5522
|
include_documents?: boolean;
|
|
5348
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5523
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
|
|
5349
5524
|
/**
|
|
5350
5525
|
* @description get pre ipo company spvs
|
|
5351
5526
|
* @tags PreIPOCompanies
|
|
@@ -5389,6 +5564,47 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
5389
5564
|
include_documents?: boolean;
|
|
5390
5565
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
|
|
5391
5566
|
}
|
|
5567
|
+
export class Ipos<HandleError extends boolean = boolean> {
|
|
5568
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5569
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5570
|
+
/**
|
|
5571
|
+
* @description get recent ipos info
|
|
5572
|
+
* @tags Ipos
|
|
5573
|
+
* @name PostRecent
|
|
5574
|
+
* @summary get recent ipos info
|
|
5575
|
+
* @request POST:/ipos/recent
|
|
5576
|
+
* @secure
|
|
5577
|
+
*/
|
|
5578
|
+
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5579
|
+
/**
|
|
5580
|
+
* @description get upcoming ipos info
|
|
5581
|
+
* @tags Ipos
|
|
5582
|
+
* @name GetUpcoming
|
|
5583
|
+
* @summary get upcoming ipos info
|
|
5584
|
+
* @request GET:/ipos/upcoming
|
|
5585
|
+
* @secure
|
|
5586
|
+
*/
|
|
5587
|
+
getUpcoming(query: {
|
|
5588
|
+
/** how many records to return. Max value is 50 */
|
|
5589
|
+
limit: number;
|
|
5590
|
+
/** how many records to skip */
|
|
5591
|
+
offset: number;
|
|
5592
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5593
|
+
/**
|
|
5594
|
+
* @description get ipo info by symbol
|
|
5595
|
+
* @tags Ipos
|
|
5596
|
+
* @name GetIpos
|
|
5597
|
+
* @summary get ipo info by symbol
|
|
5598
|
+
* @request GET:/ipos/{symbol}
|
|
5599
|
+
* @secure
|
|
5600
|
+
*/
|
|
5601
|
+
getIpos(symbol: string, query?: {
|
|
5602
|
+
/** load quotes */
|
|
5603
|
+
load_quotes?: boolean;
|
|
5604
|
+
/** statuses */
|
|
5605
|
+
statuses?: string[];
|
|
5606
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
|
|
5607
|
+
}
|
|
5392
5608
|
export class Logos<HandleError extends boolean = boolean> {
|
|
5393
5609
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5394
5610
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5489,48 +5705,7 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5489
5705
|
symbol: string;
|
|
5490
5706
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
|
|
5491
5707
|
}
|
|
5492
|
-
export class
|
|
5493
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5494
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5495
|
-
/**
|
|
5496
|
-
* @description get recent ipos info
|
|
5497
|
-
* @tags Ipos
|
|
5498
|
-
* @name PostRecent
|
|
5499
|
-
* @summary get recent ipos info
|
|
5500
|
-
* @request POST:/ipos/recent
|
|
5501
|
-
* @secure
|
|
5502
|
-
*/
|
|
5503
|
-
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5504
|
-
/**
|
|
5505
|
-
* @description get upcoming ipos info
|
|
5506
|
-
* @tags Ipos
|
|
5507
|
-
* @name GetUpcoming
|
|
5508
|
-
* @summary get upcoming ipos info
|
|
5509
|
-
* @request GET:/ipos/upcoming
|
|
5510
|
-
* @secure
|
|
5511
|
-
*/
|
|
5512
|
-
getUpcoming(query: {
|
|
5513
|
-
/** how many records to return. Max value is 50 */
|
|
5514
|
-
limit: number;
|
|
5515
|
-
/** how many records to skip */
|
|
5516
|
-
offset: number;
|
|
5517
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5518
|
-
/**
|
|
5519
|
-
* @description get ipo info by symbol
|
|
5520
|
-
* @tags Ipos
|
|
5521
|
-
* @name GetIpos
|
|
5522
|
-
* @summary get ipo info by symbol
|
|
5523
|
-
* @request GET:/ipos/{symbol}
|
|
5524
|
-
* @secure
|
|
5525
|
-
*/
|
|
5526
|
-
getIpos(symbol: string, query?: {
|
|
5527
|
-
/** load quotes */
|
|
5528
|
-
load_quotes?: boolean;
|
|
5529
|
-
/** statuses */
|
|
5530
|
-
statuses?: string[];
|
|
5531
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
|
|
5532
|
-
}
|
|
5533
|
-
export class MarketDates<HandleError extends boolean = boolean> {
|
|
5708
|
+
export class MarketDates<HandleError extends boolean = boolean> {
|
|
5534
5709
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5535
5710
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5536
5711
|
/**
|
|
@@ -5555,6 +5730,28 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
5555
5730
|
market: string;
|
|
5556
5731
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
5557
5732
|
}
|
|
5733
|
+
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
5734
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5735
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5736
|
+
/**
|
|
5737
|
+
* @description Returns calculated matrix
|
|
5738
|
+
* @tags OptionGreeks
|
|
5739
|
+
* @name OgCalculateMatrix
|
|
5740
|
+
* @summary Calculate matrix
|
|
5741
|
+
* @request POST:/og/calculate-matrix
|
|
5742
|
+
* @secure
|
|
5743
|
+
*/
|
|
5744
|
+
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
5745
|
+
/**
|
|
5746
|
+
* @description Returns calculated params
|
|
5747
|
+
* @tags OptionGreeks
|
|
5748
|
+
* @name OgCalculateParams
|
|
5749
|
+
* @summary Calculate params
|
|
5750
|
+
* @request POST:/og/calculate-params
|
|
5751
|
+
* @secure
|
|
5752
|
+
*/
|
|
5753
|
+
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
5754
|
+
}
|
|
5558
5755
|
export class News<HandleError extends boolean = boolean> {
|
|
5559
5756
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5560
5757
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5745,6 +5942,203 @@ export class AlphaTools<HandleError extends boolean = boolean> {
|
|
|
5745
5942
|
*/
|
|
5746
5943
|
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
5747
5944
|
}
|
|
5945
|
+
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
5946
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5947
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5948
|
+
/**
|
|
5949
|
+
* @description get usage date per branch for a period
|
|
5950
|
+
* @tags UsageTracking
|
|
5951
|
+
* @name GetUsageData
|
|
5952
|
+
* @summary get insight usage data
|
|
5953
|
+
* @request POST:/tracking/usage
|
|
5954
|
+
* @secure
|
|
5955
|
+
*/
|
|
5956
|
+
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
5957
|
+
}
|
|
5958
|
+
export class Passport<HandleError extends boolean = boolean> {
|
|
5959
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5960
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5961
|
+
/**
|
|
5962
|
+
* @description Returns article by id
|
|
5963
|
+
* @tags Passport
|
|
5964
|
+
* @name PassportArticleById
|
|
5965
|
+
* @summary Get article by id
|
|
5966
|
+
* @request POST:/passport/article-by-id
|
|
5967
|
+
* @secure
|
|
5968
|
+
*/
|
|
5969
|
+
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
5970
|
+
/**
|
|
5971
|
+
* @description Returns articles
|
|
5972
|
+
* @tags Passport
|
|
5973
|
+
* @name PassportArticles
|
|
5974
|
+
* @summary Get articles
|
|
5975
|
+
* @request POST:/passport/articles
|
|
5976
|
+
* @secure
|
|
5977
|
+
*/
|
|
5978
|
+
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5979
|
+
/**
|
|
5980
|
+
* @description Returns author profile
|
|
5981
|
+
* @tags Passport
|
|
5982
|
+
* @name PassportAuthorProfile
|
|
5983
|
+
* @summary Get author profile
|
|
5984
|
+
* @request POST:/passport/author-profile
|
|
5985
|
+
* @secure
|
|
5986
|
+
*/
|
|
5987
|
+
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
5988
|
+
/**
|
|
5989
|
+
* @description Returns most popular tags
|
|
5990
|
+
* @tags Passport
|
|
5991
|
+
* @name PassportMostPopularTags
|
|
5992
|
+
* @summary Get most popular tags
|
|
5993
|
+
* @request POST:/passport/most-popular-tags
|
|
5994
|
+
* @secure
|
|
5995
|
+
*/
|
|
5996
|
+
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
5997
|
+
/**
|
|
5998
|
+
* @description Returns news feed
|
|
5999
|
+
* @tags Passport
|
|
6000
|
+
* @name PassportNewsFeed
|
|
6001
|
+
* @summary Get news feed
|
|
6002
|
+
* @request POST:/passport/newsfeed
|
|
6003
|
+
* @secure
|
|
6004
|
+
*/
|
|
6005
|
+
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
|
|
6006
|
+
/**
|
|
6007
|
+
* @description Returns article by parameters
|
|
6008
|
+
* @tags Passport
|
|
6009
|
+
* @name PassportSearchArticle
|
|
6010
|
+
* @summary Search article by parameters
|
|
6011
|
+
* @request POST:/passport/search-article
|
|
6012
|
+
* @secure
|
|
6013
|
+
*/
|
|
6014
|
+
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
6015
|
+
}
|
|
6016
|
+
export class Public<HandleError extends boolean = boolean> {
|
|
6017
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6018
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6019
|
+
/**
|
|
6020
|
+
* @description Calculate estimated returns for selected symbols. Uses split adjusted prices
|
|
6021
|
+
* @tags Public
|
|
6022
|
+
* @name CalculateEstimatedReturns
|
|
6023
|
+
* @summary Calculate Estimated Returns
|
|
6024
|
+
* @request GET:/public/estimated-returns
|
|
6025
|
+
* @secure
|
|
6026
|
+
*/
|
|
6027
|
+
calculateEstimatedReturns(query: {
|
|
6028
|
+
/** Single symbol */
|
|
6029
|
+
symbol: string;
|
|
6030
|
+
/** Non-zero amount */
|
|
6031
|
+
amount: number;
|
|
6032
|
+
/** Start date for calculations */
|
|
6033
|
+
start_date: string;
|
|
6034
|
+
/** End date for calculations */
|
|
6035
|
+
end_date: string;
|
|
6036
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
6037
|
+
/**
|
|
6038
|
+
* @description Returns an expert forecast
|
|
6039
|
+
* @tags Public
|
|
6040
|
+
* @name ExpertForecast
|
|
6041
|
+
* @summary Expert forecast
|
|
6042
|
+
* @request GET:/public/expert-forecast
|
|
6043
|
+
* @secure
|
|
6044
|
+
*/
|
|
6045
|
+
expertForecast(query: {
|
|
6046
|
+
/** Comma separated symbols */
|
|
6047
|
+
symbols: string;
|
|
6048
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
6049
|
+
/**
|
|
6050
|
+
* @description get fundamentals by symbol data
|
|
6051
|
+
* @tags Public
|
|
6052
|
+
* @name GetPublicFundamentalsBySymbolData
|
|
6053
|
+
* @summary get fundamentals by symbol data
|
|
6054
|
+
* @request GET:/public/fundamentals/{symbol}
|
|
6055
|
+
* @secure
|
|
6056
|
+
*/
|
|
6057
|
+
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
6058
|
+
/** Annual or quarterly */
|
|
6059
|
+
mode: string;
|
|
6060
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
6061
|
+
/**
|
|
6062
|
+
* @description Daily price history
|
|
6063
|
+
* @tags Public
|
|
6064
|
+
* @name DailyPriceHistory
|
|
6065
|
+
* @summary Daily price history
|
|
6066
|
+
* @request GET:/public/price-history/daily
|
|
6067
|
+
* @secure
|
|
6068
|
+
*/
|
|
6069
|
+
dailyPriceHistory(query: {
|
|
6070
|
+
/** Single symbol */
|
|
6071
|
+
symbol: string;
|
|
6072
|
+
/** Target date */
|
|
6073
|
+
date: string;
|
|
6074
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
6075
|
+
/**
|
|
6076
|
+
* @description Public quote profile
|
|
6077
|
+
* @tags Public
|
|
6078
|
+
* @name PublicQuoteProfile
|
|
6079
|
+
* @summary Public quote profile
|
|
6080
|
+
* @request GET:/public/quote-profile/{symbol}
|
|
6081
|
+
* @secure
|
|
6082
|
+
*/
|
|
6083
|
+
publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
|
|
6084
|
+
/**
|
|
6085
|
+
* @description get ratios by symbol data
|
|
6086
|
+
* @tags Public
|
|
6087
|
+
* @name GetPublicRatiosBySymbolData
|
|
6088
|
+
* @summary get ratios by symbol data
|
|
6089
|
+
* @request GET:/public/ratios/{symbol}
|
|
6090
|
+
* @secure
|
|
6091
|
+
*/
|
|
6092
|
+
getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
|
|
6093
|
+
/**
|
|
6094
|
+
* @description find a symbol by name or description
|
|
6095
|
+
* @tags Public
|
|
6096
|
+
* @name QuoteFundamentalsSearch
|
|
6097
|
+
* @summary find a symbol by name or description
|
|
6098
|
+
* @request GET:/public/symbol-search
|
|
6099
|
+
* @secure
|
|
6100
|
+
*/
|
|
6101
|
+
quoteFundamentalsSearch(query: {
|
|
6102
|
+
/** Search query */
|
|
6103
|
+
search_query: string;
|
|
6104
|
+
/** how many records to return. Max value is 50 */
|
|
6105
|
+
limit: number;
|
|
6106
|
+
/** how many records to skip */
|
|
6107
|
+
offset: number;
|
|
6108
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
6109
|
+
/**
|
|
6110
|
+
* @description Get top gainers
|
|
6111
|
+
* @tags Public
|
|
6112
|
+
* @name TopGainers
|
|
6113
|
+
* @summary Top Gainers
|
|
6114
|
+
* @request GET:/public/top-gainers
|
|
6115
|
+
* @secure
|
|
6116
|
+
*/
|
|
6117
|
+
topGainers(query: {
|
|
6118
|
+
/** sort direction - asc or desc */
|
|
6119
|
+
order_direction?: string;
|
|
6120
|
+
/** how many records to return. Max value is 50 */
|
|
6121
|
+
limit: number;
|
|
6122
|
+
/** how many records to skip */
|
|
6123
|
+
offset: number;
|
|
6124
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6125
|
+
/**
|
|
6126
|
+
* @description Get top stocks
|
|
6127
|
+
* @tags Public
|
|
6128
|
+
* @name TopStocks
|
|
6129
|
+
* @summary Top Stocks
|
|
6130
|
+
* @request GET:/public/top-stocks
|
|
6131
|
+
* @secure
|
|
6132
|
+
*/
|
|
6133
|
+
topStocks(query: {
|
|
6134
|
+
/** EQUITY|ETF|CRYPTO */
|
|
6135
|
+
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
6136
|
+
/** how many records to return. Max value is 50 */
|
|
6137
|
+
limit: number;
|
|
6138
|
+
/** how many records to skip */
|
|
6139
|
+
offset: number;
|
|
6140
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6141
|
+
}
|
|
5748
6142
|
export class TipRank<HandleError extends boolean = boolean> {
|
|
5749
6143
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5750
6144
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -6111,225 +6505,6 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6111
6505
|
Authorization?: string;
|
|
6112
6506
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
|
|
6113
6507
|
}
|
|
6114
|
-
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
6115
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6116
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6117
|
-
/**
|
|
6118
|
-
* @description get usage date per branch for a period
|
|
6119
|
-
* @tags UsageTracking
|
|
6120
|
-
* @name GetUsageData
|
|
6121
|
-
* @summary get insight usage data
|
|
6122
|
-
* @request POST:/tracking/usage
|
|
6123
|
-
* @secure
|
|
6124
|
-
*/
|
|
6125
|
-
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
6126
|
-
}
|
|
6127
|
-
export class Passport<HandleError extends boolean = boolean> {
|
|
6128
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6129
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6130
|
-
/**
|
|
6131
|
-
* @description Returns article by id
|
|
6132
|
-
* @tags Passport
|
|
6133
|
-
* @name PassportArticleById
|
|
6134
|
-
* @summary Get article by id
|
|
6135
|
-
* @request POST:/passport/article-by-id
|
|
6136
|
-
* @secure
|
|
6137
|
-
*/
|
|
6138
|
-
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
6139
|
-
/**
|
|
6140
|
-
* @description Returns articles
|
|
6141
|
-
* @tags Passport
|
|
6142
|
-
* @name PassportArticles
|
|
6143
|
-
* @summary Get articles
|
|
6144
|
-
* @request POST:/passport/articles
|
|
6145
|
-
* @secure
|
|
6146
|
-
*/
|
|
6147
|
-
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
6148
|
-
/**
|
|
6149
|
-
* @description Returns author profile
|
|
6150
|
-
* @tags Passport
|
|
6151
|
-
* @name PassportAuthorProfile
|
|
6152
|
-
* @summary Get author profile
|
|
6153
|
-
* @request POST:/passport/author-profile
|
|
6154
|
-
* @secure
|
|
6155
|
-
*/
|
|
6156
|
-
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
6157
|
-
/**
|
|
6158
|
-
* @description Returns most popular tags
|
|
6159
|
-
* @tags Passport
|
|
6160
|
-
* @name PassportMostPopularTags
|
|
6161
|
-
* @summary Get most popular tags
|
|
6162
|
-
* @request POST:/passport/most-popular-tags
|
|
6163
|
-
* @secure
|
|
6164
|
-
*/
|
|
6165
|
-
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
6166
|
-
/**
|
|
6167
|
-
* @description Returns news feed
|
|
6168
|
-
* @tags Passport
|
|
6169
|
-
* @name PassportNewsFeed
|
|
6170
|
-
* @summary Get news feed
|
|
6171
|
-
* @request POST:/passport/newsfeed
|
|
6172
|
-
* @secure
|
|
6173
|
-
*/
|
|
6174
|
-
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
|
|
6175
|
-
/**
|
|
6176
|
-
* @description Returns article by parameters
|
|
6177
|
-
* @tags Passport
|
|
6178
|
-
* @name PassportSearchArticle
|
|
6179
|
-
* @summary Search article by parameters
|
|
6180
|
-
* @request POST:/passport/search-article
|
|
6181
|
-
* @secure
|
|
6182
|
-
*/
|
|
6183
|
-
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
6184
|
-
}
|
|
6185
|
-
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
6186
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6187
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6188
|
-
/**
|
|
6189
|
-
* @description Returns calculated matrix
|
|
6190
|
-
* @tags OptionGreeks
|
|
6191
|
-
* @name OgCalculateMatrix
|
|
6192
|
-
* @summary Calculate matrix
|
|
6193
|
-
* @request POST:/og/calculate-matrix
|
|
6194
|
-
* @secure
|
|
6195
|
-
*/
|
|
6196
|
-
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
6197
|
-
/**
|
|
6198
|
-
* @description Returns calculated params
|
|
6199
|
-
* @tags OptionGreeks
|
|
6200
|
-
* @name OgCalculateParams
|
|
6201
|
-
* @summary Calculate params
|
|
6202
|
-
* @request POST:/og/calculate-params
|
|
6203
|
-
* @secure
|
|
6204
|
-
*/
|
|
6205
|
-
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
6206
|
-
}
|
|
6207
|
-
export class Public<HandleError extends boolean = boolean> {
|
|
6208
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6209
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6210
|
-
/**
|
|
6211
|
-
* @description Calculate estimated returns for selected symbols. Uses split adjusted prices
|
|
6212
|
-
* @tags Public
|
|
6213
|
-
* @name CalculateEstimatedReturns
|
|
6214
|
-
* @summary Calculate Estimated Returns
|
|
6215
|
-
* @request GET:/public/estimated-returns
|
|
6216
|
-
* @secure
|
|
6217
|
-
*/
|
|
6218
|
-
calculateEstimatedReturns(query: {
|
|
6219
|
-
/** Single symbol */
|
|
6220
|
-
symbol: string;
|
|
6221
|
-
/** Non-zero amount */
|
|
6222
|
-
amount: number;
|
|
6223
|
-
/** Start date for calculations */
|
|
6224
|
-
start_date: string;
|
|
6225
|
-
/** End date for calculations */
|
|
6226
|
-
end_date: string;
|
|
6227
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
6228
|
-
/**
|
|
6229
|
-
* @description Returns an expert forecast
|
|
6230
|
-
* @tags Public
|
|
6231
|
-
* @name ExpertForecast
|
|
6232
|
-
* @summary Expert forecast
|
|
6233
|
-
* @request GET:/public/expert-forecast
|
|
6234
|
-
* @secure
|
|
6235
|
-
*/
|
|
6236
|
-
expertForecast(query: {
|
|
6237
|
-
/** Comma separated symbols */
|
|
6238
|
-
symbols: string;
|
|
6239
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
6240
|
-
/**
|
|
6241
|
-
* @description get fundamentals by symbol data
|
|
6242
|
-
* @tags Public
|
|
6243
|
-
* @name GetPublicFundamentalsBySymbolData
|
|
6244
|
-
* @summary get fundamentals by symbol data
|
|
6245
|
-
* @request GET:/public/fundamentals/{symbol}
|
|
6246
|
-
* @secure
|
|
6247
|
-
*/
|
|
6248
|
-
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
6249
|
-
/** Annual or quarterly */
|
|
6250
|
-
mode: string;
|
|
6251
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
6252
|
-
/**
|
|
6253
|
-
* @description Daily price history
|
|
6254
|
-
* @tags Public
|
|
6255
|
-
* @name DailyPriceHistory
|
|
6256
|
-
* @summary Daily price history
|
|
6257
|
-
* @request GET:/public/price-history/daily
|
|
6258
|
-
* @secure
|
|
6259
|
-
*/
|
|
6260
|
-
dailyPriceHistory(query: {
|
|
6261
|
-
/** Single symbol */
|
|
6262
|
-
symbol: string;
|
|
6263
|
-
/** Target date */
|
|
6264
|
-
date: string;
|
|
6265
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
6266
|
-
/**
|
|
6267
|
-
* @description Public quote profile
|
|
6268
|
-
* @tags Public
|
|
6269
|
-
* @name PublicQuoteProfile
|
|
6270
|
-
* @summary Public quote profile
|
|
6271
|
-
* @request GET:/public/quote-profile/{symbol}
|
|
6272
|
-
* @secure
|
|
6273
|
-
*/
|
|
6274
|
-
publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
|
|
6275
|
-
/**
|
|
6276
|
-
* @description get ratios by symbol data
|
|
6277
|
-
* @tags Public
|
|
6278
|
-
* @name GetPublicRatiosBySymbolData
|
|
6279
|
-
* @summary get ratios by symbol data
|
|
6280
|
-
* @request GET:/public/ratios/{symbol}
|
|
6281
|
-
* @secure
|
|
6282
|
-
*/
|
|
6283
|
-
getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
|
|
6284
|
-
/**
|
|
6285
|
-
* @description find a symbol by name or description
|
|
6286
|
-
* @tags Public
|
|
6287
|
-
* @name QuoteFundamentalsSearch
|
|
6288
|
-
* @summary find a symbol by name or description
|
|
6289
|
-
* @request GET:/public/symbol-search
|
|
6290
|
-
* @secure
|
|
6291
|
-
*/
|
|
6292
|
-
quoteFundamentalsSearch(query: {
|
|
6293
|
-
/** Search query */
|
|
6294
|
-
search_query: string;
|
|
6295
|
-
/** how many records to return. Max value is 50 */
|
|
6296
|
-
limit: number;
|
|
6297
|
-
/** how many records to skip */
|
|
6298
|
-
offset: number;
|
|
6299
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
6300
|
-
/**
|
|
6301
|
-
* @description Get top gainers
|
|
6302
|
-
* @tags Public
|
|
6303
|
-
* @name TopGainers
|
|
6304
|
-
* @summary Top Gainers
|
|
6305
|
-
* @request GET:/public/top-gainers
|
|
6306
|
-
* @secure
|
|
6307
|
-
*/
|
|
6308
|
-
topGainers(query: {
|
|
6309
|
-
/** sort direction - asc or desc */
|
|
6310
|
-
order_direction?: string;
|
|
6311
|
-
/** how many records to return. Max value is 50 */
|
|
6312
|
-
limit: number;
|
|
6313
|
-
/** how many records to skip */
|
|
6314
|
-
offset: number;
|
|
6315
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6316
|
-
/**
|
|
6317
|
-
* @description Get top stocks
|
|
6318
|
-
* @tags Public
|
|
6319
|
-
* @name TopStocks
|
|
6320
|
-
* @summary Top Stocks
|
|
6321
|
-
* @request GET:/public/top-stocks
|
|
6322
|
-
* @secure
|
|
6323
|
-
*/
|
|
6324
|
-
topStocks(query: {
|
|
6325
|
-
/** EQUITY|ETF|CRYPTO */
|
|
6326
|
-
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
6327
|
-
/** how many records to return. Max value is 50 */
|
|
6328
|
-
limit: number;
|
|
6329
|
-
/** how many records to skip */
|
|
6330
|
-
offset: number;
|
|
6331
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6332
|
-
}
|
|
6333
6508
|
export interface InsightBeforeAndAfterV2 {
|
|
6334
6509
|
after?: string;
|
|
6335
6510
|
before?: string;
|
|
@@ -6555,6 +6730,19 @@ export enum InsightOrderingDirectionEnumV2 {
|
|
|
6555
6730
|
Asc = "asc",
|
|
6556
6731
|
Desc = "desc"
|
|
6557
6732
|
}
|
|
6733
|
+
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
6734
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6735
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6736
|
+
/**
|
|
6737
|
+
* @description get fixed income entries
|
|
6738
|
+
* @tags FixedIncome
|
|
6739
|
+
* @name GetFixedIncomeEntries
|
|
6740
|
+
* @summary get fixed income entries
|
|
6741
|
+
* @request POST:/fixed-income
|
|
6742
|
+
* @secure
|
|
6743
|
+
*/
|
|
6744
|
+
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
6745
|
+
}
|
|
6558
6746
|
export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
6559
6747
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6560
6748
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -6577,19 +6765,6 @@ export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
|
6577
6765
|
*/
|
|
6578
6766
|
getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
6579
6767
|
}
|
|
6580
|
-
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
6581
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6582
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6583
|
-
/**
|
|
6584
|
-
* @description get fixed income entries
|
|
6585
|
-
* @tags FixedIncome
|
|
6586
|
-
* @name GetFixedIncomeEntries
|
|
6587
|
-
* @summary get fixed income entries
|
|
6588
|
-
* @request POST:/fixed-income
|
|
6589
|
-
* @secure
|
|
6590
|
-
*/
|
|
6591
|
-
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
6592
|
-
}
|
|
6593
6768
|
export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
6594
6769
|
readonly config: JwtClientConfig<HandleError>;
|
|
6595
6770
|
alphaTools: AlphaTools<HandleError>;
|