@orbis-systems/orbis-api-clients 0.7.6 → 0.7.7
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 +92 -90
- 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 +282 -263
- 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 +425 -398
- 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 +101 -101
- 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 +2866 -2862
- 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 +316 -304
- 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 +170 -170
- 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
|
@@ -949,6 +949,7 @@ export interface InsightFundScreenerQuote {
|
|
|
949
949
|
export interface InsightFundScreenerRequest {
|
|
950
950
|
assets?: string[];
|
|
951
951
|
categories?: string[];
|
|
952
|
+
expense_ratio?: InsightLessAndMore;
|
|
952
953
|
/** @example "ETF" */
|
|
953
954
|
fund_type?: InsightFundScreenerRequestFundTypeEnum;
|
|
954
955
|
/** @example "ANY" */
|
|
@@ -3341,6 +3342,7 @@ export interface InsightPreIPOCompanyResearchDocument {
|
|
|
3341
3342
|
export interface InsightPreIPOCompanySPV {
|
|
3342
3343
|
all_in_price_per_share: number;
|
|
3343
3344
|
close_date: string;
|
|
3345
|
+
co_manager_partner_ids: string[];
|
|
3344
3346
|
cusip: string;
|
|
3345
3347
|
demand_side_commission_split: number;
|
|
3346
3348
|
description: string;
|
|
@@ -3352,9 +3354,11 @@ export interface InsightPreIPOCompanySPV {
|
|
|
3352
3354
|
investor_price_per_share: number;
|
|
3353
3355
|
management_fee: number;
|
|
3354
3356
|
management_fee_years_payable: number;
|
|
3357
|
+
manager_partner_id: string;
|
|
3355
3358
|
master_llc_name: string;
|
|
3356
3359
|
min_commitment_amount: number;
|
|
3357
3360
|
monark_commission_split: number;
|
|
3361
|
+
monark_stage: string;
|
|
3358
3362
|
name: string;
|
|
3359
3363
|
notable_investors: string[];
|
|
3360
3364
|
number_of_seats_remaining: number;
|
|
@@ -3387,6 +3391,7 @@ export interface InsightPreIPOCompanySPVDocument {
|
|
|
3387
3391
|
tax_year: number;
|
|
3388
3392
|
template_document: boolean;
|
|
3389
3393
|
type: string;
|
|
3394
|
+
url: string;
|
|
3390
3395
|
}
|
|
3391
3396
|
export interface InsightPublicQuoteProfile {
|
|
3392
3397
|
average_volume_30d: number;
|
|
@@ -4265,6 +4270,26 @@ export enum InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum {
|
|
|
4265
4270
|
SUBJECT = "SUBJECT",
|
|
4266
4271
|
CONNECTED = "CONNECTED"
|
|
4267
4272
|
}
|
|
4273
|
+
/** search by monark stage */
|
|
4274
|
+
export enum InsightGetPreIpoCompanySpvsParamsMonarkStageEnum {
|
|
4275
|
+
DRAFT = "DRAFT",
|
|
4276
|
+
WAITING_MONARK_REVIEW = "WAITING_MONARK_REVIEW",
|
|
4277
|
+
FUND_ADMIN_REVIEW = "FUND_ADMIN_REVIEW",
|
|
4278
|
+
FUND_ADMIN_APPROVED = "FUND_ADMIN_APPROVED",
|
|
4279
|
+
PRIMARY_FUNDRAISE = "PRIMARY_FUNDRAISE",
|
|
4280
|
+
MONARK_DILIGENCE = "MONARK_DILIGENCE",
|
|
4281
|
+
PRE_CLOSE_REVIEW = "PRE_CLOSE_REVIEW",
|
|
4282
|
+
CLOSE_REQUESTED = "CLOSE_REQUESTED",
|
|
4283
|
+
CLOSE_IN_PROCESS = "CLOSE_IN_PROCESS",
|
|
4284
|
+
FUNDS_SENT_TO_TARGET = "FUNDS_SENT_TO_TARGET",
|
|
4285
|
+
CLOSED = "CLOSED",
|
|
4286
|
+
REGULATORY_HOLD_PERIOD = "REGULATORY_HOLD_PERIOD",
|
|
4287
|
+
ACTIVELY_TRADING = "ACTIVELY_TRADING",
|
|
4288
|
+
CLOSE_FAILED = "CLOSE_FAILED",
|
|
4289
|
+
HALTED = "HALTED",
|
|
4290
|
+
LIQUIDATION = "LIQUIDATION",
|
|
4291
|
+
DISSOLVED = "DISSOLVED"
|
|
4292
|
+
}
|
|
4268
4293
|
/** sort direction */
|
|
4269
4294
|
export enum InsightGetPreIpoCompanySpvsParamsDirectionEnum {
|
|
4270
4295
|
ASC = "ASC",
|
|
@@ -4307,6 +4332,45 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
|
|
|
4307
4332
|
Date = "date",
|
|
4308
4333
|
Rank = "rank"
|
|
4309
4334
|
}
|
|
4335
|
+
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4336
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4337
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4338
|
+
/**
|
|
4339
|
+
* @description get company profile, industries classification and closest earning release
|
|
4340
|
+
* @tags CompanyProfile
|
|
4341
|
+
* @name GetCompanyProfile
|
|
4342
|
+
* @summary get company profile
|
|
4343
|
+
* @request GET:/company-profile
|
|
4344
|
+
* @secure
|
|
4345
|
+
*/
|
|
4346
|
+
getCompanyProfile(query: {
|
|
4347
|
+
/** Company symbol */
|
|
4348
|
+
symbol: string;
|
|
4349
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
|
|
4350
|
+
/**
|
|
4351
|
+
* @description get combined profile, equities and funds
|
|
4352
|
+
* @tags CompanyProfile
|
|
4353
|
+
* @name GetCombinedProfile
|
|
4354
|
+
* @summary get company profile
|
|
4355
|
+
* @request GET:/quote-profile
|
|
4356
|
+
* @secure
|
|
4357
|
+
*/
|
|
4358
|
+
getCombinedProfile(query: {
|
|
4359
|
+
/** Company symbol */
|
|
4360
|
+
symbol: string;
|
|
4361
|
+
/** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
|
|
4362
|
+
symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
|
|
4363
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
|
|
4364
|
+
/**
|
|
4365
|
+
* @description sort input array of symbols by type
|
|
4366
|
+
* @tags CompanyProfile
|
|
4367
|
+
* @name GetSymbolsPerSymbolType
|
|
4368
|
+
* @summary sort input array of symbols by type
|
|
4369
|
+
* @request POST:/symbols-per-type
|
|
4370
|
+
* @secure
|
|
4371
|
+
*/
|
|
4372
|
+
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
4373
|
+
}
|
|
4310
4374
|
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
4311
4375
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4312
4376
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4489,45 +4553,6 @@ export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
|
4489
4553
|
id: string;
|
|
4490
4554
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4491
4555
|
}
|
|
4492
|
-
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4493
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4494
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4495
|
-
/**
|
|
4496
|
-
* @description get company profile, industries classification and closest earning release
|
|
4497
|
-
* @tags CompanyProfile
|
|
4498
|
-
* @name GetCompanyProfile
|
|
4499
|
-
* @summary get company profile
|
|
4500
|
-
* @request GET:/company-profile
|
|
4501
|
-
* @secure
|
|
4502
|
-
*/
|
|
4503
|
-
getCompanyProfile(query: {
|
|
4504
|
-
/** Company symbol */
|
|
4505
|
-
symbol: string;
|
|
4506
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
|
|
4507
|
-
/**
|
|
4508
|
-
* @description get combined profile, equities and funds
|
|
4509
|
-
* @tags CompanyProfile
|
|
4510
|
-
* @name GetCombinedProfile
|
|
4511
|
-
* @summary get company profile
|
|
4512
|
-
* @request GET:/quote-profile
|
|
4513
|
-
* @secure
|
|
4514
|
-
*/
|
|
4515
|
-
getCombinedProfile(query: {
|
|
4516
|
-
/** Company symbol */
|
|
4517
|
-
symbol: string;
|
|
4518
|
-
/** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
|
|
4519
|
-
symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
|
|
4520
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
|
|
4521
|
-
/**
|
|
4522
|
-
* @description sort input array of symbols by type
|
|
4523
|
-
* @tags CompanyProfile
|
|
4524
|
-
* @name GetSymbolsPerSymbolType
|
|
4525
|
-
* @summary sort input array of symbols by type
|
|
4526
|
-
* @request POST:/symbols-per-type
|
|
4527
|
-
* @secure
|
|
4528
|
-
*/
|
|
4529
|
-
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
4530
|
-
}
|
|
4531
4556
|
export class CustomLists<HandleError extends boolean = boolean> {
|
|
4532
4557
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4533
4558
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4785,102 +4810,6 @@ export class Fundamentals<HandleError extends boolean = boolean> {
|
|
|
4785
4810
|
*/
|
|
4786
4811
|
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
4787
4812
|
}
|
|
4788
|
-
export class StockScreener<HandleError extends boolean = boolean> {
|
|
4789
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4790
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4791
|
-
/**
|
|
4792
|
-
* @description data for visual heat map
|
|
4793
|
-
* @tags StockScreener
|
|
4794
|
-
* @name StockMarketHeatmap
|
|
4795
|
-
* @summary data for visual heat map
|
|
4796
|
-
* @request GET:/heatmaps
|
|
4797
|
-
* @secure
|
|
4798
|
-
*/
|
|
4799
|
-
stockMarketHeatmap(query?: {
|
|
4800
|
-
/** Name of symbol list to fetch details for. Empty is default */
|
|
4801
|
-
heatmap_name?: string;
|
|
4802
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
4803
|
-
/**
|
|
4804
|
-
* @description create or update heat map preset
|
|
4805
|
-
* @tags StockScreener
|
|
4806
|
-
* @name CreateStockMarketHeatmapPreset
|
|
4807
|
-
* @summary create or update heat map preset
|
|
4808
|
-
* @request POST:/heatmaps
|
|
4809
|
-
* @secure
|
|
4810
|
-
*/
|
|
4811
|
-
createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4812
|
-
/**
|
|
4813
|
-
* @description Sector and Industry Group performance
|
|
4814
|
-
* @tags StockScreener
|
|
4815
|
-
* @name IndustriesPerformance
|
|
4816
|
-
* @summary get industries performance
|
|
4817
|
-
* @request POST:/industries-performance
|
|
4818
|
-
* @secure
|
|
4819
|
-
*/
|
|
4820
|
-
industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
|
|
4821
|
-
/**
|
|
4822
|
-
* @description filter stocks by params
|
|
4823
|
-
* @tags StockScreener
|
|
4824
|
-
* @name StockScreener
|
|
4825
|
-
* @summary filter stocks by params
|
|
4826
|
-
* @request POST:/stock-screener
|
|
4827
|
-
* @secure
|
|
4828
|
-
*/
|
|
4829
|
-
stockScreener(filter: InsightStockScreenerV1Request, headers?: {
|
|
4830
|
-
/** Authorization */
|
|
4831
|
-
Authorization?: string;
|
|
4832
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
4833
|
-
/**
|
|
4834
|
-
* @description get screener presets
|
|
4835
|
-
* @tags StockScreener
|
|
4836
|
-
* @name GetScreenerPresets
|
|
4837
|
-
* @summary get screener presets
|
|
4838
|
-
* @request GET:/stock-screener/presets
|
|
4839
|
-
* @secure
|
|
4840
|
-
*/
|
|
4841
|
-
getScreenerPresets(query: {
|
|
4842
|
-
/** how many records to return */
|
|
4843
|
-
limit: number;
|
|
4844
|
-
/** how many records to skip */
|
|
4845
|
-
offset: number;
|
|
4846
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
4847
|
-
/**
|
|
4848
|
-
* @description update screener preset
|
|
4849
|
-
* @tags StockScreener
|
|
4850
|
-
* @name UpdateScreenerPreset
|
|
4851
|
-
* @summary update screener preset
|
|
4852
|
-
* @request PUT:/stock-screener/presets
|
|
4853
|
-
* @secure
|
|
4854
|
-
*/
|
|
4855
|
-
updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
4856
|
-
/**
|
|
4857
|
-
* @description create screener preset
|
|
4858
|
-
* @tags StockScreener
|
|
4859
|
-
* @name CreateOrScreenerPreset
|
|
4860
|
-
* @summary create screener preset
|
|
4861
|
-
* @request POST:/stock-screener/presets
|
|
4862
|
-
* @secure
|
|
4863
|
-
*/
|
|
4864
|
-
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
4865
|
-
/**
|
|
4866
|
-
* @description remove screener preset
|
|
4867
|
-
* @tags StockScreener
|
|
4868
|
-
* @name RemoveScreenerPreset
|
|
4869
|
-
* @summary remove screener preset
|
|
4870
|
-
* @request DELETE:/stock-screener/presets
|
|
4871
|
-
* @secure
|
|
4872
|
-
*/
|
|
4873
|
-
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4874
|
-
/**
|
|
4875
|
-
* @description get top symbols
|
|
4876
|
-
* @tags StockScreener
|
|
4877
|
-
* @name GetTopSymbols
|
|
4878
|
-
* @summary get top symbols
|
|
4879
|
-
* @request POST:/stock-screener/top
|
|
4880
|
-
* @secure
|
|
4881
|
-
*/
|
|
4882
|
-
getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
4883
|
-
}
|
|
4884
4813
|
export class Funds<HandleError extends boolean = boolean> {
|
|
4885
4814
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4886
4815
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4995,73 +4924,169 @@ export class Funds<HandleError extends boolean = boolean> {
|
|
|
4995
4924
|
Authorization?: string;
|
|
4996
4925
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
|
|
4997
4926
|
}
|
|
4998
|
-
export class
|
|
4927
|
+
export class StockScreener<HandleError extends boolean = boolean> {
|
|
4999
4928
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5000
4929
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5001
4930
|
/**
|
|
5002
|
-
* @description
|
|
5003
|
-
* @tags
|
|
5004
|
-
* @name
|
|
5005
|
-
* @summary
|
|
5006
|
-
* @request GET:/
|
|
4931
|
+
* @description data for visual heat map
|
|
4932
|
+
* @tags StockScreener
|
|
4933
|
+
* @name StockMarketHeatmap
|
|
4934
|
+
* @summary data for visual heat map
|
|
4935
|
+
* @request GET:/heatmaps
|
|
5007
4936
|
* @secure
|
|
5008
4937
|
*/
|
|
5009
|
-
|
|
5010
|
-
/**
|
|
5011
|
-
|
|
5012
|
-
|
|
5013
|
-
date: string;
|
|
5014
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
4938
|
+
stockMarketHeatmap(query?: {
|
|
4939
|
+
/** Name of symbol list to fetch details for. Empty is default */
|
|
4940
|
+
heatmap_name?: string;
|
|
4941
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
5015
4942
|
/**
|
|
5016
|
-
* @description
|
|
5017
|
-
* @tags
|
|
5018
|
-
* @name
|
|
5019
|
-
* @summary
|
|
5020
|
-
* @request POST:/
|
|
4943
|
+
* @description create or update heat map preset
|
|
4944
|
+
* @tags StockScreener
|
|
4945
|
+
* @name CreateStockMarketHeatmapPreset
|
|
4946
|
+
* @summary create or update heat map preset
|
|
4947
|
+
* @request POST:/heatmaps
|
|
5021
4948
|
* @secure
|
|
5022
4949
|
*/
|
|
5023
|
-
|
|
4950
|
+
createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5024
4951
|
/**
|
|
5025
|
-
* @description
|
|
5026
|
-
* @tags
|
|
5027
|
-
* @name
|
|
5028
|
-
* @summary
|
|
5029
|
-
* @request
|
|
4952
|
+
* @description Sector and Industry Group performance
|
|
4953
|
+
* @tags StockScreener
|
|
4954
|
+
* @name IndustriesPerformance
|
|
4955
|
+
* @summary get industries performance
|
|
4956
|
+
* @request POST:/industries-performance
|
|
5030
4957
|
* @secure
|
|
5031
4958
|
*/
|
|
5032
|
-
|
|
5033
|
-
/** Comma separated symbols */
|
|
5034
|
-
symbols: string;
|
|
5035
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
5036
|
-
}
|
|
5037
|
-
export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
5038
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5039
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4959
|
+
industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
|
|
5040
4960
|
/**
|
|
5041
|
-
* @description
|
|
5042
|
-
* @tags
|
|
5043
|
-
* @name
|
|
5044
|
-
* @summary
|
|
5045
|
-
* @request
|
|
4961
|
+
* @description filter stocks by params
|
|
4962
|
+
* @tags StockScreener
|
|
4963
|
+
* @name StockScreener
|
|
4964
|
+
* @summary filter stocks by params
|
|
4965
|
+
* @request POST:/stock-screener
|
|
5046
4966
|
* @secure
|
|
5047
4967
|
*/
|
|
5048
|
-
|
|
5049
|
-
/**
|
|
5050
|
-
|
|
5051
|
-
|
|
5052
|
-
|
|
5053
|
-
|
|
5054
|
-
|
|
5055
|
-
|
|
5056
|
-
|
|
5057
|
-
|
|
5058
|
-
|
|
5059
|
-
|
|
5060
|
-
|
|
5061
|
-
|
|
5062
|
-
|
|
5063
|
-
|
|
5064
|
-
|
|
4968
|
+
stockScreener(filter: InsightStockScreenerV1Request, headers?: {
|
|
4969
|
+
/** Authorization */
|
|
4970
|
+
Authorization?: string;
|
|
4971
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
4972
|
+
/**
|
|
4973
|
+
* @description get screener presets
|
|
4974
|
+
* @tags StockScreener
|
|
4975
|
+
* @name GetScreenerPresets
|
|
4976
|
+
* @summary get screener presets
|
|
4977
|
+
* @request GET:/stock-screener/presets
|
|
4978
|
+
* @secure
|
|
4979
|
+
*/
|
|
4980
|
+
getScreenerPresets(query: {
|
|
4981
|
+
/** how many records to return */
|
|
4982
|
+
limit: number;
|
|
4983
|
+
/** how many records to skip */
|
|
4984
|
+
offset: number;
|
|
4985
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
4986
|
+
/**
|
|
4987
|
+
* @description update screener preset
|
|
4988
|
+
* @tags StockScreener
|
|
4989
|
+
* @name UpdateScreenerPreset
|
|
4990
|
+
* @summary update screener preset
|
|
4991
|
+
* @request PUT:/stock-screener/presets
|
|
4992
|
+
* @secure
|
|
4993
|
+
*/
|
|
4994
|
+
updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
4995
|
+
/**
|
|
4996
|
+
* @description create screener preset
|
|
4997
|
+
* @tags StockScreener
|
|
4998
|
+
* @name CreateOrScreenerPreset
|
|
4999
|
+
* @summary create screener preset
|
|
5000
|
+
* @request POST:/stock-screener/presets
|
|
5001
|
+
* @secure
|
|
5002
|
+
*/
|
|
5003
|
+
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5004
|
+
/**
|
|
5005
|
+
* @description remove screener preset
|
|
5006
|
+
* @tags StockScreener
|
|
5007
|
+
* @name RemoveScreenerPreset
|
|
5008
|
+
* @summary remove screener preset
|
|
5009
|
+
* @request DELETE:/stock-screener/presets
|
|
5010
|
+
* @secure
|
|
5011
|
+
*/
|
|
5012
|
+
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5013
|
+
/**
|
|
5014
|
+
* @description get top symbols
|
|
5015
|
+
* @tags StockScreener
|
|
5016
|
+
* @name GetTopSymbols
|
|
5017
|
+
* @summary get top symbols
|
|
5018
|
+
* @request POST:/stock-screener/top
|
|
5019
|
+
* @secure
|
|
5020
|
+
*/
|
|
5021
|
+
getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
5022
|
+
}
|
|
5023
|
+
export class Quotes<HandleError extends boolean = boolean> {
|
|
5024
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5025
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5026
|
+
/**
|
|
5027
|
+
* @description Get single historical quote
|
|
5028
|
+
* @tags Quotes
|
|
5029
|
+
* @name GitHistoricalQuote
|
|
5030
|
+
* @summary Get single historical quote
|
|
5031
|
+
* @request GET:/historical/quote
|
|
5032
|
+
* @secure
|
|
5033
|
+
*/
|
|
5034
|
+
gitHistoricalQuote(query: {
|
|
5035
|
+
/** Symbol */
|
|
5036
|
+
symbol: string;
|
|
5037
|
+
/** Date */
|
|
5038
|
+
date: string;
|
|
5039
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
5040
|
+
/**
|
|
5041
|
+
* @description get quote history by symbol
|
|
5042
|
+
* @tags Quotes
|
|
5043
|
+
* @name GitQuoteHistory
|
|
5044
|
+
* @summary Get quote history
|
|
5045
|
+
* @request POST:/quote-history
|
|
5046
|
+
* @secure
|
|
5047
|
+
*/
|
|
5048
|
+
gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
|
|
5049
|
+
/**
|
|
5050
|
+
* @description Returns a list of quotes equity info for specified symbols.
|
|
5051
|
+
* @tags Quotes
|
|
5052
|
+
* @name GetQuotesEquityData
|
|
5053
|
+
* @summary Get Quotes Equity data
|
|
5054
|
+
* @request GET:/quotes/equity
|
|
5055
|
+
* @secure
|
|
5056
|
+
*/
|
|
5057
|
+
getQuotesEquityData(query: {
|
|
5058
|
+
/** Comma separated symbols */
|
|
5059
|
+
symbols: string;
|
|
5060
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
5061
|
+
}
|
|
5062
|
+
export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
5063
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5064
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5065
|
+
/**
|
|
5066
|
+
* @description get pre ipo companies Avaliable categories: on-demand business-video reverse-etl modern-data-stack video-api global-payroll banking-as-a-service ultrafast-delivery online-grocery website-builder fintech b2b venture-capital ecommerce creator-economy productivity real-estate private-markets-exchanges fpa vertical-saas card-issuing connected-fitness gig-marketplaces cms soc-2 analytics cap-table-management contractor-payroll social-media design online-whiteboard conversational-marketing expense-management stock-option-financing customer-onboarding crypto help-desk payroll documents databases mortgage-lending crypto-exchange marketing-automation payments operations checkout cybersecurity messaging investing marketplaces climate-tech robotics data-security online-education gaming universal-api automation biotechnology contact-center defense machine-learning logistics prefab-tech materials telehealth b2c alternative-proteins b2b-marketplaces wealth-management web3 neobank managed-marketplaces plg-crm jamstack public-safety background-checks identity-verification construction home-services sales blockchain-developer-platform space financial-data-aggregation ai writing-assistant autonomous-driving 401k-provider vector-databases ai-models devtools payroll-api internal-tools mlops bookkeeping cloud-infrastructure data-backups personal-finance ai-frameworks generative-ai cloud-gpus micromobility ai-avatars ai-chips life-sciences partnerships wearables fitness-tracking ai-search ai-medical-scribes networking quantum-computing code-editors
|
|
5067
|
+
* @tags PreIPOCompanies
|
|
5068
|
+
* @name GetPreIpoCompanies
|
|
5069
|
+
* @summary get pre ipo companies
|
|
5070
|
+
* @request GET:/ipos/pre-ipo-companies
|
|
5071
|
+
* @secure
|
|
5072
|
+
*/
|
|
5073
|
+
getPreIpoCompanies(query: {
|
|
5074
|
+
/** search by company name */
|
|
5075
|
+
name?: string;
|
|
5076
|
+
/** search by categories */
|
|
5077
|
+
categories?: string;
|
|
5078
|
+
/** how many records to return. Max value is 50 */
|
|
5079
|
+
limit: number;
|
|
5080
|
+
/** how many records to skip */
|
|
5081
|
+
offset: number;
|
|
5082
|
+
/** sort field */
|
|
5083
|
+
order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
|
|
5084
|
+
/** sort direction */
|
|
5085
|
+
order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
|
|
5086
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
|
|
5087
|
+
/**
|
|
5088
|
+
* @description get pre ipo company by id
|
|
5089
|
+
* @tags PreIPOCompanies
|
|
5065
5090
|
* @name GetPreIpoCompaniesById
|
|
5066
5091
|
* @summary get pre ipo company by id
|
|
5067
5092
|
* @request GET:/ipos/pre-ipo-companies/{id}
|
|
@@ -5211,6 +5236,8 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
5211
5236
|
limit: number;
|
|
5212
5237
|
/** how many records to skip */
|
|
5213
5238
|
offset: number;
|
|
5239
|
+
/** search by monark stage */
|
|
5240
|
+
monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
|
|
5214
5241
|
/** sort direction */
|
|
5215
5242
|
direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
|
|
5216
5243
|
/** sort field */
|
|
@@ -5241,47 +5268,6 @@ export class Intraday<HandleError extends boolean = boolean> {
|
|
|
5241
5268
|
*/
|
|
5242
5269
|
intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
|
|
5243
5270
|
}
|
|
5244
|
-
export class Ipos<HandleError extends boolean = boolean> {
|
|
5245
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5246
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5247
|
-
/**
|
|
5248
|
-
* @description get recent ipos info
|
|
5249
|
-
* @tags Ipos
|
|
5250
|
-
* @name PostRecent
|
|
5251
|
-
* @summary get recent ipos info
|
|
5252
|
-
* @request POST:/ipos/recent
|
|
5253
|
-
* @secure
|
|
5254
|
-
*/
|
|
5255
|
-
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5256
|
-
/**
|
|
5257
|
-
* @description get upcoming ipos info
|
|
5258
|
-
* @tags Ipos
|
|
5259
|
-
* @name GetUpcoming
|
|
5260
|
-
* @summary get upcoming ipos info
|
|
5261
|
-
* @request GET:/ipos/upcoming
|
|
5262
|
-
* @secure
|
|
5263
|
-
*/
|
|
5264
|
-
getUpcoming(query: {
|
|
5265
|
-
/** how many records to return. Max value is 50 */
|
|
5266
|
-
limit: number;
|
|
5267
|
-
/** how many records to skip */
|
|
5268
|
-
offset: number;
|
|
5269
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5270
|
-
/**
|
|
5271
|
-
* @description get ipo info by symbol
|
|
5272
|
-
* @tags Ipos
|
|
5273
|
-
* @name GetIpos
|
|
5274
|
-
* @summary get ipo info by symbol
|
|
5275
|
-
* @request GET:/ipos/{symbol}
|
|
5276
|
-
* @secure
|
|
5277
|
-
*/
|
|
5278
|
-
getIpos(symbol: string, query?: {
|
|
5279
|
-
/** load quotes */
|
|
5280
|
-
load_quotes?: boolean;
|
|
5281
|
-
/** statuses */
|
|
5282
|
-
statuses?: string[];
|
|
5283
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
|
|
5284
|
-
}
|
|
5285
5271
|
export class Logos<HandleError extends boolean = boolean> {
|
|
5286
5272
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5287
5273
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5382,6 +5368,47 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5382
5368
|
symbol: string;
|
|
5383
5369
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
|
|
5384
5370
|
}
|
|
5371
|
+
export class Ipos<HandleError extends boolean = boolean> {
|
|
5372
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5373
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5374
|
+
/**
|
|
5375
|
+
* @description get recent ipos info
|
|
5376
|
+
* @tags Ipos
|
|
5377
|
+
* @name PostRecent
|
|
5378
|
+
* @summary get recent ipos info
|
|
5379
|
+
* @request POST:/ipos/recent
|
|
5380
|
+
* @secure
|
|
5381
|
+
*/
|
|
5382
|
+
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5383
|
+
/**
|
|
5384
|
+
* @description get upcoming ipos info
|
|
5385
|
+
* @tags Ipos
|
|
5386
|
+
* @name GetUpcoming
|
|
5387
|
+
* @summary get upcoming ipos info
|
|
5388
|
+
* @request GET:/ipos/upcoming
|
|
5389
|
+
* @secure
|
|
5390
|
+
*/
|
|
5391
|
+
getUpcoming(query: {
|
|
5392
|
+
/** how many records to return. Max value is 50 */
|
|
5393
|
+
limit: number;
|
|
5394
|
+
/** how many records to skip */
|
|
5395
|
+
offset: number;
|
|
5396
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5397
|
+
/**
|
|
5398
|
+
* @description get ipo info by symbol
|
|
5399
|
+
* @tags Ipos
|
|
5400
|
+
* @name GetIpos
|
|
5401
|
+
* @summary get ipo info by symbol
|
|
5402
|
+
* @request GET:/ipos/{symbol}
|
|
5403
|
+
* @secure
|
|
5404
|
+
*/
|
|
5405
|
+
getIpos(symbol: string, query?: {
|
|
5406
|
+
/** load quotes */
|
|
5407
|
+
load_quotes?: boolean;
|
|
5408
|
+
/** statuses */
|
|
5409
|
+
statuses?: string[];
|
|
5410
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
|
|
5411
|
+
}
|
|
5385
5412
|
export class MarketDates<HandleError extends boolean = boolean> {
|
|
5386
5413
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5387
5414
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5564,38 +5591,142 @@ export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
|
5564
5591
|
* @request POST:/og/calculate-matrix
|
|
5565
5592
|
* @secure
|
|
5566
5593
|
*/
|
|
5567
|
-
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
5594
|
+
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
5595
|
+
/**
|
|
5596
|
+
* @description Returns calculated params
|
|
5597
|
+
* @tags OptionGreeks
|
|
5598
|
+
* @name OgCalculateParams
|
|
5599
|
+
* @summary Calculate params
|
|
5600
|
+
* @request POST:/og/calculate-params
|
|
5601
|
+
* @secure
|
|
5602
|
+
*/
|
|
5603
|
+
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
5604
|
+
}
|
|
5605
|
+
export class Public<HandleError extends boolean = boolean> {
|
|
5606
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5607
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5608
|
+
/**
|
|
5609
|
+
* @description Calculate estimated returns for selected symbols. Uses split adjusted prices
|
|
5610
|
+
* @tags Public
|
|
5611
|
+
* @name CalculateEstimatedReturns
|
|
5612
|
+
* @summary Calculate Estimated Returns
|
|
5613
|
+
* @request GET:/public/estimated-returns
|
|
5614
|
+
* @secure
|
|
5615
|
+
*/
|
|
5616
|
+
calculateEstimatedReturns(query: {
|
|
5617
|
+
/** Single symbol */
|
|
5618
|
+
symbol: string;
|
|
5619
|
+
/** Non-zero amount */
|
|
5620
|
+
amount: number;
|
|
5621
|
+
/** Start date for calculations */
|
|
5622
|
+
start_date: string;
|
|
5623
|
+
/** End date for calculations */
|
|
5624
|
+
end_date: string;
|
|
5625
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
5626
|
+
/**
|
|
5627
|
+
* @description Returns an expert forecast
|
|
5628
|
+
* @tags Public
|
|
5629
|
+
* @name ExpertForecast
|
|
5630
|
+
* @summary Expert forecast
|
|
5631
|
+
* @request GET:/public/expert-forecast
|
|
5632
|
+
* @secure
|
|
5633
|
+
*/
|
|
5634
|
+
expertForecast(query: {
|
|
5635
|
+
/** Comma separated symbols */
|
|
5636
|
+
symbols: string;
|
|
5637
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
5638
|
+
/**
|
|
5639
|
+
* @description get fundamentals by symbol data
|
|
5640
|
+
* @tags Public
|
|
5641
|
+
* @name GetPublicFundamentalsBySymbolData
|
|
5642
|
+
* @summary get fundamentals by symbol data
|
|
5643
|
+
* @request GET:/public/fundamentals/{symbol}
|
|
5644
|
+
* @secure
|
|
5645
|
+
*/
|
|
5646
|
+
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
5647
|
+
/** Annual or quarterly */
|
|
5648
|
+
mode: string;
|
|
5649
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5650
|
+
/**
|
|
5651
|
+
* @description Daily price history
|
|
5652
|
+
* @tags Public
|
|
5653
|
+
* @name DailyPriceHistory
|
|
5654
|
+
* @summary Daily price history
|
|
5655
|
+
* @request GET:/public/price-history/daily
|
|
5656
|
+
* @secure
|
|
5657
|
+
*/
|
|
5658
|
+
dailyPriceHistory(query: {
|
|
5659
|
+
/** Single symbol */
|
|
5660
|
+
symbol: string;
|
|
5661
|
+
/** Target date */
|
|
5662
|
+
date: string;
|
|
5663
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
5664
|
+
/**
|
|
5665
|
+
* @description Public quote profile
|
|
5666
|
+
* @tags Public
|
|
5667
|
+
* @name PublicQuoteProfile
|
|
5668
|
+
* @summary Public quote profile
|
|
5669
|
+
* @request GET:/public/quote-profile/{symbol}
|
|
5670
|
+
* @secure
|
|
5671
|
+
*/
|
|
5672
|
+
publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
|
|
5673
|
+
/**
|
|
5674
|
+
* @description get ratios by symbol data
|
|
5675
|
+
* @tags Public
|
|
5676
|
+
* @name GetPublicRatiosBySymbolData
|
|
5677
|
+
* @summary get ratios by symbol data
|
|
5678
|
+
* @request GET:/public/ratios/{symbol}
|
|
5679
|
+
* @secure
|
|
5680
|
+
*/
|
|
5681
|
+
getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
|
|
5568
5682
|
/**
|
|
5569
|
-
* @description
|
|
5570
|
-
* @tags
|
|
5571
|
-
* @name
|
|
5572
|
-
* @summary
|
|
5573
|
-
* @request
|
|
5683
|
+
* @description find a symbol by name or description
|
|
5684
|
+
* @tags Public
|
|
5685
|
+
* @name QuoteFundamentalsSearch
|
|
5686
|
+
* @summary find a symbol by name or description
|
|
5687
|
+
* @request GET:/public/symbol-search
|
|
5574
5688
|
* @secure
|
|
5575
5689
|
*/
|
|
5576
|
-
|
|
5577
|
-
|
|
5578
|
-
|
|
5579
|
-
|
|
5580
|
-
|
|
5690
|
+
quoteFundamentalsSearch(query: {
|
|
5691
|
+
/** Search query */
|
|
5692
|
+
search_query: string;
|
|
5693
|
+
/** how many records to return. Max value is 50 */
|
|
5694
|
+
limit: number;
|
|
5695
|
+
/** how many records to skip */
|
|
5696
|
+
offset: number;
|
|
5697
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
5581
5698
|
/**
|
|
5582
|
-
* @description
|
|
5583
|
-
* @tags
|
|
5584
|
-
* @name
|
|
5585
|
-
* @summary
|
|
5586
|
-
* @request
|
|
5699
|
+
* @description Get top gainers
|
|
5700
|
+
* @tags Public
|
|
5701
|
+
* @name TopGainers
|
|
5702
|
+
* @summary Top Gainers
|
|
5703
|
+
* @request GET:/public/top-gainers
|
|
5587
5704
|
* @secure
|
|
5588
5705
|
*/
|
|
5589
|
-
|
|
5706
|
+
topGainers(query: {
|
|
5707
|
+
/** sort direction - asc or desc */
|
|
5708
|
+
order_direction?: string;
|
|
5709
|
+
/** how many records to return. Max value is 50 */
|
|
5710
|
+
limit: number;
|
|
5711
|
+
/** how many records to skip */
|
|
5712
|
+
offset: number;
|
|
5713
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
5590
5714
|
/**
|
|
5591
|
-
* @description
|
|
5592
|
-
* @tags
|
|
5593
|
-
* @name
|
|
5594
|
-
* @summary
|
|
5595
|
-
* @request
|
|
5715
|
+
* @description Get top stocks
|
|
5716
|
+
* @tags Public
|
|
5717
|
+
* @name TopStocks
|
|
5718
|
+
* @summary Top Stocks
|
|
5719
|
+
* @request GET:/public/top-stocks
|
|
5596
5720
|
* @secure
|
|
5597
5721
|
*/
|
|
5598
|
-
|
|
5722
|
+
topStocks(query: {
|
|
5723
|
+
/** EQUITY|ETF|CRYPTO */
|
|
5724
|
+
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
5725
|
+
/** how many records to return. Max value is 50 */
|
|
5726
|
+
limit: number;
|
|
5727
|
+
/** how many records to skip */
|
|
5728
|
+
offset: number;
|
|
5729
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
5599
5730
|
}
|
|
5600
5731
|
export class TipRank<HandleError extends boolean = boolean> {
|
|
5601
5732
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5963,131 +6094,18 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
5963
6094
|
Authorization?: string;
|
|
5964
6095
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
|
|
5965
6096
|
}
|
|
5966
|
-
export class
|
|
6097
|
+
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
5967
6098
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5968
6099
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5969
6100
|
/**
|
|
5970
|
-
* @description
|
|
5971
|
-
* @tags
|
|
5972
|
-
* @name
|
|
5973
|
-
* @summary
|
|
5974
|
-
* @request
|
|
5975
|
-
* @secure
|
|
5976
|
-
*/
|
|
5977
|
-
calculateEstimatedReturns(query: {
|
|
5978
|
-
/** Single symbol */
|
|
5979
|
-
symbol: string;
|
|
5980
|
-
/** Non-zero amount */
|
|
5981
|
-
amount: number;
|
|
5982
|
-
/** Start date for calculations */
|
|
5983
|
-
start_date: string;
|
|
5984
|
-
/** End date for calculations */
|
|
5985
|
-
end_date: string;
|
|
5986
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
5987
|
-
/**
|
|
5988
|
-
* @description Returns an expert forecast
|
|
5989
|
-
* @tags Public
|
|
5990
|
-
* @name ExpertForecast
|
|
5991
|
-
* @summary Expert forecast
|
|
5992
|
-
* @request GET:/public/expert-forecast
|
|
5993
|
-
* @secure
|
|
5994
|
-
*/
|
|
5995
|
-
expertForecast(query: {
|
|
5996
|
-
/** Comma separated symbols */
|
|
5997
|
-
symbols: string;
|
|
5998
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
5999
|
-
/**
|
|
6000
|
-
* @description get fundamentals by symbol data
|
|
6001
|
-
* @tags Public
|
|
6002
|
-
* @name GetPublicFundamentalsBySymbolData
|
|
6003
|
-
* @summary get fundamentals by symbol data
|
|
6004
|
-
* @request GET:/public/fundamentals/{symbol}
|
|
6005
|
-
* @secure
|
|
6006
|
-
*/
|
|
6007
|
-
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
6008
|
-
/** Annual or quarterly */
|
|
6009
|
-
mode: string;
|
|
6010
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
6011
|
-
/**
|
|
6012
|
-
* @description Daily price history
|
|
6013
|
-
* @tags Public
|
|
6014
|
-
* @name DailyPriceHistory
|
|
6015
|
-
* @summary Daily price history
|
|
6016
|
-
* @request GET:/public/price-history/daily
|
|
6017
|
-
* @secure
|
|
6018
|
-
*/
|
|
6019
|
-
dailyPriceHistory(query: {
|
|
6020
|
-
/** Single symbol */
|
|
6021
|
-
symbol: string;
|
|
6022
|
-
/** Target date */
|
|
6023
|
-
date: string;
|
|
6024
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
6025
|
-
/**
|
|
6026
|
-
* @description Public quote profile
|
|
6027
|
-
* @tags Public
|
|
6028
|
-
* @name PublicQuoteProfile
|
|
6029
|
-
* @summary Public quote profile
|
|
6030
|
-
* @request GET:/public/quote-profile/{symbol}
|
|
6031
|
-
* @secure
|
|
6032
|
-
*/
|
|
6033
|
-
publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
|
|
6034
|
-
/**
|
|
6035
|
-
* @description get ratios by symbol data
|
|
6036
|
-
* @tags Public
|
|
6037
|
-
* @name GetPublicRatiosBySymbolData
|
|
6038
|
-
* @summary get ratios by symbol data
|
|
6039
|
-
* @request GET:/public/ratios/{symbol}
|
|
6040
|
-
* @secure
|
|
6041
|
-
*/
|
|
6042
|
-
getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
|
|
6043
|
-
/**
|
|
6044
|
-
* @description find a symbol by name or description
|
|
6045
|
-
* @tags Public
|
|
6046
|
-
* @name QuoteFundamentalsSearch
|
|
6047
|
-
* @summary find a symbol by name or description
|
|
6048
|
-
* @request GET:/public/symbol-search
|
|
6049
|
-
* @secure
|
|
6050
|
-
*/
|
|
6051
|
-
quoteFundamentalsSearch(query: {
|
|
6052
|
-
/** Search query */
|
|
6053
|
-
search_query: string;
|
|
6054
|
-
/** how many records to return. Max value is 50 */
|
|
6055
|
-
limit: number;
|
|
6056
|
-
/** how many records to skip */
|
|
6057
|
-
offset: number;
|
|
6058
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
6059
|
-
/**
|
|
6060
|
-
* @description Get top gainers
|
|
6061
|
-
* @tags Public
|
|
6062
|
-
* @name TopGainers
|
|
6063
|
-
* @summary Top Gainers
|
|
6064
|
-
* @request GET:/public/top-gainers
|
|
6065
|
-
* @secure
|
|
6066
|
-
*/
|
|
6067
|
-
topGainers(query: {
|
|
6068
|
-
/** sort direction - asc or desc */
|
|
6069
|
-
order_direction?: string;
|
|
6070
|
-
/** how many records to return. Max value is 50 */
|
|
6071
|
-
limit: number;
|
|
6072
|
-
/** how many records to skip */
|
|
6073
|
-
offset: number;
|
|
6074
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6075
|
-
/**
|
|
6076
|
-
* @description Get top stocks
|
|
6077
|
-
* @tags Public
|
|
6078
|
-
* @name TopStocks
|
|
6079
|
-
* @summary Top Stocks
|
|
6080
|
-
* @request GET:/public/top-stocks
|
|
6101
|
+
* @description get usage date per branch for a period
|
|
6102
|
+
* @tags UsageTracking
|
|
6103
|
+
* @name GetUsageData
|
|
6104
|
+
* @summary get insight usage data
|
|
6105
|
+
* @request POST:/tracking/usage
|
|
6081
6106
|
* @secure
|
|
6082
6107
|
*/
|
|
6083
|
-
|
|
6084
|
-
/** EQUITY|ETF|CRYPTO */
|
|
6085
|
-
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
6086
|
-
/** how many records to return. Max value is 50 */
|
|
6087
|
-
limit: number;
|
|
6088
|
-
/** how many records to skip */
|
|
6089
|
-
offset: number;
|
|
6090
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6108
|
+
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
6091
6109
|
}
|
|
6092
6110
|
export class Ownerships<HandleError extends boolean = boolean> {
|
|
6093
6111
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -6111,6 +6129,28 @@ export class Ownerships<HandleError extends boolean = boolean> {
|
|
|
6111
6129
|
*/
|
|
6112
6130
|
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
6113
6131
|
}
|
|
6132
|
+
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
6133
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6134
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6135
|
+
/**
|
|
6136
|
+
* @description get seasonlity data with comparison to benchmark
|
|
6137
|
+
* @tags AlphaTools
|
|
6138
|
+
* @name GetMomentumRatioGraph
|
|
6139
|
+
* @summary get seasonlity data
|
|
6140
|
+
* @request POST:/rst
|
|
6141
|
+
* @secure
|
|
6142
|
+
*/
|
|
6143
|
+
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
6144
|
+
/**
|
|
6145
|
+
* @description get seasonlity data with comparison to benchmark
|
|
6146
|
+
* @tags AlphaTools
|
|
6147
|
+
* @name GetSeasonality
|
|
6148
|
+
* @summary get seasonlity data
|
|
6149
|
+
* @request POST:/seasonality
|
|
6150
|
+
* @secure
|
|
6151
|
+
*/
|
|
6152
|
+
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
6153
|
+
}
|
|
6114
6154
|
export class Passport<HandleError extends boolean = boolean> {
|
|
6115
6155
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6116
6156
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -6169,19 +6209,6 @@ export class Passport<HandleError extends boolean = boolean> {
|
|
|
6169
6209
|
*/
|
|
6170
6210
|
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
6171
6211
|
}
|
|
6172
|
-
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
6173
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6174
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6175
|
-
/**
|
|
6176
|
-
* @description get usage date per branch for a period
|
|
6177
|
-
* @tags UsageTracking
|
|
6178
|
-
* @name GetUsageData
|
|
6179
|
-
* @summary get insight usage data
|
|
6180
|
-
* @request POST:/tracking/usage
|
|
6181
|
-
* @secure
|
|
6182
|
-
*/
|
|
6183
|
-
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
6184
|
-
}
|
|
6185
6212
|
export interface InsightBeforeAndAfterV2 {
|
|
6186
6213
|
after?: string;
|
|
6187
6214
|
before?: string;
|
|
@@ -6407,6 +6434,19 @@ export enum InsightOrderingDirectionEnumV2 {
|
|
|
6407
6434
|
Asc = "asc",
|
|
6408
6435
|
Desc = "desc"
|
|
6409
6436
|
}
|
|
6437
|
+
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
6438
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6439
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6440
|
+
/**
|
|
6441
|
+
* @description get fixed income entries
|
|
6442
|
+
* @tags FixedIncome
|
|
6443
|
+
* @name GetFixedIncomeEntries
|
|
6444
|
+
* @summary get fixed income entries
|
|
6445
|
+
* @request POST:/fixed-income
|
|
6446
|
+
* @secure
|
|
6447
|
+
*/
|
|
6448
|
+
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
6449
|
+
}
|
|
6410
6450
|
export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
6411
6451
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6412
6452
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -6429,19 +6469,6 @@ export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
|
6429
6469
|
*/
|
|
6430
6470
|
getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
6431
6471
|
}
|
|
6432
|
-
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
6433
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6434
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6435
|
-
/**
|
|
6436
|
-
* @description get fixed income entries
|
|
6437
|
-
* @tags FixedIncome
|
|
6438
|
-
* @name GetFixedIncomeEntries
|
|
6439
|
-
* @summary get fixed income entries
|
|
6440
|
-
* @request POST:/fixed-income
|
|
6441
|
-
* @secure
|
|
6442
|
-
*/
|
|
6443
|
-
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
6444
|
-
}
|
|
6445
6472
|
export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
6446
6473
|
readonly config: JwtClientConfig<HandleError>;
|
|
6447
6474
|
alphaTools: AlphaTools<HandleError>;
|