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

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 +36 -30
  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 +4769 -4768
  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 +1489 -1488
  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 +102 -101
  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 +4034 -4033
  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 +750 -761
  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;
@@ -4782,187 +4783,27 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
4782
4783
  Date = "date",
4783
4784
  Rank = "rank"
4784
4785
  }
4785
- export class WorldMarkets<HandleError extends boolean = boolean> {
4786
+ export class AlphaTools<HandleError extends boolean = boolean> {
4786
4787
  protected readonly apiClient: JwtClient<HandleError>;
4787
4788
  constructor(apiClient: JwtClient<HandleError>);
4788
4789
  /**
4789
- * @description Get continents
4790
- * @tags World Markets
4791
- * @name ContinentGet
4792
- * @summary Get continents
4793
- * @request GET:/continents
4794
- * @secure
4795
- */
4796
- continentGet(query: {
4797
- /** Query limit */
4798
- limit: number;
4799
- /** Query offset */
4800
- offset: number;
4801
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
4802
- /**
4803
- * @description Edit continent
4804
- * @tags World Markets
4805
- * @name ContinentEdit
4806
- * @summary Edit continent
4807
- * @request PUT:/continents
4808
- * @secure
4809
- */
4810
- continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4811
- /**
4812
- * @description Create continents
4813
- * @tags World Markets
4814
- * @name ContinentCreate
4815
- * @summary Create continents
4816
- * @request POST:/continents
4817
- * @secure
4818
- */
4819
- continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
4820
- /**
4821
- * @description Delete continent
4822
- * @tags World Markets
4823
- * @name ContinentDelete
4824
- * @summary Delete continent
4825
- * @request DELETE:/continents
4826
- * @secure
4827
- */
4828
- continentDelete(query: {
4829
- /** continent id */
4830
- id: string;
4831
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4832
- /**
4833
- * @description Get country codes
4834
- * @tags World Markets
4835
- * @name CountryCodeGet
4836
- * @summary Get country codes
4837
- * @request GET:/country-codes
4838
- * @secure
4839
- */
4840
- countryCodeGet(query: {
4841
- /** Query limit */
4842
- limit: number;
4843
- /** Query offset */
4844
- offset: number;
4845
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
4846
- /**
4847
- * @description Edit country code
4848
- * @tags World Markets
4849
- * @name CountryCodeEdit
4850
- * @summary Edit country code
4851
- * @request PUT:/country-codes
4852
- * @secure
4853
- */
4854
- countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4855
- /**
4856
- * @description Add country codes
4857
- * @tags World Markets
4858
- * @name CountryCodeAdd
4859
- * @summary Add country codes
4860
- * @request POST:/country-codes
4861
- * @secure
4862
- */
4863
- countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
4864
- /**
4865
- * @description Delete country code
4866
- * @tags World Markets
4867
- * @name CountryCodeDelete
4868
- * @summary Delete country code
4869
- * @request DELETE:/country-codes
4870
- * @secure
4871
- */
4872
- countryCodeDelete(query: {
4873
- /** a3 code */
4874
- a3code: string;
4875
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4876
- /**
4877
- * @description Get global indexes
4878
- * @tags World Markets
4879
- * @name GlobalIndexGet
4880
- * @summary Get global indexes
4881
- * @request GET:/global-indexes
4882
- * @secure
4883
- */
4884
- globalIndexGet(query: {
4885
- /** Query limit */
4886
- limit: number;
4887
- /** Query offset */
4888
- offset: number;
4889
- /** Continent code for filtering */
4890
- continent?: string;
4891
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
4892
- /**
4893
- * @description Edit global index
4894
- * @tags World Markets
4895
- * @name GlobalIndexEdit
4896
- * @summary Edit global index
4897
- * @request PUT:/global-indexes
4898
- * @secure
4899
- */
4900
- globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4901
- /**
4902
- * @description Add global indexes
4903
- * @tags World Markets
4904
- * @name GlobalIndexAdd
4905
- * @summary Add global indexes
4906
- * @request POST:/global-indexes
4907
- * @secure
4908
- */
4909
- globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
4910
- /**
4911
- * @description Edit global index
4912
- * @tags World Markets
4913
- * @name GlobalIndexDelete
4914
- * @summary Delete global index
4915
- * @request DELETE:/global-indexes
4916
- * @secure
4917
- */
4918
- globalIndexDelete(query: {
4919
- /** a3 code */
4920
- a3code: string;
4921
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4922
- /**
4923
- * @description Get regions
4924
- * @tags World Markets
4925
- * @name RegionGet
4926
- * @summary Get regions
4927
- * @request GET:/regions
4928
- * @secure
4929
- */
4930
- regionGet(query: {
4931
- /** Query limit */
4932
- limit: number;
4933
- /** Query offset */
4934
- offset: number;
4935
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
4936
- /**
4937
- * @description Edit region
4938
- * @tags World Markets
4939
- * @name RegionEdit
4940
- * @summary Edit region
4941
- * @request PUT:/regions
4942
- * @secure
4943
- */
4944
- regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4945
- /**
4946
- * @description Create regions
4947
- * @tags World Markets
4948
- * @name RegionCreate
4949
- * @summary Create regions
4950
- * @request POST:/regions
4790
+ * @description get seasonlity data with comparison to benchmark
4791
+ * @tags AlphaTools
4792
+ * @name GetMomentumRatioGraph
4793
+ * @summary get seasonlity data
4794
+ * @request POST:/rst
4951
4795
  * @secure
4952
4796
  */
4953
- regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
4797
+ getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
4954
4798
  /**
4955
- * @description Delete region
4956
- * @tags World Markets
4957
- * @name RegionDelete
4958
- * @summary Delete region
4959
- * @request DELETE:/regions
4799
+ * @description get seasonlity data with comparison to benchmark
4800
+ * @tags AlphaTools
4801
+ * @name GetSeasonality
4802
+ * @summary get seasonlity data
4803
+ * @request POST:/seasonality
4960
4804
  * @secure
4961
4805
  */
4962
- regionDelete(query: {
4963
- /** region id */
4964
- id: string;
4965
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4806
+ getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
4966
4807
  }
4967
4808
  export class CompanyProfile<HandleError extends boolean = boolean> {
4968
4809
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5087,44 +4928,6 @@ export class CustomLists<HandleError extends boolean = boolean> {
5087
4928
  symbols?: string[];
5088
4929
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
5089
4930
  }
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
4931
  export class Dashboard<HandleError extends boolean = boolean> {
5129
4932
  protected readonly apiClient: JwtClient<HandleError>;
5130
4933
  constructor(apiClient: JwtClient<HandleError>);
@@ -5200,132 +5003,43 @@ export class Dashboard<HandleError extends boolean = boolean> {
5200
5003
  symbol: string;
5201
5004
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolRelatedFieldsResponse, HandleError>>;
5202
5005
  }
5203
- export class Fundamentals<HandleError extends boolean = boolean> {
5204
- protected readonly apiClient: JwtClient<HandleError>;
5205
- constructor(apiClient: JwtClient<HandleError>);
5206
- /**
5207
- * @description get fundamentals by symbol data
5208
- * @tags Fundamentals
5209
- * @name GetFundamentalsBySymbolData
5210
- * @summary get fundamentals by symbol data
5211
- * @request POST:/fundamentals
5212
- * @secure
5213
- */
5214
- getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
5215
- }
5216
- export class Funds<HandleError extends boolean = boolean> {
5006
+ export class Earnings<HandleError extends boolean = boolean> {
5217
5007
  protected readonly apiClient: JwtClient<HandleError>;
5218
5008
  constructor(apiClient: JwtClient<HandleError>);
5219
5009
  /**
5220
- * @description get fund details
5221
- * @tags Funds
5222
- * @name GetFundDetails
5223
- * @summary get fund details
5224
- * @request GET:/funds/details
5010
+ * @description get earnings releases count per day
5011
+ * @tags Earnings
5012
+ * @name GetEarningsReleasesCountPerDay
5013
+ * @summary get earnings releases count per day
5014
+ * @request GET:/earnings-calendar
5225
5015
  * @secure
5226
5016
  */
5227
- getFundDetails(query: {
5228
- /** Fund symbol */
5229
- symbol: string;
5230
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError>>;
5231
- /**
5232
- * @description get funds for holding
5233
- * @tags Funds
5234
- * @name GetFundsForHolding
5235
- * @summary get funds for holding
5236
- * @request POST:/funds/funds-for-holding
5237
- * @secure
5238
- */
5239
- getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
5240
- /** Authorization */
5241
- Authorization?: string;
5242
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError>>;
5243
- /**
5244
- * @description filter funds by params
5245
- * @tags Funds
5246
- * @name FundScreener
5247
- * @summary filter funds by params
5248
- * @request POST:/funds/screener
5249
- * @secure
5250
- */
5251
- fundScreener(filter: InsightFundScreenerRequest, headers?: {
5252
- /** Authorization */
5253
- Authorization?: string;
5254
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
5255
- /**
5256
- * @description get fund screener filters
5257
- * @tags Funds
5258
- * @name GetScreenerFilters
5259
- * @summary get fund screener filters
5260
- * @request GET:/funds/screener/filters
5261
- * @secure
5262
- */
5263
- getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError>>;
5264
- /**
5265
- * @description get fund screener presets
5266
- * @tags Funds
5267
- * @name GetFundScreenerPresets
5268
- * @summary get fund screener presets
5269
- * @request GET:/funds/screener/presets
5270
- * @secure
5271
- */
5272
- getFundScreenerPresets(query: {
5273
- /** how many records to return */
5274
- limit: number;
5275
- /** how many records to skip */
5276
- offset: number;
5277
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
5278
- /**
5279
- * @description update fund screener preset
5280
- * @tags Funds
5281
- * @name UpdateFundScreenerPreset
5282
- * @summary update fund screener preset
5283
- * @request PUT:/funds/screener/presets
5284
- * @secure
5285
- */
5286
- updateFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5287
- /**
5288
- * @description create fund screener preset
5289
- * @tags Funds
5290
- * @name CreateFundScreenerPreset
5291
- * @summary create fund screener preset
5292
- * @request POST:/funds/screener/presets
5293
- * @secure
5294
- */
5295
- createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5296
- /**
5297
- * @description remove fund screener preset
5298
- * @tags Funds
5299
- * @name RemoveFundScreenerPreset
5300
- * @summary remove fund screener preset
5301
- * @request DELETE:/funds/screener/presets
5302
- * @secure
5303
- */
5304
- removeFundScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5305
- /**
5306
- * @description filter funds by params
5307
- * @tags Funds
5308
- * @name FundSectorScreener
5309
- * @summary filter funds by params
5310
- * @request POST:/funds/sector-screener
5311
- * @secure
5312
- */
5313
- fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
5314
- /** Authorization */
5315
- Authorization?: string;
5316
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
5017
+ getEarningsReleasesCountPerDay(query?: {
5018
+ /**
5019
+ * Start date in format YYYY-MM-DD
5020
+ * @example ""2024-01-01""
5021
+ */
5022
+ start_date?: string;
5023
+ /**
5024
+ * End date in format YYYY-MM-DD
5025
+ * @example ""2024-01-31""
5026
+ */
5027
+ end_date?: string;
5028
+ /**
5029
+ * Filter by exchanges
5030
+ * @example ""NYSE,NAS""
5031
+ */
5032
+ exchanges?: string[];
5033
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, number>, HandleError>>;
5317
5034
  /**
5318
- * @description get top funds
5319
- * @tags Funds
5320
- * @name GetTopFunds
5321
- * @summary get top funds
5322
- * @request POST:/funds/top
5035
+ * @description get earnings release dates for symbols
5036
+ * @tags Earnings
5037
+ * @name GetEarningsCalendar
5038
+ * @summary get earnings calendar data
5039
+ * @request POST:/earnings-calendar
5323
5040
  * @secure
5324
5041
  */
5325
- getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
5326
- /** Authorization */
5327
- Authorization?: string;
5328
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
5042
+ getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
5329
5043
  }
5330
5044
  export class FixedIncome<HandleError extends boolean = boolean> {
5331
5045
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5417,481 +5131,528 @@ export class FixedIncome<HandleError extends boolean = boolean> {
5417
5131
  */
5418
5132
  getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
5419
5133
  }
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
5429
- * @secure
5430
- */
5431
- stockMarketHeatmap(query?: {
5432
- /** Name of symbol list to fetch details for. Empty is default */
5433
- heatmap_name?: string;
5434
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
5134
+ export interface InsightBeforeAndAfterV2 {
5135
+ after?: string;
5136
+ before?: string;
5137
+ }
5138
+ export interface InsightFixedIncomeV2 {
5139
+ a144: boolean;
5140
+ accrued_interest: number;
5141
+ bank_qualified: boolean;
5142
+ bond_warrant: boolean;
5143
+ call_type: string;
5144
+ callable: boolean;
5145
+ close_price: number;
5146
+ close_price_asof: string;
5147
+ close_ytw: number;
5148
+ convertible: boolean;
5149
+ country: string;
5150
+ country_code: string;
5151
+ country_domicile: string;
5152
+ country_issue: string;
5153
+ coupon: number;
5154
+ coupon_frequency: string;
5155
+ coupon_type: string;
5156
+ currency: string;
5157
+ cusip: string;
5158
+ dated_date: string;
5159
+ daycount: string;
5160
+ description: string;
5161
+ description_short: string;
5162
+ duration: number;
5163
+ first_coupon_date: string;
5164
+ insured: boolean;
5165
+ isin: string;
5166
+ issue_date: string;
5167
+ issue_minimum_denomination: number;
5168
+ issue_price: number;
5169
+ issue_size: number;
5170
+ issuer: string;
5171
+ last_coupon_date: string;
5172
+ liquidity_institutional_aggregate: number;
5173
+ liquidity_institutional_buy: number;
5174
+ liquidity_institutional_sell: number;
5175
+ liquidity_micro_aggregate: number;
5176
+ liquidity_micro_buy: number;
5177
+ liquidity_micro_sell: number;
5178
+ liquidity_retail_aggregate: number;
5179
+ liquidity_retail_buy: number;
5180
+ liquidity_retail_sell: number;
5181
+ maturity_date: string;
5182
+ municipal_state: string;
5183
+ municipal_taxable_federal: boolean;
5184
+ municipal_type: string;
5185
+ next_call_date: string;
5186
+ next_call_price: number;
5187
+ next_coupon_date: string;
5188
+ par_value: number;
5189
+ perpetual: boolean;
5190
+ private_placement: boolean;
5191
+ purpose: string;
5192
+ puttable: boolean;
5193
+ reg_s: boolean;
5194
+ sector: string;
5195
+ seniority: string;
5196
+ settlement_convention: string;
5197
+ sinking_fund: boolean;
5198
+ sp_creditwatch: string;
5199
+ sp_creditwatch_date: string;
5200
+ sp_outlook: string;
5201
+ sp_outlook_date: string;
5202
+ sp_rating: string;
5203
+ sp_rating_date: string;
5204
+ status: string;
5205
+ ticker: string;
5206
+ treasury_subtype: string;
5207
+ type: string;
5208
+ updated_at: string;
5209
+ }
5210
+ export interface InsightGetFixedIncomeEntriesResponseV2 {
5211
+ count: number;
5212
+ data: InsightFixedIncomeV2[];
5213
+ }
5214
+ export interface InsightGetFixedIncomeEntriesRequestV2 {
5215
+ /** @example true */
5216
+ bank_qualified?: boolean;
5217
+ /** @example true */
5218
+ callable?: boolean;
5219
+ /** @example true */
5220
+ convertible?: boolean;
5221
+ /** @example ["USA"] */
5222
+ country_codes?: string[];
5223
+ coupon?: InsightLessAndMoreV2;
5224
+ /** @example ["quarterly","zero"] */
5225
+ coupon_frequencies?: string[];
5226
+ /** @example ["655664AH3","9128286R6"] */
5227
+ cusip?: string[];
5435
5228
  /**
5436
- * @description create or update heat map preset
5437
- * @tags StockScreener
5438
- * @name CreateStockMarketHeatmapPreset
5439
- * @summary create or update heat map preset
5440
- * @request POST:/heatmaps
5441
- * @secure
5229
+ * @maxLength 100
5230
+ * @example "Donald's"
5442
5231
  */
5443
- createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5232
+ description?: string;
5233
+ /** @example true */
5234
+ has_ticker?: boolean;
5235
+ /** @example true */
5236
+ insured?: boolean;
5237
+ /** @example ["US655664AH33","US9128286R69"] */
5238
+ isin?: string[];
5239
+ issue_date?: InsightBeforeAndAfterV2;
5444
5240
  /**
5445
- * @description Sector and Industry Group performance
5446
- * @tags StockScreener
5447
- * @name IndustriesPerformance
5448
- * @summary get industries performance
5449
- * @request POST:/industries-performance
5450
- * @secure
5241
+ * @maxLength 100
5242
+ * @example "Donald's"
5451
5243
  */
5452
- industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
5453
- /**
5454
- * @description filter stocks by params
5455
- * @tags StockScreener
5456
- * @name StockScreener
5457
- * @summary filter stocks by params
5458
- * @request POST:/stock-screener
5459
- * @secure
5460
- */
5461
- stockScreener(filter: InsightStockScreenerV1Request, headers?: {
5462
- /** Authorization */
5463
- Authorization?: string;
5464
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5465
- /**
5466
- * @description get screener presets
5467
- * @tags StockScreener
5468
- * @name GetScreenerPresets
5469
- * @summary get screener presets
5470
- * @request GET:/stock-screener/presets
5471
- * @secure
5472
- */
5473
- getScreenerPresets(query: {
5474
- /** how many records to return */
5475
- limit: number;
5476
- /** how many records to skip */
5477
- offset: number;
5478
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
5244
+ issuer?: string;
5245
+ maturity?: InsightBeforeAndAfterV2;
5246
+ /** @example ["NY"] */
5247
+ municipal_states?: string[];
5248
+ /** @example true */
5249
+ municipal_tax?: boolean;
5250
+ /** @example ["general_obligation"] */
5251
+ municipal_types?: string[];
5252
+ pagination: InsightPaginationV2;
5253
+ purposes?: string[];
5254
+ /** @example ["SOVEREIGN"] */
5255
+ sectors?: string[];
5256
+ sorts?: InsightOrderingV2[];
5257
+ /** @example ["AAA"] */
5258
+ sp_ratings?: string[];
5259
+ /** @example ["called","outstanding"] */
5260
+ statuses?: string[];
5261
+ tickers?: string[];
5262
+ /** @example ["corporate"] */
5263
+ types?: string[];
5264
+ }
5265
+ export interface InsightGetTopSymbolsRequestV2 {
5266
+ exchange?: string[];
5267
+ market_cap?: InsightLessAndMoreV2;
5268
+ pagination?: InsightPaginationV2;
5269
+ price?: InsightLessAndMoreV2;
5270
+ sorts?: InsightOrderingV2[];
5271
+ volume?: InsightLessAndMoreV2;
5272
+ }
5273
+ export interface InsightIncludeExcludeV2 {
5274
+ exclude?: string[];
5275
+ include?: string[];
5276
+ }
5277
+ export interface InsightLessAndMoreV2 {
5278
+ less_than?: number;
5279
+ more_than?: number;
5280
+ }
5281
+ export enum InsightOrderDirectionV2 {
5282
+ OrderASC = "asc",
5283
+ OrderDESC = "desc"
5284
+ }
5285
+ export interface InsightOrderingV2 {
5479
5286
  /**
5480
- * @description update screener preset
5481
- * @tags StockScreener
5482
- * @name UpdateScreenerPreset
5483
- * @summary update screener preset
5484
- * @request PUT:/stock-screener/presets
5485
- * @secure
5287
+ * @default "asc"
5288
+ * @example "asc"
5486
5289
  */
5487
- updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5290
+ direction: InsightOrderingDirectionEnumV2;
5488
5291
  /**
5489
- * @description create screener preset
5490
- * @tags StockScreener
5491
- * @name CreateOrScreenerPreset
5492
- * @summary create screener preset
5493
- * @request POST:/stock-screener/presets
5494
- * @secure
5292
+ * Sort direction:
5293
+ * * asc - Ascending, from A to Z.
5294
+ * * desc - Descending, from Z to A.
5295
+ * @example "name"
5495
5296
  */
5496
- createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5297
+ field: string;
5298
+ }
5299
+ export interface InsightPaginationV2 {
5497
5300
  /**
5498
- * @description remove screener preset
5499
- * @tags StockScreener
5500
- * @name RemoveScreenerPreset
5501
- * @summary remove screener preset
5502
- * @request DELETE:/stock-screener/presets
5503
- * @secure
5301
+ * @min 1
5302
+ * @example 1
5504
5303
  */
5505
- removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5304
+ page: number;
5506
5305
  /**
5507
- * @description get top symbols
5508
- * @tags StockScreener
5509
- * @name GetTopSymbols
5510
- * @summary get top symbols
5511
- * @request POST:/stock-screener/top
5512
- * @secure
5306
+ * @min 1
5307
+ * @max 50
5308
+ * @example 10
5513
5309
  */
5514
- getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5310
+ size: number;
5515
5311
  }
5516
- export class Quotes<HandleError extends boolean = boolean> {
5312
+ export interface InsightStockScreenerQuoteV2 {
5313
+ average_volume_30d: number;
5314
+ company_name: string;
5315
+ dividend_ex_date: string;
5316
+ dividend_pay_date: string;
5317
+ dividend_percent: number;
5318
+ exchange: string;
5319
+ exchange_name: string;
5320
+ gap: number;
5321
+ industry: string;
5322
+ industry_code: string;
5323
+ last_price: number;
5324
+ market_cap: number;
5325
+ pe_ratio: number;
5326
+ price_change: number;
5327
+ price_change_percent: number;
5328
+ symbol: string;
5329
+ volume: number;
5330
+ }
5331
+ export interface InsightStockScreenerRequestV2 {
5332
+ average_volume_30d?: InsightLessAndMoreV2;
5333
+ dividend_ex_date?: InsightBeforeAndAfterV2;
5334
+ dividend_pay_date?: InsightBeforeAndAfterV2;
5335
+ dividend_percent?: InsightLessAndMoreV2;
5336
+ exchange?: InsightIncludeExcludeV2;
5337
+ gap?: InsightLessAndMoreV2;
5338
+ industry?: InsightIncludeExcludeV2;
5339
+ market_cap?: InsightLessAndMoreV2;
5340
+ pagination: InsightPaginationV2;
5341
+ pe_ratio?: InsightLessAndMoreV2;
5342
+ price?: InsightLessAndMoreV2;
5343
+ sorts?: InsightOrderingV2[];
5344
+ /** @example "ADR" */
5345
+ stock_type?: string;
5346
+ volume?: InsightLessAndMoreV2;
5347
+ }
5348
+ export interface InsightStockScreenerResponseV2 {
5349
+ current_page: number;
5350
+ data: InsightStockScreenerQuoteV2[];
5351
+ page_count: number;
5352
+ status: number;
5353
+ total_records: number;
5354
+ }
5355
+ /**
5356
+ * @default "asc"
5357
+ * @example "asc"
5358
+ */
5359
+ export enum InsightOrderingDirectionEnumV2 {
5360
+ Asc = "asc",
5361
+ Desc = "desc"
5362
+ }
5363
+ export class FixedIncomeV2<HandleError extends boolean = boolean> {
5517
5364
  protected readonly apiClient: JwtClient<HandleError>;
5518
5365
  constructor(apiClient: JwtClient<HandleError>);
5519
5366
  /**
5520
- * @description Get single historical quote
5521
- * @tags Quotes
5522
- * @name GitHistoricalQuote
5523
- * @summary Get single historical quote
5524
- * @request GET:/historical/quote
5525
- * @secure
5526
- */
5527
- gitHistoricalQuote(query: {
5528
- /** Symbol */
5529
- symbol: string;
5530
- /** Date */
5531
- date: string;
5532
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
5533
- /**
5534
- * @description get quote history by symbol
5535
- * @tags Quotes
5536
- * @name GitQuoteHistory
5537
- * @summary Get quote history
5538
- * @request POST:/quote-history
5539
- * @secure
5540
- */
5541
- gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
5542
- /**
5543
- * @description Returns a list of quotes equity info for specified symbols.
5544
- * @tags Quotes
5545
- * @name GetQuotesEquityData
5546
- * @summary Get Quotes Equity data
5547
- * @request GET:/quotes/equity
5367
+ * @description get fixed income entries
5368
+ * @tags FixedIncome
5369
+ * @name GetFixedIncomeEntries
5370
+ * @summary get fixed income entries
5371
+ * @request POST:/fixed-income
5548
5372
  * @secure
5549
5373
  */
5550
- getQuotesEquityData(query: {
5551
- /** Comma separated symbols */
5552
- symbols: string;
5553
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
5374
+ getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
5554
5375
  }
5555
- export class Intraday<HandleError extends boolean = boolean> {
5376
+ export class Fundamentals<HandleError extends boolean = boolean> {
5556
5377
  protected readonly apiClient: JwtClient<HandleError>;
5557
5378
  constructor(apiClient: JwtClient<HandleError>);
5558
5379
  /**
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
5380
+ * @description get fundamentals by symbol data
5381
+ * @tags Fundamentals
5382
+ * @name GetFundamentalsBySymbolData
5383
+ * @summary get fundamentals by symbol data
5384
+ * @request POST:/fundamentals
5564
5385
  * @secure
5565
5386
  */
5566
- intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
5387
+ getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
5567
5388
  }
5568
- export class Ipos<HandleError extends boolean = boolean> {
5389
+ export class Funds<HandleError extends boolean = boolean> {
5569
5390
  protected readonly apiClient: JwtClient<HandleError>;
5570
5391
  constructor(apiClient: JwtClient<HandleError>);
5571
5392
  /**
5572
- * @description get recent ipos info
5573
- * @tags Ipos
5574
- * @name PostRecent
5575
- * @summary get recent ipos info
5576
- * @request POST:/ipos/recent
5393
+ * @description get fund details
5394
+ * @tags Funds
5395
+ * @name GetFundDetails
5396
+ * @summary get fund details
5397
+ * @request GET:/funds/details
5577
5398
  * @secure
5578
5399
  */
5579
- postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5400
+ getFundDetails(query: {
5401
+ /** Fund symbol */
5402
+ symbol: string;
5403
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError>>;
5580
5404
  /**
5581
- * @description get upcoming ipos info
5582
- * @tags Ipos
5583
- * @name GetUpcoming
5584
- * @summary get upcoming ipos info
5585
- * @request GET:/ipos/upcoming
5405
+ * @description get funds for holding
5406
+ * @tags Funds
5407
+ * @name GetFundsForHolding
5408
+ * @summary get funds for holding
5409
+ * @request POST:/funds/funds-for-holding
5586
5410
  * @secure
5587
5411
  */
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>>;
5412
+ getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
5413
+ /** Authorization */
5414
+ Authorization?: string;
5415
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError>>;
5594
5416
  /**
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
- export class PreIpoCompanies<HandleError extends boolean = boolean> {
5610
- protected readonly apiClient: JwtClient<HandleError>;
5611
- constructor(apiClient: JwtClient<HandleError>);
5612
- /**
5613
- * @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
5614
- * @tags PreIPOCompanies
5615
- * @name MonarkOghlcDataForSymbol
5616
- * @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
5617
- * @request GET:/ipos/market-data/ohlc/{symbol}
5417
+ * @description filter funds by params
5418
+ * @tags Funds
5419
+ * @name FundScreener
5420
+ * @summary filter funds by params
5421
+ * @request POST:/funds/screener
5618
5422
  * @secure
5619
5423
  */
5620
- monarkOghlcDataForSymbol(symbol: string, query?: {
5621
- /** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
5622
- from?: string;
5623
- /** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
5624
- to?: string;
5625
- /** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
5626
- interval?: string;
5627
- /** Limit the number of OHLC data points returned. Default is 100. */
5628
- limit?: number;
5629
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
5630
- close?: number;
5631
- high?: number;
5632
- low?: number;
5633
- open?: number;
5634
- time?: string;
5635
- volume?: number;
5636
- }[], HandleError>>;
5424
+ fundScreener(filter: InsightFundScreenerRequest, headers?: {
5425
+ /** Authorization */
5426
+ Authorization?: string;
5427
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
5637
5428
  /**
5638
- * @description Retrieves all symbols available in the market data
5639
- * @tags PreIPOCompanies
5640
- * @name MonarkAllAvailableSymbols
5641
- * @summary Retrieves all symbols available in the market data
5642
- * @request GET:/ipos/market-data/symbols
5429
+ * @description get fund screener filters
5430
+ * @tags Funds
5431
+ * @name GetScreenerFilters
5432
+ * @summary get fund screener filters
5433
+ * @request GET:/funds/screener/filters
5643
5434
  * @secure
5644
5435
  */
5645
- monarkAllAvailableSymbols(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5436
+ getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError>>;
5646
5437
  /**
5647
- * @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
5648
- * @tags PreIPOCompanies
5649
- * @name GetPreIpoCompanies
5650
- * @summary get pre ipo companies
5651
- * @request GET:/ipos/pre-ipo-companies
5438
+ * @description get fund screener presets
5439
+ * @tags Funds
5440
+ * @name GetFundScreenerPresets
5441
+ * @summary get fund screener presets
5442
+ * @request GET:/funds/screener/presets
5652
5443
  * @secure
5653
5444
  */
5654
- getPreIpoCompanies(query: {
5655
- /** search by company name */
5656
- name?: string;
5657
- /** search by categories */
5658
- categories?: string;
5659
- /** search by listing type */
5660
- listing_type?: string;
5661
- /** filter by active status */
5662
- is_active?: InsightGetPreIpoCompaniesParamsIsActiveEnum;
5663
- /** filter by minimum last valuation */
5664
- min_last_valuation?: number;
5665
- /** filter by maximum last valuation */
5666
- max_last_valuation?: number;
5667
- /** filter by minimum total funding */
5668
- min_total_funding?: number;
5669
- /** filter by maximum total funding */
5670
- max_total_funding?: number;
5671
- /** how many records to return. Max value is 50 */
5445
+ getFundScreenerPresets(query: {
5446
+ /** how many records to return */
5672
5447
  limit: number;
5673
5448
  /** how many records to skip */
5674
5449
  offset: number;
5675
- /** sort field */
5676
- order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
5677
- /** sort direction */
5678
- order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
5679
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
5450
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
5680
5451
  /**
5681
- * @description get pre ipo company by id
5682
- * @tags PreIPOCompanies
5683
- * @name GetPreIpoCompaniesById
5684
- * @summary get pre ipo company by id
5685
- * @request GET:/ipos/pre-ipo-companies/{id}
5686
- * @originalName getPreIpoCompanies
5687
- * @duplicate
5452
+ * @description update fund screener preset
5453
+ * @tags Funds
5454
+ * @name UpdateFundScreenerPreset
5455
+ * @summary update fund screener preset
5456
+ * @request PUT:/funds/screener/presets
5688
5457
  * @secure
5689
5458
  */
5690
- getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
5459
+ updateFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5691
5460
  /**
5692
- * @description get pre ipo company funding rounds
5693
- * @tags PreIPOCompanies
5694
- * @name GetPreIpoCompanyFundingRounds
5695
- * @summary get pre ipo company funding rounds
5696
- * @request GET:/ipos/pre-ipo-company-funding-rounds
5461
+ * @description create fund screener preset
5462
+ * @tags Funds
5463
+ * @name CreateFundScreenerPreset
5464
+ * @summary create fund screener preset
5465
+ * @request POST:/funds/screener/presets
5697
5466
  * @secure
5698
5467
  */
5699
- getPreIpoCompanyFundingRounds(query: {
5700
- /** company id */
5701
- pre_ipo_company_id?: string;
5702
- /** search by round name */
5703
- round_name?: string;
5704
- /** how many records to return. Max value is 50 */
5705
- limit: number;
5706
- /** how many records to skip */
5707
- offset: number;
5708
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
5468
+ createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5709
5469
  /**
5710
- * @description get pre ipo company funding round by id
5711
- * @tags PreIPOCompanies
5712
- * @name GetPreIpoCompanyFundingRoundsById
5713
- * @summary get pre ipo company funding round by id
5714
- * @request GET:/ipos/pre-ipo-company-funding-rounds/{id}
5715
- * @originalName getPreIpoCompanyFundingRounds
5716
- * @duplicate
5470
+ * @description remove fund screener preset
5471
+ * @tags Funds
5472
+ * @name RemoveFundScreenerPreset
5473
+ * @summary remove fund screener preset
5474
+ * @request DELETE:/funds/screener/presets
5717
5475
  * @secure
5718
5476
  */
5719
- getPreIpoCompanyFundingRoundsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyFundingRound, HandleError>>;
5477
+ removeFundScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5720
5478
  /**
5721
- * @description get pre ipo company investments
5722
- * @tags PreIPOCompanies
5723
- * @name GetPreIpoCompanyInvestments
5724
- * @summary get pre ipo company investments
5725
- * @request GET:/ipos/pre-ipo-company-investments
5479
+ * @description filter funds by params
5480
+ * @tags Funds
5481
+ * @name FundSectorScreener
5482
+ * @summary filter funds by params
5483
+ * @request POST:/funds/sector-screener
5726
5484
  * @secure
5727
5485
  */
5728
- getPreIpoCompanyInvestments(query: {
5729
- /** company id */
5730
- pre_ipo_company_id?: string;
5731
- /** company name */
5732
- company_name?: string;
5733
- /** how many records to return. Max value is 50 */
5734
- limit: number;
5735
- /** how many records to skip */
5736
- offset: number;
5737
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
5486
+ fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
5487
+ /** Authorization */
5488
+ Authorization?: string;
5489
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
5738
5490
  /**
5739
- * @description get pre ipo company investment by id
5740
- * @tags PreIPOCompanies
5741
- * @name GetPreIpoCompanyInvestmentsById
5742
- * @summary get pre ipo company investment by id
5743
- * @request GET:/ipos/pre-ipo-company-investments/{id}
5744
- * @originalName getPreIpoCompanyInvestments
5745
- * @duplicate
5491
+ * @description get top funds
5492
+ * @tags Funds
5493
+ * @name GetTopFunds
5494
+ * @summary get top funds
5495
+ * @request POST:/funds/top
5746
5496
  * @secure
5747
5497
  */
5748
- getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
5498
+ getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
5499
+ /** Authorization */
5500
+ Authorization?: string;
5501
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
5502
+ }
5503
+ export class Intraday<HandleError extends boolean = boolean> {
5504
+ protected readonly apiClient: JwtClient<HandleError>;
5505
+ constructor(apiClient: JwtClient<HandleError>);
5749
5506
  /**
5750
- * @description get pre ipo company news
5751
- * @tags PreIPOCompanies
5752
- * @name GetPreIpoCompanyNews
5753
- * @summary get pre ipo company news
5754
- * @request GET:/ipos/pre-ipo-company-news
5507
+ * @description Returns an array of intraday chart data values for the given ticker.
5508
+ * @tags Intraday
5509
+ * @name IntradayQuotes
5510
+ * @summary Get an array of intraday chart data values for the given ticker
5511
+ * @request POST:/intraday/quotes
5755
5512
  * @secure
5756
5513
  */
5757
- getPreIpoCompanyNews(query: {
5758
- /** company id */
5759
- pre_ipo_company_id?: string;
5760
- /** search by headline */
5761
- headline?: string;
5762
- /** how many records to return. Max value is 50 */
5763
- limit: number;
5764
- /** how many records to skip */
5765
- offset: number;
5766
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
5514
+ intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
5515
+ }
5516
+ export class Ipos<HandleError extends boolean = boolean> {
5517
+ protected readonly apiClient: JwtClient<HandleError>;
5518
+ constructor(apiClient: JwtClient<HandleError>);
5767
5519
  /**
5768
- * @description get pre ipo company news by id
5769
- * @tags PreIPOCompanies
5770
- * @name GetPreIpoCompanyNewsById
5771
- * @summary get pre ipo company news by id
5772
- * @request GET:/ipos/pre-ipo-company-news/{id}
5773
- * @originalName getPreIpoCompanyNews
5774
- * @duplicate
5520
+ * @description get recent ipos info
5521
+ * @tags Ipos
5522
+ * @name PostRecent
5523
+ * @summary get recent ipos info
5524
+ * @request POST:/ipos/recent
5775
5525
  * @secure
5776
5526
  */
5777
- getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
5527
+ postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5778
5528
  /**
5779
- * @description get pre ipo company research documents
5780
- * @tags PreIPOCompanies
5781
- * @name GetPreIpoCompanyResearchDocuments
5782
- * @summary get pre ipo company research documents
5783
- * @request GET:/ipos/pre-ipo-company-research-documents
5529
+ * @description get upcoming ipos info
5530
+ * @tags Ipos
5531
+ * @name GetUpcoming
5532
+ * @summary get upcoming ipos info
5533
+ * @request GET:/ipos/upcoming
5784
5534
  * @secure
5785
5535
  */
5786
- getPreIpoCompanyResearchDocuments(query: {
5787
- /** company id */
5788
- pre_ipo_company_id?: string;
5789
- /** search by title */
5790
- title?: string;
5536
+ getUpcoming(query: {
5791
5537
  /** how many records to return. Max value is 50 */
5792
5538
  limit: number;
5793
5539
  /** how many records to skip */
5794
5540
  offset: number;
5795
- /** search by research type */
5796
- research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
5797
- /** search by relation */
5798
- relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
5799
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
5800
- /**
5801
- * @description get pre ipo company research document by id
5802
- * @tags PreIPOCompanies
5803
- * @name GetPreIpoCompanyResearchDocumentsById
5804
- * @summary get pre ipo company research document by id
5805
- * @request GET:/ipos/pre-ipo-company-research-documents/{id}
5806
- * @originalName getPreIpoCompanyResearchDocuments
5807
- * @duplicate
5808
- * @secure
5809
- */
5810
- getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
5541
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5811
5542
  /**
5812
- * @description get pre ipo company spvs with investor id
5813
- * @tags PreIPOCompanies
5814
- * @name GetInvestor
5815
- * @summary get pre ipo company spvs with investor id
5816
- * @request GET:/ipos/pre-ipo-company-spv/investor/{investor_id}
5543
+ * @description get ipo info by symbol
5544
+ * @tags Ipos
5545
+ * @name GetIpos
5546
+ * @summary get ipo info by symbol
5547
+ * @request GET:/ipos/{symbol}
5817
5548
  * @secure
5818
5549
  */
5819
- getInvestor(investorId: string, query: {
5820
- /** search by monark stage */
5821
- monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
5822
- /** Optional param to filter returned spv's based on the exemptions claimed */
5823
- exemptions_claimed?: string[];
5824
- /** Optional param to filter returned spv's based on the name */
5825
- name_filter?: string;
5826
- /** investment id */
5827
- pre_ipo_company_id?: string;
5828
- /** investment id */
5829
- pre_ipo_company_investment_id?: string;
5830
- /** page number */
5831
- page: number;
5832
- /** page size */
5833
- page_size: number;
5834
- /** sort direction */
5835
- sort_order?: InsightGetInvestorParamsSortOrderEnum;
5836
- /** sort field */
5837
- sort_by?: InsightGetInvestorParamsSortByEnum;
5838
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
5550
+ getIpos(symbol: string, query?: {
5551
+ /** load quotes */
5552
+ load_quotes?: boolean;
5553
+ /** statuses */
5554
+ statuses?: string[];
5555
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
5556
+ }
5557
+ export class Logos<HandleError extends boolean = boolean> {
5558
+ protected readonly apiClient: JwtClient<HandleError>;
5559
+ constructor(apiClient: JwtClient<HandleError>);
5839
5560
  /**
5840
- * @description get pre ipo company spv by id with investor id
5841
- * @tags PreIPOCompanies
5842
- * @name GetInvestorByIdAndInvestorId
5843
- * @summary get pre ipo company spv by id with investor id
5844
- * @request GET:/ipos/pre-ipo-company-spv/{id}/investor/{investor_id}
5845
- * @originalName getInvestor
5846
- * @duplicate
5561
+ * @description Returns converted logo for crypto symbol
5562
+ * @tags Logos
5563
+ * @name LogosConvertedCryptoSymbolLogo
5564
+ * @summary Get converted logo for crypto symbol
5565
+ * @request POST:/logos/converted-crypto-symbol-logo
5847
5566
  * @secure
5848
5567
  */
5849
- getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
5850
- /** default is false, if true documents will be included in the response */
5851
- include_documents?: boolean;
5852
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
5568
+ logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5853
5569
  /**
5854
- * @description get pre ipo company spvs
5855
- * @tags PreIPOCompanies
5856
- * @name GetPreIpoCompanySpvs
5857
- * @summary get pre ipo company spvs
5858
- * @request GET:/ipos/pre-ipo-company-spvs
5570
+ * @description Returns converted logo for symbol
5571
+ * @tags Logos
5572
+ * @name LogosConvertedSymbolLogo
5573
+ * @summary Get converted logo for symbol
5574
+ * @request POST:/logos/converted-symbol-logo
5859
5575
  * @secure
5860
5576
  */
5861
- getPreIpoCompanySpvs(query: {
5862
- /** company id */
5863
- pre_ipo_company_id?: string;
5864
- /** investment id */
5865
- investment_id?: string;
5866
- /** search by name */
5867
- name?: string;
5868
- /** search by company name */
5869
- company_name?: string;
5870
- /** how many records to return. Max value is 50 */
5871
- limit: number;
5872
- /** how many records to skip */
5873
- offset: number;
5874
- /** search by monark stage */
5875
- monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
5876
- /** sort direction */
5877
- direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
5878
- /** sort field */
5879
- field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
5880
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
5577
+ logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5881
5578
  /**
5882
- * @description get pre ipo company spv by id
5883
- * @tags PreIPOCompanies
5884
- * @name GetPreIpoCompanySpvsById
5885
- * @summary get pre ipo company spv by id
5886
- * @request GET:/ipos/pre-ipo-company-spvs/{id}
5887
- * @originalName getPreIpoCompanySpvs
5888
- * @duplicate
5579
+ * @description Returns logo for crypto symbol
5580
+ * @tags Logos
5581
+ * @name LogosCryptoSymbolLogo
5582
+ * @summary Get logo for crypto symbol
5583
+ * @request GET:/logos/crypto-symbol-logo
5889
5584
  * @secure
5890
5585
  */
5891
- getPreIpoCompanySpvsById(id: string, query?: {
5892
- /** default is false, if true documents will be included in the response */
5893
- include_documents?: boolean;
5894
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
5586
+ logosCryptoSymbolLogo(query: {
5587
+ /** Company symbol */
5588
+ symbol: string;
5589
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
5590
+ /**
5591
+ * @description Returns direct logo for crypto symbol
5592
+ * @tags Logos
5593
+ * @name LogosDirectCryptoSymbolLogo
5594
+ * @summary Get direct logo for crypto symbol
5595
+ * @request GET:/logos/direct-crypto-symbol-logo
5596
+ * @secure
5597
+ */
5598
+ logosDirectCryptoSymbolLogo(query: {
5599
+ /** Company symbol */
5600
+ symbol: string;
5601
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5602
+ /**
5603
+ * @description Returns direct logo for symbol
5604
+ * @tags Logos
5605
+ * @name LogosDirectSymbolLogo
5606
+ * @summary Get direct logo for symbol
5607
+ * @request GET:/logos/direct-symbol-logo
5608
+ * @secure
5609
+ */
5610
+ logosDirectSymbolLogo(query: {
5611
+ /** Company symbol */
5612
+ symbol: string;
5613
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5614
+ /**
5615
+ * @description Returns logos for multiple symbols
5616
+ * @tags Logos
5617
+ * @name LogosMultipleCryptoSymbolLogo
5618
+ * @summary Get logos for multiple symbols
5619
+ * @request POST:/logos/multiple-crypto-symbol-logo
5620
+ * @secure
5621
+ */
5622
+ logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
5623
+ /**
5624
+ * @description Returns logos for multiple symbol
5625
+ * @tags Logos
5626
+ * @name LogosMultipleSymbolLogos
5627
+ * @summary Get logos for multiple symbols
5628
+ * @request POST:/logos/multiple-symbol-logos
5629
+ * @secure
5630
+ */
5631
+ logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
5632
+ /**
5633
+ * @description Returns links of socials logos for symbol
5634
+ * @tags Logos
5635
+ * @name LogosSocialSymbolLogos
5636
+ * @summary Get social logos for symbol
5637
+ * @request GET:/logos/social-symbol-logos
5638
+ * @secure
5639
+ */
5640
+ logosSocialSymbolLogos(query: {
5641
+ /** Company symbol */
5642
+ symbol: string;
5643
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
5644
+ /**
5645
+ * @description Returns logos for company symbol
5646
+ * @tags Logos
5647
+ * @name LogosSymbolLogos
5648
+ * @summary Get symbol logos
5649
+ * @request GET:/logos/symbol-logos
5650
+ * @secure
5651
+ */
5652
+ logosSymbolLogos(query: {
5653
+ /** Company symbol */
5654
+ symbol: string;
5655
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
5895
5656
  }
5896
5657
  export class MarketDates<HandleError extends boolean = boolean> {
5897
5658
  protected readonly apiClient: JwtClient<HandleError>;
@@ -6171,1001 +5932,1241 @@ export class News<HandleError extends boolean = boolean> {
6171
5932
  */
6172
5933
  newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6173
5934
  }
6174
- export class Logos<HandleError extends boolean = boolean> {
5935
+ export class OptionGreeks<HandleError extends boolean = boolean> {
6175
5936
  protected readonly apiClient: JwtClient<HandleError>;
6176
5937
  constructor(apiClient: JwtClient<HandleError>);
6177
5938
  /**
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
5939
+ * @description Returns calculated matrix
5940
+ * @tags OptionGreeks
5941
+ * @name OgCalculateMatrix
5942
+ * @summary Calculate matrix
5943
+ * @request POST:/og/calculate-matrix
6183
5944
  * @secure
6184
5945
  */
6185
- logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5946
+ ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
6186
5947
  /**
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
5948
+ * @description Returns calculated params
5949
+ * @tags OptionGreeks
5950
+ * @name OgCalculateParams
5951
+ * @summary Calculate params
5952
+ * @request POST:/og/calculate-params
6192
5953
  * @secure
6193
5954
  */
6194
- logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5955
+ ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
5956
+ }
5957
+ export class Ownerships<HandleError extends boolean = boolean> {
5958
+ protected readonly apiClient: JwtClient<HandleError>;
5959
+ constructor(apiClient: JwtClient<HandleError>);
6195
5960
  /**
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
5961
+ * @description get ownerships by id datadata
5962
+ * @tags Ownerships
5963
+ * @name GetOwnershipsByIdData
5964
+ * @summary get ownerships by id data
5965
+ * @request POST:/ownerships
6201
5966
  * @secure
6202
5967
  */
6203
- logosCryptoSymbolLogo(query: {
6204
- /** Company symbol */
6205
- symbol: string;
6206
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
5968
+ getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6207
5969
  /**
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
5970
+ * @description get ownerships by symbol data
5971
+ * @tags Ownerships
5972
+ * @name GetOwnershipsBySymbolData
5973
+ * @summary get ownerships by symbol data
5974
+ * @request POST:/symbol-ownerships
6213
5975
  * @secure
6214
5976
  */
6215
- logosDirectCryptoSymbolLogo(query: {
6216
- /** Company symbol */
6217
- symbol: string;
6218
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5977
+ getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5978
+ }
5979
+ export class Passport<HandleError extends boolean = boolean> {
5980
+ protected readonly apiClient: JwtClient<HandleError>;
5981
+ constructor(apiClient: JwtClient<HandleError>);
6219
5982
  /**
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
5983
+ * @description Returns article by id
5984
+ * @tags Passport
5985
+ * @name PassportArticleById
5986
+ * @summary Get article by id
5987
+ * @request POST:/passport/article-by-id
6225
5988
  * @secure
6226
5989
  */
6227
- logosDirectSymbolLogo(query: {
6228
- /** Company symbol */
6229
- symbol: string;
6230
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5990
+ passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
6231
5991
  /**
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
5992
+ * @description Returns articles
5993
+ * @tags Passport
5994
+ * @name PassportArticles
5995
+ * @summary Get articles
5996
+ * @request POST:/passport/articles
6246
5997
  * @secure
6247
5998
  */
6248
- logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
5999
+ passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6249
6000
  /**
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
6001
+ * @description Returns author profile
6002
+ * @tags Passport
6003
+ * @name PassportAuthorProfile
6004
+ * @summary Get author profile
6005
+ * @request POST:/passport/author-profile
6255
6006
  * @secure
6256
6007
  */
6257
- logosSocialSymbolLogos(query: {
6258
- /** Company symbol */
6259
- symbol: string;
6260
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
6008
+ passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
6261
6009
  /**
6262
- * @description Returns logos for company symbol
6263
- * @tags Logos
6264
- * @name LogosSymbolLogos
6265
- * @summary Get symbol logos
6266
- * @request GET:/logos/symbol-logos
6010
+ * @description Returns most popular tags
6011
+ * @tags Passport
6012
+ * @name PassportMostPopularTags
6013
+ * @summary Get most popular tags
6014
+ * @request POST:/passport/most-popular-tags
6267
6015
  * @secure
6268
6016
  */
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>);
6017
+ passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
6277
6018
  /**
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
6019
+ * @description Returns news feed
6020
+ * @tags Passport
6021
+ * @name PassportNewsFeed
6022
+ * @summary Get news feed
6023
+ * @request POST:/passport/newsfeed
6283
6024
  * @secure
6284
6025
  */
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>>;
6026
+ passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
6298
6027
  /**
6299
- * @description Returns an expert forecast
6300
- * @tags Public
6301
- * @name ExpertForecast
6302
- * @summary Expert forecast
6303
- * @request GET:/public/expert-forecast
6028
+ * @description Returns article by parameters
6029
+ * @tags Passport
6030
+ * @name PassportSearchArticle
6031
+ * @summary Search article by parameters
6032
+ * @request POST:/passport/search-article
6304
6033
  * @secure
6305
6034
  */
6306
- expertForecast(query: {
6307
- /** Comma separated symbols */
6308
- symbols: string;
6309
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
6035
+ passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6036
+ }
6037
+ export class PreIpoCompanies<HandleError extends boolean = boolean> {
6038
+ protected readonly apiClient: JwtClient<HandleError>;
6039
+ constructor(apiClient: JwtClient<HandleError>);
6310
6040
  /**
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}
6041
+ * @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
6042
+ * @tags PreIPOCompanies
6043
+ * @name MonarkOghlcDataForSymbol
6044
+ * @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
6045
+ * @request GET:/ipos/market-data/ohlc/{symbol}
6316
6046
  * @secure
6317
6047
  */
6318
- getPublicFundamentalsBySymbolData(symbol: string, query: {
6319
- /** Annual or quarterly */
6320
- mode: string;
6321
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
6048
+ monarkOghlcDataForSymbol(symbol: string, query?: {
6049
+ /** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
6050
+ from?: string;
6051
+ /** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
6052
+ to?: string;
6053
+ /** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
6054
+ interval?: string;
6055
+ /** Limit the number of OHLC data points returned. Default is 100. */
6056
+ limit?: number;
6057
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
6058
+ close?: number;
6059
+ high?: number;
6060
+ low?: number;
6061
+ open?: number;
6062
+ time?: string;
6063
+ volume?: number;
6064
+ }[], HandleError>>;
6322
6065
  /**
6323
- * @description Daily price history
6324
- * @tags Public
6325
- * @name DailyPriceHistory
6326
- * @summary Daily price history
6327
- * @request GET:/public/price-history/daily
6066
+ * @description Retrieves all symbols available in the market data
6067
+ * @tags PreIPOCompanies
6068
+ * @name MonarkAllAvailableSymbols
6069
+ * @summary Retrieves all symbols available in the market data
6070
+ * @request GET:/ipos/market-data/symbols
6328
6071
  * @secure
6329
6072
  */
6330
- dailyPriceHistory(query: {
6331
- /** Single symbol */
6332
- symbol: string;
6333
- /** Target date */
6334
- date: string;
6335
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
6073
+ monarkAllAvailableSymbols(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6336
6074
  /**
6337
- * @description Public quote profile
6338
- * @tags Public
6339
- * @name PublicQuoteProfile
6340
- * @summary Public quote profile
6341
- * @request GET:/public/quote-profile/{symbol}
6075
+ * @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
6076
+ * @tags PreIPOCompanies
6077
+ * @name GetPreIpoCompanies
6078
+ * @summary get pre ipo companies
6079
+ * @request GET:/ipos/pre-ipo-companies
6342
6080
  * @secure
6343
6081
  */
6344
- publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
6082
+ getPreIpoCompanies(query: {
6083
+ /** search by company name */
6084
+ name?: string;
6085
+ /** search by categories */
6086
+ categories?: string;
6087
+ /** search by listing type */
6088
+ listing_type?: string;
6089
+ /** filter by active status */
6090
+ is_active?: InsightGetPreIpoCompaniesParamsIsActiveEnum;
6091
+ /** filter by minimum last valuation */
6092
+ min_last_valuation?: number;
6093
+ /** filter by maximum last valuation */
6094
+ max_last_valuation?: number;
6095
+ /** filter by minimum total funding */
6096
+ min_total_funding?: number;
6097
+ /** filter by maximum total funding */
6098
+ max_total_funding?: number;
6099
+ /** how many records to return. Max value is 50 */
6100
+ limit: number;
6101
+ /** how many records to skip */
6102
+ offset: number;
6103
+ /** sort field */
6104
+ order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
6105
+ /** sort direction */
6106
+ order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
6107
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
6345
6108
  /**
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}
6109
+ * @description get pre ipo company by id
6110
+ * @tags PreIPOCompanies
6111
+ * @name GetPreIpoCompaniesById
6112
+ * @summary get pre ipo company by id
6113
+ * @request GET:/ipos/pre-ipo-companies/{id}
6114
+ * @originalName getPreIpoCompanies
6115
+ * @duplicate
6351
6116
  * @secure
6352
6117
  */
6353
- getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
6118
+ getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
6354
6119
  /**
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
6120
+ * @description get pre ipo company funding rounds
6121
+ * @tags PreIPOCompanies
6122
+ * @name GetPreIpoCompanyFundingRounds
6123
+ * @summary get pre ipo company funding rounds
6124
+ * @request GET:/ipos/pre-ipo-company-funding-rounds
6360
6125
  * @secure
6361
6126
  */
6362
- quoteFundamentalsSearch(query: {
6363
- /** Search query */
6364
- search_query: string;
6127
+ getPreIpoCompanyFundingRounds(query: {
6128
+ /** company id */
6129
+ pre_ipo_company_id?: string;
6130
+ /** search by round name */
6131
+ round_name?: string;
6365
6132
  /** how many records to return. Max value is 50 */
6366
6133
  limit: number;
6367
6134
  /** how many records to skip */
6368
6135
  offset: number;
6369
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
6136
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
6370
6137
  /**
6371
- * @description Get top gainers
6372
- * @tags Public
6373
- * @name TopGainers
6374
- * @summary Top Gainers
6375
- * @request GET:/public/top-gainers
6138
+ * @description get pre ipo company funding round by id
6139
+ * @tags PreIPOCompanies
6140
+ * @name GetPreIpoCompanyFundingRoundsById
6141
+ * @summary get pre ipo company funding round by id
6142
+ * @request GET:/ipos/pre-ipo-company-funding-rounds/{id}
6143
+ * @originalName getPreIpoCompanyFundingRounds
6144
+ * @duplicate
6376
6145
  * @secure
6377
6146
  */
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>>;
6147
+ getPreIpoCompanyFundingRoundsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyFundingRound, HandleError>>;
6386
6148
  /**
6387
- * @description Get top stocks
6388
- * @tags Public
6389
- * @name TopStocks
6390
- * @summary Top Stocks
6391
- * @request GET:/public/top-stocks
6149
+ * @description get pre ipo company investments
6150
+ * @tags PreIPOCompanies
6151
+ * @name GetPreIpoCompanyInvestments
6152
+ * @summary get pre ipo company investments
6153
+ * @request GET:/ipos/pre-ipo-company-investments
6392
6154
  * @secure
6393
6155
  */
6394
- topStocks(query: {
6395
- /** EQUITY|ETF|CRYPTO */
6396
- stock_type: InsightTopStocksParamsStockTypeEnum;
6156
+ getPreIpoCompanyInvestments(query: {
6157
+ /** company id */
6158
+ pre_ipo_company_id?: string;
6159
+ /** company name */
6160
+ company_name?: string;
6397
6161
  /** how many records to return. Max value is 50 */
6398
6162
  limit: number;
6399
6163
  /** how many records to skip */
6400
6164
  offset: number;
6401
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6402
- }
6403
- export class AlphaTools<HandleError extends boolean = boolean> {
6404
- protected readonly apiClient: JwtClient<HandleError>;
6405
- constructor(apiClient: JwtClient<HandleError>);
6165
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
6406
6166
  /**
6407
- * @description get seasonlity data with comparison to benchmark
6408
- * @tags AlphaTools
6409
- * @name GetMomentumRatioGraph
6410
- * @summary get seasonlity data
6411
- * @request POST:/rst
6167
+ * @description get pre ipo company investment by id
6168
+ * @tags PreIPOCompanies
6169
+ * @name GetPreIpoCompanyInvestmentsById
6170
+ * @summary get pre ipo company investment by id
6171
+ * @request GET:/ipos/pre-ipo-company-investments/{id}
6172
+ * @originalName getPreIpoCompanyInvestments
6173
+ * @duplicate
6412
6174
  * @secure
6413
6175
  */
6414
- getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
6176
+ getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
6415
6177
  /**
6416
- * @description get seasonlity data with comparison to benchmark
6417
- * @tags AlphaTools
6418
- * @name GetSeasonality
6419
- * @summary get seasonlity data
6420
- * @request POST:/seasonality
6178
+ * @description get pre ipo company news
6179
+ * @tags PreIPOCompanies
6180
+ * @name GetPreIpoCompanyNews
6181
+ * @summary get pre ipo company news
6182
+ * @request GET:/ipos/pre-ipo-company-news
6421
6183
  * @secure
6422
6184
  */
6423
- getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
6424
- }
6425
- export class TipRank<HandleError extends boolean = boolean> {
6426
- protected readonly apiClient: JwtClient<HandleError>;
6427
- constructor(apiClient: JwtClient<HandleError>);
6185
+ getPreIpoCompanyNews(query: {
6186
+ /** company id */
6187
+ pre_ipo_company_id?: string;
6188
+ /** search by headline */
6189
+ headline?: string;
6190
+ /** how many records to return. Max value is 50 */
6191
+ limit: number;
6192
+ /** how many records to skip */
6193
+ offset: number;
6194
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
6428
6195
  /**
6429
- * @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
6430
- * @tags TipRank
6431
- * @name TiprankAnalystConsensus
6432
- * @summary Get tiprank AnalystConsensus
6433
- * @request POST:/tipranks/analyst-consensus
6196
+ * @description get pre ipo company news by id
6197
+ * @tags PreIPOCompanies
6198
+ * @name GetPreIpoCompanyNewsById
6199
+ * @summary get pre ipo company news by id
6200
+ * @request GET:/ipos/pre-ipo-company-news/{id}
6201
+ * @originalName getPreIpoCompanyNews
6202
+ * @duplicate
6434
6203
  * @secure
6435
6204
  */
6436
- tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
6205
+ getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
6437
6206
  /**
6438
- * @description Returns the latest analyst ratings on a given stock or multiple stocks.
6439
- * @tags TipRank
6440
- * @name TiprankLatestAnalystRatingsOnStock
6441
- * @summary Get tiprank LatestAnalystRatingsOnStock
6442
- * @request POST:/tipranks/analyst-multi
6207
+ * @description get pre ipo company research documents
6208
+ * @tags PreIPOCompanies
6209
+ * @name GetPreIpoCompanyResearchDocuments
6210
+ * @summary get pre ipo company research documents
6211
+ * @request GET:/ipos/pre-ipo-company-research-documents
6443
6212
  * @secure
6444
6213
  */
6445
- tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError>>;
6214
+ getPreIpoCompanyResearchDocuments(query: {
6215
+ /** company id */
6216
+ pre_ipo_company_id?: string;
6217
+ /** search by title */
6218
+ title?: string;
6219
+ /** how many records to return. Max value is 50 */
6220
+ limit: number;
6221
+ /** how many records to skip */
6222
+ offset: number;
6223
+ /** search by research type */
6224
+ research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
6225
+ /** search by relation */
6226
+ relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
6227
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
6446
6228
  /**
6447
- * @description Returns the latest analyst portfolio items.
6448
- * @tags TipRank
6449
- * @name TiprankPortfolios
6450
- * @summary Get the latest analyst portfolio items
6451
- * @request POST:/tipranks/analyst-portfolio
6229
+ * @description get pre ipo company research document by id
6230
+ * @tags PreIPOCompanies
6231
+ * @name GetPreIpoCompanyResearchDocumentsById
6232
+ * @summary get pre ipo company research document by id
6233
+ * @request GET:/ipos/pre-ipo-company-research-documents/{id}
6234
+ * @originalName getPreIpoCompanyResearchDocuments
6235
+ * @duplicate
6452
6236
  * @secure
6453
6237
  */
6454
- tiprankPortfolios(filter: InsightPortfoliosRequest, headers?: {
6455
- /** Authorization */
6456
- Authorization?: string;
6457
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError>>;
6238
+ getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
6458
6239
  /**
6459
- * @description Returns the analyst profile information
6460
- * @tags TipRank
6461
- * @name TiprankAnalystProfile
6462
- * @summary Get tiprank AnalystProfile
6463
- * @request GET:/tipranks/analyst-profile
6240
+ * @description get pre ipo company spvs with investor id
6241
+ * @tags PreIPOCompanies
6242
+ * @name GetInvestor
6243
+ * @summary get pre ipo company spvs with investor id
6244
+ * @request GET:/ipos/pre-ipo-company-spv/investor/{investor_id}
6464
6245
  * @secure
6465
6246
  */
6466
- tiprankAnalystProfile(query: {
6467
- /** ID of tiprank analyst profile */
6468
- id: string;
6469
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystProfileResponse, HandleError>>;
6247
+ getInvestor(investorId: string, query: {
6248
+ /** search by monark stage */
6249
+ monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
6250
+ /** Optional param to filter returned spv's based on the exemptions claimed */
6251
+ exemptions_claimed?: string[];
6252
+ /** Optional param to filter returned spv's based on the name */
6253
+ name_filter?: string;
6254
+ /** investment id */
6255
+ pre_ipo_company_id?: string;
6256
+ /** investment id */
6257
+ pre_ipo_company_investment_id?: string;
6258
+ /** page number */
6259
+ page: number;
6260
+ /** page size */
6261
+ page_size: number;
6262
+ /** sort direction */
6263
+ sort_order?: InsightGetInvestorParamsSortOrderEnum;
6264
+ /** sort field */
6265
+ sort_by?: InsightGetInvestorParamsSortByEnum;
6266
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
6470
6267
  /**
6471
- * @description Returns the URL prefix to the expertPictureUrl field.
6472
- * @tags TipRank
6473
- * @name TiprankAnalystsExpertPictureStore
6474
- * @summary Get tiprank AnalystsExpertPictureStore
6475
- * @request GET:/tipranks/analysts-expert-picture-store
6268
+ * @description get pre ipo company spv by id with investor id
6269
+ * @tags PreIPOCompanies
6270
+ * @name GetInvestorByIdAndInvestorId
6271
+ * @summary get pre ipo company spv by id with investor id
6272
+ * @request GET:/ipos/pre-ipo-company-spv/{id}/investor/{investor_id}
6273
+ * @originalName getInvestor
6274
+ * @duplicate
6476
6275
  * @secure
6477
6276
  */
6478
- tiprankAnalystsExpertPictureStore(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystsExpertPictureStoreResponse, HandleError>>;
6277
+ getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
6278
+ /** default is false, if true documents will be included in the response */
6279
+ include_documents?: boolean;
6280
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
6479
6281
  /**
6480
- * @description Returns a list of top-ranked analysts.
6481
- * @tags TipRank
6482
- * @name TiprankBestPerformingExperts
6483
- * @summary Get tiprank BestPerformingExperts
6484
- * @request GET:/tipranks/best-performing-experts
6282
+ * @description get pre ipo company spvs
6283
+ * @tags PreIPOCompanies
6284
+ * @name GetPreIpoCompanySpvs
6285
+ * @summary get pre ipo company spvs
6286
+ * @request GET:/ipos/pre-ipo-company-spvs
6485
6287
  * @secure
6486
6288
  */
6487
- tiprankBestPerformingExperts(query?: {
6488
- /** The number of analysts to return */
6489
- num?: number;
6490
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBestPerformingExpertsResponse[], HandleError>>;
6289
+ getPreIpoCompanySpvs(query: {
6290
+ /** company id */
6291
+ pre_ipo_company_id?: string;
6292
+ /** investment id */
6293
+ investment_id?: string;
6294
+ /** search by name */
6295
+ name?: string;
6296
+ /** search by company name */
6297
+ company_name?: string;
6298
+ /** how many records to return. Max value is 50 */
6299
+ limit: number;
6300
+ /** how many records to skip */
6301
+ offset: number;
6302
+ /** search by monark stage */
6303
+ monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
6304
+ /** sort direction */
6305
+ direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
6306
+ /** sort field */
6307
+ field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
6308
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
6491
6309
  /**
6492
- * @description Returns the blogger consensus on the stock along with the blogger opinion distribution by site.
6493
- * @tags TipRank
6494
- * @name TiprankBloggerConsensusOnStock
6495
- * @summary Get tiprank BloggerConsensusOnStock
6496
- * @request GET:/tipranks/blogger-consensus-on-stock
6310
+ * @description get pre ipo company spv by id
6311
+ * @tags PreIPOCompanies
6312
+ * @name GetPreIpoCompanySpvsById
6313
+ * @summary get pre ipo company spv by id
6314
+ * @request GET:/ipos/pre-ipo-company-spvs/{id}
6315
+ * @originalName getPreIpoCompanySpvs
6316
+ * @duplicate
6497
6317
  * @secure
6498
6318
  */
6499
- tiprankBloggerConsensusOnStock(query: {
6500
- /** The ticker of the stock */
6501
- ticker: string;
6502
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBloggerConsensusOnStockResponse[], HandleError>>;
6319
+ getPreIpoCompanySpvsById(id: string, query?: {
6320
+ /** default is false, if true documents will be included in the response */
6321
+ include_documents?: boolean;
6322
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
6323
+ }
6324
+ export class Public<HandleError extends boolean = boolean> {
6325
+ protected readonly apiClient: JwtClient<HandleError>;
6326
+ constructor(apiClient: JwtClient<HandleError>);
6503
6327
  /**
6504
- * @description Returns a list of the upcoming IPOs and recent IPOs that have already been priced
6505
- * @tags TipRank
6506
- * @name TiprankCalendarsIpos
6507
- * @summary Get tiprank CalendarsIPOS
6508
- * @request GET:/tipranks/calendars-ipos
6328
+ * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
6329
+ * @tags Public
6330
+ * @name CalculateEstimatedReturns
6331
+ * @summary Calculate Estimated Returns
6332
+ * @request GET:/public/estimated-returns
6509
6333
  * @secure
6510
6334
  */
6511
- tiprankCalendarsIpos(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalendarsIPOSResponse[], HandleError>>;
6335
+ calculateEstimatedReturns(query: {
6336
+ /** Single symbol */
6337
+ symbol: string;
6338
+ /**
6339
+ * Non-zero amount
6340
+ * @format float64
6341
+ */
6342
+ amount: number;
6343
+ /** Start date for calculations */
6344
+ start_date: string;
6345
+ /** End date for calculations */
6346
+ end_date: string;
6347
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
6512
6348
  /**
6513
- * @description Returns all stocks that have been updated since a specified UTC time.
6514
- * @tags TipRank
6515
- * @name TiprankGeneralStockUpdates
6516
- * @summary Get tiprank GeneralStockUpdates
6517
- * @request GET:/tipranks/general-stock-updates
6349
+ * @description Returns an expert forecast
6350
+ * @tags Public
6351
+ * @name ExpertForecast
6352
+ * @summary Expert forecast
6353
+ * @request GET:/public/expert-forecast
6518
6354
  * @secure
6519
6355
  */
6520
- tiprankGeneralStockUpdates(query?: {
6521
- /** The specific requested time */
6522
- utc_time?: string;
6523
- /** Level of detail on updated stocks */
6524
- details?: InsightTiprankGeneralStockUpdatesParamsDetailsEnum;
6525
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGeneralStockUpdatesResponse, HandleError>>;
6356
+ expertForecast(query: {
6357
+ /** Comma separated symbols */
6358
+ symbols: string;
6359
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
6526
6360
  /**
6527
- * @description Returns all hedge funds that have a position on a given stock along with the hedge fund activity trends and consensus.
6528
- * @tags TipRank
6529
- * @name TiprankHedgefunds
6530
- * @summary Get tiprank HedgeFunds
6531
- * @request GET:/tipranks/hedgefunds
6361
+ * @description get fundamentals by symbol data
6362
+ * @tags Public
6363
+ * @name GetPublicFundamentalsBySymbolData
6364
+ * @summary get fundamentals by symbol data
6365
+ * @request GET:/public/fundamentals/{symbol}
6532
6366
  * @secure
6533
6367
  */
6534
- tiprankHedgefunds(query: {
6535
- /** The ticker of the stock */
6536
- ticker: string;
6537
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsResponse[], HandleError>>;
6368
+ getPublicFundamentalsBySymbolData(symbol: string, query: {
6369
+ /** Annual or quarterly */
6370
+ mode: string;
6371
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
6538
6372
  /**
6539
- * @description Returns a list of top-ranked hedge fund managers.
6540
- * @tags TipRank
6541
- * @name TiprankHedgefundsBestPerformingExperts
6542
- * @summary Get tiprank HedgeFundsBestPerformingExperts
6543
- * @request GET:/tipranks/hedgefunds-best-performing-experts
6373
+ * @description Daily price history
6374
+ * @tags Public
6375
+ * @name DailyPriceHistory
6376
+ * @summary Daily price history
6377
+ * @request GET:/public/price-history/daily
6544
6378
  * @secure
6545
6379
  */
6546
- tiprankHedgefundsBestPerformingExperts(query?: {
6547
- /** The number of hedge fund managers to return */
6548
- num?: number;
6549
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsBestPerformingExpertsResponse[], HandleError>>;
6380
+ dailyPriceHistory(query: {
6381
+ /** Single symbol */
6382
+ symbol: string;
6383
+ /** Target date */
6384
+ date: string;
6385
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
6550
6386
  /**
6551
- * @description Returns the biggest 200 hedge fund transactions from the last quarter filtered based on minStars. Returns at most 50 transactions, sorted by size (biggest on top).
6552
- * @tags TipRank
6553
- * @name TiprankHedgefundsRecentTransactions
6554
- * @summary Get tiprank HedgefundsRecentTransactions
6555
- * @request GET:/tipranks/hedgefunds-recent-transactions
6387
+ * @description Public quote profile
6388
+ * @tags Public
6389
+ * @name PublicQuoteProfile
6390
+ * @summary Public quote profile
6391
+ * @request GET:/public/quote-profile/{symbol}
6556
6392
  * @secure
6557
6393
  */
6558
- tiprankHedgefundsRecentTransactions(query?: {
6559
- /** Show only managers with these number of stars or higher */
6560
- min_stars?: number;
6561
- /** The order of the latest insider transactions */
6562
- sort?: InsightTiprankHedgefundsRecentTransactionsParamsSortEnum;
6563
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsRecentTransactionsResponse[], HandleError>>;
6394
+ publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
6564
6395
  /**
6565
- * @description Returns the latest insider transactions and an overall sentiment on a given stock.
6566
- * @tags TipRank
6567
- * @name TiprankInsiders
6568
- * @summary Get tiprank Insiders
6569
- * @request GET:/tipranks/insiders
6396
+ * @description get ratios by symbol data
6397
+ * @tags Public
6398
+ * @name GetPublicRatiosBySymbolData
6399
+ * @summary get ratios by symbol data
6400
+ * @request GET:/public/ratios/{symbol}
6570
6401
  * @secure
6571
6402
  */
6572
- tiprankInsiders(query: {
6573
- /** The ticker of the stock */
6574
- ticker: string;
6575
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersResponse[], HandleError>>;
6403
+ getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
6576
6404
  /**
6577
- * @description Returns a list of top ranked insiders.
6578
- * @tags TipRank
6579
- * @name TiprankInsidersBestPerformingExperts
6580
- * @summary Get tiprank InsidersBestPerformingExperts
6581
- * @request GET:/tipranks/insiders-best-performing-experts
6405
+ * @description find a symbol by name or description
6406
+ * @tags Public
6407
+ * @name QuoteFundamentalsSearch
6408
+ * @summary find a symbol by name or description
6409
+ * @request GET:/public/symbol-search
6582
6410
  * @secure
6583
6411
  */
6584
- tiprankInsidersBestPerformingExperts(query?: {
6585
- /** The number of insiders to return */
6586
- num?: number;
6587
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersBestPerformingExpertsResponse[], HandleError>>;
6412
+ quoteFundamentalsSearch(query: {
6413
+ /** Search query */
6414
+ search_query: string;
6415
+ /** how many records to return. Max value is 50 */
6416
+ limit: number;
6417
+ /** how many records to skip */
6418
+ offset: number;
6419
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
6588
6420
  /**
6589
- * @description Returns all the information required to build TipRanks Insider Hot Stocks.
6590
- * @tags TipRank
6591
- * @name TiprankInsidersHotstocks
6592
- * @summary Get tiprank InsidersHotstocks
6593
- * @request GET:/tipranks/insiders-hotstocks
6421
+ * @description Get top gainers
6422
+ * @tags Public
6423
+ * @name TopGainers
6424
+ * @summary Top Gainers
6425
+ * @request GET:/public/top-gainers
6594
6426
  * @secure
6595
6427
  */
6596
- tiprankInsidersHotstocks(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersHotstocksResponse[], HandleError>>;
6428
+ topGainers(query: {
6429
+ /** sort direction - asc or desc */
6430
+ order_direction?: string;
6431
+ /** how many records to return. Max value is 50 */
6432
+ limit: number;
6433
+ /** how many records to skip */
6434
+ offset: number;
6435
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6597
6436
  /**
6598
- * @description Returns a feed of the latest insider transactions reported to the SEC.
6599
- * @tags TipRank
6600
- * @name TiprankInsidersLiveFeed
6601
- * @summary Get tiprank InsidersLiveFeed
6602
- * @request GET:/tipranks/insiders-live-feed
6437
+ * @description Get top stocks
6438
+ * @tags Public
6439
+ * @name TopStocks
6440
+ * @summary Top Stocks
6441
+ * @request GET:/public/top-stocks
6603
6442
  * @secure
6604
6443
  */
6605
- tiprankInsidersLiveFeed(query?: {
6606
- /** Return the latest X transactions */
6607
- num?: number;
6608
- /** The order of the latest insider transactions */
6609
- sort?: InsightTiprankInsidersLiveFeedParamsSortEnum;
6610
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersLiveFeedResponse[], HandleError>>;
6444
+ topStocks(query: {
6445
+ /** EQUITY|ETF|CRYPTO */
6446
+ stock_type: InsightTopStocksParamsStockTypeEnum;
6447
+ /** how many records to return. Max value is 50 */
6448
+ limit: number;
6449
+ /** how many records to skip */
6450
+ offset: number;
6451
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6452
+ }
6453
+ export class Quotes<HandleError extends boolean = boolean> {
6454
+ protected readonly apiClient: JwtClient<HandleError>;
6455
+ constructor(apiClient: JwtClient<HandleError>);
6611
6456
  /**
6612
- * @description Returns the insider profile information.
6613
- * @tags TipRank
6614
- * @name TiprankInsidersOverview
6615
- * @summary Get tiprank InsidersOverview
6616
- * @request GET:/tipranks/insiders-overview
6457
+ * @description Get single historical quote
6458
+ * @tags Quotes
6459
+ * @name GitHistoricalQuote
6460
+ * @summary Get single historical quote
6461
+ * @request GET:/historical/quote
6617
6462
  * @secure
6618
6463
  */
6619
- tiprankInsidersOverview(query?: {
6620
- /** The UID of the expert */
6621
- expert_uid?: string;
6622
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersOverviewResponse, HandleError>>;
6464
+ gitHistoricalQuote(query: {
6465
+ /** Symbol */
6466
+ symbol: string;
6467
+ /** Date */
6468
+ date: string;
6469
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
6623
6470
  /**
6624
- * @description Returns the sentiment of TipRanks users on the stock.
6625
- * @tags TipRank
6626
- * @name TiprankInvestorSentiment
6627
- * @summary Get tiprank InvestorSentiment
6628
- * @request GET:/tipranks/investor-sentiment
6471
+ * @description get quote history by symbol
6472
+ * @tags Quotes
6473
+ * @name GitQuoteHistory
6474
+ * @summary Get quote history
6475
+ * @request POST:/quote-history
6629
6476
  * @secure
6630
6477
  */
6631
- tiprankInvestorSentiment(query: {
6632
- /** The ticker of the stock */
6633
- ticker: string;
6634
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInvestorSentimentResponse, HandleError>>;
6478
+ gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
6635
6479
  /**
6636
- * @description Returns the latest analyst ratings.
6637
- * @tags TipRank
6638
- * @name TiprankLiveFeed
6639
- * @summary Get tiprank LiveFeed
6640
- * @request POST:/tipranks/live-feed
6480
+ * @description Returns a list of quotes equity info for specified symbols.
6481
+ * @tags Quotes
6482
+ * @name GetQuotesEquityData
6483
+ * @summary Get Quotes Equity data
6484
+ * @request GET:/quotes/equity
6641
6485
  * @secure
6642
6486
  */
6643
- tiprankLiveFeed(filter: InsightLiveFeedRequest, headers?: {
6644
- /** Authorization */
6645
- Authorization?: string;
6646
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLiveFeedResponse[], HandleError>>;
6487
+ getQuotesEquityData(query: {
6488
+ /** Comma separated symbols */
6489
+ symbols: string;
6490
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
6491
+ }
6492
+ export class StockScreener<HandleError extends boolean = boolean> {
6493
+ protected readonly apiClient: JwtClient<HandleError>;
6494
+ constructor(apiClient: JwtClient<HandleError>);
6647
6495
  /**
6648
- * @description Returns the latest news articles on the stock and their sentiment (bullish / neutral or bearish).
6649
- * @tags TipRank
6650
- * @name TiprankNewsArticles
6651
- * @summary Get tiprank NewsArticles
6652
- * @request GET:/tipranks/news-articles
6496
+ * @description data for visual heat map
6497
+ * @tags StockScreener
6498
+ * @name StockMarketHeatmap
6499
+ * @summary data for visual heat map
6500
+ * @request GET:/heatmaps
6653
6501
  * @secure
6654
6502
  */
6655
- tiprankNewsArticles(query: {
6656
- /** The ticker of the stock */
6657
- ticker: string;
6658
- /** Limit to number of articles 1-200 */
6659
- num?: number;
6660
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsArticlesResponse[], HandleError>>;
6503
+ stockMarketHeatmap(query?: {
6504
+ /** Name of symbol list to fetch details for. Empty is default */
6505
+ heatmap_name?: string;
6506
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
6661
6507
  /**
6662
- * @description Returns the overall sentiment, buzz score and word cloud for the stock.
6663
- * @tags TipRank
6664
- * @name TiprankNewsSentiment
6665
- * @summary Get tiprank NewsSentiment
6666
- * @request GET:/tipranks/news-sentiment
6508
+ * @description create or update heat map preset
6509
+ * @tags StockScreener
6510
+ * @name CreateStockMarketHeatmapPreset
6511
+ * @summary create or update heat map preset
6512
+ * @request POST:/heatmaps
6667
6513
  * @secure
6668
6514
  */
6669
- tiprankNewsSentiment(query: {
6670
- /** The ticker of the stock */
6671
- ticker: string;
6672
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsSentimentResponse, HandleError>>;
6515
+ createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6673
6516
  /**
6674
- * @description Returns the list of sectors and for each sector the distribution of stocks by analyst consensus (Strong Buy / Moderate Buy / Neutral / Moderate Sell / Strong Sell).
6675
- * @tags TipRank
6676
- * @name TiprankSectorConsensus
6677
- * @summary Get tiprank SectorConsensus
6678
- * @request GET:/tipranks/sector-consensus
6517
+ * @description Sector and Industry Group performance
6518
+ * @tags StockScreener
6519
+ * @name IndustriesPerformance
6520
+ * @summary get industries performance
6521
+ * @request POST:/industries-performance
6679
6522
  * @secure
6680
6523
  */
6681
- tiprankSectorConsensus(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSectorConsensusResponse, HandleError>>;
6524
+ industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
6682
6525
  /**
6683
- * @description Returns the stock analysis overview: which is derived from 8 unique data sets including Analyst recommendations, Crowd Wisdom, Hedge Fund Activity, Media Sentiment, Blogger Opinions, Insider Transactions, Technical and Fundamental stock factors.
6684
- * @tags TipRank
6685
- * @name TiprankSmartScore
6686
- * @summary Get tiprank SmartScore
6687
- * @request POST:/tipranks/smart-score
6526
+ * @description filter stocks by params
6527
+ * @tags StockScreener
6528
+ * @name StockScreener
6529
+ * @summary filter stocks by params
6530
+ * @request POST:/stock-screener
6688
6531
  * @secure
6689
6532
  */
6690
- tiprankSmartScore(filter: InsightSmartScoreRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError>>;
6533
+ stockScreener(filter: InsightStockScreenerV1Request, headers?: {
6534
+ /** Authorization */
6535
+ Authorization?: string;
6536
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
6691
6537
  /**
6692
- * @description Returns the historical daily and yearly performance of a portfolio that contains all the top smart score stocks (rebalanced daily) and the historical performance of S&P-500 (SPY) for benchmarking purposes.
6693
- * @tags TipRank
6694
- * @name TiprankSmartScorePerformance
6695
- * @summary Get tiprank SmartScorePerformance
6696
- * @request GET:/tipranks/smart-score-performance
6538
+ * @description get screener presets
6539
+ * @tags StockScreener
6540
+ * @name GetScreenerPresets
6541
+ * @summary get screener presets
6542
+ * @request GET:/stock-screener/presets
6697
6543
  * @secure
6698
6544
  */
6699
- tiprankSmartScorePerformance(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScorePerformanceResponse, HandleError>>;
6545
+ getScreenerPresets(query: {
6546
+ /** how many records to return */
6547
+ limit: number;
6548
+ /** how many records to skip */
6549
+ offset: number;
6550
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
6700
6551
  /**
6701
- * @description Returns a list of stocks with the top Smart Score of 10.
6702
- * @tags TipRank
6703
- * @name TiprankSmartScoreTopStocks
6704
- * @summary Get tiprank SmartScoreTopStocks
6705
- * @request POST:/tipranks/smart-score-top-stocks
6552
+ * @description update screener preset
6553
+ * @tags StockScreener
6554
+ * @name UpdateScreenerPreset
6555
+ * @summary update screener preset
6556
+ * @request PUT:/stock-screener/presets
6706
6557
  * @secure
6707
6558
  */
6708
- tiprankSmartScoreTopStocks(filter: InsightSmartScoreTopStocksRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError>>;
6559
+ updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
6709
6560
  /**
6710
- * @description Returns a list of top-ranked analysts.
6711
- * @tags TipRank
6712
- * @name TiprankStocksConsensusOverTime
6713
- * @summary Get tiprank StocksConsensusOverTime
6714
- * @request POST:/tipranks/stocks-consensus-over-time
6561
+ * @description create screener preset
6562
+ * @tags StockScreener
6563
+ * @name CreateOrScreenerPreset
6564
+ * @summary create screener preset
6565
+ * @request POST:/stock-screener/presets
6715
6566
  * @secure
6716
6567
  */
6717
- tiprankStocksConsensusOverTime(filter: InsightStocksConsensusOverTimeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksConsensusOverTimeResponse[], HandleError>>;
6568
+ createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
6718
6569
  /**
6719
- * @description Returns the latest events per a specific stock, these include sell side analyst ratings, blogger opinions and corporate insider transactions
6720
- * @tags TipRank
6721
- * @name TiprankStocksEvents
6722
- * @summary Get tiprank StocksEvents
6723
- * @request POST:/tipranks/stocks-events
6570
+ * @description remove screener preset
6571
+ * @tags StockScreener
6572
+ * @name RemoveScreenerPreset
6573
+ * @summary remove screener preset
6574
+ * @request DELETE:/stock-screener/presets
6724
6575
  * @secure
6725
6576
  */
6726
- tiprankStocksEvents(filter: InsightStocksEventsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksEventsResponse[], HandleError>>;
6577
+ removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6727
6578
  /**
6728
- * @description Returns a list of stocks similar to the given ticker.
6729
- * @tags TipRank
6730
- * @name TiprankStocksSimilarStocks
6731
- * @summary Get tiprank StocksSimilarStocks
6732
- * @request GET:/tipranks/stocks-similar-stocks
6579
+ * @description get top symbols
6580
+ * @tags StockScreener
6581
+ * @name GetTopSymbols
6582
+ * @summary get top symbols
6583
+ * @request POST:/stock-screener/top
6733
6584
  * @secure
6734
6585
  */
6735
- tiprankStocksSimilarStocks(query: {
6736
- /** The ticker of the stock */
6737
- ticker: string;
6738
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6586
+ getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
6587
+ }
6588
+ export class StockScreenerV2<HandleError extends boolean = boolean> {
6589
+ protected readonly apiClient: JwtClient<HandleError>;
6590
+ constructor(apiClient: JwtClient<HandleError>);
6739
6591
  /**
6740
- * @description Returns the stocks with the highest share price increase / decrease and volume. Note that the API call only returns the list of stocks that make it to the top movers list, the real time price action for these stocks should be pulled by the web page to provide the most up to date values.
6741
- * @tags TipRank
6742
- * @name TiprankStocksTopMovers
6743
- * @summary Get tiprank StocksTopMovers
6744
- * @request GET:/tipranks/stocks-top-movers
6592
+ * @description filter stocks by params
6593
+ * @tags StockScreener
6594
+ * @name StockScreener
6595
+ * @summary filter stocks by params
6596
+ * @request POST:/stock-screener
6745
6597
  * @secure
6746
6598
  */
6747
- tiprankStocksTopMovers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksTopMoversResponse[], HandleError>>;
6599
+ stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
6748
6600
  /**
6749
- * @description Returns the stock symbols covered by TipRanks.
6750
- * @tags TipRank
6751
- * @name TiprankSupportedTickers
6752
- * @summary Get tiprank SupportedTickers
6753
- * @request GET:/tipranks/supported-tickers
6601
+ * @description get top symbols
6602
+ * @tags StockScreener
6603
+ * @name GetTopSymbols
6604
+ * @summary get top symbols
6605
+ * @request POST:/stock-screener/top
6754
6606
  * @secure
6755
6607
  */
6756
- tiprankSupportedTickers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSupportedTickersResponse, HandleError>>;
6608
+ getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
6609
+ }
6610
+ export class TipRank<HandleError extends boolean = boolean> {
6611
+ protected readonly apiClient: JwtClient<HandleError>;
6612
+ constructor(apiClient: JwtClient<HandleError>);
6757
6613
  /**
6758
- * @description Returns a list of stocks that have the strongest consensus ratings (Strong Buy or Strong Sell) amongst top-ranked analysts (ranked 3.5 stars or higher).
6614
+ * @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
6759
6615
  * @tags TipRank
6760
- * @name TiprankTopRateStocks
6761
- * @summary Get tiprank TopRateStocks
6762
- * @request GET:/tipranks/top-rate-stocks
6616
+ * @name TiprankAnalystConsensus
6617
+ * @summary Get tiprank AnalystConsensus
6618
+ * @request POST:/tipranks/analyst-consensus
6763
6619
  * @secure
6764
6620
  */
6765
- tiprankTopRateStocks(query?: {
6766
- /** Return the most trending X stocks */
6767
- num?: number;
6768
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopRateStocksResponse, HandleError>>;
6621
+ tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
6769
6622
  /**
6770
- * @description Returns the top-rated stocks by the sector of the given ticker. The API call returns top stocks by analysts, bloggers, insiders, hedge funds, news sentiment and individual investor sentiment.
6623
+ * @description Returns the latest analyst ratings on a given stock or multiple stocks.
6771
6624
  * @tags TipRank
6772
- * @name TiprankTopStocksBySectors
6773
- * @summary Get tiprank TopStocksBySectors
6774
- * @request POST:/tipranks/top-stocks-by-sectors
6625
+ * @name TiprankLatestAnalystRatingsOnStock
6626
+ * @summary Get tiprank LatestAnalystRatingsOnStock
6627
+ * @request POST:/tipranks/analyst-multi
6775
6628
  * @secure
6776
6629
  */
6777
- tiprankTopStocksBySectors(filter: InsightTopStocksBySectorsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksBySectorsResponse, HandleError>>;
6630
+ tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError>>;
6778
6631
  /**
6779
- * @description Returns a list of stocks with the highest number of analyst ratings in the last 7 days.
6632
+ * @description Returns the latest analyst portfolio items.
6780
6633
  * @tags TipRank
6781
- * @name TiprankTrendingStocks
6782
- * @summary Get tiprank TrendingStocks
6783
- * @request POST:/tipranks/trending-stocks
6634
+ * @name TiprankPortfolios
6635
+ * @summary Get the latest analyst portfolio items
6636
+ * @request POST:/tipranks/analyst-portfolio
6784
6637
  * @secure
6785
6638
  */
6786
- tiprankTrendingStocks(filter: InsightTrendingStocksRequest, headers?: {
6639
+ tiprankPortfolios(filter: InsightPortfoliosRequest, headers?: {
6787
6640
  /** Authorization */
6788
6641
  Authorization?: string;
6789
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
6790
- }
6791
- export class UsageTracking<HandleError extends boolean = boolean> {
6792
- protected readonly apiClient: JwtClient<HandleError>;
6793
- constructor(apiClient: JwtClient<HandleError>);
6642
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError>>;
6794
6643
  /**
6795
- * @description get usage date per branch for a period
6796
- * @tags UsageTracking
6797
- * @name GetUsageData
6798
- * @summary get insight usage data
6799
- * @request POST:/tracking/usage
6644
+ * @description Returns the analyst profile information
6645
+ * @tags TipRank
6646
+ * @name TiprankAnalystProfile
6647
+ * @summary Get tiprank AnalystProfile
6648
+ * @request GET:/tipranks/analyst-profile
6800
6649
  * @secure
6801
6650
  */
6802
- getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
6803
- }
6804
- export class Passport<HandleError extends boolean = boolean> {
6805
- protected readonly apiClient: JwtClient<HandleError>;
6806
- constructor(apiClient: JwtClient<HandleError>);
6651
+ tiprankAnalystProfile(query: {
6652
+ /** ID of tiprank analyst profile */
6653
+ id: string;
6654
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystProfileResponse, HandleError>>;
6807
6655
  /**
6808
- * @description Returns article by id
6809
- * @tags Passport
6810
- * @name PassportArticleById
6811
- * @summary Get article by id
6812
- * @request POST:/passport/article-by-id
6656
+ * @description Returns the URL prefix to the expertPictureUrl field.
6657
+ * @tags TipRank
6658
+ * @name TiprankAnalystsExpertPictureStore
6659
+ * @summary Get tiprank AnalystsExpertPictureStore
6660
+ * @request GET:/tipranks/analysts-expert-picture-store
6813
6661
  * @secure
6814
6662
  */
6815
- passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
6663
+ tiprankAnalystsExpertPictureStore(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystsExpertPictureStoreResponse, HandleError>>;
6816
6664
  /**
6817
- * @description Returns articles
6818
- * @tags Passport
6819
- * @name PassportArticles
6820
- * @summary Get articles
6821
- * @request POST:/passport/articles
6665
+ * @description Returns a list of top-ranked analysts.
6666
+ * @tags TipRank
6667
+ * @name TiprankBestPerformingExperts
6668
+ * @summary Get tiprank BestPerformingExperts
6669
+ * @request GET:/tipranks/best-performing-experts
6822
6670
  * @secure
6823
6671
  */
6824
- passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6672
+ tiprankBestPerformingExperts(query?: {
6673
+ /** The number of analysts to return */
6674
+ num?: number;
6675
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBestPerformingExpertsResponse[], HandleError>>;
6825
6676
  /**
6826
- * @description Returns author profile
6827
- * @tags Passport
6828
- * @name PassportAuthorProfile
6829
- * @summary Get author profile
6830
- * @request POST:/passport/author-profile
6677
+ * @description Returns the blogger consensus on the stock along with the blogger opinion distribution by site.
6678
+ * @tags TipRank
6679
+ * @name TiprankBloggerConsensusOnStock
6680
+ * @summary Get tiprank BloggerConsensusOnStock
6681
+ * @request GET:/tipranks/blogger-consensus-on-stock
6831
6682
  * @secure
6832
6683
  */
6833
- passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
6684
+ tiprankBloggerConsensusOnStock(query: {
6685
+ /** The ticker of the stock */
6686
+ ticker: string;
6687
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBloggerConsensusOnStockResponse[], HandleError>>;
6834
6688
  /**
6835
- * @description Returns most popular tags
6836
- * @tags Passport
6837
- * @name PassportMostPopularTags
6838
- * @summary Get most popular tags
6839
- * @request POST:/passport/most-popular-tags
6689
+ * @description Returns a list of the upcoming IPOs and recent IPOs that have already been priced
6690
+ * @tags TipRank
6691
+ * @name TiprankCalendarsIpos
6692
+ * @summary Get tiprank CalendarsIPOS
6693
+ * @request GET:/tipranks/calendars-ipos
6840
6694
  * @secure
6841
6695
  */
6842
- passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
6696
+ tiprankCalendarsIpos(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalendarsIPOSResponse[], HandleError>>;
6843
6697
  /**
6844
- * @description Returns news feed
6845
- * @tags Passport
6846
- * @name PassportNewsFeed
6847
- * @summary Get news feed
6848
- * @request POST:/passport/newsfeed
6698
+ * @description Returns all stocks that have been updated since a specified UTC time.
6699
+ * @tags TipRank
6700
+ * @name TiprankGeneralStockUpdates
6701
+ * @summary Get tiprank GeneralStockUpdates
6702
+ * @request GET:/tipranks/general-stock-updates
6849
6703
  * @secure
6850
6704
  */
6851
- passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
6705
+ tiprankGeneralStockUpdates(query?: {
6706
+ /** The specific requested time */
6707
+ utc_time?: string;
6708
+ /** Level of detail on updated stocks */
6709
+ details?: InsightTiprankGeneralStockUpdatesParamsDetailsEnum;
6710
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGeneralStockUpdatesResponse, HandleError>>;
6852
6711
  /**
6853
- * @description Returns article by parameters
6854
- * @tags Passport
6855
- * @name PassportSearchArticle
6856
- * @summary Search article by parameters
6857
- * @request POST:/passport/search-article
6712
+ * @description Returns all hedge funds that have a position on a given stock along with the hedge fund activity trends and consensus.
6713
+ * @tags TipRank
6714
+ * @name TiprankHedgefunds
6715
+ * @summary Get tiprank HedgeFunds
6716
+ * @request GET:/tipranks/hedgefunds
6858
6717
  * @secure
6859
6718
  */
6860
- passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6861
- }
6862
- export class OptionGreeks<HandleError extends boolean = boolean> {
6863
- protected readonly apiClient: JwtClient<HandleError>;
6864
- constructor(apiClient: JwtClient<HandleError>);
6719
+ tiprankHedgefunds(query: {
6720
+ /** The ticker of the stock */
6721
+ ticker: string;
6722
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsResponse[], HandleError>>;
6865
6723
  /**
6866
- * @description Returns calculated matrix
6867
- * @tags OptionGreeks
6868
- * @name OgCalculateMatrix
6869
- * @summary Calculate matrix
6870
- * @request POST:/og/calculate-matrix
6724
+ * @description Returns a list of top-ranked hedge fund managers.
6725
+ * @tags TipRank
6726
+ * @name TiprankHedgefundsBestPerformingExperts
6727
+ * @summary Get tiprank HedgeFundsBestPerformingExperts
6728
+ * @request GET:/tipranks/hedgefunds-best-performing-experts
6871
6729
  * @secure
6872
6730
  */
6873
- ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
6731
+ tiprankHedgefundsBestPerformingExperts(query?: {
6732
+ /** The number of hedge fund managers to return */
6733
+ num?: number;
6734
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsBestPerformingExpertsResponse[], HandleError>>;
6874
6735
  /**
6875
- * @description Returns calculated params
6876
- * @tags OptionGreeks
6877
- * @name OgCalculateParams
6878
- * @summary Calculate params
6879
- * @request POST:/og/calculate-params
6736
+ * @description Returns the biggest 200 hedge fund transactions from the last quarter filtered based on minStars. Returns at most 50 transactions, sorted by size (biggest on top).
6737
+ * @tags TipRank
6738
+ * @name TiprankHedgefundsRecentTransactions
6739
+ * @summary Get tiprank HedgefundsRecentTransactions
6740
+ * @request GET:/tipranks/hedgefunds-recent-transactions
6880
6741
  * @secure
6881
6742
  */
6882
- ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
6743
+ tiprankHedgefundsRecentTransactions(query?: {
6744
+ /** Show only managers with these number of stars or higher */
6745
+ min_stars?: number;
6746
+ /** The order of the latest insider transactions */
6747
+ sort?: InsightTiprankHedgefundsRecentTransactionsParamsSortEnum;
6748
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsRecentTransactionsResponse[], HandleError>>;
6749
+ /**
6750
+ * @description Returns the latest insider transactions and an overall sentiment on a given stock.
6751
+ * @tags TipRank
6752
+ * @name TiprankInsiders
6753
+ * @summary Get tiprank Insiders
6754
+ * @request GET:/tipranks/insiders
6755
+ * @secure
6756
+ */
6757
+ tiprankInsiders(query: {
6758
+ /** The ticker of the stock */
6759
+ ticker: string;
6760
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersResponse[], HandleError>>;
6761
+ /**
6762
+ * @description Returns a list of top ranked insiders.
6763
+ * @tags TipRank
6764
+ * @name TiprankInsidersBestPerformingExperts
6765
+ * @summary Get tiprank InsidersBestPerformingExperts
6766
+ * @request GET:/tipranks/insiders-best-performing-experts
6767
+ * @secure
6768
+ */
6769
+ tiprankInsidersBestPerformingExperts(query?: {
6770
+ /** The number of insiders to return */
6771
+ num?: number;
6772
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersBestPerformingExpertsResponse[], HandleError>>;
6773
+ /**
6774
+ * @description Returns all the information required to build TipRanks Insider Hot Stocks.
6775
+ * @tags TipRank
6776
+ * @name TiprankInsidersHotstocks
6777
+ * @summary Get tiprank InsidersHotstocks
6778
+ * @request GET:/tipranks/insiders-hotstocks
6779
+ * @secure
6780
+ */
6781
+ tiprankInsidersHotstocks(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersHotstocksResponse[], HandleError>>;
6782
+ /**
6783
+ * @description Returns a feed of the latest insider transactions reported to the SEC.
6784
+ * @tags TipRank
6785
+ * @name TiprankInsidersLiveFeed
6786
+ * @summary Get tiprank InsidersLiveFeed
6787
+ * @request GET:/tipranks/insiders-live-feed
6788
+ * @secure
6789
+ */
6790
+ tiprankInsidersLiveFeed(query?: {
6791
+ /** Return the latest X transactions */
6792
+ num?: number;
6793
+ /** The order of the latest insider transactions */
6794
+ sort?: InsightTiprankInsidersLiveFeedParamsSortEnum;
6795
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersLiveFeedResponse[], HandleError>>;
6796
+ /**
6797
+ * @description Returns the insider profile information.
6798
+ * @tags TipRank
6799
+ * @name TiprankInsidersOverview
6800
+ * @summary Get tiprank InsidersOverview
6801
+ * @request GET:/tipranks/insiders-overview
6802
+ * @secure
6803
+ */
6804
+ tiprankInsidersOverview(query?: {
6805
+ /** The UID of the expert */
6806
+ expert_uid?: string;
6807
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersOverviewResponse, HandleError>>;
6808
+ /**
6809
+ * @description Returns the sentiment of TipRanks users on the stock.
6810
+ * @tags TipRank
6811
+ * @name TiprankInvestorSentiment
6812
+ * @summary Get tiprank InvestorSentiment
6813
+ * @request GET:/tipranks/investor-sentiment
6814
+ * @secure
6815
+ */
6816
+ tiprankInvestorSentiment(query: {
6817
+ /** The ticker of the stock */
6818
+ ticker: string;
6819
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInvestorSentimentResponse, HandleError>>;
6820
+ /**
6821
+ * @description Returns the latest analyst ratings.
6822
+ * @tags TipRank
6823
+ * @name TiprankLiveFeed
6824
+ * @summary Get tiprank LiveFeed
6825
+ * @request POST:/tipranks/live-feed
6826
+ * @secure
6827
+ */
6828
+ tiprankLiveFeed(filter: InsightLiveFeedRequest, headers?: {
6829
+ /** Authorization */
6830
+ Authorization?: string;
6831
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLiveFeedResponse[], HandleError>>;
6832
+ /**
6833
+ * @description Returns the latest news articles on the stock and their sentiment (bullish / neutral or bearish).
6834
+ * @tags TipRank
6835
+ * @name TiprankNewsArticles
6836
+ * @summary Get tiprank NewsArticles
6837
+ * @request GET:/tipranks/news-articles
6838
+ * @secure
6839
+ */
6840
+ tiprankNewsArticles(query: {
6841
+ /** The ticker of the stock */
6842
+ ticker: string;
6843
+ /** Limit to number of articles 1-200 */
6844
+ num?: number;
6845
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsArticlesResponse[], HandleError>>;
6846
+ /**
6847
+ * @description Returns the overall sentiment, buzz score and word cloud for the stock.
6848
+ * @tags TipRank
6849
+ * @name TiprankNewsSentiment
6850
+ * @summary Get tiprank NewsSentiment
6851
+ * @request GET:/tipranks/news-sentiment
6852
+ * @secure
6853
+ */
6854
+ tiprankNewsSentiment(query: {
6855
+ /** The ticker of the stock */
6856
+ ticker: string;
6857
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsSentimentResponse, HandleError>>;
6858
+ /**
6859
+ * @description Returns the list of sectors and for each sector the distribution of stocks by analyst consensus (Strong Buy / Moderate Buy / Neutral / Moderate Sell / Strong Sell).
6860
+ * @tags TipRank
6861
+ * @name TiprankSectorConsensus
6862
+ * @summary Get tiprank SectorConsensus
6863
+ * @request GET:/tipranks/sector-consensus
6864
+ * @secure
6865
+ */
6866
+ tiprankSectorConsensus(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSectorConsensusResponse, HandleError>>;
6867
+ /**
6868
+ * @description Returns the stock analysis overview: which is derived from 8 unique data sets including Analyst recommendations, Crowd Wisdom, Hedge Fund Activity, Media Sentiment, Blogger Opinions, Insider Transactions, Technical and Fundamental stock factors.
6869
+ * @tags TipRank
6870
+ * @name TiprankSmartScore
6871
+ * @summary Get tiprank SmartScore
6872
+ * @request POST:/tipranks/smart-score
6873
+ * @secure
6874
+ */
6875
+ tiprankSmartScore(filter: InsightSmartScoreRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError>>;
6876
+ /**
6877
+ * @description Returns the historical daily and yearly performance of a portfolio that contains all the top smart score stocks (rebalanced daily) and the historical performance of S&P-500 (SPY) for benchmarking purposes.
6878
+ * @tags TipRank
6879
+ * @name TiprankSmartScorePerformance
6880
+ * @summary Get tiprank SmartScorePerformance
6881
+ * @request GET:/tipranks/smart-score-performance
6882
+ * @secure
6883
+ */
6884
+ tiprankSmartScorePerformance(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScorePerformanceResponse, HandleError>>;
6885
+ /**
6886
+ * @description Returns a list of stocks with the top Smart Score of 10.
6887
+ * @tags TipRank
6888
+ * @name TiprankSmartScoreTopStocks
6889
+ * @summary Get tiprank SmartScoreTopStocks
6890
+ * @request POST:/tipranks/smart-score-top-stocks
6891
+ * @secure
6892
+ */
6893
+ tiprankSmartScoreTopStocks(filter: InsightSmartScoreTopStocksRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError>>;
6894
+ /**
6895
+ * @description Returns a list of top-ranked analysts.
6896
+ * @tags TipRank
6897
+ * @name TiprankStocksConsensusOverTime
6898
+ * @summary Get tiprank StocksConsensusOverTime
6899
+ * @request POST:/tipranks/stocks-consensus-over-time
6900
+ * @secure
6901
+ */
6902
+ tiprankStocksConsensusOverTime(filter: InsightStocksConsensusOverTimeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksConsensusOverTimeResponse[], HandleError>>;
6903
+ /**
6904
+ * @description Returns the latest events per a specific stock, these include sell side analyst ratings, blogger opinions and corporate insider transactions
6905
+ * @tags TipRank
6906
+ * @name TiprankStocksEvents
6907
+ * @summary Get tiprank StocksEvents
6908
+ * @request POST:/tipranks/stocks-events
6909
+ * @secure
6910
+ */
6911
+ tiprankStocksEvents(filter: InsightStocksEventsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksEventsResponse[], HandleError>>;
6912
+ /**
6913
+ * @description Returns a list of stocks similar to the given ticker.
6914
+ * @tags TipRank
6915
+ * @name TiprankStocksSimilarStocks
6916
+ * @summary Get tiprank StocksSimilarStocks
6917
+ * @request GET:/tipranks/stocks-similar-stocks
6918
+ * @secure
6919
+ */
6920
+ tiprankStocksSimilarStocks(query: {
6921
+ /** The ticker of the stock */
6922
+ ticker: string;
6923
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6924
+ /**
6925
+ * @description Returns the stocks with the highest share price increase / decrease and volume. Note that the API call only returns the list of stocks that make it to the top movers list, the real time price action for these stocks should be pulled by the web page to provide the most up to date values.
6926
+ * @tags TipRank
6927
+ * @name TiprankStocksTopMovers
6928
+ * @summary Get tiprank StocksTopMovers
6929
+ * @request GET:/tipranks/stocks-top-movers
6930
+ * @secure
6931
+ */
6932
+ tiprankStocksTopMovers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksTopMoversResponse[], HandleError>>;
6933
+ /**
6934
+ * @description Returns the stock symbols covered by TipRanks.
6935
+ * @tags TipRank
6936
+ * @name TiprankSupportedTickers
6937
+ * @summary Get tiprank SupportedTickers
6938
+ * @request GET:/tipranks/supported-tickers
6939
+ * @secure
6940
+ */
6941
+ tiprankSupportedTickers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSupportedTickersResponse, HandleError>>;
6942
+ /**
6943
+ * @description Returns a list of stocks that have the strongest consensus ratings (Strong Buy or Strong Sell) amongst top-ranked analysts (ranked 3.5 stars or higher).
6944
+ * @tags TipRank
6945
+ * @name TiprankTopRateStocks
6946
+ * @summary Get tiprank TopRateStocks
6947
+ * @request GET:/tipranks/top-rate-stocks
6948
+ * @secure
6949
+ */
6950
+ tiprankTopRateStocks(query?: {
6951
+ /** Return the most trending X stocks */
6952
+ num?: number;
6953
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopRateStocksResponse, HandleError>>;
6954
+ /**
6955
+ * @description Returns the top-rated stocks by the sector of the given ticker. The API call returns top stocks by analysts, bloggers, insiders, hedge funds, news sentiment and individual investor sentiment.
6956
+ * @tags TipRank
6957
+ * @name TiprankTopStocksBySectors
6958
+ * @summary Get tiprank TopStocksBySectors
6959
+ * @request POST:/tipranks/top-stocks-by-sectors
6960
+ * @secure
6961
+ */
6962
+ tiprankTopStocksBySectors(filter: InsightTopStocksBySectorsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksBySectorsResponse, HandleError>>;
6963
+ /**
6964
+ * @description Returns a list of stocks with the highest number of analyst ratings in the last 7 days.
6965
+ * @tags TipRank
6966
+ * @name TiprankTrendingStocks
6967
+ * @summary Get tiprank TrendingStocks
6968
+ * @request POST:/tipranks/trending-stocks
6969
+ * @secure
6970
+ */
6971
+ tiprankTrendingStocks(filter: InsightTrendingStocksRequest, headers?: {
6972
+ /** Authorization */
6973
+ Authorization?: string;
6974
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
6883
6975
  }
6884
- export class Ownerships<HandleError extends boolean = boolean> {
6976
+ export class UsageTracking<HandleError extends boolean = boolean> {
6885
6977
  protected readonly apiClient: JwtClient<HandleError>;
6886
6978
  constructor(apiClient: JwtClient<HandleError>);
6887
6979
  /**
6888
- * @description get ownerships by id datadata
6889
- * @tags Ownerships
6890
- * @name GetOwnershipsByIdData
6891
- * @summary get ownerships by id data
6892
- * @request POST:/ownerships
6980
+ * @description get usage date per branch for a period
6981
+ * @tags UsageTracking
6982
+ * @name GetUsageData
6983
+ * @summary get insight usage data
6984
+ * @request POST:/tracking/usage
6893
6985
  * @secure
6894
6986
  */
6895
- getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6987
+ getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
6988
+ }
6989
+ export class WorldMarkets<HandleError extends boolean = boolean> {
6990
+ protected readonly apiClient: JwtClient<HandleError>;
6991
+ constructor(apiClient: JwtClient<HandleError>);
6896
6992
  /**
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
6993
+ * @description Get continents
6994
+ * @tags World Markets
6995
+ * @name ContinentGet
6996
+ * @summary Get continents
6997
+ * @request GET:/continents
6902
6998
  * @secure
6903
6999
  */
6904
- getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6905
- }
6906
- export interface InsightBeforeAndAfterV2 {
6907
- after?: string;
6908
- before?: string;
6909
- }
6910
- export interface InsightFixedIncomeV2 {
6911
- a144: boolean;
6912
- accrued_interest: number;
6913
- bank_qualified: boolean;
6914
- bond_warrant: boolean;
6915
- call_type: string;
6916
- callable: boolean;
6917
- close_price: number;
6918
- close_price_asof: string;
6919
- close_ytw: number;
6920
- convertible: boolean;
6921
- country: string;
6922
- country_code: string;
6923
- country_domicile: string;
6924
- country_issue: string;
6925
- coupon: number;
6926
- coupon_frequency: string;
6927
- coupon_type: string;
6928
- currency: string;
6929
- cusip: string;
6930
- dated_date: string;
6931
- daycount: string;
6932
- description: string;
6933
- description_short: string;
6934
- duration: number;
6935
- first_coupon_date: string;
6936
- insured: boolean;
6937
- isin: string;
6938
- issue_date: string;
6939
- issue_minimum_denomination: number;
6940
- issue_price: number;
6941
- issue_size: number;
6942
- issuer: string;
6943
- last_coupon_date: string;
6944
- liquidity_institutional_aggregate: number;
6945
- liquidity_institutional_buy: number;
6946
- liquidity_institutional_sell: number;
6947
- liquidity_micro_aggregate: number;
6948
- liquidity_micro_buy: number;
6949
- liquidity_micro_sell: number;
6950
- liquidity_retail_aggregate: number;
6951
- liquidity_retail_buy: number;
6952
- liquidity_retail_sell: number;
6953
- maturity_date: string;
6954
- municipal_state: string;
6955
- municipal_taxable_federal: boolean;
6956
- municipal_type: string;
6957
- next_call_date: string;
6958
- next_call_price: number;
6959
- next_coupon_date: string;
6960
- par_value: number;
6961
- perpetual: boolean;
6962
- private_placement: boolean;
6963
- purpose: string;
6964
- puttable: boolean;
6965
- reg_s: boolean;
6966
- sector: string;
6967
- seniority: string;
6968
- settlement_convention: string;
6969
- sinking_fund: boolean;
6970
- sp_creditwatch: string;
6971
- sp_creditwatch_date: string;
6972
- sp_outlook: string;
6973
- sp_outlook_date: string;
6974
- sp_rating: string;
6975
- sp_rating_date: string;
6976
- status: string;
6977
- ticker: string;
6978
- treasury_subtype: string;
6979
- type: string;
6980
- updated_at: string;
6981
- }
6982
- export interface InsightGetFixedIncomeEntriesResponseV2 {
6983
- count: number;
6984
- data: InsightFixedIncomeV2[];
6985
- }
6986
- export interface InsightGetFixedIncomeEntriesRequestV2 {
6987
- /** @example true */
6988
- bank_qualified?: boolean;
6989
- /** @example true */
6990
- callable?: boolean;
6991
- /** @example true */
6992
- convertible?: boolean;
6993
- /** @example ["USA"] */
6994
- country_codes?: string[];
6995
- coupon?: InsightLessAndMoreV2;
6996
- /** @example ["quarterly","zero"] */
6997
- coupon_frequencies?: string[];
6998
- /** @example ["655664AH3","9128286R6"] */
6999
- cusip?: string[];
7000
+ continentGet(query: {
7001
+ /** Query limit */
7002
+ limit: number;
7003
+ /** Query offset */
7004
+ offset: number;
7005
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
7006
+ /**
7007
+ * @description Edit continent
7008
+ * @tags World Markets
7009
+ * @name ContinentEdit
7010
+ * @summary Edit continent
7011
+ * @request PUT:/continents
7012
+ * @secure
7013
+ */
7014
+ continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7015
+ /**
7016
+ * @description Create continents
7017
+ * @tags World Markets
7018
+ * @name ContinentCreate
7019
+ * @summary Create continents
7020
+ * @request POST:/continents
7021
+ * @secure
7022
+ */
7023
+ continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
7024
+ /**
7025
+ * @description Delete continent
7026
+ * @tags World Markets
7027
+ * @name ContinentDelete
7028
+ * @summary Delete continent
7029
+ * @request DELETE:/continents
7030
+ * @secure
7031
+ */
7032
+ continentDelete(query: {
7033
+ /** continent id */
7034
+ id: string;
7035
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7036
+ /**
7037
+ * @description Get country codes
7038
+ * @tags World Markets
7039
+ * @name CountryCodeGet
7040
+ * @summary Get country codes
7041
+ * @request GET:/country-codes
7042
+ * @secure
7043
+ */
7044
+ countryCodeGet(query: {
7045
+ /** Query limit */
7046
+ limit: number;
7047
+ /** Query offset */
7048
+ offset: number;
7049
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
7000
7050
  /**
7001
- * @maxLength 100
7002
- * @example "Donald's"
7051
+ * @description Edit country code
7052
+ * @tags World Markets
7053
+ * @name CountryCodeEdit
7054
+ * @summary Edit country code
7055
+ * @request PUT:/country-codes
7056
+ * @secure
7003
7057
  */
7004
- description?: string;
7005
- /** @example true */
7006
- has_ticker?: boolean;
7007
- /** @example true */
7008
- insured?: boolean;
7009
- /** @example ["US655664AH33","US9128286R69"] */
7010
- isin?: string[];
7011
- issue_date?: InsightBeforeAndAfterV2;
7058
+ countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7012
7059
  /**
7013
- * @maxLength 100
7014
- * @example "Donald's"
7060
+ * @description Add country codes
7061
+ * @tags World Markets
7062
+ * @name CountryCodeAdd
7063
+ * @summary Add country codes
7064
+ * @request POST:/country-codes
7065
+ * @secure
7015
7066
  */
7016
- issuer?: string;
7017
- maturity?: InsightBeforeAndAfterV2;
7018
- /** @example ["NY"] */
7019
- municipal_states?: string[];
7020
- /** @example true */
7021
- municipal_tax?: boolean;
7022
- /** @example ["general_obligation"] */
7023
- municipal_types?: string[];
7024
- pagination: InsightPaginationV2;
7025
- purposes?: string[];
7026
- /** @example ["SOVEREIGN"] */
7027
- sectors?: string[];
7028
- sorts?: InsightOrderingV2[];
7029
- /** @example ["AAA"] */
7030
- sp_ratings?: string[];
7031
- /** @example ["called","outstanding"] */
7032
- statuses?: string[];
7033
- tickers?: string[];
7034
- /** @example ["corporate"] */
7035
- types?: string[];
7036
- }
7037
- export interface InsightGetTopSymbolsRequestV2 {
7038
- exchange?: string[];
7039
- market_cap?: InsightLessAndMoreV2;
7040
- pagination?: InsightPaginationV2;
7041
- price?: InsightLessAndMoreV2;
7042
- sorts?: InsightOrderingV2[];
7043
- volume?: InsightLessAndMoreV2;
7044
- }
7045
- export interface InsightIncludeExcludeV2 {
7046
- exclude?: string[];
7047
- include?: string[];
7048
- }
7049
- export interface InsightLessAndMoreV2 {
7050
- less_than?: number;
7051
- more_than?: number;
7052
- }
7053
- export enum InsightOrderDirectionV2 {
7054
- OrderASC = "asc",
7055
- OrderDESC = "desc"
7056
- }
7057
- export interface InsightOrderingV2 {
7067
+ countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
7058
7068
  /**
7059
- * @default "asc"
7060
- * @example "asc"
7069
+ * @description Delete country code
7070
+ * @tags World Markets
7071
+ * @name CountryCodeDelete
7072
+ * @summary Delete country code
7073
+ * @request DELETE:/country-codes
7074
+ * @secure
7061
7075
  */
7062
- direction: InsightOrderingDirectionEnumV2;
7076
+ countryCodeDelete(query: {
7077
+ /** a3 code */
7078
+ a3code: string;
7079
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7063
7080
  /**
7064
- * Sort direction:
7065
- * * asc - Ascending, from A to Z.
7066
- * * desc - Descending, from Z to A.
7067
- * @example "name"
7081
+ * @description Get global indexes
7082
+ * @tags World Markets
7083
+ * @name GlobalIndexGet
7084
+ * @summary Get global indexes
7085
+ * @request GET:/global-indexes
7086
+ * @secure
7068
7087
  */
7069
- field: string;
7070
- }
7071
- export interface InsightPaginationV2 {
7088
+ globalIndexGet(query: {
7089
+ /** Query limit */
7090
+ limit: number;
7091
+ /** Query offset */
7092
+ offset: number;
7093
+ /** Continent code for filtering */
7094
+ continent?: string;
7095
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
7072
7096
  /**
7073
- * @min 1
7074
- * @example 1
7097
+ * @description Edit global index
7098
+ * @tags World Markets
7099
+ * @name GlobalIndexEdit
7100
+ * @summary Edit global index
7101
+ * @request PUT:/global-indexes
7102
+ * @secure
7075
7103
  */
7076
- page: number;
7104
+ globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7077
7105
  /**
7078
- * @min 1
7079
- * @max 50
7080
- * @example 10
7106
+ * @description Add global indexes
7107
+ * @tags World Markets
7108
+ * @name GlobalIndexAdd
7109
+ * @summary Add global indexes
7110
+ * @request POST:/global-indexes
7111
+ * @secure
7081
7112
  */
7082
- size: number;
7083
- }
7084
- export interface InsightStockScreenerQuoteV2 {
7085
- average_volume_30d: number;
7086
- company_name: string;
7087
- dividend_ex_date: string;
7088
- dividend_pay_date: string;
7089
- dividend_percent: number;
7090
- exchange: string;
7091
- exchange_name: string;
7092
- gap: number;
7093
- industry: string;
7094
- industry_code: string;
7095
- last_price: number;
7096
- market_cap: number;
7097
- pe_ratio: number;
7098
- price_change: number;
7099
- price_change_percent: number;
7100
- symbol: string;
7101
- volume: number;
7102
- }
7103
- export interface InsightStockScreenerRequestV2 {
7104
- average_volume_30d?: InsightLessAndMoreV2;
7105
- dividend_ex_date?: InsightBeforeAndAfterV2;
7106
- dividend_pay_date?: InsightBeforeAndAfterV2;
7107
- dividend_percent?: InsightLessAndMoreV2;
7108
- exchange?: InsightIncludeExcludeV2;
7109
- gap?: InsightLessAndMoreV2;
7110
- industry?: InsightIncludeExcludeV2;
7111
- market_cap?: InsightLessAndMoreV2;
7112
- pagination: InsightPaginationV2;
7113
- pe_ratio?: InsightLessAndMoreV2;
7114
- price?: InsightLessAndMoreV2;
7115
- sorts?: InsightOrderingV2[];
7116
- /** @example "ADR" */
7117
- stock_type?: string;
7118
- volume?: InsightLessAndMoreV2;
7119
- }
7120
- export interface InsightStockScreenerResponseV2 {
7121
- current_page: number;
7122
- data: InsightStockScreenerQuoteV2[];
7123
- page_count: number;
7124
- status: number;
7125
- total_records: number;
7126
- }
7127
- /**
7128
- * @default "asc"
7129
- * @example "asc"
7130
- */
7131
- export enum InsightOrderingDirectionEnumV2 {
7132
- Asc = "asc",
7133
- Desc = "desc"
7134
- }
7135
- export class FixedIncomeV2<HandleError extends boolean = boolean> {
7136
- protected readonly apiClient: JwtClient<HandleError>;
7137
- constructor(apiClient: JwtClient<HandleError>);
7113
+ globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
7138
7114
  /**
7139
- * @description get fixed income entries
7140
- * @tags FixedIncome
7141
- * @name GetFixedIncomeEntries
7142
- * @summary get fixed income entries
7143
- * @request POST:/fixed-income
7115
+ * @description Edit global index
7116
+ * @tags World Markets
7117
+ * @name GlobalIndexDelete
7118
+ * @summary Delete global index
7119
+ * @request DELETE:/global-indexes
7144
7120
  * @secure
7145
7121
  */
7146
- getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
7147
- }
7148
- export class StockScreenerV2<HandleError extends boolean = boolean> {
7149
- protected readonly apiClient: JwtClient<HandleError>;
7150
- constructor(apiClient: JwtClient<HandleError>);
7122
+ globalIndexDelete(query: {
7123
+ /** a3 code */
7124
+ a3code: string;
7125
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7151
7126
  /**
7152
- * @description filter stocks by params
7153
- * @tags StockScreener
7154
- * @name StockScreener
7155
- * @summary filter stocks by params
7156
- * @request POST:/stock-screener
7127
+ * @description Get regions
7128
+ * @tags World Markets
7129
+ * @name RegionGet
7130
+ * @summary Get regions
7131
+ * @request GET:/regions
7157
7132
  * @secure
7158
7133
  */
7159
- stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
7134
+ regionGet(query: {
7135
+ /** Query limit */
7136
+ limit: number;
7137
+ /** Query offset */
7138
+ offset: number;
7139
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
7160
7140
  /**
7161
- * @description get top symbols
7162
- * @tags StockScreener
7163
- * @name GetTopSymbols
7164
- * @summary get top symbols
7165
- * @request POST:/stock-screener/top
7141
+ * @description Edit region
7142
+ * @tags World Markets
7143
+ * @name RegionEdit
7144
+ * @summary Edit region
7145
+ * @request PUT:/regions
7166
7146
  * @secure
7167
7147
  */
7168
- getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
7148
+ regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7149
+ /**
7150
+ * @description Create regions
7151
+ * @tags World Markets
7152
+ * @name RegionCreate
7153
+ * @summary Create regions
7154
+ * @request POST:/regions
7155
+ * @secure
7156
+ */
7157
+ regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
7158
+ /**
7159
+ * @description Delete region
7160
+ * @tags World Markets
7161
+ * @name RegionDelete
7162
+ * @summary Delete region
7163
+ * @request DELETE:/regions
7164
+ * @secure
7165
+ */
7166
+ regionDelete(query: {
7167
+ /** region id */
7168
+ id: string;
7169
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7169
7170
  }
7170
7171
  export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
7171
7172
  readonly config: JwtClientConfig<HandleError>;