@orbis-systems/orbis-api-clients 0.7.10 → 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 +39 -39
- 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 +313 -304
- 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 +774 -521
- 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 +1501 -1501
- 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 +452 -452
- 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 +563 -563
- 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;
|
|
@@ -4277,6 +4452,42 @@ export enum InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum {
|
|
|
4277
4452
|
CONNECTED = "CONNECTED"
|
|
4278
4453
|
}
|
|
4279
4454
|
/** search by monark stage */
|
|
4455
|
+
export enum InsightGetInvestorParamsMonarkStageEnum {
|
|
4456
|
+
DRAFT = "DRAFT",
|
|
4457
|
+
WAITING_MONARK_REVIEW = "WAITING_MONARK_REVIEW",
|
|
4458
|
+
FUND_ADMIN_REVIEW = "FUND_ADMIN_REVIEW",
|
|
4459
|
+
FUND_ADMIN_APPROVED = "FUND_ADMIN_APPROVED",
|
|
4460
|
+
PRIMARY_FUNDRAISE = "PRIMARY_FUNDRAISE",
|
|
4461
|
+
MONARK_DILIGENCE = "MONARK_DILIGENCE",
|
|
4462
|
+
PRE_CLOSE_REVIEW = "PRE_CLOSE_REVIEW",
|
|
4463
|
+
CLOSE_REQUESTED = "CLOSE_REQUESTED",
|
|
4464
|
+
CLOSE_IN_PROCESS = "CLOSE_IN_PROCESS",
|
|
4465
|
+
FUNDS_SENT_TO_TARGET = "FUNDS_SENT_TO_TARGET",
|
|
4466
|
+
CLOSED = "CLOSED",
|
|
4467
|
+
REGULATORY_HOLD_PERIOD = "REGULATORY_HOLD_PERIOD",
|
|
4468
|
+
ACTIVELY_TRADING = "ACTIVELY_TRADING",
|
|
4469
|
+
CLOSE_FAILED = "CLOSE_FAILED",
|
|
4470
|
+
HALTED = "HALTED",
|
|
4471
|
+
LIQUIDATION = "LIQUIDATION",
|
|
4472
|
+
DISSOLVED = "DISSOLVED"
|
|
4473
|
+
}
|
|
4474
|
+
/** sort direction */
|
|
4475
|
+
export enum InsightGetInvestorParamsSortOrderEnum {
|
|
4476
|
+
Ascending = "Ascending",
|
|
4477
|
+
Descending = "Descending"
|
|
4478
|
+
}
|
|
4479
|
+
/** sort field */
|
|
4480
|
+
export enum InsightGetInvestorParamsSortByEnum {
|
|
4481
|
+
UpdatedAt = "UpdatedAt",
|
|
4482
|
+
CreatedAt = "CreatedAt",
|
|
4483
|
+
Name = "Name",
|
|
4484
|
+
RemainingDollarAllocation = "RemainingDollarAllocation",
|
|
4485
|
+
RemainingShareAllocation = "RemainingShareAllocation",
|
|
4486
|
+
NumberOfSeatsRemaining = "NumberOfSeatsRemaining",
|
|
4487
|
+
Valuation = "Valuation",
|
|
4488
|
+
MinCommitmentAmount = "MinCommitmentAmount"
|
|
4489
|
+
}
|
|
4490
|
+
/** search by monark stage */
|
|
4280
4491
|
export enum InsightGetPreIpoCompanySpvsParamsMonarkStageEnum {
|
|
4281
4492
|
DRAFT = "DRAFT",
|
|
4282
4493
|
WAITING_MONARK_REVIEW = "WAITING_MONARK_REVIEW",
|
|
@@ -4338,6 +4549,45 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
|
|
|
4338
4549
|
Date = "date",
|
|
4339
4550
|
Rank = "rank"
|
|
4340
4551
|
}
|
|
4552
|
+
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4553
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4554
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4555
|
+
/**
|
|
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
|
|
4561
|
+
* @secure
|
|
4562
|
+
*/
|
|
4563
|
+
getCompanyProfile(query: {
|
|
4564
|
+
/** Company symbol */
|
|
4565
|
+
symbol: string;
|
|
4566
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
|
|
4567
|
+
/**
|
|
4568
|
+
* @description get combined profile, equities and funds
|
|
4569
|
+
* @tags CompanyProfile
|
|
4570
|
+
* @name GetCombinedProfile
|
|
4571
|
+
* @summary get company profile
|
|
4572
|
+
* @request GET:/quote-profile
|
|
4573
|
+
* @secure
|
|
4574
|
+
*/
|
|
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>>;
|
|
4581
|
+
/**
|
|
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
|
|
4587
|
+
* @secure
|
|
4588
|
+
*/
|
|
4589
|
+
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
4590
|
+
}
|
|
4341
4591
|
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
4342
4592
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4343
4593
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4520,45 +4770,6 @@ export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
|
4520
4770
|
id: string;
|
|
4521
4771
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4522
4772
|
}
|
|
4523
|
-
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4524
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4525
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4526
|
-
/**
|
|
4527
|
-
* @description get company profile, industries classification and closest earning release
|
|
4528
|
-
* @tags CompanyProfile
|
|
4529
|
-
* @name GetCompanyProfile
|
|
4530
|
-
* @summary get company profile
|
|
4531
|
-
* @request GET:/company-profile
|
|
4532
|
-
* @secure
|
|
4533
|
-
*/
|
|
4534
|
-
getCompanyProfile(query: {
|
|
4535
|
-
/** Company symbol */
|
|
4536
|
-
symbol: string;
|
|
4537
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
|
|
4538
|
-
/**
|
|
4539
|
-
* @description get combined profile, equities and funds
|
|
4540
|
-
* @tags CompanyProfile
|
|
4541
|
-
* @name GetCombinedProfile
|
|
4542
|
-
* @summary get company profile
|
|
4543
|
-
* @request GET:/quote-profile
|
|
4544
|
-
* @secure
|
|
4545
|
-
*/
|
|
4546
|
-
getCombinedProfile(query: {
|
|
4547
|
-
/** Company symbol */
|
|
4548
|
-
symbol: string;
|
|
4549
|
-
/** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
|
|
4550
|
-
symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
|
|
4551
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
|
|
4552
|
-
/**
|
|
4553
|
-
* @description sort input array of symbols by type
|
|
4554
|
-
* @tags CompanyProfile
|
|
4555
|
-
* @name GetSymbolsPerSymbolType
|
|
4556
|
-
* @summary sort input array of symbols by type
|
|
4557
|
-
* @request POST:/symbols-per-type
|
|
4558
|
-
* @secure
|
|
4559
|
-
*/
|
|
4560
|
-
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
4561
|
-
}
|
|
4562
4773
|
export class CustomLists<HandleError extends boolean = boolean> {
|
|
4563
4774
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4564
4775
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4731,101 +4942,300 @@ export class Earnings<HandleError extends boolean = boolean> {
|
|
|
4731
4942
|
*/
|
|
4732
4943
|
getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
|
|
4733
4944
|
}
|
|
4734
|
-
export class
|
|
4945
|
+
export class FixedIncome<HandleError extends boolean = boolean> {
|
|
4735
4946
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4736
4947
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4737
4948
|
/**
|
|
4738
|
-
* @description
|
|
4739
|
-
* @tags
|
|
4740
|
-
* @name
|
|
4741
|
-
* @summary
|
|
4742
|
-
* @request
|
|
4743
|
-
* @secure
|
|
4744
|
-
*/
|
|
4745
|
-
stockMarketHeatmap(query?: {
|
|
4746
|
-
/** Name of symbol list to fetch details for. Empty is default */
|
|
4747
|
-
heatmap_name?: string;
|
|
4748
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
4749
|
-
/**
|
|
4750
|
-
* @description create or update heat map preset
|
|
4751
|
-
* @tags StockScreener
|
|
4752
|
-
* @name CreateStockMarketHeatmapPreset
|
|
4753
|
-
* @summary create or update heat map preset
|
|
4754
|
-
* @request POST:/heatmaps
|
|
4755
|
-
* @secure
|
|
4756
|
-
*/
|
|
4757
|
-
createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4758
|
-
/**
|
|
4759
|
-
* @description Sector and Industry Group performance
|
|
4760
|
-
* @tags StockScreener
|
|
4761
|
-
* @name IndustriesPerformance
|
|
4762
|
-
* @summary get industries performance
|
|
4763
|
-
* @request POST:/industries-performance
|
|
4949
|
+
* @description get fixed income entries
|
|
4950
|
+
* @tags FixedIncome
|
|
4951
|
+
* @name GetFixedIncomeEntries
|
|
4952
|
+
* @summary get fixed income entries
|
|
4953
|
+
* @request POST:/fixed-income
|
|
4764
4954
|
* @secure
|
|
4765
4955
|
*/
|
|
4766
|
-
|
|
4956
|
+
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponse, HandleError>>;
|
|
4767
4957
|
/**
|
|
4768
|
-
* @description
|
|
4769
|
-
* @tags
|
|
4770
|
-
* @name
|
|
4771
|
-
* @summary
|
|
4772
|
-
* @request POST:/
|
|
4958
|
+
* @description Returns historical fixed income
|
|
4959
|
+
* @tags FixedIncome
|
|
4960
|
+
* @name FixedIncomeHistorical
|
|
4961
|
+
* @summary Get historical fixed income
|
|
4962
|
+
* @request POST:/fixed-income/historical
|
|
4773
4963
|
* @secure
|
|
4774
4964
|
*/
|
|
4775
|
-
|
|
4776
|
-
/** Authorization */
|
|
4777
|
-
Authorization?: string;
|
|
4778
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
4965
|
+
fixedIncomeHistorical(filter: InsightGetFixedIncomeHistoricalRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeHistoricalResponse, HandleError>>;
|
|
4779
4966
|
/**
|
|
4780
|
-
* @description get
|
|
4781
|
-
* @tags
|
|
4782
|
-
* @name
|
|
4783
|
-
* @summary get
|
|
4784
|
-
* @request GET:/
|
|
4967
|
+
* @description get fixed-income presets
|
|
4968
|
+
* @tags FixedIncome
|
|
4969
|
+
* @name GetFixedIncomePresets
|
|
4970
|
+
* @summary get fixed-income presets
|
|
4971
|
+
* @request GET:/fixed-income/presets
|
|
4785
4972
|
* @secure
|
|
4786
4973
|
*/
|
|
4787
|
-
|
|
4974
|
+
getFixedIncomePresets(query: {
|
|
4788
4975
|
/** how many records to return */
|
|
4789
4976
|
limit: number;
|
|
4790
4977
|
/** how many records to skip */
|
|
4791
4978
|
offset: number;
|
|
4792
4979
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
4793
4980
|
/**
|
|
4794
|
-
* @description update
|
|
4795
|
-
* @tags
|
|
4796
|
-
* @name
|
|
4797
|
-
* @summary update
|
|
4798
|
-
* @request PUT:/
|
|
4981
|
+
* @description update fixed-income preset
|
|
4982
|
+
* @tags FixedIncome
|
|
4983
|
+
* @name UpdateFixedIncomePreset
|
|
4984
|
+
* @summary update fixed-income preset
|
|
4985
|
+
* @request PUT:/fixed-income/presets
|
|
4799
4986
|
* @secure
|
|
4800
4987
|
*/
|
|
4801
|
-
|
|
4988
|
+
updateFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
4802
4989
|
/**
|
|
4803
|
-
* @description create
|
|
4804
|
-
* @tags
|
|
4805
|
-
* @name
|
|
4806
|
-
* @summary create
|
|
4807
|
-
* @request POST:/
|
|
4990
|
+
* @description create fixed-income preset
|
|
4991
|
+
* @tags FixedIncome
|
|
4992
|
+
* @name CreateFixedIncomePreset
|
|
4993
|
+
* @summary create fixed-income preset
|
|
4994
|
+
* @request POST:/fixed-income/presets
|
|
4808
4995
|
* @secure
|
|
4809
4996
|
*/
|
|
4810
|
-
|
|
4997
|
+
createFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
4811
4998
|
/**
|
|
4812
|
-
* @description remove
|
|
4813
|
-
* @tags
|
|
4814
|
-
* @name
|
|
4815
|
-
* @summary remove
|
|
4816
|
-
* @request DELETE:/
|
|
4999
|
+
* @description remove fixed-income preset
|
|
5000
|
+
* @tags FixedIncome
|
|
5001
|
+
* @name RemoveFixedIncomePreset
|
|
5002
|
+
* @summary remove fixed-income preset
|
|
5003
|
+
* @request DELETE:/fixed-income/presets
|
|
4817
5004
|
* @secure
|
|
4818
5005
|
*/
|
|
4819
|
-
|
|
5006
|
+
removeFixedIncomePreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4820
5007
|
/**
|
|
4821
|
-
* @description get
|
|
4822
|
-
* @tags
|
|
4823
|
-
* @name
|
|
4824
|
-
* @summary get
|
|
4825
|
-
* @request
|
|
5008
|
+
* @description get single fixed income entry
|
|
5009
|
+
* @tags FixedIncome
|
|
5010
|
+
* @name GetSingleFixedIncomeEntry
|
|
5011
|
+
* @summary get single fixed income entry
|
|
5012
|
+
* @request GET:/fixed-income/{id}
|
|
4826
5013
|
* @secure
|
|
4827
5014
|
*/
|
|
4828
|
-
|
|
5015
|
+
getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
|
|
5016
|
+
}
|
|
5017
|
+
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
5018
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5019
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5020
|
+
/**
|
|
5021
|
+
* @description get fundamentals by symbol data
|
|
5022
|
+
* @tags Fundamentals
|
|
5023
|
+
* @name GetFundamentalsBySymbolData
|
|
5024
|
+
* @summary get fundamentals by symbol data
|
|
5025
|
+
* @request POST:/fundamentals
|
|
5026
|
+
* @secure
|
|
5027
|
+
*/
|
|
5028
|
+
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5029
|
+
}
|
|
5030
|
+
export class Funds<HandleError extends boolean = boolean> {
|
|
5031
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5032
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5033
|
+
/**
|
|
5034
|
+
* @description get fund details
|
|
5035
|
+
* @tags Funds
|
|
5036
|
+
* @name GetFundDetails
|
|
5037
|
+
* @summary get fund details
|
|
5038
|
+
* @request GET:/funds/details
|
|
5039
|
+
* @secure
|
|
5040
|
+
*/
|
|
5041
|
+
getFundDetails(query: {
|
|
5042
|
+
/** Fund symbol */
|
|
5043
|
+
symbol: string;
|
|
5044
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError>>;
|
|
5045
|
+
/**
|
|
5046
|
+
* @description get funds for holding
|
|
5047
|
+
* @tags Funds
|
|
5048
|
+
* @name GetFundsForHolding
|
|
5049
|
+
* @summary get funds for holding
|
|
5050
|
+
* @request POST:/funds/funds-for-holding
|
|
5051
|
+
* @secure
|
|
5052
|
+
*/
|
|
5053
|
+
getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
|
|
5054
|
+
/** Authorization */
|
|
5055
|
+
Authorization?: string;
|
|
5056
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError>>;
|
|
5057
|
+
/**
|
|
5058
|
+
* @description filter funds by params
|
|
5059
|
+
* @tags Funds
|
|
5060
|
+
* @name FundScreener
|
|
5061
|
+
* @summary filter funds by params
|
|
5062
|
+
* @request POST:/funds/screener
|
|
5063
|
+
* @secure
|
|
5064
|
+
*/
|
|
5065
|
+
fundScreener(filter: InsightFundScreenerRequest, headers?: {
|
|
5066
|
+
/** Authorization */
|
|
5067
|
+
Authorization?: string;
|
|
5068
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
5069
|
+
/**
|
|
5070
|
+
* @description get fund screener filters
|
|
5071
|
+
* @tags Funds
|
|
5072
|
+
* @name GetScreenerFilters
|
|
5073
|
+
* @summary get fund screener filters
|
|
5074
|
+
* @request GET:/funds/screener/filters
|
|
5075
|
+
* @secure
|
|
5076
|
+
*/
|
|
5077
|
+
getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError>>;
|
|
5078
|
+
/**
|
|
5079
|
+
* @description get fund screener presets
|
|
5080
|
+
* @tags Funds
|
|
5081
|
+
* @name GetFundScreenerPresets
|
|
5082
|
+
* @summary get fund screener presets
|
|
5083
|
+
* @request GET:/funds/screener/presets
|
|
5084
|
+
* @secure
|
|
5085
|
+
*/
|
|
5086
|
+
getFundScreenerPresets(query: {
|
|
5087
|
+
/** how many records to return */
|
|
5088
|
+
limit: number;
|
|
5089
|
+
/** how many records to skip */
|
|
5090
|
+
offset: number;
|
|
5091
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
5092
|
+
/**
|
|
5093
|
+
* @description update fund screener preset
|
|
5094
|
+
* @tags Funds
|
|
5095
|
+
* @name UpdateFundScreenerPreset
|
|
5096
|
+
* @summary update fund screener preset
|
|
5097
|
+
* @request PUT:/funds/screener/presets
|
|
5098
|
+
* @secure
|
|
5099
|
+
*/
|
|
5100
|
+
updateFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5101
|
+
/**
|
|
5102
|
+
* @description create fund screener preset
|
|
5103
|
+
* @tags Funds
|
|
5104
|
+
* @name CreateFundScreenerPreset
|
|
5105
|
+
* @summary create fund screener preset
|
|
5106
|
+
* @request POST:/funds/screener/presets
|
|
5107
|
+
* @secure
|
|
5108
|
+
*/
|
|
5109
|
+
createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5110
|
+
/**
|
|
5111
|
+
* @description remove fund screener preset
|
|
5112
|
+
* @tags Funds
|
|
5113
|
+
* @name RemoveFundScreenerPreset
|
|
5114
|
+
* @summary remove fund screener preset
|
|
5115
|
+
* @request DELETE:/funds/screener/presets
|
|
5116
|
+
* @secure
|
|
5117
|
+
*/
|
|
5118
|
+
removeFundScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5119
|
+
/**
|
|
5120
|
+
* @description filter funds by params
|
|
5121
|
+
* @tags Funds
|
|
5122
|
+
* @name FundSectorScreener
|
|
5123
|
+
* @summary filter funds by params
|
|
5124
|
+
* @request POST:/funds/sector-screener
|
|
5125
|
+
* @secure
|
|
5126
|
+
*/
|
|
5127
|
+
fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
|
|
5128
|
+
/** Authorization */
|
|
5129
|
+
Authorization?: string;
|
|
5130
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
5131
|
+
/**
|
|
5132
|
+
* @description get top funds
|
|
5133
|
+
* @tags Funds
|
|
5134
|
+
* @name GetTopFunds
|
|
5135
|
+
* @summary get top funds
|
|
5136
|
+
* @request POST:/funds/top
|
|
5137
|
+
* @secure
|
|
5138
|
+
*/
|
|
5139
|
+
getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
|
|
5140
|
+
/** Authorization */
|
|
5141
|
+
Authorization?: string;
|
|
5142
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
|
|
5143
|
+
}
|
|
5144
|
+
export class StockScreener<HandleError extends boolean = boolean> {
|
|
5145
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5146
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5147
|
+
/**
|
|
5148
|
+
* @description data for visual heat map
|
|
5149
|
+
* @tags StockScreener
|
|
5150
|
+
* @name StockMarketHeatmap
|
|
5151
|
+
* @summary data for visual heat map
|
|
5152
|
+
* @request GET:/heatmaps
|
|
5153
|
+
* @secure
|
|
5154
|
+
*/
|
|
5155
|
+
stockMarketHeatmap(query?: {
|
|
5156
|
+
/** Name of symbol list to fetch details for. Empty is default */
|
|
5157
|
+
heatmap_name?: string;
|
|
5158
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
5159
|
+
/**
|
|
5160
|
+
* @description create or update heat map preset
|
|
5161
|
+
* @tags StockScreener
|
|
5162
|
+
* @name CreateStockMarketHeatmapPreset
|
|
5163
|
+
* @summary create or update heat map preset
|
|
5164
|
+
* @request POST:/heatmaps
|
|
5165
|
+
* @secure
|
|
5166
|
+
*/
|
|
5167
|
+
createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5168
|
+
/**
|
|
5169
|
+
* @description Sector and Industry Group performance
|
|
5170
|
+
* @tags StockScreener
|
|
5171
|
+
* @name IndustriesPerformance
|
|
5172
|
+
* @summary get industries performance
|
|
5173
|
+
* @request POST:/industries-performance
|
|
5174
|
+
* @secure
|
|
5175
|
+
*/
|
|
5176
|
+
industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
|
|
5177
|
+
/**
|
|
5178
|
+
* @description filter stocks by params
|
|
5179
|
+
* @tags StockScreener
|
|
5180
|
+
* @name StockScreener
|
|
5181
|
+
* @summary filter stocks by params
|
|
5182
|
+
* @request POST:/stock-screener
|
|
5183
|
+
* @secure
|
|
5184
|
+
*/
|
|
5185
|
+
stockScreener(filter: InsightStockScreenerV1Request, headers?: {
|
|
5186
|
+
/** Authorization */
|
|
5187
|
+
Authorization?: string;
|
|
5188
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
5189
|
+
/**
|
|
5190
|
+
* @description get screener presets
|
|
5191
|
+
* @tags StockScreener
|
|
5192
|
+
* @name GetScreenerPresets
|
|
5193
|
+
* @summary get screener presets
|
|
5194
|
+
* @request GET:/stock-screener/presets
|
|
5195
|
+
* @secure
|
|
5196
|
+
*/
|
|
5197
|
+
getScreenerPresets(query: {
|
|
5198
|
+
/** how many records to return */
|
|
5199
|
+
limit: number;
|
|
5200
|
+
/** how many records to skip */
|
|
5201
|
+
offset: number;
|
|
5202
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
5203
|
+
/**
|
|
5204
|
+
* @description update screener preset
|
|
5205
|
+
* @tags StockScreener
|
|
5206
|
+
* @name UpdateScreenerPreset
|
|
5207
|
+
* @summary update screener preset
|
|
5208
|
+
* @request PUT:/stock-screener/presets
|
|
5209
|
+
* @secure
|
|
5210
|
+
*/
|
|
5211
|
+
updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5212
|
+
/**
|
|
5213
|
+
* @description create screener preset
|
|
5214
|
+
* @tags StockScreener
|
|
5215
|
+
* @name CreateOrScreenerPreset
|
|
5216
|
+
* @summary create screener preset
|
|
5217
|
+
* @request POST:/stock-screener/presets
|
|
5218
|
+
* @secure
|
|
5219
|
+
*/
|
|
5220
|
+
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5221
|
+
/**
|
|
5222
|
+
* @description remove screener preset
|
|
5223
|
+
* @tags StockScreener
|
|
5224
|
+
* @name RemoveScreenerPreset
|
|
5225
|
+
* @summary remove screener preset
|
|
5226
|
+
* @request DELETE:/stock-screener/presets
|
|
5227
|
+
* @secure
|
|
5228
|
+
*/
|
|
5229
|
+
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5230
|
+
/**
|
|
5231
|
+
* @description get top symbols
|
|
5232
|
+
* @tags StockScreener
|
|
5233
|
+
* @name GetTopSymbols
|
|
5234
|
+
* @summary get top symbols
|
|
5235
|
+
* @request POST:/stock-screener/top
|
|
5236
|
+
* @secure
|
|
5237
|
+
*/
|
|
5238
|
+
getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
4829
5239
|
}
|
|
4830
5240
|
export class Quotes<HandleError extends boolean = boolean> {
|
|
4831
5241
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4883,7 +5293,7 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
4883
5293
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4884
5294
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4885
5295
|
/**
|
|
4886
|
-
* @description Retrieves OHLC (Open, High, Low, Close) market data for a given
|
|
5296
|
+
* @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
|
|
4887
5297
|
* @tags PreIPOCompanies
|
|
4888
5298
|
* @name MonarkOghlcDataForSymbol
|
|
4889
5299
|
* @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
|
|
@@ -5069,6 +5479,48 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
5069
5479
|
* @secure
|
|
5070
5480
|
*/
|
|
5071
5481
|
getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
|
|
5482
|
+
/**
|
|
5483
|
+
* @description get pre ipo company spvs
|
|
5484
|
+
* @tags PreIPOCompanies
|
|
5485
|
+
* @name GetInvestor
|
|
5486
|
+
* @summary get pre ipo company spvs
|
|
5487
|
+
* @request GET:/ipos/pre-ipo-company-spv/investor/{investor_id}
|
|
5488
|
+
* @secure
|
|
5489
|
+
*/
|
|
5490
|
+
getInvestor(investorId: string, query: {
|
|
5491
|
+
/** search by monark stage */
|
|
5492
|
+
monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
|
|
5493
|
+
/** Optional param to filter returned spv's based on the exemptions claimed */
|
|
5494
|
+
exemptions_claimed?: string[];
|
|
5495
|
+
/** Optional param to filter returned spv's based on the name */
|
|
5496
|
+
name_filter?: string;
|
|
5497
|
+
/** investment id */
|
|
5498
|
+
pre_ipo_company_id?: string;
|
|
5499
|
+
/** investment id */
|
|
5500
|
+
pre_ipo_company_investment_id?: string;
|
|
5501
|
+
/** page number */
|
|
5502
|
+
page: number;
|
|
5503
|
+
/** page size */
|
|
5504
|
+
page_size: number;
|
|
5505
|
+
/** sort direction */
|
|
5506
|
+
sort_order?: InsightGetInvestorParamsSortOrderEnum;
|
|
5507
|
+
/** sort field */
|
|
5508
|
+
sort_by?: InsightGetInvestorParamsSortByEnum;
|
|
5509
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
|
|
5510
|
+
/**
|
|
5511
|
+
* @description get pre ipo company spv by id
|
|
5512
|
+
* @tags PreIPOCompanies
|
|
5513
|
+
* @name GetInvestorByIdAndInvestorId
|
|
5514
|
+
* @summary get pre ipo company spv by id
|
|
5515
|
+
* @request GET:/ipos/pre-ipo-company-spv/{id}/investor/{investor_id}
|
|
5516
|
+
* @originalName getInvestor
|
|
5517
|
+
* @duplicate
|
|
5518
|
+
* @secure
|
|
5519
|
+
*/
|
|
5520
|
+
getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
|
|
5521
|
+
/** default is false, if true documents will be included in the response */
|
|
5522
|
+
include_documents?: boolean;
|
|
5523
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
|
|
5072
5524
|
/**
|
|
5073
5525
|
* @description get pre ipo company spvs
|
|
5074
5526
|
* @tags PreIPOCompanies
|
|
@@ -5278,15 +5730,37 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
5278
5730
|
market: string;
|
|
5279
5731
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
5280
5732
|
}
|
|
5281
|
-
export class
|
|
5733
|
+
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
5282
5734
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5283
5735
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5284
5736
|
/**
|
|
5285
|
-
* @description Returns
|
|
5286
|
-
* @tags
|
|
5287
|
-
* @name
|
|
5288
|
-
* @summary
|
|
5289
|
-
* @request POST:/
|
|
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
|
+
}
|
|
5755
|
+
export class News<HandleError extends boolean = boolean> {
|
|
5756
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5757
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5758
|
+
/**
|
|
5759
|
+
* @description Returns available authors in DB
|
|
5760
|
+
* @tags News
|
|
5761
|
+
* @name NewsAvailableAuthors
|
|
5762
|
+
* @summary Get available authors in DB (for filters)
|
|
5763
|
+
* @request POST:/news/authors
|
|
5290
5764
|
* @secure
|
|
5291
5765
|
*/
|
|
5292
5766
|
newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
@@ -5424,248 +5898,246 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
5424
5898
|
*/
|
|
5425
5899
|
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5426
5900
|
}
|
|
5427
|
-
export class
|
|
5901
|
+
export class Ownerships<HandleError extends boolean = boolean> {
|
|
5428
5902
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5429
5903
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5430
5904
|
/**
|
|
5431
|
-
* @description
|
|
5432
|
-
* @tags
|
|
5433
|
-
* @name
|
|
5434
|
-
* @summary
|
|
5435
|
-
* @request POST:/
|
|
5905
|
+
* @description get ownerships by id datadata
|
|
5906
|
+
* @tags Ownerships
|
|
5907
|
+
* @name GetOwnershipsByIdData
|
|
5908
|
+
* @summary get ownerships by id data
|
|
5909
|
+
* @request POST:/ownerships
|
|
5436
5910
|
* @secure
|
|
5437
5911
|
*/
|
|
5438
|
-
|
|
5912
|
+
getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
5439
5913
|
/**
|
|
5440
|
-
* @description
|
|
5441
|
-
* @tags
|
|
5442
|
-
* @name
|
|
5443
|
-
* @summary
|
|
5444
|
-
* @request POST:/
|
|
5914
|
+
* @description get ownerships by symbol data
|
|
5915
|
+
* @tags Ownerships
|
|
5916
|
+
* @name GetOwnershipsBySymbolData
|
|
5917
|
+
* @summary get ownerships by symbol data
|
|
5918
|
+
* @request POST:/symbol-ownerships
|
|
5445
5919
|
* @secure
|
|
5446
5920
|
*/
|
|
5447
|
-
|
|
5921
|
+
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
5448
5922
|
}
|
|
5449
|
-
export class
|
|
5923
|
+
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
5450
5924
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5451
5925
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5452
5926
|
/**
|
|
5453
|
-
* @description get
|
|
5454
|
-
* @tags
|
|
5455
|
-
* @name
|
|
5456
|
-
* @summary get
|
|
5457
|
-
* @request POST:/
|
|
5927
|
+
* @description get seasonlity data with comparison to benchmark
|
|
5928
|
+
* @tags AlphaTools
|
|
5929
|
+
* @name GetMomentumRatioGraph
|
|
5930
|
+
* @summary get seasonlity data
|
|
5931
|
+
* @request POST:/rst
|
|
5458
5932
|
* @secure
|
|
5459
5933
|
*/
|
|
5460
|
-
|
|
5934
|
+
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
5461
5935
|
/**
|
|
5462
|
-
* @description
|
|
5463
|
-
* @tags
|
|
5464
|
-
* @name
|
|
5465
|
-
* @summary
|
|
5466
|
-
* @request POST:/
|
|
5936
|
+
* @description get seasonlity data with comparison to benchmark
|
|
5937
|
+
* @tags AlphaTools
|
|
5938
|
+
* @name GetSeasonality
|
|
5939
|
+
* @summary get seasonlity data
|
|
5940
|
+
* @request POST:/seasonality
|
|
5467
5941
|
* @secure
|
|
5468
5942
|
*/
|
|
5469
|
-
|
|
5943
|
+
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
5944
|
+
}
|
|
5945
|
+
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
5946
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5947
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5470
5948
|
/**
|
|
5471
|
-
* @description get
|
|
5472
|
-
* @tags
|
|
5473
|
-
* @name
|
|
5474
|
-
* @summary get
|
|
5475
|
-
* @request
|
|
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
|
|
5476
5954
|
* @secure
|
|
5477
5955
|
*/
|
|
5478
|
-
|
|
5479
|
-
|
|
5480
|
-
|
|
5481
|
-
|
|
5482
|
-
|
|
5483
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
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>);
|
|
5484
5961
|
/**
|
|
5485
|
-
* @description
|
|
5486
|
-
* @tags
|
|
5487
|
-
* @name
|
|
5488
|
-
* @summary
|
|
5489
|
-
* @request
|
|
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
|
|
5490
5967
|
* @secure
|
|
5491
5968
|
*/
|
|
5492
|
-
|
|
5969
|
+
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
5493
5970
|
/**
|
|
5494
|
-
* @description
|
|
5495
|
-
* @tags
|
|
5496
|
-
* @name
|
|
5497
|
-
* @summary
|
|
5498
|
-
* @request POST:/
|
|
5971
|
+
* @description Returns articles
|
|
5972
|
+
* @tags Passport
|
|
5973
|
+
* @name PassportArticles
|
|
5974
|
+
* @summary Get articles
|
|
5975
|
+
* @request POST:/passport/articles
|
|
5499
5976
|
* @secure
|
|
5500
5977
|
*/
|
|
5501
|
-
|
|
5978
|
+
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5502
5979
|
/**
|
|
5503
|
-
* @description
|
|
5504
|
-
* @tags
|
|
5505
|
-
* @name
|
|
5506
|
-
* @summary
|
|
5507
|
-
* @request
|
|
5980
|
+
* @description Returns author profile
|
|
5981
|
+
* @tags Passport
|
|
5982
|
+
* @name PassportAuthorProfile
|
|
5983
|
+
* @summary Get author profile
|
|
5984
|
+
* @request POST:/passport/author-profile
|
|
5508
5985
|
* @secure
|
|
5509
5986
|
*/
|
|
5510
|
-
|
|
5987
|
+
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
5511
5988
|
/**
|
|
5512
|
-
* @description
|
|
5513
|
-
* @tags
|
|
5514
|
-
* @name
|
|
5515
|
-
* @summary
|
|
5516
|
-
* @request
|
|
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
|
|
5517
5994
|
* @secure
|
|
5518
5995
|
*/
|
|
5519
|
-
|
|
5520
|
-
}
|
|
5521
|
-
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
5522
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5523
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5996
|
+
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
5524
5997
|
/**
|
|
5525
|
-
* @description
|
|
5526
|
-
* @tags
|
|
5527
|
-
* @name
|
|
5528
|
-
* @summary
|
|
5529
|
-
* @request POST:/
|
|
5998
|
+
* @description Returns news feed
|
|
5999
|
+
* @tags Passport
|
|
6000
|
+
* @name PassportNewsFeed
|
|
6001
|
+
* @summary Get news feed
|
|
6002
|
+
* @request POST:/passport/newsfeed
|
|
5530
6003
|
* @secure
|
|
5531
6004
|
*/
|
|
5532
|
-
|
|
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>>;
|
|
5533
6015
|
}
|
|
5534
|
-
export class
|
|
6016
|
+
export class Public<HandleError extends boolean = boolean> {
|
|
5535
6017
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5536
6018
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5537
6019
|
/**
|
|
5538
|
-
* @description
|
|
5539
|
-
* @tags
|
|
5540
|
-
* @name
|
|
5541
|
-
* @summary
|
|
5542
|
-
* @request GET:/
|
|
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
|
|
5543
6025
|
* @secure
|
|
5544
6026
|
*/
|
|
5545
|
-
|
|
5546
|
-
/**
|
|
6027
|
+
calculateEstimatedReturns(query: {
|
|
6028
|
+
/** Single symbol */
|
|
5547
6029
|
symbol: string;
|
|
5548
|
-
|
|
5549
|
-
|
|
5550
|
-
|
|
5551
|
-
|
|
5552
|
-
|
|
5553
|
-
|
|
5554
|
-
|
|
5555
|
-
* @secure
|
|
5556
|
-
*/
|
|
5557
|
-
getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
|
|
5558
|
-
/** Authorization */
|
|
5559
|
-
Authorization?: string;
|
|
5560
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError>>;
|
|
5561
|
-
/**
|
|
5562
|
-
* @description filter funds by params
|
|
5563
|
-
* @tags Funds
|
|
5564
|
-
* @name FundScreener
|
|
5565
|
-
* @summary filter funds by params
|
|
5566
|
-
* @request POST:/funds/screener
|
|
5567
|
-
* @secure
|
|
5568
|
-
*/
|
|
5569
|
-
fundScreener(filter: InsightFundScreenerRequest, headers?: {
|
|
5570
|
-
/** Authorization */
|
|
5571
|
-
Authorization?: string;
|
|
5572
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
5573
|
-
/**
|
|
5574
|
-
* @description get fund screener filters
|
|
5575
|
-
* @tags Funds
|
|
5576
|
-
* @name GetScreenerFilters
|
|
5577
|
-
* @summary get fund screener filters
|
|
5578
|
-
* @request GET:/funds/screener/filters
|
|
5579
|
-
* @secure
|
|
5580
|
-
*/
|
|
5581
|
-
getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError>>;
|
|
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>>;
|
|
5582
6037
|
/**
|
|
5583
|
-
* @description
|
|
5584
|
-
* @tags
|
|
5585
|
-
* @name
|
|
5586
|
-
* @summary
|
|
5587
|
-
* @request GET:/
|
|
6038
|
+
* @description Returns an expert forecast
|
|
6039
|
+
* @tags Public
|
|
6040
|
+
* @name ExpertForecast
|
|
6041
|
+
* @summary Expert forecast
|
|
6042
|
+
* @request GET:/public/expert-forecast
|
|
5588
6043
|
* @secure
|
|
5589
6044
|
*/
|
|
5590
|
-
|
|
5591
|
-
/**
|
|
5592
|
-
|
|
5593
|
-
|
|
5594
|
-
offset: number;
|
|
5595
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
6045
|
+
expertForecast(query: {
|
|
6046
|
+
/** Comma separated symbols */
|
|
6047
|
+
symbols: string;
|
|
6048
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
5596
6049
|
/**
|
|
5597
|
-
* @description
|
|
5598
|
-
* @tags
|
|
5599
|
-
* @name
|
|
5600
|
-
* @summary
|
|
5601
|
-
* @request
|
|
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}
|
|
5602
6055
|
* @secure
|
|
5603
6056
|
*/
|
|
5604
|
-
|
|
6057
|
+
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
6058
|
+
/** Annual or quarterly */
|
|
6059
|
+
mode: string;
|
|
6060
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5605
6061
|
/**
|
|
5606
|
-
* @description
|
|
5607
|
-
* @tags
|
|
5608
|
-
* @name
|
|
5609
|
-
* @summary
|
|
5610
|
-
* @request
|
|
6062
|
+
* @description Daily price history
|
|
6063
|
+
* @tags Public
|
|
6064
|
+
* @name DailyPriceHistory
|
|
6065
|
+
* @summary Daily price history
|
|
6066
|
+
* @request GET:/public/price-history/daily
|
|
5611
6067
|
* @secure
|
|
5612
6068
|
*/
|
|
5613
|
-
|
|
6069
|
+
dailyPriceHistory(query: {
|
|
6070
|
+
/** Single symbol */
|
|
6071
|
+
symbol: string;
|
|
6072
|
+
/** Target date */
|
|
6073
|
+
date: string;
|
|
6074
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
5614
6075
|
/**
|
|
5615
|
-
* @description
|
|
5616
|
-
* @tags
|
|
5617
|
-
* @name
|
|
5618
|
-
* @summary
|
|
5619
|
-
* @request
|
|
6076
|
+
* @description Public quote profile
|
|
6077
|
+
* @tags Public
|
|
6078
|
+
* @name PublicQuoteProfile
|
|
6079
|
+
* @summary Public quote profile
|
|
6080
|
+
* @request GET:/public/quote-profile/{symbol}
|
|
5620
6081
|
* @secure
|
|
5621
6082
|
*/
|
|
5622
|
-
|
|
6083
|
+
publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
|
|
5623
6084
|
/**
|
|
5624
|
-
* @description
|
|
5625
|
-
* @tags
|
|
5626
|
-
* @name
|
|
5627
|
-
* @summary
|
|
5628
|
-
* @request
|
|
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}
|
|
5629
6090
|
* @secure
|
|
5630
6091
|
*/
|
|
5631
|
-
|
|
5632
|
-
/** Authorization */
|
|
5633
|
-
Authorization?: string;
|
|
5634
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
6092
|
+
getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
|
|
5635
6093
|
/**
|
|
5636
|
-
* @description
|
|
5637
|
-
* @tags
|
|
5638
|
-
* @name
|
|
5639
|
-
* @summary
|
|
5640
|
-
* @request
|
|
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
|
|
5641
6099
|
* @secure
|
|
5642
6100
|
*/
|
|
5643
|
-
|
|
5644
|
-
/**
|
|
5645
|
-
|
|
5646
|
-
|
|
5647
|
-
|
|
5648
|
-
|
|
5649
|
-
|
|
5650
|
-
|
|
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>>;
|
|
5651
6109
|
/**
|
|
5652
|
-
* @description
|
|
5653
|
-
* @tags
|
|
5654
|
-
* @name
|
|
5655
|
-
* @summary
|
|
5656
|
-
* @request
|
|
6110
|
+
* @description Get top gainers
|
|
6111
|
+
* @tags Public
|
|
6112
|
+
* @name TopGainers
|
|
6113
|
+
* @summary Top Gainers
|
|
6114
|
+
* @request GET:/public/top-gainers
|
|
5657
6115
|
* @secure
|
|
5658
6116
|
*/
|
|
5659
|
-
|
|
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>>;
|
|
5660
6125
|
/**
|
|
5661
|
-
* @description
|
|
5662
|
-
* @tags
|
|
5663
|
-
* @name
|
|
5664
|
-
* @summary
|
|
5665
|
-
* @request
|
|
6126
|
+
* @description Get top stocks
|
|
6127
|
+
* @tags Public
|
|
6128
|
+
* @name TopStocks
|
|
6129
|
+
* @summary Top Stocks
|
|
6130
|
+
* @request GET:/public/top-stocks
|
|
5666
6131
|
* @secure
|
|
5667
6132
|
*/
|
|
5668
|
-
|
|
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>>;
|
|
5669
6141
|
}
|
|
5670
6142
|
export class TipRank<HandleError extends boolean = boolean> {
|
|
5671
6143
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -6033,225 +6505,6 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6033
6505
|
Authorization?: string;
|
|
6034
6506
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
|
|
6035
6507
|
}
|
|
6036
|
-
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
6037
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6038
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6039
|
-
/**
|
|
6040
|
-
* @description get usage date per branch for a period
|
|
6041
|
-
* @tags UsageTracking
|
|
6042
|
-
* @name GetUsageData
|
|
6043
|
-
* @summary get insight usage data
|
|
6044
|
-
* @request POST:/tracking/usage
|
|
6045
|
-
* @secure
|
|
6046
|
-
*/
|
|
6047
|
-
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
6048
|
-
}
|
|
6049
|
-
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
6050
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6051
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6052
|
-
/**
|
|
6053
|
-
* @description get seasonlity data with comparison to benchmark
|
|
6054
|
-
* @tags AlphaTools
|
|
6055
|
-
* @name GetMomentumRatioGraph
|
|
6056
|
-
* @summary get seasonlity data
|
|
6057
|
-
* @request POST:/rst
|
|
6058
|
-
* @secure
|
|
6059
|
-
*/
|
|
6060
|
-
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
6061
|
-
/**
|
|
6062
|
-
* @description get seasonlity data with comparison to benchmark
|
|
6063
|
-
* @tags AlphaTools
|
|
6064
|
-
* @name GetSeasonality
|
|
6065
|
-
* @summary get seasonlity data
|
|
6066
|
-
* @request POST:/seasonality
|
|
6067
|
-
* @secure
|
|
6068
|
-
*/
|
|
6069
|
-
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
6070
|
-
}
|
|
6071
|
-
export class Public<HandleError extends boolean = boolean> {
|
|
6072
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6073
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6074
|
-
/**
|
|
6075
|
-
* @description Calculate estimated returns for selected symbols. Uses split adjusted prices
|
|
6076
|
-
* @tags Public
|
|
6077
|
-
* @name CalculateEstimatedReturns
|
|
6078
|
-
* @summary Calculate Estimated Returns
|
|
6079
|
-
* @request GET:/public/estimated-returns
|
|
6080
|
-
* @secure
|
|
6081
|
-
*/
|
|
6082
|
-
calculateEstimatedReturns(query: {
|
|
6083
|
-
/** Single symbol */
|
|
6084
|
-
symbol: string;
|
|
6085
|
-
/** Non-zero amount */
|
|
6086
|
-
amount: number;
|
|
6087
|
-
/** Start date for calculations */
|
|
6088
|
-
start_date: string;
|
|
6089
|
-
/** End date for calculations */
|
|
6090
|
-
end_date: string;
|
|
6091
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
6092
|
-
/**
|
|
6093
|
-
* @description Returns an expert forecast
|
|
6094
|
-
* @tags Public
|
|
6095
|
-
* @name ExpertForecast
|
|
6096
|
-
* @summary Expert forecast
|
|
6097
|
-
* @request GET:/public/expert-forecast
|
|
6098
|
-
* @secure
|
|
6099
|
-
*/
|
|
6100
|
-
expertForecast(query: {
|
|
6101
|
-
/** Comma separated symbols */
|
|
6102
|
-
symbols: string;
|
|
6103
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
6104
|
-
/**
|
|
6105
|
-
* @description get fundamentals by symbol data
|
|
6106
|
-
* @tags Public
|
|
6107
|
-
* @name GetPublicFundamentalsBySymbolData
|
|
6108
|
-
* @summary get fundamentals by symbol data
|
|
6109
|
-
* @request GET:/public/fundamentals/{symbol}
|
|
6110
|
-
* @secure
|
|
6111
|
-
*/
|
|
6112
|
-
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
6113
|
-
/** Annual or quarterly */
|
|
6114
|
-
mode: string;
|
|
6115
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
6116
|
-
/**
|
|
6117
|
-
* @description Daily price history
|
|
6118
|
-
* @tags Public
|
|
6119
|
-
* @name DailyPriceHistory
|
|
6120
|
-
* @summary Daily price history
|
|
6121
|
-
* @request GET:/public/price-history/daily
|
|
6122
|
-
* @secure
|
|
6123
|
-
*/
|
|
6124
|
-
dailyPriceHistory(query: {
|
|
6125
|
-
/** Single symbol */
|
|
6126
|
-
symbol: string;
|
|
6127
|
-
/** Target date */
|
|
6128
|
-
date: string;
|
|
6129
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
6130
|
-
/**
|
|
6131
|
-
* @description Public quote profile
|
|
6132
|
-
* @tags Public
|
|
6133
|
-
* @name PublicQuoteProfile
|
|
6134
|
-
* @summary Public quote profile
|
|
6135
|
-
* @request GET:/public/quote-profile/{symbol}
|
|
6136
|
-
* @secure
|
|
6137
|
-
*/
|
|
6138
|
-
publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
|
|
6139
|
-
/**
|
|
6140
|
-
* @description get ratios by symbol data
|
|
6141
|
-
* @tags Public
|
|
6142
|
-
* @name GetPublicRatiosBySymbolData
|
|
6143
|
-
* @summary get ratios by symbol data
|
|
6144
|
-
* @request GET:/public/ratios/{symbol}
|
|
6145
|
-
* @secure
|
|
6146
|
-
*/
|
|
6147
|
-
getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
|
|
6148
|
-
/**
|
|
6149
|
-
* @description find a symbol by name or description
|
|
6150
|
-
* @tags Public
|
|
6151
|
-
* @name QuoteFundamentalsSearch
|
|
6152
|
-
* @summary find a symbol by name or description
|
|
6153
|
-
* @request GET:/public/symbol-search
|
|
6154
|
-
* @secure
|
|
6155
|
-
*/
|
|
6156
|
-
quoteFundamentalsSearch(query: {
|
|
6157
|
-
/** Search query */
|
|
6158
|
-
search_query: string;
|
|
6159
|
-
/** how many records to return. Max value is 50 */
|
|
6160
|
-
limit: number;
|
|
6161
|
-
/** how many records to skip */
|
|
6162
|
-
offset: number;
|
|
6163
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
6164
|
-
/**
|
|
6165
|
-
* @description Get top gainers
|
|
6166
|
-
* @tags Public
|
|
6167
|
-
* @name TopGainers
|
|
6168
|
-
* @summary Top Gainers
|
|
6169
|
-
* @request GET:/public/top-gainers
|
|
6170
|
-
* @secure
|
|
6171
|
-
*/
|
|
6172
|
-
topGainers(query: {
|
|
6173
|
-
/** sort direction - asc or desc */
|
|
6174
|
-
order_direction?: string;
|
|
6175
|
-
/** how many records to return. Max value is 50 */
|
|
6176
|
-
limit: number;
|
|
6177
|
-
/** how many records to skip */
|
|
6178
|
-
offset: number;
|
|
6179
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6180
|
-
/**
|
|
6181
|
-
* @description Get top stocks
|
|
6182
|
-
* @tags Public
|
|
6183
|
-
* @name TopStocks
|
|
6184
|
-
* @summary Top Stocks
|
|
6185
|
-
* @request GET:/public/top-stocks
|
|
6186
|
-
* @secure
|
|
6187
|
-
*/
|
|
6188
|
-
topStocks(query: {
|
|
6189
|
-
/** EQUITY|ETF|CRYPTO */
|
|
6190
|
-
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
6191
|
-
/** how many records to return. Max value is 50 */
|
|
6192
|
-
limit: number;
|
|
6193
|
-
/** how many records to skip */
|
|
6194
|
-
offset: number;
|
|
6195
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6196
|
-
}
|
|
6197
|
-
export class Passport<HandleError extends boolean = boolean> {
|
|
6198
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6199
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6200
|
-
/**
|
|
6201
|
-
* @description Returns article by id
|
|
6202
|
-
* @tags Passport
|
|
6203
|
-
* @name PassportArticleById
|
|
6204
|
-
* @summary Get article by id
|
|
6205
|
-
* @request POST:/passport/article-by-id
|
|
6206
|
-
* @secure
|
|
6207
|
-
*/
|
|
6208
|
-
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
6209
|
-
/**
|
|
6210
|
-
* @description Returns articles
|
|
6211
|
-
* @tags Passport
|
|
6212
|
-
* @name PassportArticles
|
|
6213
|
-
* @summary Get articles
|
|
6214
|
-
* @request POST:/passport/articles
|
|
6215
|
-
* @secure
|
|
6216
|
-
*/
|
|
6217
|
-
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
6218
|
-
/**
|
|
6219
|
-
* @description Returns author profile
|
|
6220
|
-
* @tags Passport
|
|
6221
|
-
* @name PassportAuthorProfile
|
|
6222
|
-
* @summary Get author profile
|
|
6223
|
-
* @request POST:/passport/author-profile
|
|
6224
|
-
* @secure
|
|
6225
|
-
*/
|
|
6226
|
-
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
6227
|
-
/**
|
|
6228
|
-
* @description Returns most popular tags
|
|
6229
|
-
* @tags Passport
|
|
6230
|
-
* @name PassportMostPopularTags
|
|
6231
|
-
* @summary Get most popular tags
|
|
6232
|
-
* @request POST:/passport/most-popular-tags
|
|
6233
|
-
* @secure
|
|
6234
|
-
*/
|
|
6235
|
-
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
6236
|
-
/**
|
|
6237
|
-
* @description Returns news feed
|
|
6238
|
-
* @tags Passport
|
|
6239
|
-
* @name PassportNewsFeed
|
|
6240
|
-
* @summary Get news feed
|
|
6241
|
-
* @request POST:/passport/newsfeed
|
|
6242
|
-
* @secure
|
|
6243
|
-
*/
|
|
6244
|
-
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
|
|
6245
|
-
/**
|
|
6246
|
-
* @description Returns article by parameters
|
|
6247
|
-
* @tags Passport
|
|
6248
|
-
* @name PassportSearchArticle
|
|
6249
|
-
* @summary Search article by parameters
|
|
6250
|
-
* @request POST:/passport/search-article
|
|
6251
|
-
* @secure
|
|
6252
|
-
*/
|
|
6253
|
-
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
6254
|
-
}
|
|
6255
6508
|
export interface InsightBeforeAndAfterV2 {
|
|
6256
6509
|
after?: string;
|
|
6257
6510
|
before?: string;
|
|
@@ -6477,6 +6730,19 @@ export enum InsightOrderingDirectionEnumV2 {
|
|
|
6477
6730
|
Asc = "asc",
|
|
6478
6731
|
Desc = "desc"
|
|
6479
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
|
+
}
|
|
6480
6746
|
export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
6481
6747
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6482
6748
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -6499,19 +6765,6 @@ export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
|
6499
6765
|
*/
|
|
6500
6766
|
getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
6501
6767
|
}
|
|
6502
|
-
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
6503
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6504
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6505
|
-
/**
|
|
6506
|
-
* @description get fixed income entries
|
|
6507
|
-
* @tags FixedIncome
|
|
6508
|
-
* @name GetFixedIncomeEntries
|
|
6509
|
-
* @summary get fixed income entries
|
|
6510
|
-
* @request POST:/fixed-income
|
|
6511
|
-
* @secure
|
|
6512
|
-
*/
|
|
6513
|
-
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
6514
|
-
}
|
|
6515
6768
|
export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
6516
6769
|
readonly config: JwtClientConfig<HandleError>;
|
|
6517
6770
|
alphaTools: AlphaTools<HandleError>;
|