@orbis-systems/orbis-api-clients 0.7.21 → 0.8.1

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.
Files changed (43) hide show
  1. package/dist/aesmidas/index.d.ts +441 -304
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +1 -1
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +1 -1
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +1193 -1163
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/index.d.ts +3 -2
  14. package/dist/index.d.ts.map +1 -1
  15. package/dist/index.esm.js +1 -1
  16. package/dist/index.esm.js.map +1 -1
  17. package/dist/index.js +1 -1
  18. package/dist/index.js.map +1 -1
  19. package/dist/insight/index.d.ts +520 -506
  20. package/dist/insight/index.d.ts.map +1 -1
  21. package/dist/insight/index.esm.js +1 -1
  22. package/dist/insight/index.esm.js.map +1 -1
  23. package/dist/insight/index.js +1 -1
  24. package/dist/insight/index.js.map +1 -1
  25. package/dist/middleware/index.d.ts +26 -4
  26. package/dist/middleware/index.d.ts.map +1 -1
  27. package/dist/middleware/index.esm.js +1 -1
  28. package/dist/middleware/index.esm.js.map +1 -1
  29. package/dist/middleware/index.js +1 -1
  30. package/dist/middleware/index.js.map +1 -1
  31. package/dist/orbis/index.d.ts +3 -2
  32. package/dist/orbis/index.d.ts.map +1 -1
  33. package/dist/orbis/index.esm.js +1 -1
  34. package/dist/orbis/index.esm.js.map +1 -1
  35. package/dist/orbis/index.js +1 -1
  36. package/dist/orbis/index.js.map +1 -1
  37. package/dist/uma/index.d.ts +426 -436
  38. package/dist/uma/index.d.ts.map +1 -1
  39. package/dist/uma/index.esm.js +1 -1
  40. package/dist/uma/index.esm.js.map +1 -1
  41. package/dist/uma/index.js +1 -1
  42. package/dist/uma/index.js.map +1 -1
  43. package/package.json +1 -1
@@ -64,7 +64,7 @@ declare class BaseApi<HandleError extends boolean = boolean, ApiClient extends B
64
64
  interface JwtClientConfig<HandleError extends boolean = boolean, AuthData extends JwtAuthData = JwtAuthData> extends BaseClientConfig<HandleError> {
65
65
  authSchema?: string;
66
66
  autoRenewToken?: boolean;
67
- onRenewToken?: () => Promise<AuthData>;
67
+ onRenewTokens?: () => Promise<AuthData>;
68
68
  }
69
69
  interface JwtAuthData {
70
70
  accessToken: string;
@@ -74,8 +74,9 @@ declare class JwtClient<HandleError extends boolean = boolean, AuthData extends
74
74
  protected readonly config: JwtClientConfig<HandleError, AuthData>;
75
75
  constructor(config: JwtClientConfig<HandleError, AuthData>);
76
76
  getConfig(): JwtClientConfig<HandleError>;
77
- setRenewTokenCallback(renewTokenCallback: () => Promise<AuthData>): void;
77
+ setRenewTokensCallback(renewTokensCallback: () => Promise<AuthData>): void;
78
78
  protected prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
79
+ protected renewTokens(): Promise<AuthData>;
79
80
  }
