@orbis-systems/orbis-api-clients 0.7.18 → 0.7.19

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.
@@ -757,7 +757,8 @@ export interface InsightEarningReleasesRequest {
757
757
  exchanges?: string[];
758
758
  /** @example true */
759
759
  load_quotes?: boolean;
760
- paging: InsightPaging;
760
+ /** Paging is required if LoadQuotes is true */
761
+ paging?: InsightPaging;
761
762
  /** @example ["AAPL","GOOGL"] */
762
763
  symbols?: string[];
763
764
  }
@@ -3828,6 +3829,11 @@ export interface InsightRemoveMarketDateRequest {
3828
3829
  market_code: string;
3829
3830
  /** @example "2023-01-01" */
3830
3831
  open_date: string;
3832
+ /**
3833
+ * Optional: if provided, only the entry with this open_time will be removed
3834
+ * @example "09:30"
3835
+ */
3836
+ open_time?: string;
3831
3837
  }
3832
3838
  export interface InsightRemoveRewrittenFieldValueRequest {
3833
3839
  /** @example "Removed" */
@@ -4762,28 +4768,6 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
4762
4768
  Date = "date",
4763
4769
  Rank = "rank"
4764
4770
  }
4765
- export class AlphaTools<HandleError extends boolean = boolean> {
4766
- protected readonly apiClient: JwtClient<HandleError>;
4767
- constructor(apiClient: JwtClient<HandleError>);
4768
- /**
4769
- * @description get seasonlity data with comparison to benchmark
4770
- * @tags AlphaTools
4771
- * @name GetMomentumRatioGraph
4772
- * @summary get seasonlity data
4773
- * @request POST:/rst
4774
- * @secure
4775
- */
4776
- getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
4777
- /**
4778
- * @description get seasonlity data with comparison to benchmark
4779
- * @tags AlphaTools
4780
- * @name GetSeasonality
4781
- * @summary get seasonlity data
4782
- * @request POST:/seasonality
4783
- * @secure
4784
- */
4785
- getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
4786
- }
4787
4771
  export class CompanyProfile<HandleError extends boolean = boolean> {
4788
4772
  protected readonly apiClient: JwtClient<HandleError>;
4789
4773
  constructor(apiClient: JwtClient<HandleError>);
@@ -4823,6 +4807,188 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
4823
4807
  */
4824
4808
  getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
4825
4809
  }
