@orbis-systems/orbis-api-clients 0.6.8 → 0.6.9
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 +9 -0
- package/dist/aesmidas/index.d.ts.map +1 -1
- package/dist/aesmidas/index.esm.js +1 -2806
- package/dist/aesmidas/index.esm.js.map +1 -1
- package/dist/aesmidas/index.js +1 -2811
- package/dist/aesmidas/index.js.map +1 -1
- package/dist/bridgewise/index.d.ts +176 -175
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +1 -1888
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +1 -1893
- package/dist/bridgewise/index.js.map +1 -1
- package/dist/index.esm.js +1 -257
- package/dist/index.esm.js.map +1 -1
- package/dist/index.js +1 -280
- package/dist/index.js.map +1 -1
- package/dist/insight/index.d.ts +322 -322
- package/dist/insight/index.d.ts.map +1 -1
- package/dist/insight/index.esm.js +1 -3754
- package/dist/insight/index.esm.js.map +1 -1
- package/dist/insight/index.js +1 -3759
- package/dist/insight/index.js.map +1 -1
- package/dist/middleware/index.esm.js +1 -1066
- package/dist/middleware/index.esm.js.map +1 -1
- package/dist/middleware/index.js +1 -1071
- package/dist/middleware/index.js.map +1 -1
- package/dist/orbis/index.d.ts +2191 -2191
- package/dist/orbis/index.d.ts.map +1 -1
- package/dist/orbis/index.esm.js +1 -7009
- package/dist/orbis/index.esm.js.map +1 -1
- package/dist/orbis/index.js +1 -7014
- package/dist/orbis/index.js.map +1 -1
- package/dist/uma/index.d.ts +194 -194
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -3993
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -3998
- package/dist/uma/index.js.map +1 -1
- package/package.json +9 -1
package/dist/insight/index.d.ts
CHANGED
|
@@ -4188,45 +4188,6 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
|
|
|
4188
4188
|
Date = "date",
|
|
4189
4189
|
Rank = "rank"
|
|
4190
4190
|
}
|
|
4191
|
-
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4192
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4193
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4194
|
-
/**
|
|
4195
|
-
* @description get company profile, industries classification and closest earning release
|
|
4196
|
-
* @tags CompanyProfile
|
|
4197
|
-
* @name GetCompanyProfile
|
|
4198
|
-
* @summary get company profile
|
|
4199
|
-
* @request GET:/company-profile
|
|
4200
|
-
* @secure
|
|
4201
|
-
*/
|
|
4202
|
-
getCompanyProfile(query: {
|
|
4203
|
-
/** Company symbol */
|
|
4204
|
-
symbol: string;
|
|
4205
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
|
|
4206
|
-
/**
|
|
4207
|
-
* @description get combined profile, equities and funds
|
|
4208
|
-
* @tags CompanyProfile
|
|
4209
|
-
* @name GetCombinedProfile
|
|
4210
|
-
* @summary get company profile
|
|
4211
|
-
* @request GET:/quote-profile
|
|
4212
|
-
* @secure
|
|
4213
|
-
*/
|
|
4214
|
-
getCombinedProfile(query: {
|
|
4215
|
-
/** Company symbol */
|
|
4216
|
-
symbol: string;
|
|
4217
|
-
/** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
|
|
4218
|
-
symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
|
|
4219
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
|
|
4220
|
-
/**
|
|
4221
|
-
* @description sort input array of symbols by type
|
|
4222
|
-
* @tags CompanyProfile
|
|
4223
|
-
* @name GetSymbolsPerSymbolType
|
|
4224
|
-
* @summary sort input array of symbols by type
|
|
4225
|
-
* @request POST:/symbols-per-type
|
|
4226
|
-
* @secure
|
|
4227
|
-
*/
|
|
4228
|
-
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
4229
|
-
}
|
|
4230
4191
|
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
4231
4192
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4232
4193
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4409,6 +4370,45 @@ export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
|
4409
4370
|
id: string;
|
|
4410
4371
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4411
4372
|
}
|
|
4373
|
+
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4374
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4375
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4376
|
+
/**
|
|
4377
|
+
* @description get company profile, industries classification and closest earning release
|
|
4378
|
+
* @tags CompanyProfile
|
|
4379
|
+
* @name GetCompanyProfile
|
|
4380
|
+
* @summary get company profile
|
|
4381
|
+
* @request GET:/company-profile
|
|
4382
|
+
* @secure
|
|
4383
|
+
*/
|
|
4384
|
+
getCompanyProfile(query: {
|
|
4385
|
+
/** Company symbol */
|
|
4386
|
+
symbol: string;
|
|
4387
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
|
|
4388
|
+
/**
|
|
4389
|
+
* @description get combined profile, equities and funds
|
|
4390
|
+
* @tags CompanyProfile
|
|
4391
|
+
* @name GetCombinedProfile
|
|
4392
|
+
* @summary get company profile
|
|
4393
|
+
* @request GET:/quote-profile
|
|
4394
|
+
* @secure
|
|
4395
|
+
*/
|
|
4396
|
+
getCombinedProfile(query: {
|
|
4397
|
+
/** Company symbol */
|
|
4398
|
+
symbol: string;
|
|
4399
|
+
/** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
|
|
4400
|
+
symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
|
|
4401
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
|
|
4402
|
+
/**
|
|
4403
|
+
* @description sort input array of symbols by type
|
|
4404
|
+
* @tags CompanyProfile
|
|
4405
|
+
* @name GetSymbolsPerSymbolType
|
|
4406
|
+
* @summary sort input array of symbols by type
|
|
4407
|
+
* @request POST:/symbols-per-type
|
|
4408
|
+
* @secure
|
|
4409
|
+
*/
|
|
4410
|
+
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
4411
|
+
}
|
|
4412
4412
|
export class CustomLists<HandleError extends boolean = boolean> {
|
|
4413
4413
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4414
4414
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5157,6 +5157,28 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
5157
5157
|
market: string;
|
|
5158
5158
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
5159
5159
|
}
|
|
5160
|
+
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
5161
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5162
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5163
|
+
/**
|
|
5164
|
+
* @description Returns calculated matrix
|
|
5165
|
+
* @tags OptionGreeks
|
|
5166
|
+
* @name OgCalculateMatrix
|
|
5167
|
+
* @summary Calculate matrix
|
|
5168
|
+
* @request POST:/og/calculate-matrix
|
|
5169
|
+
* @secure
|
|
5170
|
+
*/
|
|
5171
|
+
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
5172
|
+
/**
|
|
5173
|
+
* @description Returns calculated params
|
|
5174
|
+
* @tags OptionGreeks
|
|
5175
|
+
* @name OgCalculateParams
|
|
5176
|
+
* @summary Calculate params
|
|
5177
|
+
* @request POST:/og/calculate-params
|
|
5178
|
+
* @secure
|
|
5179
|
+
*/
|
|
5180
|
+
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
5181
|
+
}
|
|
5160
5182
|
export class News<HandleError extends boolean = boolean> {
|
|
5161
5183
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5162
5184
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5298,28 +5320,6 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
5298
5320
|
*/
|
|
5299
5321
|
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5300
5322
|
}
|
|
5301
|
-
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
5302
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5303
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5304
|
-
/**
|
|
5305
|
-
* @description Returns calculated matrix
|
|
5306
|
-
* @tags OptionGreeks
|
|
5307
|
-
* @name OgCalculateMatrix
|
|
5308
|
-
* @summary Calculate matrix
|
|
5309
|
-
* @request POST:/og/calculate-matrix
|
|
5310
|
-
* @secure
|
|
5311
|
-
*/
|
|
5312
|
-
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
5313
|
-
/**
|
|
5314
|
-
* @description Returns calculated params
|
|
5315
|
-
* @tags OptionGreeks
|
|
5316
|
-
* @name OgCalculateParams
|
|
5317
|
-
* @summary Calculate params
|
|
5318
|
-
* @request POST:/og/calculate-params
|
|
5319
|
-
* @secure
|
|
5320
|
-
*/
|
|
5321
|
-
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
5322
|
-
}
|
|
5323
5323
|
export class Ownerships<HandleError extends boolean = boolean> {
|
|
5324
5324
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5325
5325
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5342,93 +5342,290 @@ export class Ownerships<HandleError extends boolean = boolean> {
|
|
|
5342
5342
|
*/
|
|
5343
5343
|
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
5344
5344
|
}
|
|
5345
|
-
export class
|
|
5345
|
+
export class Public<HandleError extends boolean = boolean> {
|
|
5346
5346
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5347
5347
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5348
5348
|
/**
|
|
5349
|
-
* @description
|
|
5350
|
-
* @tags
|
|
5351
|
-
* @name
|
|
5352
|
-
* @summary
|
|
5353
|
-
* @request
|
|
5354
|
-
* @secure
|
|
5355
|
-
*/
|
|
5356
|
-
tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
|
|
5357
|
-
/**
|
|
5358
|
-
* @description Returns the latest analyst ratings on a given stock or multiple stocks.
|
|
5359
|
-
* @tags TipRank
|
|
5360
|
-
* @name TiprankLatestAnalystRatingsOnStock
|
|
5361
|
-
* @summary Get tiprank LatestAnalystRatingsOnStock
|
|
5362
|
-
* @request POST:/tipranks/analyst-multi
|
|
5349
|
+
* @description Calculate estimated returns for selected symbols. Uses split adjusted prices
|
|
5350
|
+
* @tags Public
|
|
5351
|
+
* @name CalculateEstimatedReturns
|
|
5352
|
+
* @summary Calculate Estimated Returns
|
|
5353
|
+
* @request GET:/public/estimated-returns
|
|
5363
5354
|
* @secure
|
|
5364
5355
|
*/
|
|
5365
|
-
|
|
5356
|
+
calculateEstimatedReturns(query: {
|
|
5357
|
+
/** Single symbol */
|
|
5358
|
+
symbol: string;
|
|
5359
|
+
/** Non-zero amount */
|
|
5360
|
+
amount: number;
|
|
5361
|
+
/** Start date for calculations */
|
|
5362
|
+
start_date: string;
|
|
5363
|
+
/** End date for calculations */
|
|
5364
|
+
end_date: string;
|
|
5365
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
5366
5366
|
/**
|
|
5367
|
-
* @description Returns
|
|
5368
|
-
* @tags
|
|
5369
|
-
* @name
|
|
5370
|
-
* @summary
|
|
5371
|
-
* @request
|
|
5367
|
+
* @description Returns an expert forecast
|
|
5368
|
+
* @tags Public
|
|
5369
|
+
* @name ExpertForecast
|
|
5370
|
+
* @summary Expert forecast
|
|
5371
|
+
* @request GET:/public/expert-forecast
|
|
5372
5372
|
* @secure
|
|
5373
5373
|
*/
|
|
5374
|
-
|
|
5375
|
-
/**
|
|
5376
|
-
|
|
5377
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5374
|
+
expertForecast(query: {
|
|
5375
|
+
/** Comma separated symbols */
|
|
5376
|
+
symbols: string;
|
|
5377
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
5378
5378
|
/**
|
|
5379
|
-
* @description
|
|
5380
|
-
* @tags
|
|
5381
|
-
* @name
|
|
5382
|
-
* @summary
|
|
5383
|
-
* @request GET:/
|
|
5379
|
+
* @description get fundamentals by symbol data
|
|
5380
|
+
* @tags Public
|
|
5381
|
+
* @name GetPublicFundamentalsBySymbolData
|
|
5382
|
+
* @summary get fundamentals by symbol data
|
|
5383
|
+
* @request GET:/public/fundamentals/{symbol}
|
|
5384
5384
|
* @secure
|
|
5385
5385
|
*/
|
|
5386
|
-
|
|
5387
|
-
/**
|
|
5388
|
-
|
|
5389
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5386
|
+
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
5387
|
+
/** Annual or quarterly */
|
|
5388
|
+
mode: string;
|
|
5389
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5390
5390
|
/**
|
|
5391
|
-
* @description
|
|
5392
|
-
* @tags
|
|
5393
|
-
* @name
|
|
5394
|
-
* @summary
|
|
5395
|
-
* @request GET:/
|
|
5391
|
+
* @description Daily price history
|
|
5392
|
+
* @tags Public
|
|
5393
|
+
* @name DailyPriceHistory
|
|
5394
|
+
* @summary Daily price history
|
|
5395
|
+
* @request GET:/public/price-history/daily
|
|
5396
5396
|
* @secure
|
|
5397
5397
|
*/
|
|
5398
|
-
|
|
5398
|
+
dailyPriceHistory(query: {
|
|
5399
|
+
/** Single symbol */
|
|
5400
|
+
symbol: string;
|
|
5401
|
+
/** Target date */
|
|
5402
|
+
date: string;
|
|
5403
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
5399
5404
|
/**
|
|
5400
|
-
* @description
|
|
5401
|
-
* @tags
|
|
5402
|
-
* @name
|
|
5403
|
-
* @summary
|
|
5404
|
-
* @request GET:/
|
|
5405
|
+
* @description Public quote profile
|
|
5406
|
+
* @tags Public
|
|
5407
|
+
* @name PublicQuoteProfile
|
|
5408
|
+
* @summary Public quote profile
|
|
5409
|
+
* @request GET:/public/quote-profile/{symbol}
|
|
5405
5410
|
* @secure
|
|
5406
5411
|
*/
|
|
5407
|
-
|
|
5408
|
-
/** The number of analysts to return */
|
|
5409
|
-
num?: number;
|
|
5410
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBestPerformingExpertsResponse[], HandleError>>;
|
|
5412
|
+
publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
|
|
5411
5413
|
/**
|
|
5412
|
-
* @description
|
|
5413
|
-
* @tags
|
|
5414
|
-
* @name
|
|
5415
|
-
* @summary
|
|
5416
|
-
* @request GET:/
|
|
5414
|
+
* @description get ratios by symbol data
|
|
5415
|
+
* @tags Public
|
|
5416
|
+
* @name GetPublicRatiosBySymbolData
|
|
5417
|
+
* @summary get ratios by symbol data
|
|
5418
|
+
* @request GET:/public/ratios/{symbol}
|
|
5417
5419
|
* @secure
|
|
5418
5420
|
*/
|
|
5419
|
-
|
|
5420
|
-
/** The ticker of the stock */
|
|
5421
|
-
ticker: string;
|
|
5422
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBloggerConsensusOnStockResponse[], HandleError>>;
|
|
5421
|
+
getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
|
|
5423
5422
|
/**
|
|
5424
|
-
* @description
|
|
5425
|
-
* @tags
|
|
5426
|
-
* @name
|
|
5427
|
-
* @summary
|
|
5428
|
-
* @request GET:/
|
|
5423
|
+
* @description find a symbol by name or description
|
|
5424
|
+
* @tags Public
|
|
5425
|
+
* @name QuoteFundamentalsSearch
|
|
5426
|
+
* @summary find a symbol by name or description
|
|
5427
|
+
* @request GET:/public/symbol-search
|
|
5429
5428
|
* @secure
|
|
5430
5429
|
*/
|
|
5431
|
-
|
|
5430
|
+
quoteFundamentalsSearch(query: {
|
|
5431
|
+
/** Search query */
|
|
5432
|
+
search_query: string;
|
|
5433
|
+
/** how many records to return. Max value is 50 */
|
|
5434
|
+
limit: number;
|
|
5435
|
+
/** how many records to skip */
|
|
5436
|
+
offset: number;
|
|
5437
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
5438
|
+
/**
|
|
5439
|
+
* @description Get top gainers
|
|
5440
|
+
* @tags Public
|
|
5441
|
+
* @name TopGainers
|
|
5442
|
+
* @summary Top Gainers
|
|
5443
|
+
* @request GET:/public/top-gainers
|
|
5444
|
+
* @secure
|
|
5445
|
+
*/
|
|
5446
|
+
topGainers(query: {
|
|
5447
|
+
/** sort direction - asc or desc */
|
|
5448
|
+
order_direction?: string;
|
|
5449
|
+
/** how many records to return. Max value is 50 */
|
|
5450
|
+
limit: number;
|
|
5451
|
+
/** how many records to skip */
|
|
5452
|
+
offset: number;
|
|
5453
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
5454
|
+
/**
|
|
5455
|
+
* @description Get top stocks
|
|
5456
|
+
* @tags Public
|
|
5457
|
+
* @name TopStocks
|
|
5458
|
+
* @summary Top Stocks
|
|
5459
|
+
* @request GET:/public/top-stocks
|
|
5460
|
+
* @secure
|
|
5461
|
+
*/
|
|
5462
|
+
topStocks(query: {
|
|
5463
|
+
/** EQUITY|ETF|CRYPTO */
|
|
5464
|
+
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
5465
|
+
/** how many records to return. Max value is 50 */
|
|
5466
|
+
limit: number;
|
|
5467
|
+
/** how many records to skip */
|
|
5468
|
+
offset: number;
|
|
5469
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
5470
|
+
}
|
|
5471
|
+
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
5472
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5473
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5474
|
+
/**
|
|
5475
|
+
* @description get usage date per branch for a period
|
|
5476
|
+
* @tags UsageTracking
|
|
5477
|
+
* @name GetUsageData
|
|
5478
|
+
* @summary get insight usage data
|
|
5479
|
+
* @request POST:/tracking/usage
|
|
5480
|
+
* @secure
|
|
5481
|
+
*/
|
|
5482
|
+
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
5483
|
+
}
|
|
5484
|
+
export class Passport<HandleError extends boolean = boolean> {
|
|
5485
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5486
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5487
|
+
/**
|
|
5488
|
+
* @description Returns article by id
|
|
5489
|
+
* @tags Passport
|
|
5490
|
+
* @name PassportArticleById
|
|
5491
|
+
* @summary Get article by id
|
|
5492
|
+
* @request POST:/passport/article-by-id
|
|
5493
|
+
* @secure
|
|
5494
|
+
*/
|
|
5495
|
+
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
5496
|
+
/**
|
|
5497
|
+
* @description Returns articles
|
|
5498
|
+
* @tags Passport
|
|
5499
|
+
* @name PassportArticles
|
|
5500
|
+
* @summary Get articles
|
|
5501
|
+
* @request POST:/passport/articles
|
|
5502
|
+
* @secure
|
|
5503
|
+
*/
|
|
5504
|
+
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5505
|
+
/**
|
|
5506
|
+
* @description Returns author profile
|
|
5507
|
+
* @tags Passport
|
|
5508
|
+
* @name PassportAuthorProfile
|
|
5509
|
+
* @summary Get author profile
|
|
5510
|
+
* @request POST:/passport/author-profile
|
|
5511
|
+
* @secure
|
|
5512
|
+
*/
|
|
5513
|
+
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
5514
|
+
/**
|
|
5515
|
+
* @description Returns most popular tags
|
|
5516
|
+
* @tags Passport
|
|
5517
|
+
* @name PassportMostPopularTags
|
|
5518
|
+
* @summary Get most popular tags
|
|
5519
|
+
* @request POST:/passport/most-popular-tags
|
|
5520
|
+
* @secure
|
|
5521
|
+
*/
|
|
5522
|
+
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
5523
|
+
/**
|
|
5524
|
+
* @description Returns news feed
|
|
5525
|
+
* @tags Passport
|
|
5526
|
+
* @name PassportNewsFeed
|
|
5527
|
+
* @summary Get news feed
|
|
5528
|
+
* @request POST:/passport/newsfeed
|
|
5529
|
+
* @secure
|
|
5530
|
+
*/
|
|
5531
|
+
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
|
|
5532
|
+
/**
|
|
5533
|
+
* @description Returns article by parameters
|
|
5534
|
+
* @tags Passport
|
|
5535
|
+
* @name PassportSearchArticle
|
|
5536
|
+
* @summary Search article by parameters
|
|
5537
|
+
* @request POST:/passport/search-article
|
|
5538
|
+
* @secure
|
|
5539
|
+
*/
|
|
5540
|
+
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5541
|
+
}
|
|
5542
|
+
export class TipRank<HandleError extends boolean = boolean> {
|
|
5543
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5544
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5545
|
+
/**
|
|
5546
|
+
* @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
|
|
5547
|
+
* @tags TipRank
|
|
5548
|
+
* @name TiprankAnalystConsensus
|
|
5549
|
+
* @summary Get tiprank AnalystConsensus
|
|
5550
|
+
* @request POST:/tipranks/analyst-consensus
|
|
5551
|
+
* @secure
|
|
5552
|
+
*/
|
|
5553
|
+
tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
|
|
5554
|
+
/**
|
|
5555
|
+
* @description Returns the latest analyst ratings on a given stock or multiple stocks.
|
|
5556
|
+
* @tags TipRank
|
|
5557
|
+
* @name TiprankLatestAnalystRatingsOnStock
|
|
5558
|
+
* @summary Get tiprank LatestAnalystRatingsOnStock
|
|
5559
|
+
* @request POST:/tipranks/analyst-multi
|
|
5560
|
+
* @secure
|
|
5561
|
+
*/
|
|
5562
|
+
tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError>>;
|
|
5563
|
+
/**
|
|
5564
|
+
* @description Returns the latest analyst portfolio items.
|
|
5565
|
+
* @tags TipRank
|
|
5566
|
+
* @name TiprankPortfolios
|
|
5567
|
+
* @summary Get the latest analyst portfolio items
|
|
5568
|
+
* @request POST:/tipranks/analyst-portfolio
|
|
5569
|
+
* @secure
|
|
5570
|
+
*/
|
|
5571
|
+
tiprankPortfolios(filter: InsightPortfoliosRequest, headers?: {
|
|
5572
|
+
/** Authorization */
|
|
5573
|
+
Authorization?: string;
|
|
5574
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError>>;
|
|
5575
|
+
/**
|
|
5576
|
+
* @description Returns the analyst profile information
|
|
5577
|
+
* @tags TipRank
|
|
5578
|
+
* @name TiprankAnalystProfile
|
|
5579
|
+
* @summary Get tiprank AnalystProfile
|
|
5580
|
+
* @request GET:/tipranks/analyst-profile
|
|
5581
|
+
* @secure
|
|
5582
|
+
*/
|
|
5583
|
+
tiprankAnalystProfile(query: {
|
|
5584
|
+
/** ID of tiprank analyst profile */
|
|
5585
|
+
id: string;
|
|
5586
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystProfileResponse, HandleError>>;
|
|
5587
|
+
/**
|
|
5588
|
+
* @description Returns the URL prefix to the expertPictureUrl field.
|
|
5589
|
+
* @tags TipRank
|
|
5590
|
+
* @name TiprankAnalystsExpertPictureStore
|
|
5591
|
+
* @summary Get tiprank AnalystsExpertPictureStore
|
|
5592
|
+
* @request GET:/tipranks/analysts-expert-picture-store
|
|
5593
|
+
* @secure
|
|
5594
|
+
*/
|
|
5595
|
+
tiprankAnalystsExpertPictureStore(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystsExpertPictureStoreResponse, HandleError>>;
|
|
5596
|
+
/**
|
|
5597
|
+
* @description Returns a list of top-ranked analysts.
|
|
5598
|
+
* @tags TipRank
|
|
5599
|
+
* @name TiprankBestPerformingExperts
|
|
5600
|
+
* @summary Get tiprank BestPerformingExperts
|
|
5601
|
+
* @request GET:/tipranks/best-performing-experts
|
|
5602
|
+
* @secure
|
|
5603
|
+
*/
|
|
5604
|
+
tiprankBestPerformingExperts(query?: {
|
|
5605
|
+
/** The number of analysts to return */
|
|
5606
|
+
num?: number;
|
|
5607
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBestPerformingExpertsResponse[], HandleError>>;
|
|
5608
|
+
/**
|
|
5609
|
+
* @description Returns the blogger consensus on the stock along with the blogger opinion distribution by site.
|
|
5610
|
+
* @tags TipRank
|
|
5611
|
+
* @name TiprankBloggerConsensusOnStock
|
|
5612
|
+
* @summary Get tiprank BloggerConsensusOnStock
|
|
5613
|
+
* @request GET:/tipranks/blogger-consensus-on-stock
|
|
5614
|
+
* @secure
|
|
5615
|
+
*/
|
|
5616
|
+
tiprankBloggerConsensusOnStock(query: {
|
|
5617
|
+
/** The ticker of the stock */
|
|
5618
|
+
ticker: string;
|
|
5619
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBloggerConsensusOnStockResponse[], HandleError>>;
|
|
5620
|
+
/**
|
|
5621
|
+
* @description Returns a list of the upcoming IPOs and recent IPOs that have already been priced
|
|
5622
|
+
* @tags TipRank
|
|
5623
|
+
* @name TiprankCalendarsIpos
|
|
5624
|
+
* @summary Get tiprank CalendarsIPOS
|
|
5625
|
+
* @request GET:/tipranks/calendars-ipos
|
|
5626
|
+
* @secure
|
|
5627
|
+
*/
|
|
5628
|
+
tiprankCalendarsIpos(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalendarsIPOSResponse[], HandleError>>;
|
|
5432
5629
|
/**
|
|
5433
5630
|
* @description Returns all stocks that have been updated since a specified UTC time.
|
|
5434
5631
|
* @tags TipRank
|
|
@@ -5708,145 +5905,6 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
5708
5905
|
Authorization?: string;
|
|
5709
5906
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
|
|
5710
5907
|
}
|
|
5711
|
-
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
5712
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5713
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5714
|
-
/**
|
|
5715
|
-
* @description get usage date per branch for a period
|
|
5716
|
-
* @tags UsageTracking
|
|
5717
|
-
* @name GetUsageData
|
|
5718
|
-
* @summary get insight usage data
|
|
5719
|
-
* @request POST:/tracking/usage
|
|
5720
|
-
* @secure
|
|
5721
|
-
*/
|
|
5722
|
-
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
5723
|
-
}
|
|
5724
|
-
export class Public<HandleError extends boolean = boolean> {
|
|
5725
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5726
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5727
|
-
/**
|
|
5728
|
-
* @description Calculate estimated returns for selected symbols. Uses split adjusted prices
|
|
5729
|
-
* @tags Public
|
|
5730
|
-
* @name CalculateEstimatedReturns
|
|
5731
|
-
* @summary Calculate Estimated Returns
|
|
5732
|
-
* @request GET:/public/estimated-returns
|
|
5733
|
-
* @secure
|
|
5734
|
-
*/
|
|
5735
|
-
calculateEstimatedReturns(query: {
|
|
5736
|
-
/** Single symbol */
|
|
5737
|
-
symbol: string;
|
|
5738
|
-
/** Non-zero amount */
|
|
5739
|
-
amount: number;
|
|
5740
|
-
/** Start date for calculations */
|
|
5741
|
-
start_date: string;
|
|
5742
|
-
/** End date for calculations */
|
|
5743
|
-
end_date: string;
|
|
5744
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
5745
|
-
/**
|
|
5746
|
-
* @description Returns an expert forecast
|
|
5747
|
-
* @tags Public
|
|
5748
|
-
* @name ExpertForecast
|
|
5749
|
-
* @summary Expert forecast
|
|
5750
|
-
* @request GET:/public/expert-forecast
|
|
5751
|
-
* @secure
|
|
5752
|
-
*/
|
|
5753
|
-
expertForecast(query: {
|
|
5754
|
-
/** Comma separated symbols */
|
|
5755
|
-
symbols: string;
|
|
5756
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
5757
|
-
/**
|
|
5758
|
-
* @description get fundamentals by symbol data
|
|
5759
|
-
* @tags Public
|
|
5760
|
-
* @name GetPublicFundamentalsBySymbolData
|
|
5761
|
-
* @summary get fundamentals by symbol data
|
|
5762
|
-
* @request GET:/public/fundamentals/{symbol}
|
|
5763
|
-
* @secure
|
|
5764
|
-
*/
|
|
5765
|
-
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
5766
|
-
/** Annual or quarterly */
|
|
5767
|
-
mode: string;
|
|
5768
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5769
|
-
/**
|
|
5770
|
-
* @description Daily price history
|
|
5771
|
-
* @tags Public
|
|
5772
|
-
* @name DailyPriceHistory
|
|
5773
|
-
* @summary Daily price history
|
|
5774
|
-
* @request GET:/public/price-history/daily
|
|
5775
|
-
* @secure
|
|
5776
|
-
*/
|
|
5777
|
-
dailyPriceHistory(query: {
|
|
5778
|
-
/** Single symbol */
|
|
5779
|
-
symbol: string;
|
|
5780
|
-
/** Target date */
|
|
5781
|
-
date: string;
|
|
5782
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
5783
|
-
/**
|
|
5784
|
-
* @description Public quote profile
|
|
5785
|
-
* @tags Public
|
|
5786
|
-
* @name PublicQuoteProfile
|
|
5787
|
-
* @summary Public quote profile
|
|
5788
|
-
* @request GET:/public/quote-profile/{symbol}
|
|
5789
|
-
* @secure
|
|
5790
|
-
*/
|
|
5791
|
-
publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
|
|
5792
|
-
/**
|
|
5793
|
-
* @description get ratios by symbol data
|
|
5794
|
-
* @tags Public
|
|
5795
|
-
* @name GetPublicRatiosBySymbolData
|
|
5796
|
-
* @summary get ratios by symbol data
|
|
5797
|
-
* @request GET:/public/ratios/{symbol}
|
|
5798
|
-
* @secure
|
|
5799
|
-
*/
|
|
5800
|
-
getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
|
|
5801
|
-
/**
|
|
5802
|
-
* @description find a symbol by name or description
|
|
5803
|
-
* @tags Public
|
|
5804
|
-
* @name QuoteFundamentalsSearch
|
|
5805
|
-
* @summary find a symbol by name or description
|
|
5806
|
-
* @request GET:/public/symbol-search
|
|
5807
|
-
* @secure
|
|
5808
|
-
*/
|
|
5809
|
-
quoteFundamentalsSearch(query: {
|
|
5810
|
-
/** Search query */
|
|
5811
|
-
search_query: string;
|
|
5812
|
-
/** how many records to return. Max value is 50 */
|
|
5813
|
-
limit: number;
|
|
5814
|
-
/** how many records to skip */
|
|
5815
|
-
offset: number;
|
|
5816
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
5817
|
-
/**
|
|
5818
|
-
* @description Get top gainers
|
|
5819
|
-
* @tags Public
|
|
5820
|
-
* @name TopGainers
|
|
5821
|
-
* @summary Top Gainers
|
|
5822
|
-
* @request GET:/public/top-gainers
|
|
5823
|
-
* @secure
|
|
5824
|
-
*/
|
|
5825
|
-
topGainers(query: {
|
|
5826
|
-
/** sort direction - asc or desc */
|
|
5827
|
-
order_direction?: string;
|
|
5828
|
-
/** how many records to return. Max value is 50 */
|
|
5829
|
-
limit: number;
|
|
5830
|
-
/** how many records to skip */
|
|
5831
|
-
offset: number;
|
|
5832
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
5833
|
-
/**
|
|
5834
|
-
* @description Get top stocks
|
|
5835
|
-
* @tags Public
|
|
5836
|
-
* @name TopStocks
|
|
5837
|
-
* @summary Top Stocks
|
|
5838
|
-
* @request GET:/public/top-stocks
|
|
5839
|
-
* @secure
|
|
5840
|
-
*/
|
|
5841
|
-
topStocks(query: {
|
|
5842
|
-
/** EQUITY|ETF|CRYPTO */
|
|
5843
|
-
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
5844
|
-
/** how many records to return. Max value is 50 */
|
|
5845
|
-
limit: number;
|
|
5846
|
-
/** how many records to skip */
|
|
5847
|
-
offset: number;
|
|
5848
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
5849
|
-
}
|
|
5850
5908
|
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
5851
5909
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5852
5910
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5869,64 +5927,6 @@ export class AlphaTools<HandleError extends boolean = boolean> {
|
|
|
5869
5927
|
*/
|
|
5870
5928
|
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
5871
5929
|
}
|
|
5872
|
-
export class Passport<HandleError extends boolean = boolean> {
|
|
5873
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5874
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5875
|
-
/**
|
|
5876
|
-
* @description Returns article by id
|
|
5877
|
-
* @tags Passport
|
|
5878
|
-
* @name PassportArticleById
|
|
5879
|
-
* @summary Get article by id
|
|
5880
|
-
* @request POST:/passport/article-by-id
|
|
5881
|
-
* @secure
|
|
5882
|
-
*/
|
|
5883
|
-
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
5884
|
-
/**
|
|
5885
|
-
* @description Returns articles
|
|
5886
|
-
* @tags Passport
|
|
5887
|
-
* @name PassportArticles
|
|
5888
|
-
* @summary Get articles
|
|
5889
|
-
* @request POST:/passport/articles
|
|
5890
|
-
* @secure
|
|
5891
|
-
*/
|
|
5892
|
-
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5893
|
-
/**
|
|
5894
|
-
* @description Returns author profile
|
|
5895
|
-
* @tags Passport
|
|
5896
|
-
* @name PassportAuthorProfile
|
|
5897
|
-
* @summary Get author profile
|
|
5898
|
-
* @request POST:/passport/author-profile
|
|
5899
|
-
* @secure
|
|
5900
|
-
*/
|
|
5901
|
-
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
5902
|
-
/**
|
|
5903
|
-
* @description Returns most popular tags
|
|
5904
|
-
* @tags Passport
|
|
5905
|
-
* @name PassportMostPopularTags
|
|
5906
|
-
* @summary Get most popular tags
|
|
5907
|
-
* @request POST:/passport/most-popular-tags
|
|
5908
|
-
* @secure
|
|
5909
|
-
*/
|
|
5910
|
-
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
5911
|
-
/**
|
|
5912
|
-
* @description Returns news feed
|
|
5913
|
-
* @tags Passport
|
|
5914
|
-
* @name PassportNewsFeed
|
|
5915
|
-
* @summary Get news feed
|
|
5916
|
-
* @request POST:/passport/newsfeed
|
|
5917
|
-
* @secure
|
|
5918
|
-
*/
|
|
5919
|
-
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
|
|
5920
|
-
/**
|
|
5921
|
-
* @description Returns article by parameters
|
|
5922
|
-
* @tags Passport
|
|
5923
|
-
* @name PassportSearchArticle
|
|
5924
|
-
* @summary Search article by parameters
|
|
5925
|
-
* @request POST:/passport/search-article
|
|
5926
|
-
* @secure
|
|
5927
|
-
*/
|
|
5928
|
-
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5929
|
-
}
|
|
5930
5930
|
export interface InsightBeforeAndAfterV2 {
|
|
5931
5931
|
after?: string;
|
|
5932
5932
|
before?: string;
|