80
81
  export interface InsightQuote {
81
82
  ask_px: number;
@@ -1212,6 +1213,9 @@ export interface InsightGetFundDetailsResponse {
1212
1213
  fund_net_assets: number;
1213
1214
  fund_type: string;
1214
1215
  holdings: InsightHoldingBreakdown[];
1216
+ inception_date: string;
1217
+ inception_market_price: number;
1218
+ inception_nav: number;
1215
1219
  inverse: boolean;
1216
1220
  leverage: number;
1217
1221
  long_description: string;
@@ -1221,6 +1225,16 @@ export interface InsightGetFundDetailsResponse {
1221
1225
  sectors: InsightSectorBreakdown[];
1222
1226
  structure: string;
1223
1227
  symbol: string;
1228
+ tracking_error_y1: number;
1229
+ trailing_return_m1: number;
1230
+ trailing_return_m3: number;
1231
+ trailing_return_m6: number;
1232
+ trailing_return_y1: number;
1233
+ trailing_return_y10: number;
1234
+ trailing_return_y2: number;
1235
+ trailing_return_y3: number;
1236
+ trailing_return_y5: number;
1237
+ trailing_return_ytd: number;
1224
1238
  website: string;
1225
1239
  }
1226
1240
  export interface InsightGetFundScreenerFiltersResponse {
@@ -4782,6 +4796,45 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
4782
4796
  Date = "date",
4783
4797
  Rank = "rank"
4784
4798
  }
4799
+ export class CompanyProfile<HandleError extends boolean = boolean> {
4800
+ protected readonly apiClient: JwtClient<HandleError>;
4801
+ constructor(apiClient: JwtClient<HandleError>);
4802
+ /**
4803
+ * @description get company profile, industries classification and closest earning release
4804
+ * @tags CompanyProfile
4805
+ * @name GetCompanyProfile
4806
+ * @summary get company profile
4807
+ * @request GET:/company-profile
4808
+ * @secure
4809
+ */
4810
+ getCompanyProfile(query: {
4811
+ /** Company symbol */
4812
+ symbol: string;
4813
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
4814
+ /**
4815
+ * @description get combined profile, equities and funds
4816
+ * @tags CompanyProfile
4817
+ * @name GetCombinedProfile
4818
+ * @summary get company profile
4819
+ * @request GET:/quote-profile
4820
+ * @secure
4821
+ */
4822
+ getCombinedProfile(query: {
4823
+ /** Company symbol */
4824
+ symbol: string;
4825
+ /** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
4826
+ symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
4827
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
4828
+ /**
4829
+ * @description sort input array of symbols by type
4830
+ * @tags CompanyProfile
4831
+ * @name GetSymbolsPerSymbolType
4832
+ * @summary sort input array of symbols by type
4833
+ * @request POST:/symbols-per-type
4834
+ * @secure
4835
+ */
4836
+ getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
4837
+ }
4785
4838
  export class WorldMarkets<HandleError extends boolean = boolean> {
4786
4839
  protected readonly apiClient: JwtClient<HandleError>;
4787
4840
  constructor(apiClient: JwtClient<HandleError>);
@@ -4964,45 +5017,6 @@ export class WorldMarkets<HandleError extends boolean = boolean> {
4964
5017
  id: string;
4965
5018
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4966
5019
  }
4967
- export class CompanyProfile<HandleError extends boolean = boolean> {
4968
- protected readonly apiClient: JwtClient<HandleError>;
4969
- constructor(apiClient: JwtClient<HandleError>);
4970
- /**
4971
- * @description get company profile, industries classification and closest earning release
4972
- * @tags CompanyProfile
4973
- * @name GetCompanyProfile
4974
- * @summary get company profile
4975
- * @request GET:/company-profile
4976
- * @secure
4977
- */
4978
- getCompanyProfile(query: {
4979
- /** Company symbol */
4980
- symbol: string;
4981
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
4982
- /**
4983
- * @description get combined profile, equities and funds
4984
- * @tags CompanyProfile
4985
- * @name GetCombinedProfile
4986
- * @summary get company profile
4987
- * @request GET:/quote-profile
4988
- * @secure
4989
- */
4990
- getCombinedProfile(query: {
4991
- /** Company symbol */
4992
- symbol: string;
4993
- /** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
4994
- symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
4995
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
4996
- /**
4997
- * @description sort input array of symbols by type
4998
- * @tags CompanyProfile
4999
- * @name GetSymbolsPerSymbolType
5000
- * @summary sort input array of symbols by type
5001
- * @request POST:/symbols-per-type
5002
- * @secure
5003
- */
5004
- getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
5005
- }
5006
5020
  export class CustomLists<HandleError extends boolean = boolean> {
5007
5021
  protected readonly apiClient: JwtClient<HandleError>;
5008
5022
  constructor(apiClient: JwtClient<HandleError>);
@@ -5087,44 +5101,6 @@ export class CustomLists<HandleError extends boolean = boolean> {
5087
5101
  symbols?: string[];
5088
5102
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
5089
5103
  }
5090
- export class Earnings<HandleError extends boolean = boolean> {
5091
- protected readonly apiClient: JwtClient<HandleError>;
5092
- constructor(apiClient: JwtClient<HandleError>);
5093
- /**
5094
- * @description get earnings releases count per day
5095
- * @tags Earnings
5096
- * @name GetEarningsReleasesCountPerDay
5097
- * @summary get earnings releases count per day
5098
- * @request GET:/earnings-calendar
5099
- * @secure
5100
- */
5101
- getEarningsReleasesCountPerDay(query?: {
5102
- /**
5103
- * Start date in format YYYY-MM-DD
5104
- * @example ""2024-01-01""
5105
- */
5106
- start_date?: string;
5107
- /**
5108
- * End date in format YYYY-MM-DD
5109
- * @example ""2024-01-31""
5110
- */
5111
- end_date?: string;
5112
- /**
5113
- * Filter by exchanges
5114
- * @example ""NYSE,NAS""
5115
- */
5116
- exchanges?: string[];
5117
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, number>, HandleError>>;
5118
- /**
5119
- * @description get earnings release dates for symbols
5120
- * @tags Earnings
5121
- * @name GetEarningsCalendar
5122
- * @summary get earnings calendar data
5123
- * @request POST:/earnings-calendar
5124
- * @secure
5125
- */
5126
- getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
5127
- }
5128
5104
  export class Dashboard<HandleError extends boolean = boolean> {
5129
5105
  protected readonly apiClient: JwtClient<HandleError>;
5130
5106
  constructor(apiClient: JwtClient<HandleError>);
@@ -5200,6 +5176,134 @@ export class Dashboard<HandleError extends boolean = boolean> {
5200
5176
  symbol: string;
5201
5177
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolRelatedFieldsResponse, HandleError>>;
5202
5178
  }
5179
+ export class Earnings<HandleError extends boolean = boolean> {
5180
+ protected readonly apiClient: JwtClient<HandleError>;
5181
+ constructor(apiClient: JwtClient<HandleError>);
5182
+ /**
5183
+ * @description get earnings releases count per day
5184
+ * @tags Earnings
5185
+ * @name GetEarningsReleasesCountPerDay
5186
+ * @summary get earnings releases count per day
5187
+ * @request GET:/earnings-calendar
5188
+ * @secure
5189
+ */
5190
+ getEarningsReleasesCountPerDay(query?: {
5191
+ /**
5192
+ * Start date in format YYYY-MM-DD
5193
+ * @example ""2024-01-01""
5194
+ */
5195
+ start_date?: string;
5196
+ /**
5197
+ * End date in format YYYY-MM-DD
5198
+ * @example ""2024-01-31""
5199
+ */
5200
+ end_date?: string;
5201
+ /**
5202
+ * Filter by exchanges
5203
+ * @example ""NYSE,NAS""
5204
+ */
5205
+ exchanges?: string[];
5206
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, number>, HandleError>>;
5207
+ /**
5208
+ * @description get earnings release dates for symbols
5209
+ * @tags Earnings
5210
+ * @name GetEarningsCalendar
5211
+ * @summary get earnings calendar data
5212
+ * @request POST:/earnings-calendar
5213
+ * @secure
5214
+ */
5215
+ getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
5216
+ }
5217
+ export class FixedIncome<HandleError extends boolean = boolean> {
5218
+ protected readonly apiClient: JwtClient<HandleError>;
5219
+ constructor(apiClient: JwtClient<HandleError>);
5220
+ /**
5221
+ * @description get fixed income entries
5222
+ * @tags FixedIncome
5223
+ * @name GetFixedIncomeEntries
5224
+ * @summary get fixed income entries
5225
+ * @request POST:/fixed-income
5226
+ * @secure
5227
+ */
5228
+ getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponse, HandleError>>;
5229
+ /**
5230
+ * @description Returns historical fixed income
5231
+ * @tags FixedIncome
5232
+ * @name FixedIncomeHistorical
5233
+ * @summary Get historical fixed income
5234
+ * @request POST:/fixed-income/historical
5235
+ * @secure
5236
+ */
5237
+ fixedIncomeHistorical(filter: InsightGetFixedIncomeHistoricalRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeHistoricalResponse, HandleError>>;
5238
+ /**
5239
+ * @description get fixed-income presets
5240
+ * @tags FixedIncome
5241
+ * @name GetFixedIncomePresets
5242
+ * @summary get fixed-income presets
5243
+ * @request GET:/fixed-income/presets
5244
+ * @secure
5245
+ */
5246
+ getFixedIncomePresets(query: {
5247
+ /** how many records to return */
5248
+ limit: number;
5249
+ /** how many records to skip */
5250
+ offset: number;
5251
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
5252
+ /**
5253
+ * @description update fixed-income preset
5254
+ * @tags FixedIncome
5255
+ * @name UpdateFixedIncomePreset
5256
+ * @summary update fixed-income preset
5257
+ * @request PUT:/fixed-income/presets
5258
+ * @secure
5259
+ */
5260
+ updateFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5261
+ /**
5262
+ * @description create fixed-income preset
5263
+ * @tags FixedIncome
5264
+ * @name CreateFixedIncomePreset
5265
+ * @summary create fixed-income preset
5266
+ * @request POST:/fixed-income/presets
5267
+ * @secure
5268
+ */
5269
+ createFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5270
+ /**
5271
+ * @description remove fixed-income preset
5272
+ * @tags FixedIncome
5273
+ * @name RemoveFixedIncomePreset
5274
+ * @summary remove fixed-income preset
5275
+ * @request DELETE:/fixed-income/presets
5276
+ * @secure
5277
+ */
5278
+ removeFixedIncomePreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5279
+ /**
5280
+ * @description search fixed income values
5281
+ * @tags FixedIncome
5282
+ * @name SearchFixedIncomeValues
5283
+ * @summary search fixed income values
5284
+ * @request GET:/fixed-income/search
5285
+ * @secure
5286
+ */
5287
+ searchFixedIncomeValues(query: {
5288
+ /** search query */
5289
+ search_query: string;
5290
+ /** field to search in */
5291
+ field: string;
5292
+ /** how many records to return */
5293
+ limit?: number;
5294
+ /** how many records to skip */
5295
+ offset?: number;
5296
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchFixedIncomeValuesResponse, HandleError>>;
5297
+ /**
5298
+ * @description get single fixed income entry
5299
+ * @tags FixedIncome
5300
+ * @name GetSingleFixedIncomeEntry
5301
+ * @summary get single fixed income entry
5302
+ * @request GET:/fixed-income/{id}
5303
+ * @secure
5304
+ */
5305
+ getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
5306
+ }
5203
5307
  export class Fundamentals<HandleError extends boolean = boolean> {
5204
5308
  protected readonly apiClient: JwtClient<HandleError>;
5205
5309
  constructor(apiClient: JwtClient<HandleError>);
@@ -5327,105 +5431,15 @@ export class Funds<HandleError extends boolean = boolean> {
5327
5431
  Authorization?: string;
5328
5432
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
5329
5433
  }
5330
- export class FixedIncome<HandleError extends boolean = boolean> {
5434
+ export class StockScreener<HandleError extends boolean = boolean> {
5331
5435
  protected readonly apiClient: JwtClient<HandleError>;
5332
5436
  constructor(apiClient: JwtClient<HandleError>);
5333
5437
  /**
5334
- * @description get fixed income entries
5335
- * @tags FixedIncome
5336
- * @name GetFixedIncomeEntries
5337
- * @summary get fixed income entries
5338
- * @request POST:/fixed-income
5339
- * @secure
5340
- */
5341
- getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponse, HandleError>>;
5342
- /**
5343
- * @description Returns historical fixed income
5344
- * @tags FixedIncome
5345
- * @name FixedIncomeHistorical
5346
- * @summary Get historical fixed income
5347
- * @request POST:/fixed-income/historical
5348
- * @secure
5349
- */
5350
- fixedIncomeHistorical(filter: InsightGetFixedIncomeHistoricalRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeHistoricalResponse, HandleError>>;
5351
- /**
5352
- * @description get fixed-income presets
5353
- * @tags FixedIncome
5354
- * @name GetFixedIncomePresets
5355
- * @summary get fixed-income presets
5356
- * @request GET:/fixed-income/presets
5357
- * @secure
5358
- */
5359
- getFixedIncomePresets(query: {
5360
- /** how many records to return */
5361
- limit: number;
5362
- /** how many records to skip */
5363
- offset: number;
5364
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
5365
- /**
5366
- * @description update fixed-income preset
5367
- * @tags FixedIncome
5368
- * @name UpdateFixedIncomePreset
5369
- * @summary update fixed-income preset
5370
- * @request PUT:/fixed-income/presets
5371
- * @secure
5372
- */
5373
- updateFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5374
- /**
5375
- * @description create fixed-income preset
5376
- * @tags FixedIncome
5377
- * @name CreateFixedIncomePreset
5378
- * @summary create fixed-income preset
5379
- * @request POST:/fixed-income/presets
5380
- * @secure
5381
- */
5382
- createFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5383
- /**
5384
- * @description remove fixed-income preset
5385
- * @tags FixedIncome
5386
- * @name RemoveFixedIncomePreset
5387
- * @summary remove fixed-income preset
5388
- * @request DELETE:/fixed-income/presets
5389
- * @secure
5390
- */
5391
- removeFixedIncomePreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5392
- /**
5393
- * @description search fixed income values
5394
- * @tags FixedIncome
5395
- * @name SearchFixedIncomeValues
5396
- * @summary search fixed income values
5397
- * @request GET:/fixed-income/search
5398
- * @secure
5399
- */
5400
- searchFixedIncomeValues(query: {
5401
- /** search query */
5402
- search_query: string;
5403
- /** field to search in */
5404
- field: string;
5405
- /** how many records to return */
5406
- limit?: number;
5407
- /** how many records to skip */
5408
- offset?: number;
5409
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchFixedIncomeValuesResponse, HandleError>>;
5410
- /**
5411
- * @description get single fixed income entry
5412
- * @tags FixedIncome
5413
- * @name GetSingleFixedIncomeEntry
5414
- * @summary get single fixed income entry
5415
- * @request GET:/fixed-income/{id}
5416
- * @secure
5417
- */
5418
- getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
5419
- }
5420
- export class StockScreener<HandleError extends boolean = boolean> {
5421
- protected readonly apiClient: JwtClient<HandleError>;
5422
- constructor(apiClient: JwtClient<HandleError>);
5423
- /**
5424
- * @description data for visual heat map
5425
- * @tags StockScreener
5426
- * @name StockMarketHeatmap
5427
- * @summary data for visual heat map
5428
- * @request GET:/heatmaps
5438
+ * @description data for visual heat map
5439
+ * @tags StockScreener
5440
+ * @name StockMarketHeatmap
5441
+ * @summary data for visual heat map
5442
+ * @request GET:/heatmaps
5429
5443
  * @secure
5430
5444
  */
5431
5445
  stockMarketHeatmap(query?: {
@@ -5513,6 +5527,19 @@ export class StockScreener<HandleError extends boolean = boolean> {
5513
5527
  */
5514
5528
  getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5515
5529
  }
5530
+ export class Intraday<HandleError extends boolean = boolean> {
5531
+ protected readonly apiClient: JwtClient<HandleError>;
5532
+ constructor(apiClient: JwtClient<HandleError>);
5533
+ /**
5534
+ * @description Returns an array of intraday chart data values for the given ticker.
5535
+ * @tags Intraday
5536
+ * @name IntradayQuotes
5537
+ * @summary Get an array of intraday chart data values for the given ticker
5538
+ * @request POST:/intraday/quotes
5539
+ * @secure
5540
+ */
5541
+ intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
5542
+ }
5516
5543
  export class Quotes<HandleError extends boolean = boolean> {
5517
5544
  protected readonly apiClient: JwtClient<HandleError>;
5518
5545
  constructor(apiClient: JwtClient<HandleError>);
@@ -5552,60 +5579,6 @@ export class Quotes<HandleError extends boolean = boolean> {
5552
5579
  symbols: string;
5553
5580
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
5554
5581
  }
5555
- export class Intraday<HandleError extends boolean = boolean> {
5556
- protected readonly apiClient: JwtClient<HandleError>;
5557
- constructor(apiClient: JwtClient<HandleError>);
5558
- /**
5559
- * @description Returns an array of intraday chart data values for the given ticker.
5560
- * @tags Intraday
5561
- * @name IntradayQuotes
5562
- * @summary Get an array of intraday chart data values for the given ticker
5563
- * @request POST:/intraday/quotes
5564
- * @secure
5565
- */
5566
- intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
5567
- }
5568
- export class Ipos<HandleError extends boolean = boolean> {
5569
- protected readonly apiClient: JwtClient<HandleError>;
5570
- constructor(apiClient: JwtClient<HandleError>);
5571
- /**
5572
- * @description get recent ipos info
5573
- * @tags Ipos
5574
- * @name PostRecent
5575
- * @summary get recent ipos info
5576
- * @request POST:/ipos/recent
5577
- * @secure
5578
- */
5579
- postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5580
- /**
5581
- * @description get upcoming ipos info
5582
- * @tags Ipos
5583
- * @name GetUpcoming
5584
- * @summary get upcoming ipos info
5585
- * @request GET:/ipos/upcoming
5586
- * @secure
5587
- */
5588
- getUpcoming(query: {
5589
- /** how many records to return. Max value is 50 */
5590
- limit: number;
5591
- /** how many records to skip */
5592
- offset: number;
5593
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5594
- /**
5595
- * @description get ipo info by symbol
5596
- * @tags Ipos
5597
- * @name GetIpos
5598
- * @summary get ipo info by symbol
5599
- * @request GET:/ipos/{symbol}
5600
- * @secure
5601
- */
5602
- getIpos(symbol: string, query?: {
5603
- /** load quotes */
5604
- load_quotes?: boolean;
5605
- /** statuses */
5606
- statuses?: string[];
5607
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
5608
- }
5609
5582
  export class PreIpoCompanies<HandleError extends boolean = boolean> {
5610
5583
  protected readonly apiClient: JwtClient<HandleError>;
5611
5584
  constructor(apiClient: JwtClient<HandleError>);
@@ -5893,6 +5866,147 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
5893
5866
  include_documents?: boolean;
5894
5867
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
5895
5868
  }
5869
+ export class Ipos<HandleError extends boolean = boolean> {
5870
+ protected readonly apiClient: JwtClient<HandleError>;
5871
+ constructor(apiClient: JwtClient<HandleError>);
5872
+ /**
5873
+ * @description get recent ipos info
5874
+ * @tags Ipos
5875
+ * @name PostRecent
5876
+ * @summary get recent ipos info
5877
+ * @request POST:/ipos/recent
5878
+ * @secure
5879
+ */
5880
+ postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5881
+ /**
5882
+ * @description get upcoming ipos info
5883
+ * @tags Ipos
5884
+ * @name GetUpcoming
5885
+ * @summary get upcoming ipos info
5886
+ * @request GET:/ipos/upcoming
5887
+ * @secure
5888
+ */
5889
+ getUpcoming(query: {
5890
+ /** how many records to return. Max value is 50 */
5891
+ limit: number;
5892
+ /** how many records to skip */
5893
+ offset: number;
5894
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5895
+ /**
5896
+ * @description get ipo info by symbol
5897
+ * @tags Ipos
5898
+ * @name GetIpos
5899
+ * @summary get ipo info by symbol
5900
+ * @request GET:/ipos/{symbol}
5901
+ * @secure
5902
+ */
5903
+ getIpos(symbol: string, query?: {
5904
+ /** load quotes */
5905
+ load_quotes?: boolean;
5906
+ /** statuses */
5907
+ statuses?: string[];
5908
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
5909
+ }
5910
+ export class Logos<HandleError extends boolean = boolean> {
5911
+ protected readonly apiClient: JwtClient<HandleError>;
5912
+ constructor(apiClient: JwtClient<HandleError>);
5913
+ /**
5914
+ * @description Returns converted logo for crypto symbol
5915
+ * @tags Logos
5916
+ * @name LogosConvertedCryptoSymbolLogo
5917
+ * @summary Get converted logo for crypto symbol
5918
+ * @request POST:/logos/converted-crypto-symbol-logo
5919
+ * @secure
5920
+ */
5921
+ logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5922
+ /**
5923
+ * @description Returns converted logo for symbol
5924
+ * @tags Logos
5925
+ * @name LogosConvertedSymbolLogo
5926
+ * @summary Get converted logo for symbol
5927
+ * @request POST:/logos/converted-symbol-logo
5928
+ * @secure
5929
+ */
5930
+ logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5931
+ /**
5932
+ * @description Returns logo for crypto symbol
5933
+ * @tags Logos
5934
+ * @name LogosCryptoSymbolLogo
5935
+ * @summary Get logo for crypto symbol
5936
+ * @request GET:/logos/crypto-symbol-logo
5937
+ * @secure
5938
+ */
5939
+ logosCryptoSymbolLogo(query: {
5940
+ /** Company symbol */
5941
+ symbol: string;
5942
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
5943
+ /**
5944
+ * @description Returns direct logo for crypto symbol
5945
+ * @tags Logos
5946
+ * @name LogosDirectCryptoSymbolLogo
5947
+ * @summary Get direct logo for crypto symbol
5948
+ * @request GET:/logos/direct-crypto-symbol-logo
5949
+ * @secure
5950
+ */
5951
+ logosDirectCryptoSymbolLogo(query: {
5952
+ /** Company symbol */
5953
+ symbol: string;
5954
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5955
+ /**
5956
+ * @description Returns direct logo for symbol
5957
+ * @tags Logos
5958
+ * @name LogosDirectSymbolLogo
5959
+ * @summary Get direct logo for symbol
5960
+ * @request GET:/logos/direct-symbol-logo
5961
+ * @secure
5962
+ */
5963
+ logosDirectSymbolLogo(query: {
5964
+ /** Company symbol */
5965
+ symbol: string;
5966
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5967
+ /**
5968
+ * @description Returns logos for multiple symbols
5969
+ * @tags Logos
5970
+ * @name LogosMultipleCryptoSymbolLogo
5971
+ * @summary Get logos for multiple symbols
5972
+ * @request POST:/logos/multiple-crypto-symbol-logo
5973
+ * @secure
5974
+ */
5975
+ logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
5976
+ /**
5977
+ * @description Returns logos for multiple symbol
5978
+ * @tags Logos
5979
+ * @name LogosMultipleSymbolLogos
5980
+ * @summary Get logos for multiple symbols
5981
+ * @request POST:/logos/multiple-symbol-logos
5982
+ * @secure
5983
+ */
5984
+ logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
5985
+ /**
5986
+ * @description Returns links of socials logos for symbol
5987
+ * @tags Logos
5988
+ * @name LogosSocialSymbolLogos
5989
+ * @summary Get social logos for symbol
5990
+ * @request GET:/logos/social-symbol-logos
5991
+ * @secure
5992
+ */
5993
+ logosSocialSymbolLogos(query: {
5994
+ /** Company symbol */
5995
+ symbol: string;
5996
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
5997
+ /**
5998
+ * @description Returns logos for company symbol
5999
+ * @tags Logos
6000
+ * @name LogosSymbolLogos
6001
+ * @summary Get symbol logos
6002
+ * @request GET:/logos/symbol-logos
6003
+ * @secure
6004
+ */
6005
+ logosSymbolLogos(query: {
6006
+ /** Company symbol */
6007
+ symbol: string;
6008
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
6009
+ }
5896
6010
  export class MarketDates<HandleError extends boolean = boolean> {
5897
6011
  protected readonly apiClient: JwtClient<HandleError>;
5898
6012
  constructor(apiClient: JwtClient<HandleError>);
@@ -6150,277 +6264,70 @@ export class News<HandleError extends boolean = boolean> {
6150
6264
  /**
6151
6265
  * @description Returns available stocks in DB
6152
6266
  * @tags News
6153
- * @name NewsAvailableStocks
6154
- * @summary Get available stocks in DB (for filters)
6155
- * @request GET:/news/symbols
6156
- * @secure
6157
- */
6158
- newsAvailableStocks(query?: {
6159
- /** Limit */
6160
- limit?: number;
6161
- /** Offset */
6162
- offset?: number;
6163
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6164
- /**
6165
- * @description Returns available tags in DB
6166
- * @tags News
6167
- * @name NewsAvailableTags
6168
- * @summary Get available tags in DB (for filters)
6169
- * @request POST:/news/tags
6170
- * @secure
6171
- */
6172
- newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6173
- }
6174
- export class Logos<HandleError extends boolean = boolean> {
6175
- protected readonly apiClient: JwtClient<HandleError>;
6176
- constructor(apiClient: JwtClient<HandleError>);
6177
- /**
6178
- * @description Returns converted logo for crypto symbol
6179
- * @tags Logos
6180
- * @name LogosConvertedCryptoSymbolLogo
6181
- * @summary Get converted logo for crypto symbol
6182
- * @request POST:/logos/converted-crypto-symbol-logo
6183
- * @secure
6184
- */
6185
- logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
6186
- /**
6187
- * @description Returns converted logo for symbol
6188
- * @tags Logos
6189
- * @name LogosConvertedSymbolLogo
6190
- * @summary Get converted logo for symbol
6191
- * @request POST:/logos/converted-symbol-logo
6192
- * @secure
6193
- */
6194
- logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
6195
- /**
6196
- * @description Returns logo for crypto symbol
6197
- * @tags Logos
6198
- * @name LogosCryptoSymbolLogo
6199
- * @summary Get logo for crypto symbol
6200
- * @request GET:/logos/crypto-symbol-logo
6201
- * @secure
6202
- */
6203
- logosCryptoSymbolLogo(query: {
6204
- /** Company symbol */
6205
- symbol: string;
6206
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
6207
- /**
6208
- * @description Returns direct logo for crypto symbol
6209
- * @tags Logos
6210
- * @name LogosDirectCryptoSymbolLogo
6211
- * @summary Get direct logo for crypto symbol
6212
- * @request GET:/logos/direct-crypto-symbol-logo
6213
- * @secure
6214
- */
6215
- logosDirectCryptoSymbolLogo(query: {
6216
- /** Company symbol */
6217
- symbol: string;
6218
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
6219
- /**
6220
- * @description Returns direct logo for symbol
6221
- * @tags Logos
6222
- * @name LogosDirectSymbolLogo
6223
- * @summary Get direct logo for symbol
6224
- * @request GET:/logos/direct-symbol-logo
6225
- * @secure
6226
- */
6227
- logosDirectSymbolLogo(query: {
6228
- /** Company symbol */
6229
- symbol: string;
6230
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
6231
- /**
6232
- * @description Returns logos for multiple symbols
6233
- * @tags Logos
6234
- * @name LogosMultipleCryptoSymbolLogo
6235
- * @summary Get logos for multiple symbols
6236
- * @request POST:/logos/multiple-crypto-symbol-logo
6237
- * @secure
6238
- */
6239
- logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
6240
- /**
6241
- * @description Returns logos for multiple symbol
6242
- * @tags Logos
6243
- * @name LogosMultipleSymbolLogos
6244
- * @summary Get logos for multiple symbols
6245
- * @request POST:/logos/multiple-symbol-logos
6246
- * @secure
6247
- */
6248
- logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
6249
- /**
6250
- * @description Returns links of socials logos for symbol
6251
- * @tags Logos
6252
- * @name LogosSocialSymbolLogos
6253
- * @summary Get social logos for symbol
6254
- * @request GET:/logos/social-symbol-logos
6255
- * @secure
6256
- */
6257
- logosSocialSymbolLogos(query: {
6258
- /** Company symbol */
6259
- symbol: string;
6260
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
6261
- /**
6262
- * @description Returns logos for company symbol
6263
- * @tags Logos
6264
- * @name LogosSymbolLogos
6265
- * @summary Get symbol logos
6266
- * @request GET:/logos/symbol-logos
6267
- * @secure
6268
- */
6269
- logosSymbolLogos(query: {
6270
- /** Company symbol */
6271
- symbol: string;
6272
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
6273
- }
6274
- export class Public<HandleError extends boolean = boolean> {
6275
- protected readonly apiClient: JwtClient<HandleError>;
6276
- constructor(apiClient: JwtClient<HandleError>);
6277
- /**
6278
- * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
6279
- * @tags Public
6280
- * @name CalculateEstimatedReturns
6281
- * @summary Calculate Estimated Returns
6282
- * @request GET:/public/estimated-returns
6283
- * @secure
6284
- */
6285
- calculateEstimatedReturns(query: {
6286
- /** Single symbol */
6287
- symbol: string;
6288
- /**
6289
- * Non-zero amount
6290
- * @format float64
6291
- */
6292
- amount: number;
6293
- /** Start date for calculations */
6294
- start_date: string;
6295
- /** End date for calculations */
6296
- end_date: string;
6297
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
6298
- /**
6299
- * @description Returns an expert forecast
6300
- * @tags Public
6301
- * @name ExpertForecast
6302
- * @summary Expert forecast
6303
- * @request GET:/public/expert-forecast
6304
- * @secure
6305
- */
6306
- expertForecast(query: {
6307
- /** Comma separated symbols */
6308
- symbols: string;
6309
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
6310
- /**
6311
- * @description get fundamentals by symbol data
6312
- * @tags Public
6313
- * @name GetPublicFundamentalsBySymbolData
6314
- * @summary get fundamentals by symbol data
6315
- * @request GET:/public/fundamentals/{symbol}
6316
- * @secure
6317
- */
6318
- getPublicFundamentalsBySymbolData(symbol: string, query: {
6319
- /** Annual or quarterly */
6320
- mode: string;
6321
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
6322
- /**
6323
- * @description Daily price history
6324
- * @tags Public
6325
- * @name DailyPriceHistory
6326
- * @summary Daily price history
6327
- * @request GET:/public/price-history/daily
6328
- * @secure
6329
- */
6330
- dailyPriceHistory(query: {
6331
- /** Single symbol */
6332
- symbol: string;
6333
- /** Target date */
6334
- date: string;
6335
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
6336
- /**
6337
- * @description Public quote profile
6338
- * @tags Public
6339
- * @name PublicQuoteProfile
6340
- * @summary Public quote profile
6341
- * @request GET:/public/quote-profile/{symbol}
6342
- * @secure
6343
- */
6344
- publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
6345
- /**
6346
- * @description get ratios by symbol data
6347
- * @tags Public
6348
- * @name GetPublicRatiosBySymbolData
6349
- * @summary get ratios by symbol data
6350
- * @request GET:/public/ratios/{symbol}
6267
+ * @name NewsAvailableStocks
6268
+ * @summary Get available stocks in DB (for filters)
6269
+ * @request GET:/news/symbols
6351
6270
  * @secure
6352
6271
  */
6353
- getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
6272
+ newsAvailableStocks(query?: {
6273
+ /** Limit */
6274
+ limit?: number;
6275
+ /** Offset */
6276
+ offset?: number;
6277
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6354
6278
  /**
6355
- * @description find a symbol by name or description
6356
- * @tags Public
6357
- * @name QuoteFundamentalsSearch
6358
- * @summary find a symbol by name or description
6359
- * @request GET:/public/symbol-search
6279
+ * @description Returns available tags in DB
6280
+ * @tags News
6281
+ * @name NewsAvailableTags
6282
+ * @summary Get available tags in DB (for filters)
6283
+ * @request POST:/news/tags
6360
6284
  * @secure
6361
6285
  */
6362
- quoteFundamentalsSearch(query: {
6363
- /** Search query */
6364
- search_query: string;
6365
- /** how many records to return. Max value is 50 */
6366
- limit: number;
6367
- /** how many records to skip */
6368
- offset: number;
6369
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
6286
+ newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6287
+ }
6288
+ export class OptionGreeks<HandleError extends boolean = boolean> {
6289
+ protected readonly apiClient: JwtClient<HandleError>;
6290
+ constructor(apiClient: JwtClient<HandleError>);
6370
6291
  /**
6371
- * @description Get top gainers
6372
- * @tags Public
6373
- * @name TopGainers
6374
- * @summary Top Gainers
6375
- * @request GET:/public/top-gainers
6292
+ * @description Returns calculated matrix
6293
+ * @tags OptionGreeks
6294
+ * @name OgCalculateMatrix
6295
+ * @summary Calculate matrix
6296
+ * @request POST:/og/calculate-matrix
6376
6297
  * @secure
6377
6298
  */
6378
- topGainers(query: {
6379
- /** sort direction - asc or desc */
6380
- order_direction?: string;
6381
- /** how many records to return. Max value is 50 */
6382
- limit: number;
6383
- /** how many records to skip */
6384
- offset: number;
6385
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6299
+ ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
6386
6300
  /**
6387
- * @description Get top stocks
6388
- * @tags Public
6389
- * @name TopStocks
6390
- * @summary Top Stocks
6391
- * @request GET:/public/top-stocks
6301
+ * @description Returns calculated params
6302
+ * @tags OptionGreeks
6303
+ * @name OgCalculateParams
6304
+ * @summary Calculate params
6305
+ * @request POST:/og/calculate-params
6392
6306
  * @secure
6393
6307
  */
6394
- topStocks(query: {
6395
- /** EQUITY|ETF|CRYPTO */
6396
- stock_type: InsightTopStocksParamsStockTypeEnum;
6397
- /** how many records to return. Max value is 50 */
6398
- limit: number;
6399
- /** how many records to skip */
6400
- offset: number;
6401
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6308
+ ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
6402
6309
  }
6403
- export class AlphaTools<HandleError extends boolean = boolean> {
6310
+ export class Ownerships<HandleError extends boolean = boolean> {
6404
6311
  protected readonly apiClient: JwtClient<HandleError>;
6405
6312
  constructor(apiClient: JwtClient<HandleError>);
6406
6313
  /**
6407
- * @description get seasonlity data with comparison to benchmark
6408
- * @tags AlphaTools
6409
- * @name GetMomentumRatioGraph
6410
- * @summary get seasonlity data
6411
- * @request POST:/rst
6314
+ * @description get ownerships by id datadata
6315
+ * @tags Ownerships
6316
+ * @name GetOwnershipsByIdData
6317
+ * @summary get ownerships by id data
6318
+ * @request POST:/ownerships
6412
6319
  * @secure
6413
6320
  */
6414
- getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
6321
+ getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6415
6322
  /**
6416
- * @description get seasonlity data with comparison to benchmark
6417
- * @tags AlphaTools
6418
- * @name GetSeasonality
6419
- * @summary get seasonlity data
6420
- * @request POST:/seasonality
6323
+ * @description get ownerships by symbol data
6324
+ * @tags Ownerships
6325
+ * @name GetOwnershipsBySymbolData
6326
+ * @summary get ownerships by symbol data
6327
+ * @request POST:/symbol-ownerships
6421
6328
  * @secure
6422
6329
  */
6423
- getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
6330
+ getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6424
6331
  }
6425
6332
  export class TipRank<HandleError extends boolean = boolean> {
6426
6333
  protected readonly apiClient: JwtClient<HandleError>;
@@ -6859,49 +6766,156 @@ export class Passport<HandleError extends boolean = boolean> {
6859
6766
  */
6860
6767
  passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6861
6768
  }
6862
- export class OptionGreeks<HandleError extends boolean = boolean> {
6769
+ export class AlphaTools<HandleError extends boolean = boolean> {
6863
6770
  protected readonly apiClient: JwtClient<HandleError>;
6864
6771
  constructor(apiClient: JwtClient<HandleError>);
6865
6772
  /**
6866
- * @description Returns calculated matrix
6867
- * @tags OptionGreeks
6868
- * @name OgCalculateMatrix
6869
- * @summary Calculate matrix
6870
- * @request POST:/og/calculate-matrix
6773
+ * @description get seasonlity data with comparison to benchmark
6774
+ * @tags AlphaTools
6775
+ * @name GetMomentumRatioGraph
6776
+ * @summary get seasonlity data
6777
+ * @request POST:/rst
6871
6778
  * @secure
6872
6779
  */
6873
- ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
6780
+ getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
6874
6781
  /**
6875
- * @description Returns calculated params
6876
- * @tags OptionGreeks
6877
- * @name OgCalculateParams
6878
- * @summary Calculate params
6879
- * @request POST:/og/calculate-params
6782
+ * @description get seasonlity data with comparison to benchmark
6783
+ * @tags AlphaTools
6784
+ * @name GetSeasonality
6785
+ * @summary get seasonlity data
6786
+ * @request POST:/seasonality
6880
6787
  * @secure
6881
6788
  */
6882
- ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
6789
+ getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
6883
6790
  }
6884
- export class Ownerships<HandleError extends boolean = boolean> {
6791
+ export class Public<HandleError extends boolean = boolean> {
6885
6792
  protected readonly apiClient: JwtClient<HandleError>;
6886
6793
  constructor(apiClient: JwtClient<HandleError>);
6887
6794
  /**
6888
- * @description get ownerships by id datadata
6889
- * @tags Ownerships
6890
- * @name GetOwnershipsByIdData
6891
- * @summary get ownerships by id data
6892
- * @request POST:/ownerships
6795
+ * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
6796
+ * @tags Public
6797
+ * @name CalculateEstimatedReturns
6798
+ * @summary Calculate Estimated Returns
6799
+ * @request GET:/public/estimated-returns
6893
6800
  * @secure
6894
6801
  */
6895
- getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6802
+ calculateEstimatedReturns(query: {
6803
+ /** Single symbol */
6804
+ symbol: string;
6805
+ /**
6806
+ * Non-zero amount
6807
+ * @format float64
6808
+ */
6809
+ amount: number;
6810
+ /** Start date for calculations */
6811
+ start_date: string;
6812
+ /** End date for calculations */
6813
+ end_date: string;
6814
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
6896
6815
  /**
6897
- * @description get ownerships by symbol data
6898
- * @tags Ownerships
6899
- * @name GetOwnershipsBySymbolData
6900
- * @summary get ownerships by symbol data
6901
- * @request POST:/symbol-ownerships
6816
+ * @description Returns an expert forecast
6817
+ * @tags Public
6818
+ * @name ExpertForecast
6819
+ * @summary Expert forecast
6820
+ * @request GET:/public/expert-forecast
6902
6821
  * @secure
6903
6822
  */
6904
- getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6823
+ expertForecast(query: {
6824
+ /** Comma separated symbols */
6825
+ symbols: string;
6826
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
6827
+ /**
6828
+ * @description get fundamentals by symbol data
6829
+ * @tags Public
6830
+ * @name GetPublicFundamentalsBySymbolData
6831
+ * @summary get fundamentals by symbol data
6832
+ * @request GET:/public/fundamentals/{symbol}
6833
+ * @secure
6834
+ */
6835
+ getPublicFundamentalsBySymbolData(symbol: string, query: {
6836
+ /** Annual or quarterly */
6837
+ mode: string;
6838
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
6839
+ /**
6840
+ * @description Daily price history
6841
+ * @tags Public
6842
+ * @name DailyPriceHistory
6843
+ * @summary Daily price history
6844
+ * @request GET:/public/price-history/daily
6845
+ * @secure
6846
+ */
6847
+ dailyPriceHistory(query: {
6848
+ /** Single symbol */
6849
+ symbol: string;
6850
+ /** Target date */
6851
+ date: string;
6852
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
6853
+ /**
6854
+ * @description Public quote profile
6855
+ * @tags Public
6856
+ * @name PublicQuoteProfile
6857
+ * @summary Public quote profile
6858
+ * @request GET:/public/quote-profile/{symbol}
6859
+ * @secure
6860
+ */
6861
+ publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
6862
+ /**
6863
+ * @description get ratios by symbol data
6864
+ * @tags Public
6865
+ * @name GetPublicRatiosBySymbolData
6866
+ * @summary get ratios by symbol data
6867
+ * @request GET:/public/ratios/{symbol}
6868
+ * @secure
6869
+ */
6870
+ getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
6871
+ /**
6872
+ * @description find a symbol by name or description
6873
+ * @tags Public
6874
+ * @name QuoteFundamentalsSearch
6875
+ * @summary find a symbol by name or description
6876
+ * @request GET:/public/symbol-search
6877
+ * @secure
6878
+ */
6879
+ quoteFundamentalsSearch(query: {
6880
+ /** Search query */
6881
+ search_query: string;
6882
+ /** how many records to return. Max value is 50 */
6883
+ limit: number;
6884
+ /** how many records to skip */
6885
+ offset: number;
6886
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
6887
+ /**
6888
+ * @description Get top gainers
6889
+ * @tags Public
6890
+ * @name TopGainers
6891
+ * @summary Top Gainers
6892
+ * @request GET:/public/top-gainers
6893
+ * @secure
6894
+ */
6895
+ topGainers(query: {
6896
+ /** sort direction - asc or desc */
6897
+ order_direction?: string;
6898
+ /** how many records to return. Max value is 50 */
6899
+ limit: number;
6900
+ /** how many records to skip */
6901
+ offset: number;
6902
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6903
+ /**
6904
+ * @description Get top stocks
6905
+ * @tags Public
6906
+ * @name TopStocks
6907
+ * @summary Top Stocks
6908
+ * @request GET:/public/top-stocks
6909
+ * @secure
6910
+ */
6911
+ topStocks(query: {
6912
+ /** EQUITY|ETF|CRYPTO */
6913
+ stock_type: InsightTopStocksParamsStockTypeEnum;
6914
+ /** how many records to return. Max value is 50 */
6915
+ limit: number;
6916
+ /** how many records to skip */
6917
+ offset: number;
6918
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6905
6919
  }
6906
6920
  export interface InsightBeforeAndAfterV2 {
6907
6921
  after?: string;