4810
+ export class WorldMarkets<HandleError extends boolean = boolean> {
4811
+ protected readonly apiClient: JwtClient<HandleError>;
4812
+ constructor(apiClient: JwtClient<HandleError>);
4813
+ /**
4814
+ * @description Get continents
4815
+ * @tags World Markets
4816
+ * @name ContinentGet
4817
+ * @summary Get continents
4818
+ * @request GET:/continents
4819
+ * @secure
4820
+ */
4821
+ continentGet(query: {
4822
+ /** Query limit */
4823
+ limit: number;
4824
+ /** Query offset */
4825
+ offset: number;
4826
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
4827
+ /**
4828
+ * @description Edit continent
4829
+ * @tags World Markets
4830
+ * @name ContinentEdit
4831
+ * @summary Edit continent
4832
+ * @request PUT:/continents
4833
+ * @secure
4834
+ */
4835
+ continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4836
+ /**
4837
+ * @description Create continents
4838
+ * @tags World Markets
4839
+ * @name ContinentCreate
4840
+ * @summary Create continents
4841
+ * @request POST:/continents
4842
+ * @secure
4843
+ */
4844
+ continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
4845
+ /**
4846
+ * @description Delete continent
4847
+ * @tags World Markets
4848
+ * @name ContinentDelete
4849
+ * @summary Delete continent
4850
+ * @request DELETE:/continents
4851
+ * @secure
4852
+ */
4853
+ continentDelete(query: {
4854
+ /** continent id */
4855
+ id: string;
4856
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4857
+ /**
4858
+ * @description Get country codes
4859
+ * @tags World Markets
4860
+ * @name CountryCodeGet
4861
+ * @summary Get country codes
4862
+ * @request GET:/country-codes
4863
+ * @secure
4864
+ */
4865
+ countryCodeGet(query: {
4866
+ /** Query limit */
4867
+ limit: number;
4868
+ /** Query offset */
4869
+ offset: number;
4870
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
4871
+ /**
4872
+ * @description Edit country code
4873
+ * @tags World Markets
4874
+ * @name CountryCodeEdit
4875
+ * @summary Edit country code
4876
+ * @request PUT:/country-codes
4877
+ * @secure
4878
+ */
4879
+ countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4880
+ /**
4881
+ * @description Add country codes
4882
+ * @tags World Markets
4883
+ * @name CountryCodeAdd
4884
+ * @summary Add country codes
4885
+ * @request POST:/country-codes
4886
+ * @secure
4887
+ */
4888
+ countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
4889
+ /**
4890
+ * @description Delete country code
4891
+ * @tags World Markets
4892
+ * @name CountryCodeDelete
4893
+ * @summary Delete country code
4894
+ * @request DELETE:/country-codes
4895
+ * @secure
4896
+ */
4897
+ countryCodeDelete(query: {
4898
+ /** a3 code */
4899
+ a3code: string;
4900
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4901
+ /**
4902
+ * @description Get global indexes
4903
+ * @tags World Markets
4904
+ * @name GlobalIndexGet
4905
+ * @summary Get global indexes
4906
+ * @request GET:/global-indexes
4907
+ * @secure
4908
+ */
4909
+ globalIndexGet(query: {
4910
+ /** Query limit */
4911
+ limit: number;
4912
+ /** Query offset */
4913
+ offset: number;
4914
+ /** Continent code for filtering */
4915
+ continent?: string;
4916
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
4917
+ /**
4918
+ * @description Edit global index
4919
+ * @tags World Markets
4920
+ * @name GlobalIndexEdit
4921
+ * @summary Edit global index
4922
+ * @request PUT:/global-indexes
4923
+ * @secure
4924
+ */
4925
+ globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4926
+ /**
4927
+ * @description Add global indexes
4928
+ * @tags World Markets
4929
+ * @name GlobalIndexAdd
4930
+ * @summary Add global indexes
4931
+ * @request POST:/global-indexes
4932
+ * @secure
4933
+ */
4934
+ globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
4935
+ /**
4936
+ * @description Edit global index
4937
+ * @tags World Markets
4938
+ * @name GlobalIndexDelete
4939
+ * @summary Delete global index
4940
+ * @request DELETE:/global-indexes
4941
+ * @secure
4942
+ */
4943
+ globalIndexDelete(query: {
4944
+ /** a3 code */
4945
+ a3code: string;
4946
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4947
+ /**
4948
+ * @description Get regions
4949
+ * @tags World Markets
4950
+ * @name RegionGet
4951
+ * @summary Get regions
4952
+ * @request GET:/regions
4953
+ * @secure
4954
+ */
4955
+ regionGet(query: {
4956
+ /** Query limit */
4957
+ limit: number;
4958
+ /** Query offset */
4959
+ offset: number;
4960
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
4961
+ /**
4962
+ * @description Edit region
4963
+ * @tags World Markets
4964
+ * @name RegionEdit
4965
+ * @summary Edit region
4966
+ * @request PUT:/regions
4967
+ * @secure
4968
+ */
4969
+ regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4970
+ /**
4971
+ * @description Create regions
4972
+ * @tags World Markets
4973
+ * @name RegionCreate
4974
+ * @summary Create regions
4975
+ * @request POST:/regions
4976
+ * @secure
4977
+ */
4978
+ regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
4979
+ /**
4980
+ * @description Delete region
4981
+ * @tags World Markets
4982
+ * @name RegionDelete
4983
+ * @summary Delete region
4984
+ * @request DELETE:/regions
4985
+ * @secure
4986
+ */
4987
+ regionDelete(query: {
4988
+ /** region id */
4989
+ id: string;
4990
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4991
+ }
4826
4992
  export class CustomLists<HandleError extends boolean = boolean> {
4827
4993
  protected readonly apiClient: JwtClient<HandleError>;
4828
4994
  constructor(apiClient: JwtClient<HandleError>);
@@ -4994,6 +5160,26 @@ export class Earnings<HandleError extends boolean = boolean> {
4994
5160
  * @secure
4995
5161
  */
4996
5162
  getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
5163
+ /**
5164
+ * @description get earnings releases count per day
5165
+ * @tags Earnings
5166
+ * @name GetEarningsReleasesCountPerDay
5167
+ * @summary get earnings releases count per day
5168
+ * @request GET:/earnings-releases
5169
+ * @secure
5170
+ */
5171
+ getEarningsReleasesCountPerDay(query?: {
5172
+ /**
5173
+ * Start date in format YYYY-MM-DD
5174
+ * @example ""2024-01-01""
5175
+ */
5176
+ start_date?: string;
5177
+ /**
5178
+ * End date in format YYYY-MM-DD
5179
+ * @example ""2024-01-31""
5180
+ */
5181
+ end_date?: string;
5182
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, number>, HandleError>>;
4997
5183
  }
4998
5184
  export class FixedIncome<HandleError extends boolean = boolean> {
4999
5185
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5067,260 +5253,18 @@ export class FixedIncome<HandleError extends boolean = boolean> {
5067
5253
  */
5068
5254
  getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
5069
5255
  }
5070
- export interface InsightBeforeAndAfterV2 {
5071
- after?: string;
5072
- before?: string;
5073
- }
5074
- export interface InsightFixedIncomeV2 {
5075
- a144: boolean;
5076
- accrued_interest: number;
5077
- bank_qualified: boolean;
5078
- bond_warrant: boolean;
5079
- call_type: string;
5080
- callable: boolean;
5081
- close_price: number;
5082
- close_price_asof: string;
5083
- close_ytw: number;
5084
- convertible: boolean;
5085
- country: string;
5086
- country_code: string;
5087
- country_domicile: string;
5088
- country_issue: string;
5089
- coupon: number;
5090
- coupon_frequency: string;
5091
- coupon_type: string;
5092
- currency: string;
5093
- cusip: string;
5094
- dated_date: string;
5095
- daycount: string;
5096
- description: string;
5097
- description_short: string;
5098
- duration: number;
5099
- first_coupon_date: string;
5100
- insured: boolean;
5101
- isin: string;
5102
- issue_date: string;
5103
- issue_minimum_denomination: number;
5104
- issue_price: number;
5105
- issue_size: number;
5106
- issuer: string;
5107
- last_coupon_date: string;
5108
- liquidity_institutional_aggregate: number;
5109
- liquidity_institutional_buy: number;
5110
- liquidity_institutional_sell: number;
5111
- liquidity_micro_aggregate: number;
5112
- liquidity_micro_buy: number;
5113
- liquidity_micro_sell: number;
5114
- liquidity_retail_aggregate: number;
5115
- liquidity_retail_buy: number;
5116
- liquidity_retail_sell: number;
5117
- maturity_date: string;
5118
- municipal_state: string;
5119
- municipal_taxable_federal: boolean;
5120
- municipal_type: string;
5121
- next_call_date: string;
5122
- next_call_price: number;
5123
- next_coupon_date: string;
5124
- par_value: number;
5125
- perpetual: boolean;
5126
- private_placement: boolean;
5127
- purpose: string;
5128
- puttable: boolean;
5129
- reg_s: boolean;
5130
- sector: string;
5131
- seniority: string;
5132
- settlement_convention: string;
5133
- sinking_fund: boolean;
5134
- sp_creditwatch: string;
5135
- sp_creditwatch_date: string;
5136
- sp_outlook: string;
5137
- sp_outlook_date: string;
5138
- sp_rating: string;
5139
- sp_rating_date: string;
5140
- status: string;
5141
- ticker: string;
5142
- treasury_subtype: string;
5143
- type: string;
5144
- updated_at: string;
5145
- }
5146
- export interface InsightGetFixedIncomeEntriesResponseV2 {
5147
- count: number;
5148
- data: InsightFixedIncomeV2[];
5149
- }
5150
- export interface InsightGetFixedIncomeEntriesRequestV2 {
5151
- /** @example true */
5152
- bank_qualified?: boolean;
5153
- /** @example true */
5154
- callable?: boolean;
5155
- /** @example true */
5156
- convertible?: boolean;
5157
- /** @example ["USA"] */
5158
- country_codes?: string[];
5159
- coupon?: InsightLessAndMoreV2;
5160
- /** @example ["quarterly","zero"] */
5161
- coupon_frequencies?: string[];
5162
- /** @example ["655664AH3","9128286R6"] */
5163
- cusip?: string[];
5164
- /**
5165
- * @maxLength 100
5166
- * @example "Donald's"
5167
- */
5168
- description?: string;
5169
- /** @example true */
5170
- has_ticker?: boolean;
5171
- /** @example true */
5172
- insured?: boolean;
5173
- /** @example ["US655664AH33","US9128286R69"] */
5174
- isin?: string[];
5175
- issue_date?: InsightBeforeAndAfterV2;
5176
- /**
5177
- * @maxLength 100
5178
- * @example "Donald's"
5179
- */
5180
- issuer?: string;
5181
- maturity?: InsightBeforeAndAfterV2;
5182
- /** @example ["NY"] */
5183
- municipal_states?: string[];
5184
- /** @example true */
5185
- municipal_tax?: boolean;
5186
- /** @example ["general_obligation"] */
5187
- municipal_types?: string[];
5188
- pagination: InsightPaginationV2;
5189
- purposes?: string[];
5190
- /** @example ["SOVEREIGN"] */
5191
- sectors?: string[];
5192
- sorts?: InsightOrderingV2[];
5193
- /** @example ["AAA"] */
5194
- sp_ratings?: string[];
5195
- /** @example ["called","outstanding"] */
5196
- statuses?: string[];
5197
- tickers?: string[];
5198
- /** @example ["corporate"] */
5199
- types?: string[];
5200
- }
5201
- export interface InsightGetTopSymbolsRequestV2 {
5202
- exchange?: string[];
5203
- market_cap?: InsightLessAndMoreV2;
5204
- pagination?: InsightPaginationV2;
5205
- price?: InsightLessAndMoreV2;
5206
- sorts?: InsightOrderingV2[];
5207
- volume?: InsightLessAndMoreV2;
5208
- }
5209
- export interface InsightIncludeExcludeV2 {
5210
- exclude?: string[];
5211
- include?: string[];
5212
- }
5213
- export interface InsightLessAndMoreV2 {
5214
- less_than?: number;
5215
- more_than?: number;
5216
- }
5217
- export enum InsightOrderDirectionV2 {
5218
- OrderASC = "asc",
5219
- OrderDESC = "desc"
5220
- }
5221
- export interface InsightOrderingV2 {
5222
- /**
5223
- * @default "asc"
5224
- * @example "asc"
5225
- */
5226
- direction: InsightOrderingDirectionEnumV2;
5227
- /**
5228
- * Sort direction:
5229
- * * asc - Ascending, from A to Z.
5230
- * * desc - Descending, from Z to A.
5231
- * @example "name"
5232
- */
5233
- field: string;
5234
- }
5235
- export interface InsightPaginationV2 {
5236
- /**
5237
- * @min 1
5238
- * @example 1
5239
- */
5240
- page: number;
5241
- /**
5242
- * @min 1
5243
- * @max 50
5244
- * @example 10
5245
- */
5246
- size: number;
5247
- }
5248
- export interface InsightStockScreenerQuoteV2 {
5249
- average_volume_30d: number;
5250
- company_name: string;
5251
- dividend_ex_date: string;
5252
- dividend_pay_date: string;
5253
- dividend_percent: number;
5254
- exchange: string;
5255
- exchange_name: string;
5256
- gap: number;
5257
- industry: string;
5258
- industry_code: string;
5259
- last_price: number;
5260
- market_cap: number;
5261
- pe_ratio: number;
5262
- price_change: number;
5263
- price_change_percent: number;
5264
- symbol: string;
5265
- volume: number;
5266
- }
5267
- export interface InsightStockScreenerRequestV2 {
5268
- average_volume_30d?: InsightLessAndMoreV2;
5269
- dividend_ex_date?: InsightBeforeAndAfterV2;
5270
- dividend_pay_date?: InsightBeforeAndAfterV2;
5271
- dividend_percent?: InsightLessAndMoreV2;
5272
- exchange?: InsightIncludeExcludeV2;
5273
- gap?: InsightLessAndMoreV2;
5274
- industry?: InsightIncludeExcludeV2;
5275
- market_cap?: InsightLessAndMoreV2;
5276
- pagination: InsightPaginationV2;
5277
- pe_ratio?: InsightLessAndMoreV2;
5278
- price?: InsightLessAndMoreV2;
5279
- sorts?: InsightOrderingV2[];
5280
- /** @example "ADR" */
5281
- stock_type?: string;
5282
- volume?: InsightLessAndMoreV2;
5283
- }
5284
- export interface InsightStockScreenerResponseV2 {
5285
- current_page: number;
5286
- data: InsightStockScreenerQuoteV2[];
5287
- page_count: number;
5288
- status: number;
5289
- total_records: number;
5290
- }
5291
- /**
5292
- * @default "asc"
5293
- * @example "asc"
5294
- */
5295
- export enum InsightOrderingDirectionEnumV2 {
5296
- Asc = "asc",
5297
- Desc = "desc"
5298
- }
5299
- export class FixedIncomeV2<HandleError extends boolean = boolean> {
5300
- protected readonly apiClient: JwtClient<HandleError>;
5301
- constructor(apiClient: JwtClient<HandleError>);
5302
- /**
5303
- * @description get fixed income entries
5304
- * @tags FixedIncome
5305
- * @name GetFixedIncomeEntries
5306
- * @summary get fixed income entries
5307
- * @request POST:/fixed-income
5308
- * @secure
5309
- */
5310
- getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
5311
- }
5312
- export class Fundamentals<HandleError extends boolean = boolean> {
5313
- protected readonly apiClient: JwtClient<HandleError>;
5314
- constructor(apiClient: JwtClient<HandleError>);
5315
- /**
5316
- * @description get fundamentals by symbol data
5317
- * @tags Fundamentals
5318
- * @name GetFundamentalsBySymbolData
5319
- * @summary get fundamentals by symbol data
5320
- * @request POST:/fundamentals
5321
- * @secure
5322
- */
5323
- getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
5256
+ export class Fundamentals<HandleError extends boolean = boolean> {
5257
+ protected readonly apiClient: JwtClient<HandleError>;
5258
+ constructor(apiClient: JwtClient<HandleError>);
5259
+ /**
5260
+ * @description get fundamentals by symbol data
5261
+ * @tags Fundamentals
5262
+ * @name GetFundamentalsBySymbolData
5263
+ * @summary get fundamentals by symbol data
5264
+ * @request POST:/fundamentals
5265
+ * @secure
5266
+ */
5267
+ getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
5324
5268
  }
5325
5269
  export class Funds<HandleError extends boolean = boolean> {
5326
5270
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5436,866 +5380,1001 @@ export class Funds<HandleError extends boolean = boolean> {
5436
5380
  Authorization?: string;
5437
5381
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
5438
5382
  }
5439
- export class Intraday<HandleError extends boolean = boolean> {
5383
+ export class StockScreener<HandleError extends boolean = boolean> {
5440
5384
  protected readonly apiClient: JwtClient<HandleError>;
5441
5385
  constructor(apiClient: JwtClient<HandleError>);
5442
5386
  /**
5443
- * @description Returns an array of intraday chart data values for the given ticker.
5444
- * @tags Intraday
5445
- * @name IntradayQuotes
5446
- * @summary Get an array of intraday chart data values for the given ticker
5447
- * @request POST:/intraday/quotes
5387
+ * @description data for visual heat map
5388
+ * @tags StockScreener
5389
+ * @name StockMarketHeatmap
5390
+ * @summary data for visual heat map
5391
+ * @request GET:/heatmaps
5448
5392
  * @secure
5449
5393
  */
5450
- intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
5451
- }
5452
- export class Ipos<HandleError extends boolean = boolean> {
5453
- protected readonly apiClient: JwtClient<HandleError>;
5454
- constructor(apiClient: JwtClient<HandleError>);
5394
+ stockMarketHeatmap(query?: {
5395
+ /** Name of symbol list to fetch details for. Empty is default */
5396
+ heatmap_name?: string;
5397
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
5455
5398
  /**
5456
- * @description get recent ipos info
5457
- * @tags Ipos
5458
- * @name PostRecent
5459
- * @summary get recent ipos info
5460
- * @request POST:/ipos/recent
5461
- * @secure
5462
- */
5463
- postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5464
- /**
5465
- * @description get upcoming ipos info
5466
- * @tags Ipos
5467
- * @name GetUpcoming
5468
- * @summary get upcoming ipos info
5469
- * @request GET:/ipos/upcoming
5399
+ * @description create or update heat map preset
5400
+ * @tags StockScreener
5401
+ * @name CreateStockMarketHeatmapPreset
5402
+ * @summary create or update heat map preset
5403
+ * @request POST:/heatmaps
5470
5404
  * @secure
5471
5405
  */
5472
- getUpcoming(query: {
5473
- /** how many records to return. Max value is 50 */
5474
- limit: number;
5475
- /** how many records to skip */
5476
- offset: number;
5477
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5406
+ createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5478
5407
  /**
5479
- * @description get ipo info by symbol
5480
- * @tags Ipos
5481
- * @name GetIpos
5482
- * @summary get ipo info by symbol
5483
- * @request GET:/ipos/{symbol}
5408
+ * @description Sector and Industry Group performance
5409
+ * @tags StockScreener
5410
+ * @name IndustriesPerformance
5411
+ * @summary get industries performance
5412
+ * @request POST:/industries-performance
5484
5413
  * @secure
5485
5414
  */
5486
- getIpos(symbol: string, query?: {
5487
- /** load quotes */
5488
- load_quotes?: boolean;
5489
- /** statuses */
5490
- statuses?: string[];
5491
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
5492
- }
5493
- export class Logos<HandleError extends boolean = boolean> {
5494
- protected readonly apiClient: JwtClient<HandleError>;
5495
- constructor(apiClient: JwtClient<HandleError>);
5415
+ industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
5496
5416
  /**
5497
- * @description Returns converted logo for crypto symbol
5498
- * @tags Logos
5499
- * @name LogosConvertedCryptoSymbolLogo
5500
- * @summary Get converted logo for crypto symbol
5501
- * @request POST:/logos/converted-crypto-symbol-logo
5417
+ * @description filter stocks by params
5418
+ * @tags StockScreener
5419
+ * @name StockScreener
5420
+ * @summary filter stocks by params
5421
+ * @request POST:/stock-screener
5502
5422
  * @secure
5503
5423
  */
5504
- logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5424
+ stockScreener(filter: InsightStockScreenerV1Request, headers?: {
5425
+ /** Authorization */
5426
+ Authorization?: string;
5427
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5505
5428
  /**
5506
- * @description Returns converted logo for symbol
5507
- * @tags Logos
5508
- * @name LogosConvertedSymbolLogo
5509
- * @summary Get converted logo for symbol
5510
- * @request POST:/logos/converted-symbol-logo
5429
+ * @description get screener presets
5430
+ * @tags StockScreener
5431
+ * @name GetScreenerPresets
5432
+ * @summary get screener presets
5433
+ * @request GET:/stock-screener/presets
5511
5434
  * @secure
5512
5435
  */
5513
- logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5436
+ getScreenerPresets(query: {
5437
+ /** how many records to return */
5438
+ limit: number;
5439
+ /** how many records to skip */
5440
+ offset: number;
5441
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
5514
5442
  /**
5515
- * @description Returns logo for crypto symbol
5516
- * @tags Logos
5517
- * @name LogosCryptoSymbolLogo
5518
- * @summary Get logo for crypto symbol
5519
- * @request GET:/logos/crypto-symbol-logo
5443
+ * @description update screener preset
5444
+ * @tags StockScreener
5445
+ * @name UpdateScreenerPreset
5446
+ * @summary update screener preset
5447
+ * @request PUT:/stock-screener/presets
5520
5448
  * @secure
5521
5449
  */
5522
- logosCryptoSymbolLogo(query: {
5523
- /** Company symbol */
5524
- symbol: string;
5525
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
5450
+ updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5526
5451
  /**
5527
- * @description Returns direct logo for crypto symbol
5528
- * @tags Logos
5529
- * @name LogosDirectCryptoSymbolLogo
5530
- * @summary Get direct logo for crypto symbol
5531
- * @request GET:/logos/direct-crypto-symbol-logo
5452
+ * @description create screener preset
5453
+ * @tags StockScreener
5454
+ * @name CreateOrScreenerPreset
5455
+ * @summary create screener preset
5456
+ * @request POST:/stock-screener/presets
5532
5457
  * @secure
5533
5458
  */
5534
- logosDirectCryptoSymbolLogo(query: {
5535
- /** Company symbol */
5536
- symbol: string;
5537
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5459
+ createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5538
5460
  /**
5539
- * @description Returns direct logo for symbol
5540
- * @tags Logos
5541
- * @name LogosDirectSymbolLogo
5542
- * @summary Get direct logo for symbol
5543
- * @request GET:/logos/direct-symbol-logo
5461
+ * @description remove screener preset
5462
+ * @tags StockScreener
5463
+ * @name RemoveScreenerPreset
5464
+ * @summary remove screener preset
5465
+ * @request DELETE:/stock-screener/presets
5544
5466
  * @secure
5545
5467
  */
5546
- logosDirectSymbolLogo(query: {
5547
- /** Company symbol */
5548
- symbol: string;
5549
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5468
+ removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5550
5469
  /**
5551
- * @description Returns logos for multiple symbols
5552
- * @tags Logos
5553
- * @name LogosMultipleCryptoSymbolLogo
5554
- * @summary Get logos for multiple symbols
5555
- * @request POST:/logos/multiple-crypto-symbol-logo
5470
+ * @description get top symbols
5471
+ * @tags StockScreener
5472
+ * @name GetTopSymbols
5473
+ * @summary get top symbols
5474
+ * @request POST:/stock-screener/top
5556
5475
  * @secure
5557
5476
  */
5558
- logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
5477
+ getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5478
+ }
5479
+ export class Quotes<HandleError extends boolean = boolean> {
5480
+ protected readonly apiClient: JwtClient<HandleError>;
5481
+ constructor(apiClient: JwtClient<HandleError>);
5559
5482
  /**
5560
- * @description Returns logos for multiple symbol
5561
- * @tags Logos
5562
- * @name LogosMultipleSymbolLogos
5563
- * @summary Get logos for multiple symbols
5564
- * @request POST:/logos/multiple-symbol-logos
5483
+ * @description Get single historical quote
5484
+ * @tags Quotes
5485
+ * @name GitHistoricalQuote
5486
+ * @summary Get single historical quote
5487
+ * @request GET:/historical/quote
5565
5488
  * @secure
5566
5489
  */
5567
- logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
5490
+ gitHistoricalQuote(query: {
5491
+ /** Symbol */
5492
+ symbol: string;
5493
+ /** Date */
5494
+ date: string;
5495
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
5568
5496
  /**
5569
- * @description Returns links of socials logos for symbol
5570
- * @tags Logos
5571
- * @name LogosSocialSymbolLogos
5572
- * @summary Get social logos for symbol
5573
- * @request GET:/logos/social-symbol-logos
5497
+ * @description get quote history by symbol
5498
+ * @tags Quotes
5499
+ * @name GitQuoteHistory
5500
+ * @summary Get quote history
5501
+ * @request POST:/quote-history
5574
5502
  * @secure
5575
5503
  */
5576
- logosSocialSymbolLogos(query: {
5577
- /** Company symbol */
5578
- symbol: string;
5579
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
5504
+ gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
5580
5505
  /**
5581
- * @description Returns logos for company symbol
5582
- * @tags Logos
5583
- * @name LogosSymbolLogos
5584
- * @summary Get symbol logos
5585
- * @request GET:/logos/symbol-logos
5506
+ * @description Returns a list of quotes equity info for specified symbols.
5507
+ * @tags Quotes
5508
+ * @name GetQuotesEquityData
5509
+ * @summary Get Quotes Equity data
5510
+ * @request GET:/quotes/equity
5586
5511
  * @secure
5587
5512
  */
5588
- logosSymbolLogos(query: {
5589
- /** Company symbol */
5590
- symbol: string;
5591
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
5513
+ getQuotesEquityData(query: {
5514
+ /** Comma separated symbols */
5515
+ symbols: string;
5516
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
5592
5517
  }
5593
- export class MarketDates<HandleError extends boolean = boolean> {
5518
+ export class Intraday<HandleError extends boolean = boolean> {
5594
5519
  protected readonly apiClient: JwtClient<HandleError>;
5595
5520
  constructor(apiClient: JwtClient<HandleError>);
5596
5521
  /**
5597
- * @description Create or update market date
5598
- * @tags MarketDates
5599
- * @name CreateOrUpdateMarketDate
5600
- * @summary Create or update market date
5601
- * @request POST:/market-dates
5522
+ * @description Returns an array of intraday chart data values for the given ticker.
5523
+ * @tags Intraday
5524
+ * @name IntradayQuotes
5525
+ * @summary Get an array of intraday chart data values for the given ticker
5526
+ * @request POST:/intraday/quotes
5602
5527
  * @secure
5603
5528
  */
5604
- createOrUpdateMarketDate(market: InsightMarketDates[], config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate[], HandleError>>;
5529
+ intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
5530
+ }
5531
+ export class PreIpoCompanies<HandleError extends boolean = boolean> {
5532
+ protected readonly apiClient: JwtClient<HandleError>;
5533
+ constructor(apiClient: JwtClient<HandleError>);
5605
5534
  /**
5606
- * @description Remove market date
5607
- * @tags MarketDates
5608
- * @name RemoveMarketDate
5609
- * @summary Remove market date
5610
- * @request DELETE:/market-dates
5535
+ * @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
5536
+ * @tags PreIPOCompanies
5537
+ * @name MonarkOghlcDataForSymbol
5538
+ * @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
5539
+ * @request GET:/ipos/market-data/ohlc/{symbol}
5611
5540
  * @secure
5612
5541
  */
5613
- removeMarketDate(market: InsightRemoveMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5542
+ monarkOghlcDataForSymbol(symbol: string, query?: {
5543
+ /** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
5544
+ from?: string;
5545
+ /** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
5546
+ to?: string;
5547
+ /** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
5548
+ interval?: string;
5549
+ /** Limit the number of OHLC data points returned. Default is 100. */
5550
+ limit?: number;
5551
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
5552
+ close?: number;
5553
+ high?: number;
5554
+ low?: number;
5555
+ open?: number;
5556
+ time?: string;
5557
+ volume?: number;
5558
+ }[], HandleError>>;
5614
5559
  /**
5615
- * @description Get market dates history
5616
- * @tags MarketDates
5617
- * @name GetMarketDatesHistory
5618
- * @summary Get market dates history
5619
- * @request POST:/market-dates/history
5560
+ * @description Retrieves all symbols available in the market data
5561
+ * @tags PreIPOCompanies
5562
+ * @name MonarkAllAvailableSymbols
5563
+ * @summary Retrieves all symbols available in the market data
5564
+ * @request GET:/ipos/market-data/symbols
5620
5565
  * @secure
5621
5566
  */
5622
- getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
5567
+ monarkAllAvailableSymbols(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5623
5568
  /**
5624
- * @description Search locode data by search string and field
5625
- * @tags MarketDates
5626
- * @name SearchLocodeData
5627
- * @summary Search locode data
5628
- * @request GET:/market-dates/locode
5569
+ * @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
5570
+ * @tags PreIPOCompanies
5571
+ * @name GetPreIpoCompanies
5572
+ * @summary get pre ipo companies
5573
+ * @request GET:/ipos/pre-ipo-companies
5629
5574
  * @secure
5630
5575
  */
5631
- searchLocodeData(query?: {
5632
- /** Search string */
5633
- search?: string;
5634
- /** Search field */
5635
- field?: InsightSearchLocodeDataParamsFieldEnum;
5636
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchLocodeDataResponse, HandleError>>;
5576
+ getPreIpoCompanies(query: {
5577
+ /** search by company name */
5578
+ name?: string;
5579
+ /** search by categories */
5580
+ categories?: string;
5581
+ /** search by listing type */
5582
+ listing_type?: string;
5583
+ /** filter by active status */
5584
+ is_active?: InsightGetPreIpoCompaniesParamsIsActiveEnum;
5585
+ /** filter by minimum last valuation */
5586
+ min_last_valuation?: number;
5587
+ /** filter by maximum last valuation */
5588
+ max_last_valuation?: number;
5589
+ /** filter by minimum total funding */
5590
+ min_total_funding?: number;
5591
+ /** filter by maximum total funding */
5592
+ max_total_funding?: number;
5593
+ /** how many records to return. Max value is 50 */
5594
+ limit: number;
5595
+ /** how many records to skip */
5596
+ offset: number;
5597
+ /** sort field */
5598
+ order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
5599
+ /** sort direction */
5600
+ order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
5601
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
5637
5602
  /**
5638
- * @description Get markets
5639
- * @tags MarketDates
5640
- * @name GetMarkets
5641
- * @summary Get markets
5642
- * @request GET:/market-dates/markets
5603
+ * @description get pre ipo company by id
5604
+ * @tags PreIPOCompanies
5605
+ * @name GetPreIpoCompaniesById
5606
+ * @summary get pre ipo company by id
5607
+ * @request GET:/ipos/pre-ipo-companies/{id}
5608
+ * @originalName getPreIpoCompanies
5609
+ * @duplicate
5643
5610
  * @secure
5644
5611
  */
5645
- getMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketsResponse, HandleError>>;
5612
+ getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
5646
5613
  /**
5647
- * @description Create or update market
5648
- * @tags MarketDates
5649
- * @name CreateOrUpdateMarket
5650
- * @summary Create or update market
5651
- * @request POST:/market-dates/markets
5614
+ * @description get pre ipo company funding rounds
5615
+ * @tags PreIPOCompanies
5616
+ * @name GetPreIpoCompanyFundingRounds
5617
+ * @summary get pre ipo company funding rounds
5618
+ * @request GET:/ipos/pre-ipo-company-funding-rounds
5652
5619
  * @secure
5653
5620
  */
5654
- createOrUpdateMarket(market: InsightCreateOrUpdateMarketRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
5621
+ getPreIpoCompanyFundingRounds(query: {
5622
+ /** company id */
5623
+ pre_ipo_company_id?: string;
5624
+ /** search by round name */
5625
+ round_name?: string;
5626
+ /** how many records to return. Max value is 50 */
5627
+ limit: number;
5628
+ /** how many records to skip */
5629
+ offset: number;
5630
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
5655
5631
  /**
5656
- * @description Get market
5657
- * @tags MarketDates
5658
- * @name GetMarket
5659
- * @summary Get market
5660
- * @request GET:/market-dates/markets/{market}
5632
+ * @description get pre ipo company funding round by id
5633
+ * @tags PreIPOCompanies
5634
+ * @name GetPreIpoCompanyFundingRoundsById
5635
+ * @summary get pre ipo company funding round by id
5636
+ * @request GET:/ipos/pre-ipo-company-funding-rounds/{id}
5637
+ * @originalName getPreIpoCompanyFundingRounds
5638
+ * @duplicate
5661
5639
  * @secure
5662
5640
  */
5663
- getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
5641
+ getPreIpoCompanyFundingRoundsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyFundingRound, HandleError>>;
5664
5642
  /**
5665
- * @description Remove market
5666
- * @tags MarketDates
5667
- * @name RemoveMarket
5668
- * @summary Remove market
5669
- * @request DELETE:/market-dates/markets/{market}
5643
+ * @description get pre ipo company investments
5644
+ * @tags PreIPOCompanies
5645
+ * @name GetPreIpoCompanyInvestments
5646
+ * @summary get pre ipo company investments
5647
+ * @request GET:/ipos/pre-ipo-company-investments
5670
5648
  * @secure
5671
5649
  */
5672
- removeMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5650
+ getPreIpoCompanyInvestments(query: {
5651
+ /** company id */
5652
+ pre_ipo_company_id?: string;
5653
+ /** company name */
5654
+ company_name?: string;
5655
+ /** how many records to return. Max value is 50 */
5656
+ limit: number;
5657
+ /** how many records to skip */
5658
+ offset: number;
5659
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
5673
5660
  /**
5674
- * @description CreateOrUpdateMarketSchedule market schedule
5675
- * @tags MarketDates
5676
- * @name CreateOrUpdateMarketSchedule
5677
- * @summary CreateOrUpdateMarketSchedule market schedule
5678
- * @request POST:/market-dates/schedule
5661
+ * @description get pre ipo company investment by id
5662
+ * @tags PreIPOCompanies
5663
+ * @name GetPreIpoCompanyInvestmentsById
5664
+ * @summary get pre ipo company investment by id
5665
+ * @request GET:/ipos/pre-ipo-company-investments/{id}
5666
+ * @originalName getPreIpoCompanyInvestments
5667
+ * @duplicate
5679
5668
  * @secure
5680
5669
  */
5681
- createOrUpdateMarketSchedule(market: InsightCreateOrUpdateMarketScheduleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
5670
+ getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
5682
5671
  /**
5683
- * @description Get market schedule
5684
- * @tags MarketDates
5685
- * @name GetMarketSchedule
5686
- * @summary Get market schedule
5687
- * @request GET:/market-dates/schedule/{market}
5672
+ * @description get pre ipo company news
5673
+ * @tags PreIPOCompanies
5674
+ * @name GetPreIpoCompanyNews
5675
+ * @summary get pre ipo company news
5676
+ * @request GET:/ipos/pre-ipo-company-news
5688
5677
  * @secure
5689
5678
  */
5690
- getMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
5679
+ getPreIpoCompanyNews(query: {
5680
+ /** company id */
5681
+ pre_ipo_company_id?: string;
5682
+ /** search by headline */
5683
+ headline?: string;
5684
+ /** how many records to return. Max value is 50 */
5685
+ limit: number;
5686
+ /** how many records to skip */
5687
+ offset: number;
5688
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
5691
5689
  /**
5692
- * @description Remove market schedule
5693
- * @tags MarketDates
5694
- * @name RemoveMarketSchedule
5695
- * @summary Remove market schedule
5696
- * @request DELETE:/market-dates/schedule/{market}
5690
+ * @description get pre ipo company news by id
5691
+ * @tags PreIPOCompanies
5692
+ * @name GetPreIpoCompanyNewsById
5693
+ * @summary get pre ipo company news by id
5694
+ * @request GET:/ipos/pre-ipo-company-news/{id}
5695
+ * @originalName getPreIpoCompanyNews
5696
+ * @duplicate
5697
5697
  * @secure
5698
5698
  */
5699
- removeMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5699
+ getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
5700
5700
  /**
5701
- * @description Get market schedules
5702
- * @tags MarketDates
5703
- * @name GetMarketSchedules
5704
- * @summary Get market schedules
5705
- * @request GET:/market-dates/schedules
5701
+ * @description get pre ipo company research documents
5702
+ * @tags PreIPOCompanies
5703
+ * @name GetPreIpoCompanyResearchDocuments
5704
+ * @summary get pre ipo company research documents
5705
+ * @request GET:/ipos/pre-ipo-company-research-documents
5706
5706
  * @secure
5707
5707
  */
5708
- getMarketSchedules(query?: {
5709
- /** Market codes, comma separated */
5710
- market?: string;
5711
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError>>;
5708
+ getPreIpoCompanyResearchDocuments(query: {
5709
+ /** company id */
5710
+ pre_ipo_company_id?: string;
5711
+ /** search by title */
5712
+ title?: string;
5713
+ /** how many records to return. Max value is 50 */
5714
+ limit: number;
5715
+ /** how many records to skip */
5716
+ offset: number;
5717
+ /** search by research type */
5718
+ research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
5719
+ /** search by relation */
5720
+ relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
5721
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
5712
5722
  /**
5713
- * @description Get todays market hours
5714
- * @tags MarketDates
5715
- * @name GetTodaysMarketHours
5716
- * @summary Get todays market hours
5717
- * @request GET:/market-dates/today
5723
+ * @description get pre ipo company research document by id
5724
+ * @tags PreIPOCompanies
5725
+ * @name GetPreIpoCompanyResearchDocumentsById
5726
+ * @summary get pre ipo company research document by id
5727
+ * @request GET:/ipos/pre-ipo-company-research-documents/{id}
5728
+ * @originalName getPreIpoCompanyResearchDocuments
5729
+ * @duplicate
5718
5730
  * @secure
5719
5731
  */
5720
- getTodaysMarketHours(query: {
5721
- /** Market */
5722
- market: string;
5723
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
5724
- }
5725
- export class News<HandleError extends boolean = boolean> {
5726
- protected readonly apiClient: JwtClient<HandleError>;
5727
- constructor(apiClient: JwtClient<HandleError>);
5732
+ getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
5728
5733
  /**
5729
- * @description Returns available authors in DB
5730
- * @tags News
5731
- * @name NewsAvailableAuthors
5732
- * @summary Get available authors in DB (for filters)
5733
- * @request POST:/news/authors
5734
+ * @description get pre ipo company spvs with investor id
5735
+ * @tags PreIPOCompanies
5736
+ * @name GetInvestor
5737
+ * @summary get pre ipo company spvs with investor id
5738
+ * @request GET:/ipos/pre-ipo-company-spv/investor/{investor_id}
5734
5739
  * @secure
5735
5740
  */
5736
- newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5741
+ getInvestor(investorId: string, query: {
5742
+ /** search by monark stage */
5743
+ monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
5744
+ /** Optional param to filter returned spv's based on the exemptions claimed */
5745
+ exemptions_claimed?: string[];
5746
+ /** Optional param to filter returned spv's based on the name */
5747
+ name_filter?: string;
5748
+ /** investment id */
5749
+ pre_ipo_company_id?: string;
5750
+ /** investment id */
5751
+ pre_ipo_company_investment_id?: string;
5752
+ /** page number */
5753
+ page: number;
5754
+ /** page size */
5755
+ page_size: number;
5756
+ /** sort direction */
5757
+ sort_order?: InsightGetInvestorParamsSortOrderEnum;
5758
+ /** sort field */
5759
+ sort_by?: InsightGetInvestorParamsSortByEnum;
5760
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
5737
5761
  /**
5738
- * @description Returns available channels in DB
5739
- * @tags News
5740
- * @name NewsAvailableChannels
5741
- * @summary Get available channels in DB (for filters)
5742
- * @request POST:/news/channels
5762
+ * @description get pre ipo company spv by id with investor id
5763
+ * @tags PreIPOCompanies
5764
+ * @name GetInvestorByIdAndInvestorId
5765
+ * @summary get pre ipo company spv by id with investor id
5766
+ * @request GET:/ipos/pre-ipo-company-spv/{id}/investor/{investor_id}
5767
+ * @originalName getInvestor
5768
+ * @duplicate
5743
5769
  * @secure
5744
5770
  */
5745
- newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5771
+ getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
5772
+ /** default is false, if true documents will be included in the response */
5773
+ include_documents?: boolean;
5774
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
5746
5775
  /**
5747
- * @description Get featured articles
5748
- * @tags News
5749
- * @name GetFeaturedArticles
5750
- * @summary Get featured articles
5751
- * @request GET:/news/featured-articles
5776
+ * @description get pre ipo company spvs
5777
+ * @tags PreIPOCompanies
5778
+ * @name GetPreIpoCompanySpvs
5779
+ * @summary get pre ipo company spvs
5780
+ * @request GET:/ipos/pre-ipo-company-spvs
5752
5781
  * @secure
5753
5782
  */
5754
- getFeaturedArticles(query: {
5755
- /** Limit */
5756
- limit: number;
5757
- /** Offset */
5758
- offset: number;
5759
- /** Start date */
5760
- start_date?: string;
5761
- /** End date */
5762
- end_date?: string;
5763
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
5764
- /**
5765
- * @description Update featured articles
5766
- * @tags News
5767
- * @name UpdateFeaturedArticles
5768
- * @summary Update featured articles
5769
- * @request PUT:/news/featured-articles
5770
- * @secure
5771
- */
5772
- updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5783
+ getPreIpoCompanySpvs(query: {
5784
+ /** company id */
5785
+ pre_ipo_company_id?: string;
5786
+ /** investment id */
5787
+ investment_id?: string;
5788
+ /** search by name */
5789
+ name?: string;
5790
+ /** search by company name */
5791
+ company_name?: string;
5792
+ /** how many records to return. Max value is 50 */
5793
+ limit: number;
5794
+ /** how many records to skip */
5795
+ offset: number;
5796
+ /** search by monark stage */
5797
+ monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
5798
+ /** sort direction */
5799
+ direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
5800
+ /** sort field */
5801
+ field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
5802
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
5773
5803
  /**
5774
- * @description Create featured articles
5775
- * @tags News
5776
- * @name CreateFeaturedArticles
5777
- * @summary Create featured articles
5778
- * @request POST:/news/featured-articles
5804
+ * @description get pre ipo company spv by id
5805
+ * @tags PreIPOCompanies
5806
+ * @name GetPreIpoCompanySpvsById
5807
+ * @summary get pre ipo company spv by id
5808
+ * @request GET:/ipos/pre-ipo-company-spvs/{id}
5809
+ * @originalName getPreIpoCompanySpvs
5810
+ * @duplicate
5779
5811
  * @secure
5780
5812
  */
5781
- createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5813
+ getPreIpoCompanySpvsById(id: string, query?: {
5814
+ /** default is false, if true documents will be included in the response */
5815
+ include_documents?: boolean;
5816
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
5817
+ }
5818
+ export class Ipos<HandleError extends boolean = boolean> {
5819
+ protected readonly apiClient: JwtClient<HandleError>;
5820
+ constructor(apiClient: JwtClient<HandleError>);
5782
5821
  /**
5783
- * @description Get active featured articles
5784
- * @tags News
5785
- * @name GetActiveFeaturedArticles
5786
- * @summary Get active featured articles
5787
- * @request GET:/news/featured-articles/active
5822
+ * @description get recent ipos info
5823
+ * @tags Ipos
5824
+ * @name PostRecent
5825
+ * @summary get recent ipos info
5826
+ * @request POST:/ipos/recent
5788
5827
  * @secure
5789
5828
  */
5790
- getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
5829
+ postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5791
5830
  /**
5792
- * @description Set featured articles
5793
- * @tags News
5794
- * @name SetFeaturedArticles
5795
- * @summary Set featured articles
5796
- * @request POST:/news/featured-articles/set
5831
+ * @description get upcoming ipos info
5832
+ * @tags Ipos
5833
+ * @name GetUpcoming
5834
+ * @summary get upcoming ipos info
5835
+ * @request GET:/ipos/upcoming
5797
5836
  * @secure
5798
5837
  */
5799
- setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5838
+ getUpcoming(query: {
5839
+ /** how many records to return. Max value is 50 */
5840
+ limit: number;
5841
+ /** how many records to skip */
5842
+ offset: number;
5843
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5800
5844
  /**
5801
- * @description Get featured article
5802
- * @tags News
5803
- * @name GetFeaturedArticle
5804
- * @summary Get featured article
5805
- * @request GET:/news/featured-articles/{id}
5845
+ * @description get ipo info by symbol
5846
+ * @tags Ipos
5847
+ * @name GetIpos
5848
+ * @summary get ipo info by symbol
5849
+ * @request GET:/ipos/{symbol}
5806
5850
  * @secure
5807
5851
  */
5808
- getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
5852
+ getIpos(symbol: string, query?: {
5853
+ /** load quotes */
5854
+ load_quotes?: boolean;
5855
+ /** statuses */
5856
+ statuses?: string[];
5857
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
5858
+ }
5859
+ export class Logos<HandleError extends boolean = boolean> {
5860
+ protected readonly apiClient: JwtClient<HandleError>;
5861
+ constructor(apiClient: JwtClient<HandleError>);
5809
5862
  /**
5810
- * @description Returns news by filters
5811
- * @tags News
5812
- * @name NewsFiltered
5813
- * @summary Get filtered news
5814
- * @request POST:/news/filter
5863
+ * @description Returns converted logo for crypto symbol
5864
+ * @tags Logos
5865
+ * @name LogosConvertedCryptoSymbolLogo
5866
+ * @summary Get converted logo for crypto symbol
5867
+ * @request POST:/logos/converted-crypto-symbol-logo
5815
5868
  * @secure
5816
5869
  */
5817
- newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
5870
+ logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5818
5871
  /**
5819
- * @description Returns news by id
5820
- * @tags News
5821
- * @name NewsById
5822
- * @summary Get news by id
5823
- * @request POST:/news/id
5872
+ * @description Returns converted logo for symbol
5873
+ * @tags Logos
5874
+ * @name LogosConvertedSymbolLogo
5875
+ * @summary Get converted logo for symbol
5876
+ * @request POST:/logos/converted-symbol-logo
5824
5877
  * @secure
5825
5878
  */
5826
- newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
5879
+ logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5827
5880
  /**
5828
- * @description Returns news previews
5829
- * @tags News
5830
- * @name NewsPreviewsFiltered
5831
- * @summary Get news previews
5832
- * @request GET:/news/previews
5881
+ * @description Returns logo for crypto symbol
5882
+ * @tags Logos
5883
+ * @name LogosCryptoSymbolLogo
5884
+ * @summary Get logo for crypto symbol
5885
+ * @request GET:/logos/crypto-symbol-logo
5833
5886
  * @secure
5834
5887
  */
5835
- newsPreviewsFiltered(query: {
5836
- /** Start date */
5837
- start_date?: string;
5838
- /** End date */
5839
- end_date?: string;
5840
- /** Symbol */
5841
- symbol?: string;
5842
- /** how many records to return. Max value is 50 */
5843
- limit: number;
5844
- /** how many records to skip */
5845
- offset: number;
5846
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
5888
+ logosCryptoSymbolLogo(query: {
5889
+ /** Company symbol */
5890
+ symbol: string;
5891
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
5847
5892
  /**
5848
- * @description Returns available stocks in DB
5849
- * @tags News
5850
- * @name NewsAvailableStocks
5851
- * @summary Get available stocks in DB (for filters)
5852
- * @request GET:/news/symbols
5893
+ * @description Returns direct logo for crypto symbol
5894
+ * @tags Logos
5895
+ * @name LogosDirectCryptoSymbolLogo
5896
+ * @summary Get direct logo for crypto symbol
5897
+ * @request GET:/logos/direct-crypto-symbol-logo
5853
5898
  * @secure
5854
5899
  */
5855
- newsAvailableStocks(query?: {
5856
- /** Limit */
5857
- limit?: number;
5858
- /** Offset */
5859
- offset?: number;
5860
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5900
+ logosDirectCryptoSymbolLogo(query: {
5901
+ /** Company symbol */
5902
+ symbol: string;
5903
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5861
5904
  /**
5862
- * @description Returns available tags in DB
5863
- * @tags News
5864
- * @name NewsAvailableTags
5865
- * @summary Get available tags in DB (for filters)
5866
- * @request POST:/news/tags
5905
+ * @description Returns direct logo for symbol
5906
+ * @tags Logos
5907
+ * @name LogosDirectSymbolLogo
5908
+ * @summary Get direct logo for symbol
5909
+ * @request GET:/logos/direct-symbol-logo
5867
5910
  * @secure
5868
5911
  */
5869
- newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5870
- }
5871
- export class OptionGreeks<HandleError extends boolean = boolean> {
5872
- protected readonly apiClient: JwtClient<HandleError>;
5873
- constructor(apiClient: JwtClient<HandleError>);
5912
+ logosDirectSymbolLogo(query: {
5913
+ /** Company symbol */
5914
+ symbol: string;
5915
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5874
5916
  /**
5875
- * @description Returns calculated matrix
5876
- * @tags OptionGreeks
5877
- * @name OgCalculateMatrix
5878
- * @summary Calculate matrix
5879
- * @request POST:/og/calculate-matrix
5917
+ * @description Returns logos for multiple symbols
5918
+ * @tags Logos
5919
+ * @name LogosMultipleCryptoSymbolLogo
5920
+ * @summary Get logos for multiple symbols
5921
+ * @request POST:/logos/multiple-crypto-symbol-logo
5880
5922
  * @secure
5881
5923
  */
5882
- ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
5924
+ logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
5883
5925
  /**
5884
- * @description Returns calculated params
5885
- * @tags OptionGreeks
5886
- * @name OgCalculateParams
5887
- * @summary Calculate params
5888
- * @request POST:/og/calculate-params
5926
+ * @description Returns logos for multiple symbol
5927
+ * @tags Logos
5928
+ * @name LogosMultipleSymbolLogos
5929
+ * @summary Get logos for multiple symbols
5930
+ * @request POST:/logos/multiple-symbol-logos
5889
5931
  * @secure
5890
5932
  */
5891
- ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
5892
- }
5893
- export class Ownerships<HandleError extends boolean = boolean> {
5894
- protected readonly apiClient: JwtClient<HandleError>;
5895
- constructor(apiClient: JwtClient<HandleError>);
5933
+ logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
5896
5934
  /**
5897
- * @description get ownerships by id datadata
5898
- * @tags Ownerships
5899
- * @name GetOwnershipsByIdData
5900
- * @summary get ownerships by id data
5901
- * @request POST:/ownerships
5935
+ * @description Returns links of socials logos for symbol
5936
+ * @tags Logos
5937
+ * @name LogosSocialSymbolLogos
5938
+ * @summary Get social logos for symbol
5939
+ * @request GET:/logos/social-symbol-logos
5902
5940
  * @secure
5903
5941
  */
5904
- getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5942
+ logosSocialSymbolLogos(query: {
5943
+ /** Company symbol */
5944
+ symbol: string;
5945
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
5905
5946
  /**
5906
- * @description get ownerships by symbol data
5907
- * @tags Ownerships
5908
- * @name GetOwnershipsBySymbolData
5909
- * @summary get ownerships by symbol data
5910
- * @request POST:/symbol-ownerships
5947
+ * @description Returns logos for company symbol
5948
+ * @tags Logos
5949
+ * @name LogosSymbolLogos
5950
+ * @summary Get symbol logos
5951
+ * @request GET:/logos/symbol-logos
5911
5952
  * @secure
5912
5953
  */
5913
- getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5954
+ logosSymbolLogos(query: {
5955
+ /** Company symbol */
5956
+ symbol: string;
5957
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
5914
5958
  }
5915
- export class Passport<HandleError extends boolean = boolean> {
5959
+ export class MarketDates<HandleError extends boolean = boolean> {
5916
5960
  protected readonly apiClient: JwtClient<HandleError>;
5917
5961
  constructor(apiClient: JwtClient<HandleError>);
5918
5962
  /**
5919
- * @description Returns article by id
5920
- * @tags Passport
5921
- * @name PassportArticleById
5922
- * @summary Get article by id
5923
- * @request POST:/passport/article-by-id
5963
+ * @description Create or update market date
5964
+ * @tags MarketDates
5965
+ * @name CreateOrUpdateMarketDate
5966
+ * @summary Create or update market date
5967
+ * @request POST:/market-dates
5924
5968
  * @secure
5925
5969
  */
5926
- passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
5970
+ createOrUpdateMarketDate(market: InsightMarketDates[], config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate[], HandleError>>;
5927
5971
  /**
5928
- * @description Returns articles
5929
- * @tags Passport
5930
- * @name PassportArticles
5931
- * @summary Get articles
5932
- * @request POST:/passport/articles
5972
+ * @description Remove market date
5973
+ * @tags MarketDates
5974
+ * @name RemoveMarketDate
5975
+ * @summary Remove market date
5976
+ * @request DELETE:/market-dates
5933
5977
  * @secure
5934
5978
  */
5935
- passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
5979
+ removeMarketDate(input: InsightRemoveMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5936
5980
  /**
5937
- * @description Returns author profile
5938
- * @tags Passport
5939
- * @name PassportAuthorProfile
5940
- * @summary Get author profile
5941
- * @request POST:/passport/author-profile
5981
+ * @description Get market dates history
5982
+ * @tags MarketDates
5983
+ * @name GetMarketDatesHistory
5984
+ * @summary Get market dates history
5985
+ * @request POST:/market-dates/history
5942
5986
  * @secure
5943
5987
  */
5944
- passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
5988
+ getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
5945
5989
  /**
5946
- * @description Returns most popular tags
5947
- * @tags Passport
5948
- * @name PassportMostPopularTags
5949
- * @summary Get most popular tags
5950
- * @request POST:/passport/most-popular-tags
5990
+ * @description Search locode data by search string and field
5991
+ * @tags MarketDates
5992
+ * @name SearchLocodeData
5993
+ * @summary Search locode data
5994
+ * @request GET:/market-dates/locode
5951
5995
  * @secure
5952
5996
  */
5953
- passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
5997
+ searchLocodeData(query?: {
5998
+ /** Search string */
5999
+ search?: string;
6000
+ /** Search field */
6001
+ field?: InsightSearchLocodeDataParamsFieldEnum;
6002
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchLocodeDataResponse, HandleError>>;
5954
6003
  /**
5955
- * @description Returns news feed
5956
- * @tags Passport
5957
- * @name PassportNewsFeed
5958
- * @summary Get news feed
5959
- * @request POST:/passport/newsfeed
6004
+ * @description Get markets
6005
+ * @tags MarketDates
6006
+ * @name GetMarkets
6007
+ * @summary Get markets
6008
+ * @request GET:/market-dates/markets
5960
6009
  * @secure
5961
6010
  */
5962
- passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
6011
+ getMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketsResponse, HandleError>>;
5963
6012
  /**
5964
- * @description Returns article by parameters
5965
- * @tags Passport
5966
- * @name PassportSearchArticle
5967
- * @summary Search article by parameters
5968
- * @request POST:/passport/search-article
6013
+ * @description Create or update market
6014
+ * @tags MarketDates
6015
+ * @name CreateOrUpdateMarket
6016
+ * @summary Create or update market
6017
+ * @request POST:/market-dates/markets
5969
6018
  * @secure
5970
6019
  */
5971
- passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
5972
- }
5973
- export class PreIpoCompanies<HandleError extends boolean = boolean> {
5974
- protected readonly apiClient: JwtClient<HandleError>;
5975
- constructor(apiClient: JwtClient<HandleError>);
6020
+ createOrUpdateMarket(market: InsightCreateOrUpdateMarketRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
5976
6021
  /**
5977
- * @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
5978
- * @tags PreIPOCompanies
5979
- * @name MonarkOghlcDataForSymbol
5980
- * @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
5981
- * @request GET:/ipos/market-data/ohlc/{symbol}
6022
+ * @description Get market
6023
+ * @tags MarketDates
6024
+ * @name GetMarket
6025
+ * @summary Get market
6026
+ * @request GET:/market-dates/markets/{market}
5982
6027
  * @secure
5983
6028
  */
5984
- monarkOghlcDataForSymbol(symbol: string, query?: {
5985
- /** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
5986
- from?: string;
5987
- /** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
5988
- to?: string;
5989
- /** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
5990
- interval?: string;
5991
- /** Limit the number of OHLC data points returned. Default is 100. */
5992
- limit?: number;
5993
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
5994
- close?: number;
5995
- high?: number;
5996
- low?: number;
5997
- open?: number;
5998
- time?: string;
5999
- volume?: number;
6000
- }[], HandleError>>;
6029
+ getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketWithSchedule, HandleError>>;
6001
6030
  /**
6002
- * @description Retrieves all symbols available in the market data
6003
- * @tags PreIPOCompanies
6004
- * @name MonarkAllAvailableSymbols
6005
- * @summary Retrieves all symbols available in the market data
6006
- * @request GET:/ipos/market-data/symbols
6031
+ * @description Remove market
6032
+ * @tags MarketDates
6033
+ * @name RemoveMarket
6034
+ * @summary Remove market
6035
+ * @request DELETE:/market-dates/markets/{market}
6007
6036
  * @secure
6008
6037
  */
6009
- monarkAllAvailableSymbols(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6038
+ removeMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6010
6039
  /**
6011
- * @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
6012
- * @tags PreIPOCompanies
6013
- * @name GetPreIpoCompanies
6014
- * @summary get pre ipo companies
6015
- * @request GET:/ipos/pre-ipo-companies
6040
+ * @description Get market schedules
6041
+ * @tags MarketDates
6042
+ * @name GetMarketSchedules
6043
+ * @summary Get market schedules
6044
+ * @request GET:/market-dates/schedule
6016
6045
  * @secure
6017
6046
  */
6018
- getPreIpoCompanies(query: {
6019
- /** search by company name */
6020
- name?: string;
6021
- /** search by categories */
6022
- categories?: string;
6023
- /** search by listing type */
6024
- listing_type?: string;
6025
- /** filter by active status */
6026
- is_active?: InsightGetPreIpoCompaniesParamsIsActiveEnum;
6027
- /** filter by minimum last valuation */
6028
- min_last_valuation?: number;
6029
- /** filter by maximum last valuation */
6030
- max_last_valuation?: number;
6031
- /** filter by minimum total funding */
6032
- min_total_funding?: number;
6033
- /** filter by maximum total funding */
6034
- max_total_funding?: number;
6035
- /** how many records to return. Max value is 50 */
6036
- limit: number;
6037
- /** how many records to skip */
6038
- offset: number;
6039
- /** sort field */
6040
- order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
6041
- /** sort direction */
6042
- order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
6043
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
6047
+ getMarketSchedules(query?: {
6048
+ /** Market codes, comma separated */
6049
+ market?: string;
6050
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError>>;
6044
6051
  /**
6045
- * @description get pre ipo company by id
6046
- * @tags PreIPOCompanies
6047
- * @name GetPreIpoCompaniesById
6048
- * @summary get pre ipo company by id
6049
- * @request GET:/ipos/pre-ipo-companies/{id}
6050
- * @originalName getPreIpoCompanies
6051
- * @duplicate
6052
+ * @description CreateOrUpdateMarketSchedule market schedule
6053
+ * @tags MarketDates
6054
+ * @name CreateOrUpdateMarketSchedule
6055
+ * @summary CreateOrUpdateMarketSchedule market schedule
6056
+ * @request POST:/market-dates/schedule
6052
6057
  * @secure
6053
6058
  */
6054
- getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
6059
+ createOrUpdateMarketSchedule(market: InsightCreateOrUpdateMarketScheduleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
6055
6060
  /**
6056
- * @description get pre ipo company funding rounds
6057
- * @tags PreIPOCompanies
6058
- * @name GetPreIpoCompanyFundingRounds
6059
- * @summary get pre ipo company funding rounds
6060
- * @request GET:/ipos/pre-ipo-company-funding-rounds
6061
+ * @description Get market schedule
6062
+ * @tags MarketDates
6063
+ * @name GetMarketSchedule
6064
+ * @summary Get market schedule
6065
+ * @request GET:/market-dates/schedule/{market}
6061
6066
  * @secure
6062
6067
  */
6063
- getPreIpoCompanyFundingRounds(query: {
6064
- /** company id */
6065
- pre_ipo_company_id?: string;
6066
- /** search by round name */
6067
- round_name?: string;
6068
- /** how many records to return. Max value is 50 */
6069
- limit: number;
6070
- /** how many records to skip */
6071
- offset: number;
6072
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
6068
+ getMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
6073
6069
  /**
6074
- * @description get pre ipo company funding round by id
6075
- * @tags PreIPOCompanies
6076
- * @name GetPreIpoCompanyFundingRoundsById
6077
- * @summary get pre ipo company funding round by id
6078
- * @request GET:/ipos/pre-ipo-company-funding-rounds/{id}
6079
- * @originalName getPreIpoCompanyFundingRounds
6080
- * @duplicate
6070
+ * @description Remove market schedule
6071
+ * @tags MarketDates
6072
+ * @name RemoveMarketSchedule
6073
+ * @summary Remove market schedule
6074
+ * @request DELETE:/market-dates/schedule/{market}
6081
6075
  * @secure
6082
6076
  */
6083
- getPreIpoCompanyFundingRoundsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyFundingRound, HandleError>>;
6077
+ removeMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6084
6078
  /**
6085
- * @description get pre ipo company investments
6086
- * @tags PreIPOCompanies
6087
- * @name GetPreIpoCompanyInvestments
6088
- * @summary get pre ipo company investments
6089
- * @request GET:/ipos/pre-ipo-company-investments
6079
+ * @description Get todays market hours
6080
+ * @tags MarketDates
6081
+ * @name GetTodaysMarketHours
6082
+ * @summary Get todays market hours
6083
+ * @request GET:/market-dates/today
6090
6084
  * @secure
6091
6085
  */
6092
- getPreIpoCompanyInvestments(query: {
6093
- /** company id */
6094
- pre_ipo_company_id?: string;
6095
- /** company name */
6096
- company_name?: string;
6097
- /** how many records to return. Max value is 50 */
6098
- limit: number;
6099
- /** how many records to skip */
6100
- offset: number;
6101
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
6086
+ getTodaysMarketHours(query: {
6087
+ /** Market */
6088
+ market: string;
6089
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
6090
+ }
6091
+ export class News<HandleError extends boolean = boolean> {
6092
+ protected readonly apiClient: JwtClient<HandleError>;
6093
+ constructor(apiClient: JwtClient<HandleError>);
6102
6094
  /**
6103
- * @description get pre ipo company investment by id
6104
- * @tags PreIPOCompanies
6105
- * @name GetPreIpoCompanyInvestmentsById
6106
- * @summary get pre ipo company investment by id
6107
- * @request GET:/ipos/pre-ipo-company-investments/{id}
6108
- * @originalName getPreIpoCompanyInvestments
6109
- * @duplicate
6095
+ * @description Returns available authors in DB
6096
+ * @tags News
6097
+ * @name NewsAvailableAuthors
6098
+ * @summary Get available authors in DB (for filters)
6099
+ * @request POST:/news/authors
6110
6100
  * @secure
6111
6101
  */
6112
- getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
6102
+ newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6113
6103
  /**
6114
- * @description get pre ipo company news
6115
- * @tags PreIPOCompanies
6116
- * @name GetPreIpoCompanyNews
6117
- * @summary get pre ipo company news
6118
- * @request GET:/ipos/pre-ipo-company-news
6104
+ * @description Returns available channels in DB
6105
+ * @tags News
6106
+ * @name NewsAvailableChannels
6107
+ * @summary Get available channels in DB (for filters)
6108
+ * @request POST:/news/channels
6119
6109
  * @secure
6120
6110
  */
6121
- getPreIpoCompanyNews(query: {
6122
- /** company id */
6123
- pre_ipo_company_id?: string;
6124
- /** search by headline */
6125
- headline?: string;
6126
- /** how many records to return. Max value is 50 */
6111
+ newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6112
+ /**
6113
+ * @description Get featured articles
6114
+ * @tags News
6115
+ * @name GetFeaturedArticles
6116
+ * @summary Get featured articles
6117
+ * @request GET:/news/featured-articles
6118
+ * @secure
6119
+ */
6120
+ getFeaturedArticles(query: {
6121
+ /** Limit */
6127
6122
  limit: number;
6128
- /** how many records to skip */
6123
+ /** Offset */
6129
6124
  offset: number;
6130
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
6125
+ /** Start date */
6126
+ start_date?: string;
6127
+ /** End date */
6128
+ end_date?: string;
6129
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
6131
6130
  /**
6132
- * @description get pre ipo company news by id
6133
- * @tags PreIPOCompanies
6134
- * @name GetPreIpoCompanyNewsById
6135
- * @summary get pre ipo company news by id
6136
- * @request GET:/ipos/pre-ipo-company-news/{id}
6137
- * @originalName getPreIpoCompanyNews
6138
- * @duplicate
6131
+ * @description Update featured articles
6132
+ * @tags News
6133
+ * @name UpdateFeaturedArticles
6134
+ * @summary Update featured articles
6135
+ * @request PUT:/news/featured-articles
6139
6136
  * @secure
6140
6137
  */
6141
- getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
6138
+ updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6142
6139
  /**
6143
- * @description get pre ipo company research documents
6144
- * @tags PreIPOCompanies
6145
- * @name GetPreIpoCompanyResearchDocuments
6146
- * @summary get pre ipo company research documents
6147
- * @request GET:/ipos/pre-ipo-company-research-documents
6140
+ * @description Create featured articles
6141
+ * @tags News
6142
+ * @name CreateFeaturedArticles
6143
+ * @summary Create featured articles
6144
+ * @request POST:/news/featured-articles
6148
6145
  * @secure
6149
6146
  */
6150
- getPreIpoCompanyResearchDocuments(query: {
6151
- /** company id */
6152
- pre_ipo_company_id?: string;
6153
- /** search by title */
6154
- title?: string;
6155
- /** how many records to return. Max value is 50 */
6156
- limit: number;
6157
- /** how many records to skip */
6158
- offset: number;
6159
- /** search by research type */
6160
- research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
6161
- /** search by relation */
6162
- relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
6163
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
6147
+ createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6164
6148
  /**
6165
- * @description get pre ipo company research document by id
6166
- * @tags PreIPOCompanies
6167
- * @name GetPreIpoCompanyResearchDocumentsById
6168
- * @summary get pre ipo company research document by id
6169
- * @request GET:/ipos/pre-ipo-company-research-documents/{id}
6170
- * @originalName getPreIpoCompanyResearchDocuments
6171
- * @duplicate
6149
+ * @description Get active featured articles
6150
+ * @tags News
6151
+ * @name GetActiveFeaturedArticles
6152
+ * @summary Get active featured articles
6153
+ * @request GET:/news/featured-articles/active
6172
6154
  * @secure
6173
6155
  */
6174
- getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
6156
+ getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
6175
6157
  /**
6176
- * @description get pre ipo company spvs with investor id
6177
- * @tags PreIPOCompanies
6178
- * @name GetInvestor
6179
- * @summary get pre ipo company spvs with investor id
6180
- * @request GET:/ipos/pre-ipo-company-spv/investor/{investor_id}
6158
+ * @description Set featured articles
6159
+ * @tags News
6160
+ * @name SetFeaturedArticles
6161
+ * @summary Set featured articles
6162
+ * @request POST:/news/featured-articles/set
6181
6163
  * @secure
6182
6164
  */
6183
- getInvestor(investorId: string, query: {
6184
- /** search by monark stage */
6185
- monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
6186
- /** Optional param to filter returned spv's based on the exemptions claimed */
6187
- exemptions_claimed?: string[];
6188
- /** Optional param to filter returned spv's based on the name */
6189
- name_filter?: string;
6190
- /** investment id */
6191
- pre_ipo_company_id?: string;
6192
- /** investment id */
6193
- pre_ipo_company_investment_id?: string;
6194
- /** page number */
6195
- page: number;
6196
- /** page size */
6197
- page_size: number;
6198
- /** sort direction */
6199
- sort_order?: InsightGetInvestorParamsSortOrderEnum;
6200
- /** sort field */
6201
- sort_by?: InsightGetInvestorParamsSortByEnum;
6202
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
6165
+ setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6203
6166
  /**
6204
- * @description get pre ipo company spv by id with investor id
6205
- * @tags PreIPOCompanies
6206
- * @name GetInvestorByIdAndInvestorId
6207
- * @summary get pre ipo company spv by id with investor id
6208
- * @request GET:/ipos/pre-ipo-company-spv/{id}/investor/{investor_id}
6209
- * @originalName getInvestor
6210
- * @duplicate
6167
+ * @description Get featured article
6168
+ * @tags News
6169
+ * @name GetFeaturedArticle
6170
+ * @summary Get featured article
6171
+ * @request GET:/news/featured-articles/{id}
6211
6172
  * @secure
6212
6173
  */
6213
- getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
6214
- /** default is false, if true documents will be included in the response */
6215
- include_documents?: boolean;
6216
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
6174
+ getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
6217
6175
  /**
6218
- * @description get pre ipo company spvs
6219
- * @tags PreIPOCompanies
6220
- * @name GetPreIpoCompanySpvs
6221
- * @summary get pre ipo company spvs
6222
- * @request GET:/ipos/pre-ipo-company-spvs
6176
+ * @description Returns news by filters
6177
+ * @tags News
6178
+ * @name NewsFiltered
6179
+ * @summary Get filtered news
6180
+ * @request POST:/news/filter
6223
6181
  * @secure
6224
6182
  */
6225
- getPreIpoCompanySpvs(query: {
6226
- /** company id */
6227
- pre_ipo_company_id?: string;
6228
- /** investment id */
6229
- investment_id?: string;
6230
- /** search by name */
6231
- name?: string;
6232
- /** search by company name */
6233
- company_name?: string;
6183
+ newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
6184
+ /**
6185
+ * @description Returns news by id
6186
+ * @tags News
6187
+ * @name NewsById
6188
+ * @summary Get news by id
6189
+ * @request POST:/news/id
6190
+ * @secure
6191
+ */
6192
+ newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
6193
+ /**
6194
+ * @description Returns news previews
6195
+ * @tags News
6196
+ * @name NewsPreviewsFiltered
6197
+ * @summary Get news previews
6198
+ * @request GET:/news/previews
6199
+ * @secure
6200
+ */
6201
+ newsPreviewsFiltered(query: {
6202
+ /** Start date */
6203
+ start_date?: string;
6204
+ /** End date */
6205
+ end_date?: string;
6206
+ /** Symbol */
6207
+ symbol?: string;
6234
6208
  /** how many records to return. Max value is 50 */
6235
6209
  limit: number;
6236
6210
  /** how many records to skip */
6237
6211
  offset: number;
6238
- /** search by monark stage */
6239
- monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
6240
- /** sort direction */
6241
- direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
6242
- /** sort field */
6243
- field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
6244
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
6212
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
6245
6213
  /**
6246
- * @description get pre ipo company spv by id
6247
- * @tags PreIPOCompanies
6248
- * @name GetPreIpoCompanySpvsById
6249
- * @summary get pre ipo company spv by id
6250
- * @request GET:/ipos/pre-ipo-company-spvs/{id}
6251
- * @originalName getPreIpoCompanySpvs
6252
- * @duplicate
6214
+ * @description Returns available stocks in DB
6215
+ * @tags News
6216
+ * @name NewsAvailableStocks
6217
+ * @summary Get available stocks in DB (for filters)
6218
+ * @request GET:/news/symbols
6253
6219
  * @secure
6254
6220
  */
6255
- getPreIpoCompanySpvsById(id: string, query?: {
6256
- /** default is false, if true documents will be included in the response */
6257
- include_documents?: boolean;
6258
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
6221
+ newsAvailableStocks(query?: {
6222
+ /** Limit */
6223
+ limit?: number;
6224
+ /** Offset */
6225
+ offset?: number;
6226
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6227
+ /**
6228
+ * @description Returns available tags in DB
6229
+ * @tags News
6230
+ * @name NewsAvailableTags
6231
+ * @summary Get available tags in DB (for filters)
6232
+ * @request POST:/news/tags
6233
+ * @secure
6234
+ */
6235
+ newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6259
6236
  }
6260
- export class Public<HandleError extends boolean = boolean> {
6237
+ export class OptionGreeks<HandleError extends boolean = boolean> {
6261
6238
  protected readonly apiClient: JwtClient<HandleError>;
6262
6239
  constructor(apiClient: JwtClient<HandleError>);
6263
6240
  /**
6264
- * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
6265
- * @tags Public
6266
- * @name CalculateEstimatedReturns
6267
- * @summary Calculate Estimated Returns
6268
- * @request GET:/public/estimated-returns
6241
+ * @description Returns calculated matrix
6242
+ * @tags OptionGreeks
6243
+ * @name OgCalculateMatrix
6244
+ * @summary Calculate matrix
6245
+ * @request POST:/og/calculate-matrix
6269
6246
  * @secure
6270
6247
  */
6271
- calculateEstimatedReturns(query: {
6272
- /** Single symbol */
6273
- symbol: string;
6274
- /**
6275
- * Non-zero amount
6276
- * @format float64
6277
- */
6278
- amount: number;
6279
- /** Start date for calculations */
6280
- start_date: string;
6281
- /** End date for calculations */
6282
- end_date: string;
6283
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
6248
+ ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
6284
6249
  /**
6285
- * @description Returns an expert forecast
6286
- * @tags Public
6287
- * @name ExpertForecast
6288
- * @summary Expert forecast
6289
- * @request GET:/public/expert-forecast
6250
+ * @description Returns calculated params
6251
+ * @tags OptionGreeks
6252
+ * @name OgCalculateParams
6253
+ * @summary Calculate params
6254
+ * @request POST:/og/calculate-params
6290
6255
  * @secure
6291
6256
  */
6292
- expertForecast(query: {
6293
- /** Comma separated symbols */
6294
- symbols: string;
6295
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
6257
+ ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
6258
+ }
6259
+ export class Ownerships<HandleError extends boolean = boolean> {
6260
+ protected readonly apiClient: JwtClient<HandleError>;
6261
+ constructor(apiClient: JwtClient<HandleError>);
6296
6262
  /**
6297
- * @description get fundamentals by symbol data
6298
- * @tags Public
6263
+ * @description get ownerships by id datadata
6264
+ * @tags Ownerships
6265
+ * @name GetOwnershipsByIdData
6266
+ * @summary get ownerships by id data
6267
+ * @request POST:/ownerships
6268
+ * @secure
6269
+ */
6270
+ getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6271
+ /**
6272
+ * @description get ownerships by symbol data
6273
+ * @tags Ownerships
6274
+ * @name GetOwnershipsBySymbolData
6275
+ * @summary get ownerships by symbol data
6276
+ * @request POST:/symbol-ownerships
6277
+ * @secure
6278
+ */
6279
+ getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6280
+ }
6281
+ export class Passport<HandleError extends boolean = boolean> {
6282
+ protected readonly apiClient: JwtClient<HandleError>;
6283
+ constructor(apiClient: JwtClient<HandleError>);
6284
+ /**
6285
+ * @description Returns article by id
6286
+ * @tags Passport
6287
+ * @name PassportArticleById
6288
+ * @summary Get article by id
6289
+ * @request POST:/passport/article-by-id
6290
+ * @secure
6291
+ */
6292
+ passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
6293
+ /**
6294
+ * @description Returns articles
6295
+ * @tags Passport
6296
+ * @name PassportArticles
6297
+ * @summary Get articles
6298
+ * @request POST:/passport/articles
6299
+ * @secure
6300
+ */
6301
+ passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6302
+ /**
6303
+ * @description Returns author profile
6304
+ * @tags Passport
6305
+ * @name PassportAuthorProfile
6306
+ * @summary Get author profile
6307
+ * @request POST:/passport/author-profile
6308
+ * @secure
6309
+ */
6310
+ passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
6311
+ /**
6312
+ * @description Returns most popular tags
6313
+ * @tags Passport
6314
+ * @name PassportMostPopularTags
6315
+ * @summary Get most popular tags
6316
+ * @request POST:/passport/most-popular-tags
6317
+ * @secure
6318
+ */
6319
+ passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
6320
+ /**
6321
+ * @description Returns news feed
6322
+ * @tags Passport
6323
+ * @name PassportNewsFeed
6324
+ * @summary Get news feed
6325
+ * @request POST:/passport/newsfeed
6326
+ * @secure
6327
+ */
6328
+ passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
6329
+ /**
6330
+ * @description Returns article by parameters
6331
+ * @tags Passport
6332
+ * @name PassportSearchArticle
6333
+ * @summary Search article by parameters
6334
+ * @request POST:/passport/search-article
6335
+ * @secure
6336
+ */
6337
+ passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6338
+ }
6339
+ export class Public<HandleError extends boolean = boolean> {
6340
+ protected readonly apiClient: JwtClient<HandleError>;
6341
+ constructor(apiClient: JwtClient<HandleError>);
6342
+ /**
6343
+ * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
6344
+ * @tags Public
6345
+ * @name CalculateEstimatedReturns
6346
+ * @summary Calculate Estimated Returns
6347
+ * @request GET:/public/estimated-returns
6348
+ * @secure
6349
+ */
6350
+ calculateEstimatedReturns(query: {
6351
+ /** Single symbol */
6352
+ symbol: string;
6353
+ /**
6354
+ * Non-zero amount
6355
+ * @format float64
6356
+ */
6357
+ amount: number;
6358
+ /** Start date for calculations */
6359
+ start_date: string;
6360
+ /** End date for calculations */
6361
+ end_date: string;
6362
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
6363
+ /**
6364
+ * @description Returns an expert forecast
6365
+ * @tags Public
6366
+ * @name ExpertForecast
6367
+ * @summary Expert forecast
6368
+ * @request GET:/public/expert-forecast
6369
+ * @secure
6370
+ */
6371
+ expertForecast(query: {
6372
+ /** Comma separated symbols */
6373
+ symbols: string;
6374
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
6375
+ /**
6376
+ * @description get fundamentals by symbol data
6377
+ * @tags Public
6299
6378
  * @name GetPublicFundamentalsBySymbolData
6300
6379
  * @summary get fundamentals by symbol data
6301
6380
  * @request GET:/public/fundamentals/{symbol}
@@ -6386,223 +6465,88 @@ export class Public<HandleError extends boolean = boolean> {
6386
6465
  offset: number;
6387
6466
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6388
6467
  }
6389
- export class Quotes<HandleError extends boolean = boolean> {
6468
+ export class AlphaTools<HandleError extends boolean = boolean> {
6390
6469
  protected readonly apiClient: JwtClient<HandleError>;
6391
6470
  constructor(apiClient: JwtClient<HandleError>);
6392
6471
  /**
6393
- * @description Get single historical quote
6394
- * @tags Quotes
6395
- * @name GitHistoricalQuote
6396
- * @summary Get single historical quote
6397
- * @request GET:/historical/quote
6398
- * @secure
6399
- */
6400
- gitHistoricalQuote(query: {
6401
- /** Symbol */
6402
- symbol: string;
6403
- /** Date */
6404
- date: string;
6405
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
6406
- /**
6407
- * @description get quote history by symbol
6408
- * @tags Quotes
6409
- * @name GitQuoteHistory
6410
- * @summary Get quote history
6411
- * @request POST:/quote-history
6472
+ * @description get seasonlity data with comparison to benchmark
6473
+ * @tags AlphaTools
6474
+ * @name GetMomentumRatioGraph
6475
+ * @summary get seasonlity data
6476
+ * @request POST:/rst
6412
6477
  * @secure
6413
6478
  */
6414
- gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
6479
+ getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
6415
6480
  /**
6416
- * @description Returns a list of quotes equity info for specified symbols.
6417
- * @tags Quotes
6418
- * @name GetQuotesEquityData
6419
- * @summary Get Quotes Equity data
6420
- * @request GET:/quotes/equity
6481
+ * @description get seasonlity data with comparison to benchmark
6482
+ * @tags AlphaTools
6483
+ * @name GetSeasonality
6484
+ * @summary get seasonlity data
6485
+ * @request POST:/seasonality
6421
6486
  * @secure
6422
6487
  */
6423
- getQuotesEquityData(query: {
6424
- /** Comma separated symbols */
6425
- symbols: string;
6426
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
6488
+ getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
6427
6489
  }
6428
- export class StockScreener<HandleError extends boolean = boolean> {
6490
+ export class TipRank<HandleError extends boolean = boolean> {
6429
6491
  protected readonly apiClient: JwtClient<HandleError>;
6430
6492
  constructor(apiClient: JwtClient<HandleError>);
6431
6493
  /**
6432
- * @description data for visual heat map
6433
- * @tags StockScreener
6434
- * @name StockMarketHeatmap
6435
- * @summary data for visual heat map
6436
- * @request GET:/heatmaps
6437
- * @secure
6438
- */
6439
- stockMarketHeatmap(query?: {
6440
- /** Name of symbol list to fetch details for. Empty is default */
6441
- heatmap_name?: string;
6442
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
6443
- /**
6444
- * @description create or update heat map preset
6445
- * @tags StockScreener
6446
- * @name CreateStockMarketHeatmapPreset
6447
- * @summary create or update heat map preset
6448
- * @request POST:/heatmaps
6494
+ * @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
6495
+ * @tags TipRank
6496
+ * @name TiprankAnalystConsensus
6497
+ * @summary Get tiprank AnalystConsensus
6498
+ * @request POST:/tipranks/analyst-consensus
6449
6499
  * @secure
6450
6500
  */
6451
- createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6501
+ tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
6452
6502
  /**
6453
- * @description Sector and Industry Group performance
6454
- * @tags StockScreener
6455
- * @name IndustriesPerformance
6456
- * @summary get industries performance
6457
- * @request POST:/industries-performance
6503
+ * @description Returns the latest analyst ratings on a given stock or multiple stocks.
6504
+ * @tags TipRank
6505
+ * @name TiprankLatestAnalystRatingsOnStock
6506
+ * @summary Get tiprank LatestAnalystRatingsOnStock
6507
+ * @request POST:/tipranks/analyst-multi
6458
6508
  * @secure
6459
6509
  */
6460
- industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
6510
+ tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError>>;
6461
6511
  /**
6462
- * @description filter stocks by params
6463
- * @tags StockScreener
6464
- * @name StockScreener
6465
- * @summary filter stocks by params
6466
- * @request POST:/stock-screener
6512
+ * @description Returns the latest analyst portfolio items.
6513
+ * @tags TipRank
6514
+ * @name TiprankPortfolios
6515
+ * @summary Get the latest analyst portfolio items
6516
+ * @request POST:/tipranks/analyst-portfolio
6467
6517
  * @secure
6468
6518
  */
6469
- stockScreener(filter: InsightStockScreenerV1Request, headers?: {
6519
+ tiprankPortfolios(filter: InsightPortfoliosRequest, headers?: {
6470
6520
  /** Authorization */
6471
6521
  Authorization?: string;
6472
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
6522
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError>>;
6473
6523
  /**
6474
- * @description get screener presets
6475
- * @tags StockScreener
6476
- * @name GetScreenerPresets
6477
- * @summary get screener presets
6478
- * @request GET:/stock-screener/presets
6524
+ * @description Returns the analyst profile information
6525
+ * @tags TipRank
6526
+ * @name TiprankAnalystProfile
6527
+ * @summary Get tiprank AnalystProfile
6528
+ * @request GET:/tipranks/analyst-profile
6479
6529
  * @secure
6480
6530
  */
6481
- getScreenerPresets(query: {
6482
- /** how many records to return */
6483
- limit: number;
6484
- /** how many records to skip */
6485
- offset: number;
6486
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
6531
+ tiprankAnalystProfile(query: {
6532
+ /** ID of tiprank analyst profile */
6533
+ id: string;
6534
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystProfileResponse, HandleError>>;
6487
6535
  /**
6488
- * @description update screener preset
6489
- * @tags StockScreener
6490
- * @name UpdateScreenerPreset
6491
- * @summary update screener preset
6492
- * @request PUT:/stock-screener/presets
6536
+ * @description Returns the URL prefix to the expertPictureUrl field.
6537
+ * @tags TipRank
6538
+ * @name TiprankAnalystsExpertPictureStore
6539
+ * @summary Get tiprank AnalystsExpertPictureStore
6540
+ * @request GET:/tipranks/analysts-expert-picture-store
6493
6541
  * @secure
6494
6542
  */
6495
- updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
6543
+ tiprankAnalystsExpertPictureStore(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystsExpertPictureStoreResponse, HandleError>>;
6496
6544
  /**
6497
- * @description create screener preset
6498
- * @tags StockScreener
6499
- * @name CreateOrScreenerPreset
6500
- * @summary create screener preset
6501
- * @request POST:/stock-screener/presets
6502
- * @secure
6503
- */
6504
- createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
6505
- /**
6506
- * @description remove screener preset
6507
- * @tags StockScreener
6508
- * @name RemoveScreenerPreset
6509
- * @summary remove screener preset
6510
- * @request DELETE:/stock-screener/presets
6511
- * @secure
6512
- */
6513
- removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6514
- /**
6515
- * @description get top symbols
6516
- * @tags StockScreener
6517
- * @name GetTopSymbols
6518
- * @summary get top symbols
6519
- * @request POST:/stock-screener/top
6520
- * @secure
6521
- */
6522
- getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
6523
- }
6524
- export class StockScreenerV2<HandleError extends boolean = boolean> {
6525
- protected readonly apiClient: JwtClient<HandleError>;
6526
- constructor(apiClient: JwtClient<HandleError>);
6527
- /**
6528
- * @description filter stocks by params
6529
- * @tags StockScreener
6530
- * @name StockScreener
6531
- * @summary filter stocks by params
6532
- * @request POST:/stock-screener
6533
- * @secure
6534
- */
6535
- stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
6536
- /**
6537
- * @description get top symbols
6538
- * @tags StockScreener
6539
- * @name GetTopSymbols
6540
- * @summary get top symbols
6541
- * @request POST:/stock-screener/top
6542
- * @secure
6543
- */
6544
- getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
6545
- }
6546
- export class TipRank<HandleError extends boolean = boolean> {
6547
- protected readonly apiClient: JwtClient<HandleError>;
6548
- constructor(apiClient: JwtClient<HandleError>);
6549
- /**
6550
- * @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
6551
- * @tags TipRank
6552
- * @name TiprankAnalystConsensus
6553
- * @summary Get tiprank AnalystConsensus
6554
- * @request POST:/tipranks/analyst-consensus
6555
- * @secure
6556
- */
6557
- tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
6558
- /**
6559
- * @description Returns the latest analyst ratings on a given stock or multiple stocks.
6560
- * @tags TipRank
6561
- * @name TiprankLatestAnalystRatingsOnStock
6562
- * @summary Get tiprank LatestAnalystRatingsOnStock
6563
- * @request POST:/tipranks/analyst-multi
6564
- * @secure
6565
- */
6566
- tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError>>;
6567
- /**
6568
- * @description Returns the latest analyst portfolio items.
6569
- * @tags TipRank
6570
- * @name TiprankPortfolios
6571
- * @summary Get the latest analyst portfolio items
6572
- * @request POST:/tipranks/analyst-portfolio
6573
- * @secure
6574
- */
6575
- tiprankPortfolios(filter: InsightPortfoliosRequest, headers?: {
6576
- /** Authorization */
6577
- Authorization?: string;
6578
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError>>;
6579
- /**
6580
- * @description Returns the analyst profile information
6581
- * @tags TipRank
6582
- * @name TiprankAnalystProfile
6583
- * @summary Get tiprank AnalystProfile
6584
- * @request GET:/tipranks/analyst-profile
6585
- * @secure
6586
- */
6587
- tiprankAnalystProfile(query: {
6588
- /** ID of tiprank analyst profile */
6589
- id: string;
6590
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystProfileResponse, HandleError>>;
6591
- /**
6592
- * @description Returns the URL prefix to the expertPictureUrl field.
6593
- * @tags TipRank
6594
- * @name TiprankAnalystsExpertPictureStore
6595
- * @summary Get tiprank AnalystsExpertPictureStore
6596
- * @request GET:/tipranks/analysts-expert-picture-store
6597
- * @secure
6598
- */
6599
- tiprankAnalystsExpertPictureStore(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystsExpertPictureStoreResponse, HandleError>>;
6600
- /**
6601
- * @description Returns a list of top-ranked analysts.
6602
- * @tags TipRank
6603
- * @name TiprankBestPerformingExperts
6604
- * @summary Get tiprank BestPerformingExperts
6605
- * @request GET:/tipranks/best-performing-experts
6545
+ * @description Returns a list of top-ranked analysts.
6546
+ * @tags TipRank
6547
+ * @name TiprankBestPerformingExperts
6548
+ * @summary Get tiprank BestPerformingExperts
6549
+ * @request GET:/tipranks/best-performing-experts
6606
6550
  * @secure
6607
6551
  */
6608
6552
  tiprankBestPerformingExperts(query?: {
@@ -6922,187 +6866,269 @@ export class UsageTracking<HandleError extends boolean = boolean> {
6922
6866
  */
6923
6867
  getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
6924
6868
  }
6925
- export class WorldMarkets<HandleError extends boolean = boolean> {
6926
- protected readonly apiClient: JwtClient<HandleError>;
6927
- constructor(apiClient: JwtClient<HandleError>);
6928
- /**
6929
- * @description Get continents
6930
- * @tags World Markets
6931
- * @name ContinentGet
6932
- * @summary Get continents
6933
- * @request GET:/continents
6934
- * @secure
6935
- */
6936
- continentGet(query: {
6937
- /** Query limit */
6938
- limit: number;
6939
- /** Query offset */
6940
- offset: number;
6941
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
6942
- /**
6943
- * @description Edit continent
6944
- * @tags World Markets
6945
- * @name ContinentEdit
6946
- * @summary Edit continent
6947
- * @request PUT:/continents
6948
- * @secure
6949
- */
6950
- continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6951
- /**
6952
- * @description Create continents
6953
- * @tags World Markets
6954
- * @name ContinentCreate
6955
- * @summary Create continents
6956
- * @request POST:/continents
6957
- * @secure
6958
- */
6959
- continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
6960
- /**
6961
- * @description Delete continent
6962
- * @tags World Markets
6963
- * @name ContinentDelete
6964
- * @summary Delete continent
6965
- * @request DELETE:/continents
6966
- * @secure
6967
- */
6968
- continentDelete(query: {
6969
- /** continent id */
6970
- id: string;
6971
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6972
- /**
6973
- * @description Get country codes
6974
- * @tags World Markets
6975
- * @name CountryCodeGet
6976
- * @summary Get country codes
6977
- * @request GET:/country-codes
6978
- * @secure
6979
- */
6980
- countryCodeGet(query: {
6981
- /** Query limit */
6982
- limit: number;
6983
- /** Query offset */
6984
- offset: number;
6985
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
6986
- /**
6987
- * @description Edit country code
6988
- * @tags World Markets
6989
- * @name CountryCodeEdit
6990
- * @summary Edit country code
6991
- * @request PUT:/country-codes
6992
- * @secure
6993
- */
6994
- countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6995
- /**
6996
- * @description Add country codes
6997
- * @tags World Markets
6998
- * @name CountryCodeAdd
6999
- * @summary Add country codes
7000
- * @request POST:/country-codes
7001
- * @secure
7002
- */
7003
- countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
6869
+ export interface InsightBeforeAndAfterV2 {
6870
+ after?: string;
6871
+ before?: string;
6872
+ }
6873
+ export interface InsightFixedIncomeV2 {
6874
+ a144: boolean;
6875
+ accrued_interest: number;
6876
+ bank_qualified: boolean;
6877
+ bond_warrant: boolean;
6878
+ call_type: string;
6879
+ callable: boolean;
6880
+ close_price: number;
6881
+ close_price_asof: string;
6882
+ close_ytw: number;
6883
+ convertible: boolean;
6884
+ country: string;
6885
+ country_code: string;
6886
+ country_domicile: string;
6887
+ country_issue: string;
6888
+ coupon: number;
6889
+ coupon_frequency: string;
6890
+ coupon_type: string;
6891
+ currency: string;
6892
+ cusip: string;
6893
+ dated_date: string;
6894
+ daycount: string;
6895
+ description: string;
6896
+ description_short: string;
6897
+ duration: number;
6898
+ first_coupon_date: string;
6899
+ insured: boolean;
6900
+ isin: string;
6901
+ issue_date: string;
6902
+ issue_minimum_denomination: number;
6903
+ issue_price: number;
6904
+ issue_size: number;
6905
+ issuer: string;
6906
+ last_coupon_date: string;
6907
+ liquidity_institutional_aggregate: number;
6908
+ liquidity_institutional_buy: number;
6909
+ liquidity_institutional_sell: number;
6910
+ liquidity_micro_aggregate: number;
6911
+ liquidity_micro_buy: number;
6912
+ liquidity_micro_sell: number;
6913
+ liquidity_retail_aggregate: number;
6914
+ liquidity_retail_buy: number;
6915
+ liquidity_retail_sell: number;
6916
+ maturity_date: string;
6917
+ municipal_state: string;
6918
+ municipal_taxable_federal: boolean;
6919
+ municipal_type: string;
6920
+ next_call_date: string;
6921
+ next_call_price: number;
6922
+ next_coupon_date: string;
6923
+ par_value: number;
6924
+ perpetual: boolean;
6925
+ private_placement: boolean;
6926
+ purpose: string;
6927
+ puttable: boolean;
6928
+ reg_s: boolean;
6929
+ sector: string;
6930
+ seniority: string;
6931
+ settlement_convention: string;
6932
+ sinking_fund: boolean;
6933
+ sp_creditwatch: string;
6934
+ sp_creditwatch_date: string;
6935
+ sp_outlook: string;
6936
+ sp_outlook_date: string;
6937
+ sp_rating: string;
6938
+ sp_rating_date: string;
6939
+ status: string;
6940
+ ticker: string;
6941
+ treasury_subtype: string;
6942
+ type: string;
6943
+ updated_at: string;
6944
+ }
6945
+ export interface InsightGetFixedIncomeEntriesResponseV2 {
6946
+ count: number;
6947
+ data: InsightFixedIncomeV2[];
6948
+ }
6949
+ export interface InsightGetFixedIncomeEntriesRequestV2 {
6950
+ /** @example true */
6951
+ bank_qualified?: boolean;
6952
+ /** @example true */
6953
+ callable?: boolean;
6954
+ /** @example true */
6955
+ convertible?: boolean;
6956
+ /** @example ["USA"] */
6957
+ country_codes?: string[];
6958
+ coupon?: InsightLessAndMoreV2;
6959
+ /** @example ["quarterly","zero"] */
6960
+ coupon_frequencies?: string[];
6961
+ /** @example ["655664AH3","9128286R6"] */
6962
+ cusip?: string[];
7004
6963
  /**
7005
- * @description Delete country code
7006
- * @tags World Markets
7007
- * @name CountryCodeDelete
7008
- * @summary Delete country code
7009
- * @request DELETE:/country-codes
7010
- * @secure
6964
+ * @maxLength 100
6965
+ * @example "Donald's"
7011
6966
  */
7012
- countryCodeDelete(query: {
7013
- /** a3 code */
7014
- a3code: string;
7015
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6967
+ description?: string;
6968
+ /** @example true */
6969
+ has_ticker?: boolean;
6970
+ /** @example true */
6971
+ insured?: boolean;
6972
+ /** @example ["US655664AH33","US9128286R69"] */
6973
+ isin?: string[];
6974
+ issue_date?: InsightBeforeAndAfterV2;
7016
6975
  /**
7017
- * @description Get global indexes
7018
- * @tags World Markets
7019
- * @name GlobalIndexGet
7020
- * @summary Get global indexes
7021
- * @request GET:/global-indexes
7022
- * @secure
6976
+ * @maxLength 100
6977
+ * @example "Donald's"
7023
6978
  */
7024
- globalIndexGet(query: {
7025
- /** Query limit */
7026
- limit: number;
7027
- /** Query offset */
7028
- offset: number;
7029
- /** Continent code for filtering */
7030
- continent?: string;
7031
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
6979
+ issuer?: string;
6980
+ maturity?: InsightBeforeAndAfterV2;
6981
+ /** @example ["NY"] */
6982
+ municipal_states?: string[];
6983
+ /** @example true */
6984
+ municipal_tax?: boolean;
6985
+ /** @example ["general_obligation"] */
6986
+ municipal_types?: string[];
6987
+ pagination: InsightPaginationV2;
6988
+ purposes?: string[];
6989
+ /** @example ["SOVEREIGN"] */
6990
+ sectors?: string[];
6991
+ sorts?: InsightOrderingV2[];
6992
+ /** @example ["AAA"] */
6993
+ sp_ratings?: string[];
6994
+ /** @example ["called","outstanding"] */
6995
+ statuses?: string[];
6996
+ tickers?: string[];
6997
+ /** @example ["corporate"] */
6998
+ types?: string[];
6999
+ }
7000
+ export interface InsightGetTopSymbolsRequestV2 {
7001
+ exchange?: string[];
7002
+ market_cap?: InsightLessAndMoreV2;
7003
+ pagination?: InsightPaginationV2;
7004
+ price?: InsightLessAndMoreV2;
7005
+ sorts?: InsightOrderingV2[];
7006
+ volume?: InsightLessAndMoreV2;
7007
+ }
7008
+ export interface InsightIncludeExcludeV2 {
7009
+ exclude?: string[];
7010
+ include?: string[];
7011
+ }
7012
+ export interface InsightLessAndMoreV2 {
7013
+ less_than?: number;
7014
+ more_than?: number;
7015
+ }
7016
+ export enum InsightOrderDirectionV2 {
7017
+ OrderASC = "asc",
7018
+ OrderDESC = "desc"
7019
+ }
7020
+ export interface InsightOrderingV2 {
7032
7021
  /**
7033
- * @description Edit global index
7034
- * @tags World Markets
7035
- * @name GlobalIndexEdit
7036
- * @summary Edit global index
7037
- * @request PUT:/global-indexes
7038
- * @secure
7022
+ * @default "asc"
7023
+ * @example "asc"
7039
7024
  */
7040
- globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7025
+ direction: InsightOrderingDirectionEnumV2;
7041
7026
  /**
7042
- * @description Add global indexes
7043
- * @tags World Markets
7044
- * @name GlobalIndexAdd
7045
- * @summary Add global indexes
7046
- * @request POST:/global-indexes
7047
- * @secure
7027
+ * Sort direction:
7028
+ * * asc - Ascending, from A to Z.
7029
+ * * desc - Descending, from Z to A.
7030
+ * @example "name"
7048
7031
  */
7049
- globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
7032
+ field: string;
7033
+ }
7034
+ export interface InsightPaginationV2 {
7050
7035
  /**
7051
- * @description Edit global index
7052
- * @tags World Markets
7053
- * @name GlobalIndexDelete
7054
- * @summary Delete global index
7055
- * @request DELETE:/global-indexes
7056
- * @secure
7036
+ * @min 1
7037
+ * @example 1
7057
7038
  */
7058
- globalIndexDelete(query: {
7059
- /** a3 code */
7060
- a3code: string;
7061
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7039
+ page: number;
7062
7040
  /**
7063
- * @description Get regions
7064
- * @tags World Markets
7065
- * @name RegionGet
7066
- * @summary Get regions
7067
- * @request GET:/regions
7068
- * @secure
7041
+ * @min 1
7042
+ * @max 50
7043
+ * @example 10
7069
7044
  */
7070
- regionGet(query: {
7071
- /** Query limit */
7072
- limit: number;
7073
- /** Query offset */
7074
- offset: number;
7075
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
7045
+ size: number;
7046
+ }
7047
+ export interface InsightStockScreenerQuoteV2 {
7048
+ average_volume_30d: number;
7049
+ company_name: string;
7050
+ dividend_ex_date: string;
7051
+ dividend_pay_date: string;
7052
+ dividend_percent: number;
7053
+ exchange: string;
7054
+ exchange_name: string;
7055
+ gap: number;
7056
+ industry: string;
7057
+ industry_code: string;
7058
+ last_price: number;
7059
+ market_cap: number;
7060
+ pe_ratio: number;
7061
+ price_change: number;
7062
+ price_change_percent: number;
7063
+ symbol: string;
7064
+ volume: number;
7065
+ }
7066
+ export interface InsightStockScreenerRequestV2 {
7067
+ average_volume_30d?: InsightLessAndMoreV2;
7068
+ dividend_ex_date?: InsightBeforeAndAfterV2;
7069
+ dividend_pay_date?: InsightBeforeAndAfterV2;
7070
+ dividend_percent?: InsightLessAndMoreV2;
7071
+ exchange?: InsightIncludeExcludeV2;
7072
+ gap?: InsightLessAndMoreV2;
7073
+ industry?: InsightIncludeExcludeV2;
7074
+ market_cap?: InsightLessAndMoreV2;
7075
+ pagination: InsightPaginationV2;
7076
+ pe_ratio?: InsightLessAndMoreV2;
7077
+ price?: InsightLessAndMoreV2;
7078
+ sorts?: InsightOrderingV2[];
7079
+ /** @example "ADR" */
7080
+ stock_type?: string;
7081
+ volume?: InsightLessAndMoreV2;
7082
+ }
7083
+ export interface InsightStockScreenerResponseV2 {
7084
+ current_page: number;
7085
+ data: InsightStockScreenerQuoteV2[];
7086
+ page_count: number;
7087
+ status: number;
7088
+ total_records: number;
7089
+ }
7090
+ /**
7091
+ * @default "asc"
7092
+ * @example "asc"
7093
+ */
7094
+ export enum InsightOrderingDirectionEnumV2 {
7095
+ Asc = "asc",
7096
+ Desc = "desc"
7097
+ }
7098
+ export class FixedIncomeV2<HandleError extends boolean = boolean> {
7099
+ protected readonly apiClient: JwtClient<HandleError>;
7100
+ constructor(apiClient: JwtClient<HandleError>);
7076
7101
  /**
7077
- * @description Edit region
7078
- * @tags World Markets
7079
- * @name RegionEdit
7080
- * @summary Edit region
7081
- * @request PUT:/regions
7102
+ * @description get fixed income entries
7103
+ * @tags FixedIncome
7104
+ * @name GetFixedIncomeEntries
7105
+ * @summary get fixed income entries
7106
+ * @request POST:/fixed-income
7082
7107
  * @secure
7083
7108
  */
7084
- regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7109
+ getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
7110
+ }
7111
+ export class StockScreenerV2<HandleError extends boolean = boolean> {
7112
+ protected readonly apiClient: JwtClient<HandleError>;
7113
+ constructor(apiClient: JwtClient<HandleError>);
7085
7114
  /**
7086
- * @description Create regions
7087
- * @tags World Markets
7088
- * @name RegionCreate
7089
- * @summary Create regions
7090
- * @request POST:/regions
7115
+ * @description filter stocks by params
7116
+ * @tags StockScreener
7117
+ * @name StockScreener
7118
+ * @summary filter stocks by params
7119
+ * @request POST:/stock-screener
7091
7120
  * @secure
7092
7121
  */
7093
- regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
7122
+ stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
7094
7123
  /**
7095
- * @description Delete region
7096
- * @tags World Markets
7097
- * @name RegionDelete
7098
- * @summary Delete region
7099
- * @request DELETE:/regions
7124
+ * @description get top symbols
7125
+ * @tags StockScreener
7126
+ * @name GetTopSymbols
7127
+ * @summary get top symbols
7128
+ * @request POST:/stock-screener/top
7100
7129
  * @secure
7101
7130
  */
7102
- regionDelete(query: {
7103
- /** region id */
7104
- id: string;
7105
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7131
+ getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
7106
7132
  }
7107
7133
  export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
7108
7134
  readonly config: JwtClientConfig<HandleError>;