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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/dist/aesmidas/index.d.ts +433 -302
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +1 -1
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +1 -1
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +5355 -5326
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/insight/index.d.ts +1285 -1272
  14. package/dist/insight/index.d.ts.map +1 -1
  15. package/dist/insight/index.esm.js +1 -1
  16. package/dist/insight/index.esm.js.map +1 -1
  17. package/dist/insight/index.js +1 -1
  18. package/dist/insight/index.js.map +1 -1
  19. package/dist/middleware/index.d.ts +122 -101
  20. package/dist/middleware/index.d.ts.map +1 -1
  21. package/dist/middleware/index.esm.js +1 -1
  22. package/dist/middleware/index.esm.js.map +1 -1
  23. package/dist/middleware/index.js +1 -1
  24. package/dist/middleware/index.js.map +1 -1
  25. package/dist/orbis/index.d.ts +3958 -3958
  26. package/dist/orbis/index.d.ts.map +1 -1
  27. package/dist/orbis/index.esm.js +1 -1
  28. package/dist/orbis/index.esm.js.map +1 -1
  29. package/dist/orbis/index.js +1 -1
  30. package/dist/orbis/index.js.map +1 -1
  31. package/dist/uma/index.d.ts +699 -698
  32. package/dist/uma/index.d.ts.map +1 -1
  33. package/dist/uma/index.esm.js +1 -1
  34. package/dist/uma/index.esm.js.map +1 -1
  35. package/dist/uma/index.js +1 -1
  36. package/dist/uma/index.js.map +1 -1
  37. package/package.json +1 -1
@@ -1213,6 +1213,9 @@ export interface InsightGetFundDetailsResponse {
1213
1213
  fund_net_assets: number;
1214
1214
  fund_type: string;
1215
1215
  holdings: InsightHoldingBreakdown[];
1216
+ inception_date: string;
1217
+ inception_market_price: number;
1218
+ inception_nav: number;
1216
1219
  inverse: boolean;
1217
1220
  leverage: number;
1218
1221
  long_description: string;
@@ -1222,6 +1225,16 @@ export interface InsightGetFundDetailsResponse {
1222
1225
  sectors: InsightSectorBreakdown[];
1223
1226
  structure: string;
1224
1227
  symbol: string;
1228
+ tracking_error_y1: number;
1229
+ trailing_return_m1: number;
1230
+ trailing_return_m3: number;
1231
+ trailing_return_m6: number;
1232
+ trailing_return_y1: number;
1233
+ trailing_return_y10: number;
1234
+ trailing_return_y2: number;
1235
+ trailing_return_y3: number;
1236
+ trailing_return_y5: number;
1237
+ trailing_return_ytd: number;
1225
1238
  website: string;
1226
1239
  }
1227
1240
  export interface InsightGetFundScreenerFiltersResponse {
@@ -4783,28 +4796,6 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
4783
4796
  Date = "date",
4784
4797
  Rank = "rank"
4785
4798
  }
4786
- export class AlphaTools<HandleError extends boolean = boolean> {
4787
- protected readonly apiClient: JwtClient<HandleError>;
4788
- constructor(apiClient: JwtClient<HandleError>);
4789
- /**
4790
- * @description get seasonlity data with comparison to benchmark
4791
- * @tags AlphaTools
4792
- * @name GetMomentumRatioGraph
4793
- * @summary get seasonlity data
4794
- * @request POST:/rst
4795
- * @secure
4796
- */
4797
- getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
4798
- /**
4799
- * @description get seasonlity data with comparison to benchmark
4800
- * @tags AlphaTools
4801
- * @name GetSeasonality
4802
- * @summary get seasonlity data
4803
- * @request POST:/seasonality
4804
- * @secure
4805
- */
4806
- getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
4807
- }
4808
4799
  export class CompanyProfile<HandleError extends boolean = boolean> {
4809
4800
  protected readonly apiClient: JwtClient<HandleError>;
4810
4801
  constructor(apiClient: JwtClient<HandleError>);
@@ -4844,6 +4835,188 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
4844
4835
  */
4845
4836
  getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
4846
4837
  }
4838
+ export class WorldMarkets<HandleError extends boolean = boolean> {
4839
+ protected readonly apiClient: JwtClient<HandleError>;
4840
+ constructor(apiClient: JwtClient<HandleError>);
4841
+ /**
4842
+ * @description Get continents
4843
+ * @tags World Markets
4844
+ * @name ContinentGet
4845
+ * @summary Get continents
4846
+ * @request GET:/continents
4847
+ * @secure
4848
+ */
4849
+ continentGet(query: {
4850
+ /** Query limit */
4851
+ limit: number;
4852
+ /** Query offset */
4853
+ offset: number;
4854
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
4855
+ /**
4856
+ * @description Edit continent
4857
+ * @tags World Markets
4858
+ * @name ContinentEdit
4859
+ * @summary Edit continent
4860
+ * @request PUT:/continents
4861
+ * @secure
4862
+ */
4863
+ continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4864
+ /**
4865
+ * @description Create continents
4866
+ * @tags World Markets
4867
+ * @name ContinentCreate
4868
+ * @summary Create continents
4869
+ * @request POST:/continents
4870
+ * @secure
4871
+ */
4872
+ continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
4873
+ /**
4874
+ * @description Delete continent
4875
+ * @tags World Markets
4876
+ * @name ContinentDelete
4877
+ * @summary Delete continent
4878
+ * @request DELETE:/continents
4879
+ * @secure
4880
+ */
4881
+ continentDelete(query: {
4882
+ /** continent id */
4883
+ id: string;
4884
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4885
+ /**
4886
+ * @description Get country codes
4887
+ * @tags World Markets
4888
+ * @name CountryCodeGet
4889
+ * @summary Get country codes
4890
+ * @request GET:/country-codes
4891
+ * @secure
4892
+ */
4893
+ countryCodeGet(query: {
4894
+ /** Query limit */
4895
+ limit: number;
4896
+ /** Query offset */
4897
+ offset: number;
4898
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
4899
+ /**
4900
+ * @description Edit country code
4901
+ * @tags World Markets
4902
+ * @name CountryCodeEdit
4903
+ * @summary Edit country code
4904
+ * @request PUT:/country-codes
4905
+ * @secure
4906
+ */
4907
+ countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4908
+ /**
4909
+ * @description Add country codes
4910
+ * @tags World Markets
4911
+ * @name CountryCodeAdd
4912
+ * @summary Add country codes
4913
+ * @request POST:/country-codes
4914
+ * @secure
4915
+ */
4916
+ countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
4917
+ /**
4918
+ * @description Delete country code
4919
+ * @tags World Markets
4920
+ * @name CountryCodeDelete
4921
+ * @summary Delete country code
4922
+ * @request DELETE:/country-codes
4923
+ * @secure
4924
+ */
4925
+ countryCodeDelete(query: {
4926
+ /** a3 code */
4927
+ a3code: string;
4928
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4929
+ /**
4930
+ * @description Get global indexes
4931
+ * @tags World Markets
4932
+ * @name GlobalIndexGet
4933
+ * @summary Get global indexes
4934
+ * @request GET:/global-indexes
4935
+ * @secure
4936
+ */
4937
+ globalIndexGet(query: {
4938
+ /** Query limit */
4939
+ limit: number;
4940
+ /** Query offset */
4941
+ offset: number;
4942
+ /** Continent code for filtering */
4943
+ continent?: string;
4944
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
4945
+ /**
4946
+ * @description Edit global index
4947
+ * @tags World Markets
4948
+ * @name GlobalIndexEdit
4949
+ * @summary Edit global index
4950
+ * @request PUT:/global-indexes
4951
+ * @secure
4952
+ */
4953
+ globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4954
+ /**
4955
+ * @description Add global indexes
4956
+ * @tags World Markets
4957
+ * @name GlobalIndexAdd
4958
+ * @summary Add global indexes
4959
+ * @request POST:/global-indexes
4960
+ * @secure
4961
+ */
4962
+ globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
4963
+ /**
4964
+ * @description Edit global index
4965
+ * @tags World Markets
4966
+ * @name GlobalIndexDelete
4967
+ * @summary Delete global index
4968
+ * @request DELETE:/global-indexes
4969
+ * @secure
4970
+ */
4971
+ globalIndexDelete(query: {
4972
+ /** a3 code */
4973
+ a3code: string;
4974
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4975
+ /**
4976
+ * @description Get regions
4977
+ * @tags World Markets
4978
+ * @name RegionGet
4979
+ * @summary Get regions
4980
+ * @request GET:/regions
4981
+ * @secure
4982
+ */
4983
+ regionGet(query: {
4984
+ /** Query limit */
4985
+ limit: number;
4986
+ /** Query offset */
4987
+ offset: number;
4988
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
4989
+ /**
4990
+ * @description Edit region
4991
+ * @tags World Markets
4992
+ * @name RegionEdit
4993
+ * @summary Edit region
4994
+ * @request PUT:/regions
4995
+ * @secure
4996
+ */
4997
+ regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4998
+ /**
4999
+ * @description Create regions
5000
+ * @tags World Markets
5001
+ * @name RegionCreate
5002
+ * @summary Create regions
5003
+ * @request POST:/regions
5004
+ * @secure
5005
+ */
5006
+ regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
5007
+ /**
5008
+ * @description Delete region
5009
+ * @tags World Markets
5010
+ * @name RegionDelete
5011
+ * @summary Delete region
5012
+ * @request DELETE:/regions
5013
+ * @secure
5014
+ */
5015
+ regionDelete(query: {
5016
+ /** region id */
5017
+ id: string;
5018
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5019
+ }
4847
5020
  export class CustomLists<HandleError extends boolean = boolean> {
4848
5021
  protected readonly apiClient: JwtClient<HandleError>;
4849
5022
  constructor(apiClient: JwtClient<HandleError>);
@@ -5131,260 +5304,18 @@ export class FixedIncome<HandleError extends boolean = boolean> {
5131
5304
  */
5132
5305
  getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
5133
5306
  }
5134
- export interface InsightBeforeAndAfterV2 {
5135
- after?: string;
5136
- before?: string;
5137
- }
5138
- export interface InsightFixedIncomeV2 {
5139
- a144: boolean;
5140
- accrued_interest: number;
5141
- bank_qualified: boolean;
5142
- bond_warrant: boolean;
5143
- call_type: string;
5144
- callable: boolean;
5145
- close_price: number;
5146
- close_price_asof: string;
5147
- close_ytw: number;
5148
- convertible: boolean;
5149
- country: string;
5150
- country_code: string;
5151
- country_domicile: string;
5152
- country_issue: string;
5153
- coupon: number;
5154
- coupon_frequency: string;
5155
- coupon_type: string;
5156
- currency: string;
5157
- cusip: string;
5158
- dated_date: string;
5159
- daycount: string;
5160
- description: string;
5161
- description_short: string;
5162
- duration: number;
5163
- first_coupon_date: string;
5164
- insured: boolean;
5165
- isin: string;
5166
- issue_date: string;
5167
- issue_minimum_denomination: number;
5168
- issue_price: number;
5169
- issue_size: number;
5170
- issuer: string;
5171
- last_coupon_date: string;
5172
- liquidity_institutional_aggregate: number;
5173
- liquidity_institutional_buy: number;
5174
- liquidity_institutional_sell: number;
5175
- liquidity_micro_aggregate: number;
5176
- liquidity_micro_buy: number;
5177
- liquidity_micro_sell: number;
5178
- liquidity_retail_aggregate: number;
5179
- liquidity_retail_buy: number;
5180
- liquidity_retail_sell: number;
5181
- maturity_date: string;
5182
- municipal_state: string;
5183
- municipal_taxable_federal: boolean;
5184
- municipal_type: string;
5185
- next_call_date: string;
5186
- next_call_price: number;
5187
- next_coupon_date: string;
5188
- par_value: number;
5189
- perpetual: boolean;
5190
- private_placement: boolean;
5191
- purpose: string;
5192
- puttable: boolean;
5193
- reg_s: boolean;
5194
- sector: string;
5195
- seniority: string;
5196
- settlement_convention: string;
5197
- sinking_fund: boolean;
5198
- sp_creditwatch: string;
5199
- sp_creditwatch_date: string;
5200
- sp_outlook: string;
5201
- sp_outlook_date: string;
5202
- sp_rating: string;
5203
- sp_rating_date: string;
5204
- status: string;
5205
- ticker: string;
5206
- treasury_subtype: string;
5207
- type: string;
5208
- updated_at: string;
5209
- }
5210
- export interface InsightGetFixedIncomeEntriesResponseV2 {
5211
- count: number;
5212
- data: InsightFixedIncomeV2[];
5213
- }
5214
- export interface InsightGetFixedIncomeEntriesRequestV2 {
5215
- /** @example true */
5216
- bank_qualified?: boolean;
5217
- /** @example true */
5218
- callable?: boolean;
5219
- /** @example true */
5220
- convertible?: boolean;
5221
- /** @example ["USA"] */
5222
- country_codes?: string[];
5223
- coupon?: InsightLessAndMoreV2;
5224
- /** @example ["quarterly","zero"] */
5225
- coupon_frequencies?: string[];
5226
- /** @example ["655664AH3","9128286R6"] */
5227
- cusip?: string[];
5228
- /**
5229
- * @maxLength 100
5230
- * @example "Donald's"
5231
- */
5232
- description?: string;
5233
- /** @example true */
5234
- has_ticker?: boolean;
5235
- /** @example true */
5236
- insured?: boolean;
5237
- /** @example ["US655664AH33","US9128286R69"] */
5238
- isin?: string[];
5239
- issue_date?: InsightBeforeAndAfterV2;
5240
- /**
5241
- * @maxLength 100
5242
- * @example "Donald's"
5243
- */
5244
- issuer?: string;
5245
- maturity?: InsightBeforeAndAfterV2;
5246
- /** @example ["NY"] */
5247
- municipal_states?: string[];
5248
- /** @example true */
5249
- municipal_tax?: boolean;
5250
- /** @example ["general_obligation"] */
5251
- municipal_types?: string[];
5252
- pagination: InsightPaginationV2;
5253
- purposes?: string[];
5254
- /** @example ["SOVEREIGN"] */
5255
- sectors?: string[];
5256
- sorts?: InsightOrderingV2[];
5257
- /** @example ["AAA"] */
5258
- sp_ratings?: string[];
5259
- /** @example ["called","outstanding"] */
5260
- statuses?: string[];
5261
- tickers?: string[];
5262
- /** @example ["corporate"] */
5263
- types?: string[];
5264
- }
5265
- export interface InsightGetTopSymbolsRequestV2 {
5266
- exchange?: string[];
5267
- market_cap?: InsightLessAndMoreV2;
5268
- pagination?: InsightPaginationV2;
5269
- price?: InsightLessAndMoreV2;
5270
- sorts?: InsightOrderingV2[];
5271
- volume?: InsightLessAndMoreV2;
5272
- }
5273
- export interface InsightIncludeExcludeV2 {
5274
- exclude?: string[];
5275
- include?: string[];
5276
- }
5277
- export interface InsightLessAndMoreV2 {
5278
- less_than?: number;
5279
- more_than?: number;
5280
- }
5281
- export enum InsightOrderDirectionV2 {
5282
- OrderASC = "asc",
5283
- OrderDESC = "desc"
5284
- }
5285
- export interface InsightOrderingV2 {
5286
- /**
5287
- * @default "asc"
5288
- * @example "asc"
5289
- */
5290
- direction: InsightOrderingDirectionEnumV2;
5291
- /**
5292
- * Sort direction:
5293
- * * asc - Ascending, from A to Z.
5294
- * * desc - Descending, from Z to A.
5295
- * @example "name"
5296
- */
5297
- field: string;
5298
- }
5299
- export interface InsightPaginationV2 {
5300
- /**
5301
- * @min 1
5302
- * @example 1
5303
- */
5304
- page: number;
5305
- /**
5306
- * @min 1
5307
- * @max 50
5308
- * @example 10
5309
- */
5310
- size: number;
5311
- }
5312
- export interface InsightStockScreenerQuoteV2 {
5313
- average_volume_30d: number;
5314
- company_name: string;
5315
- dividend_ex_date: string;
5316
- dividend_pay_date: string;
5317
- dividend_percent: number;
5318
- exchange: string;
5319
- exchange_name: string;
5320
- gap: number;
5321
- industry: string;
5322
- industry_code: string;
5323
- last_price: number;
5324
- market_cap: number;
5325
- pe_ratio: number;
5326
- price_change: number;
5327
- price_change_percent: number;
5328
- symbol: string;
5329
- volume: number;
5330
- }
5331
- export interface InsightStockScreenerRequestV2 {
5332
- average_volume_30d?: InsightLessAndMoreV2;
5333
- dividend_ex_date?: InsightBeforeAndAfterV2;
5334
- dividend_pay_date?: InsightBeforeAndAfterV2;
5335
- dividend_percent?: InsightLessAndMoreV2;
5336
- exchange?: InsightIncludeExcludeV2;
5337
- gap?: InsightLessAndMoreV2;
5338
- industry?: InsightIncludeExcludeV2;
5339
- market_cap?: InsightLessAndMoreV2;
5340
- pagination: InsightPaginationV2;
5341
- pe_ratio?: InsightLessAndMoreV2;
5342
- price?: InsightLessAndMoreV2;
5343
- sorts?: InsightOrderingV2[];
5344
- /** @example "ADR" */
5345
- stock_type?: string;
5346
- volume?: InsightLessAndMoreV2;
5347
- }
5348
- export interface InsightStockScreenerResponseV2 {
5349
- current_page: number;
5350
- data: InsightStockScreenerQuoteV2[];
5351
- page_count: number;
5352
- status: number;
5353
- total_records: number;
5354
- }
5355
- /**
5356
- * @default "asc"
5357
- * @example "asc"
5358
- */
5359
- export enum InsightOrderingDirectionEnumV2 {
5360
- Asc = "asc",
5361
- Desc = "desc"
5362
- }
5363
- export class FixedIncomeV2<HandleError extends boolean = boolean> {
5364
- protected readonly apiClient: JwtClient<HandleError>;
5365
- constructor(apiClient: JwtClient<HandleError>);
5366
- /**
5367
- * @description get fixed income entries
5368
- * @tags FixedIncome
5369
- * @name GetFixedIncomeEntries
5370
- * @summary get fixed income entries
5371
- * @request POST:/fixed-income
5372
- * @secure
5373
- */
5374
- getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
5375
- }
5376
- export class Fundamentals<HandleError extends boolean = boolean> {
5377
- protected readonly apiClient: JwtClient<HandleError>;
5378
- constructor(apiClient: JwtClient<HandleError>);
5379
- /**
5380
- * @description get fundamentals by symbol data
5381
- * @tags Fundamentals
5382
- * @name GetFundamentalsBySymbolData
5383
- * @summary get fundamentals by symbol data
5384
- * @request POST:/fundamentals
5385
- * @secure
5386
- */
5387
- getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
5307
+ export class Fundamentals<HandleError extends boolean = boolean> {
5308
+ protected readonly apiClient: JwtClient<HandleError>;
5309
+ constructor(apiClient: JwtClient<HandleError>);
5310
+ /**
5311
+ * @description get fundamentals by symbol data
5312
+ * @tags Fundamentals
5313
+ * @name GetFundamentalsBySymbolData
5314
+ * @summary get fundamentals by symbol data
5315
+ * @request POST:/fundamentals
5316
+ * @secure
5317
+ */
5318
+ getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
5388
5319
  }
5389
5320
  export class Funds<HandleError extends boolean = boolean> {
5390
5321
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5500,1112 +5431,903 @@ export class Funds<HandleError extends boolean = boolean> {
5500
5431
  Authorization?: string;
5501
5432
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
5502
5433
  }
5503
- export class Intraday<HandleError extends boolean = boolean> {
5434
+ export class StockScreener<HandleError extends boolean = boolean> {
5504
5435
  protected readonly apiClient: JwtClient<HandleError>;
5505
5436
  constructor(apiClient: JwtClient<HandleError>);
5506
5437
  /**
5507
- * @description Returns an array of intraday chart data values for the given ticker.
5508
- * @tags Intraday
5509
- * @name IntradayQuotes
5510
- * @summary Get an array of intraday chart data values for the given ticker
5511
- * @request POST:/intraday/quotes
5438
+ * @description data for visual heat map
5439
+ * @tags StockScreener
5440
+ * @name StockMarketHeatmap
5441
+ * @summary data for visual heat map
5442
+ * @request GET:/heatmaps
5512
5443
  * @secure
5513
5444
  */
5514
- intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
5515
- }
5516
- export class Ipos<HandleError extends boolean = boolean> {
5517
- protected readonly apiClient: JwtClient<HandleError>;
5518
- constructor(apiClient: JwtClient<HandleError>);
5445
+ stockMarketHeatmap(query?: {
5446
+ /** Name of symbol list to fetch details for. Empty is default */
5447
+ heatmap_name?: string;
5448
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
5519
5449
  /**
5520
- * @description get recent ipos info
5521
- * @tags Ipos
5522
- * @name PostRecent
5523
- * @summary get recent ipos info
5524
- * @request POST:/ipos/recent
5450
+ * @description create or update heat map preset
5451
+ * @tags StockScreener
5452
+ * @name CreateStockMarketHeatmapPreset
5453
+ * @summary create or update heat map preset
5454
+ * @request POST:/heatmaps
5525
5455
  * @secure
5526
5456
  */
5527
- postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5457
+ createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5528
5458
  /**
5529
- * @description get upcoming ipos info
5530
- * @tags Ipos
5531
- * @name GetUpcoming
5532
- * @summary get upcoming ipos info
5533
- * @request GET:/ipos/upcoming
5534
- * @secure
5535
- */
5536
- getUpcoming(query: {
5537
- /** how many records to return. Max value is 50 */
5538
- limit: number;
5539
- /** how many records to skip */
5540
- offset: number;
5541
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5542
- /**
5543
- * @description get ipo info by symbol
5544
- * @tags Ipos
5545
- * @name GetIpos
5546
- * @summary get ipo info by symbol
5547
- * @request GET:/ipos/{symbol}
5548
- * @secure
5549
- */
5550
- getIpos(symbol: string, query?: {
5551
- /** load quotes */
5552
- load_quotes?: boolean;
5553
- /** statuses */
5554
- statuses?: string[];
5555
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
5556
- }
5557
- export class Logos<HandleError extends boolean = boolean> {
5558
- protected readonly apiClient: JwtClient<HandleError>;
5559
- constructor(apiClient: JwtClient<HandleError>);
5560
- /**
5561
- * @description Returns converted logo for crypto symbol
5562
- * @tags Logos
5563
- * @name LogosConvertedCryptoSymbolLogo
5564
- * @summary Get converted logo for crypto symbol
5565
- * @request POST:/logos/converted-crypto-symbol-logo
5566
- * @secure
5567
- */
5568
- logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5569
- /**
5570
- * @description Returns converted logo for symbol
5571
- * @tags Logos
5572
- * @name LogosConvertedSymbolLogo
5573
- * @summary Get converted logo for symbol
5574
- * @request POST:/logos/converted-symbol-logo
5459
+ * @description Sector and Industry Group performance
5460
+ * @tags StockScreener
5461
+ * @name IndustriesPerformance
5462
+ * @summary get industries performance
5463
+ * @request POST:/industries-performance
5575
5464
  * @secure
5576
5465
  */
5577
- logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5466
+ industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
5578
5467
  /**
5579
- * @description Returns logo for crypto symbol
5580
- * @tags Logos
5581
- * @name LogosCryptoSymbolLogo
5582
- * @summary Get logo for crypto symbol
5583
- * @request GET:/logos/crypto-symbol-logo
5468
+ * @description filter stocks by params
5469
+ * @tags StockScreener
5470
+ * @name StockScreener
5471
+ * @summary filter stocks by params
5472
+ * @request POST:/stock-screener
5584
5473
  * @secure
5585
5474
  */
5586
- logosCryptoSymbolLogo(query: {
5587
- /** Company symbol */
5588
- symbol: string;
5589
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
5475
+ stockScreener(filter: InsightStockScreenerV1Request, headers?: {
5476
+ /** Authorization */
5477
+ Authorization?: string;
5478
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5590
5479
  /**
5591
- * @description Returns direct logo for crypto symbol
5592
- * @tags Logos
5593
- * @name LogosDirectCryptoSymbolLogo
5594
- * @summary Get direct logo for crypto symbol
5595
- * @request GET:/logos/direct-crypto-symbol-logo
5480
+ * @description get screener presets
5481
+ * @tags StockScreener
5482
+ * @name GetScreenerPresets
5483
+ * @summary get screener presets
5484
+ * @request GET:/stock-screener/presets
5596
5485
  * @secure
5597
5486
  */
5598
- logosDirectCryptoSymbolLogo(query: {
5599
- /** Company symbol */
5600
- symbol: string;
5601
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5487
+ getScreenerPresets(query: {
5488
+ /** how many records to return */
5489
+ limit: number;
5490
+ /** how many records to skip */
5491
+ offset: number;
5492
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
5602
5493
  /**
5603
- * @description Returns direct logo for symbol
5604
- * @tags Logos
5605
- * @name LogosDirectSymbolLogo
5606
- * @summary Get direct logo for symbol
5607
- * @request GET:/logos/direct-symbol-logo
5494
+ * @description update screener preset
5495
+ * @tags StockScreener
5496
+ * @name UpdateScreenerPreset
5497
+ * @summary update screener preset
5498
+ * @request PUT:/stock-screener/presets
5608
5499
  * @secure
5609
5500
  */
5610
- logosDirectSymbolLogo(query: {
5611
- /** Company symbol */
5612
- symbol: string;
5613
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5501
+ updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5614
5502
  /**
5615
- * @description Returns logos for multiple symbols
5616
- * @tags Logos
5617
- * @name LogosMultipleCryptoSymbolLogo
5618
- * @summary Get logos for multiple symbols
5619
- * @request POST:/logos/multiple-crypto-symbol-logo
5503
+ * @description create screener preset
5504
+ * @tags StockScreener
5505
+ * @name CreateOrScreenerPreset
5506
+ * @summary create screener preset
5507
+ * @request POST:/stock-screener/presets
5620
5508
  * @secure
5621
5509
  */
5622
- logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
5510
+ createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5623
5511
  /**
5624
- * @description Returns logos for multiple symbol
5625
- * @tags Logos
5626
- * @name LogosMultipleSymbolLogos
5627
- * @summary Get logos for multiple symbols
5628
- * @request POST:/logos/multiple-symbol-logos
5512
+ * @description remove screener preset
5513
+ * @tags StockScreener
5514
+ * @name RemoveScreenerPreset
5515
+ * @summary remove screener preset
5516
+ * @request DELETE:/stock-screener/presets
5629
5517
  * @secure
5630
5518
  */
5631
- logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
5519
+ removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5632
5520
  /**
5633
- * @description Returns links of socials logos for symbol
5634
- * @tags Logos
5635
- * @name LogosSocialSymbolLogos
5636
- * @summary Get social logos for symbol
5637
- * @request GET:/logos/social-symbol-logos
5521
+ * @description get top symbols
5522
+ * @tags StockScreener
5523
+ * @name GetTopSymbols
5524
+ * @summary get top symbols
5525
+ * @request POST:/stock-screener/top
5638
5526
  * @secure
5639
5527
  */
5640
- logosSocialSymbolLogos(query: {
5641
- /** Company symbol */
5642
- symbol: string;
5643
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
5528
+ getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5529
+ }
5530
+ export class Intraday<HandleError extends boolean = boolean> {
5531
+ protected readonly apiClient: JwtClient<HandleError>;
5532
+ constructor(apiClient: JwtClient<HandleError>);
5644
5533
  /**
5645
- * @description Returns logos for company symbol
5646
- * @tags Logos
5647
- * @name LogosSymbolLogos
5648
- * @summary Get symbol logos
5649
- * @request GET:/logos/symbol-logos
5534
+ * @description Returns an array of intraday chart data values for the given ticker.
5535
+ * @tags Intraday
5536
+ * @name IntradayQuotes
5537
+ * @summary Get an array of intraday chart data values for the given ticker
5538
+ * @request POST:/intraday/quotes
5650
5539
  * @secure
5651
5540
  */
5652
- logosSymbolLogos(query: {
5653
- /** Company symbol */
5654
- symbol: string;
5655
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
5541
+ intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
5656
5542
  }
5657
- export class MarketDates<HandleError extends boolean = boolean> {
5543
+ export class Quotes<HandleError extends boolean = boolean> {
5658
5544
  protected readonly apiClient: JwtClient<HandleError>;
5659
5545
  constructor(apiClient: JwtClient<HandleError>);
5660
5546
  /**
5661
- * @description Create or update market date
5662
- * @tags MarketDates
5663
- * @name CreateOrUpdateMarketDate
5664
- * @summary Create or update market date
5665
- * @request POST:/market-dates
5547
+ * @description Get single historical quote
5548
+ * @tags Quotes
5549
+ * @name GitHistoricalQuote
5550
+ * @summary Get single historical quote
5551
+ * @request GET:/historical/quote
5666
5552
  * @secure
5667
5553
  */
5668
- createOrUpdateMarketDate(market: InsightMarketDates[], config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate[], HandleError>>;
5554
+ gitHistoricalQuote(query: {
5555
+ /** Symbol */
5556
+ symbol: string;
5557
+ /** Date */
5558
+ date: string;
5559
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
5669
5560
  /**
5670
- * @description Remove market date
5671
- * @tags MarketDates
5672
- * @name RemoveMarketDate
5673
- * @summary Remove market date
5674
- * @request DELETE:/market-dates
5561
+ * @description get quote history by symbol
5562
+ * @tags Quotes
5563
+ * @name GitQuoteHistory
5564
+ * @summary Get quote history
5565
+ * @request POST:/quote-history
5675
5566
  * @secure
5676
5567
  */
5677
- removeMarketDate(input: InsightRemoveMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5568
+ gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
5678
5569
  /**
5679
- * @description Get market dates history
5680
- * @tags MarketDates
5681
- * @name GetMarketDatesHistory
5682
- * @summary Get market dates history
5683
- * @request POST:/market-dates/history
5570
+ * @description Returns a list of quotes equity info for specified symbols.
5571
+ * @tags Quotes
5572
+ * @name GetQuotesEquityData
5573
+ * @summary Get Quotes Equity data
5574
+ * @request GET:/quotes/equity
5684
5575
  * @secure
5685
5576
  */
5686
- getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
5577
+ getQuotesEquityData(query: {
5578
+ /** Comma separated symbols */
5579
+ symbols: string;
5580
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
5581
+ }
5582
+ export class PreIpoCompanies<HandleError extends boolean = boolean> {
5583
+ protected readonly apiClient: JwtClient<HandleError>;
5584
+ constructor(apiClient: JwtClient<HandleError>);
5687
5585
  /**
5688
- * @description Search locode data by search string and field
5689
- * @tags MarketDates
5690
- * @name SearchLocodeData
5691
- * @summary Search locode data
5692
- * @request GET:/market-dates/locode
5586
+ * @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
5587
+ * @tags PreIPOCompanies
5588
+ * @name MonarkOghlcDataForSymbol
5589
+ * @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
5590
+ * @request GET:/ipos/market-data/ohlc/{symbol}
5693
5591
  * @secure
5694
5592
  */
5695
- searchLocodeData(query?: {
5696
- /** Search string */
5697
- search?: string;
5698
- /** Search field */
5699
- field?: InsightSearchLocodeDataParamsFieldEnum;
5700
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchLocodeDataResponse, HandleError>>;
5593
+ monarkOghlcDataForSymbol(symbol: string, query?: {
5594
+ /** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
5595
+ from?: string;
5596
+ /** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
5597
+ to?: string;
5598
+ /** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
5599
+ interval?: string;
5600
+ /** Limit the number of OHLC data points returned. Default is 100. */
5601
+ limit?: number;
5602
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
5603
+ close?: number;
5604
+ high?: number;
5605
+ low?: number;
5606
+ open?: number;
5607
+ time?: string;
5608
+ volume?: number;
5609
+ }[], HandleError>>;
5701
5610
  /**
5702
- * @description Get markets
5703
- * @tags MarketDates
5704
- * @name GetMarkets
5705
- * @summary Get markets
5706
- * @request GET:/market-dates/markets
5611
+ * @description Retrieves all symbols available in the market data
5612
+ * @tags PreIPOCompanies
5613
+ * @name MonarkAllAvailableSymbols
5614
+ * @summary Retrieves all symbols available in the market data
5615
+ * @request GET:/ipos/market-data/symbols
5707
5616
  * @secure
5708
5617
  */
5709
- getMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketsResponse, HandleError>>;
5618
+ monarkAllAvailableSymbols(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5710
5619
  /**
5711
- * @description Create or update market
5712
- * @tags MarketDates
5713
- * @name CreateOrUpdateMarket
5714
- * @summary Create or update market
5715
- * @request POST:/market-dates/markets
5716
- * @secure
5717
- */
5718
- createOrUpdateMarket(market: InsightCreateOrUpdateMarketRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
5719
- /**
5720
- * @description Get market
5721
- * @tags MarketDates
5722
- * @name GetMarket
5723
- * @summary Get market
5724
- * @request GET:/market-dates/markets/{market}
5725
- * @secure
5726
- */
5727
- getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketWithSchedule, HandleError>>;
5728
- /**
5729
- * @description Remove market
5730
- * @tags MarketDates
5731
- * @name RemoveMarket
5732
- * @summary Remove market
5733
- * @request DELETE:/market-dates/markets/{market}
5620
+ * @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
5621
+ * @tags PreIPOCompanies
5622
+ * @name GetPreIpoCompanies
5623
+ * @summary get pre ipo companies
5624
+ * @request GET:/ipos/pre-ipo-companies
5734
5625
  * @secure
5735
5626
  */
5736
- removeMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5627
+ getPreIpoCompanies(query: {
5628
+ /** search by company name */
5629
+ name?: string;
5630
+ /** search by categories */
5631
+ categories?: string;
5632
+ /** search by listing type */
5633
+ listing_type?: string;
5634
+ /** filter by active status */
5635
+ is_active?: InsightGetPreIpoCompaniesParamsIsActiveEnum;
5636
+ /** filter by minimum last valuation */
5637
+ min_last_valuation?: number;
5638
+ /** filter by maximum last valuation */
5639
+ max_last_valuation?: number;
5640
+ /** filter by minimum total funding */
5641
+ min_total_funding?: number;
5642
+ /** filter by maximum total funding */
5643
+ max_total_funding?: number;
5644
+ /** how many records to return. Max value is 50 */
5645
+ limit: number;
5646
+ /** how many records to skip */
5647
+ offset: number;
5648
+ /** sort field */
5649
+ order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
5650
+ /** sort direction */
5651
+ order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
5652
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
5737
5653
  /**
5738
- * @description Get market schedules
5739
- * @tags MarketDates
5740
- * @name GetMarketSchedules
5741
- * @summary Get market schedules
5742
- * @request GET:/market-dates/schedule
5654
+ * @description get pre ipo company by id
5655
+ * @tags PreIPOCompanies
5656
+ * @name GetPreIpoCompaniesById
5657
+ * @summary get pre ipo company by id
5658
+ * @request GET:/ipos/pre-ipo-companies/{id}
5659
+ * @originalName getPreIpoCompanies
5660
+ * @duplicate
5743
5661
  * @secure
5744
5662
  */
5745
- getMarketSchedules(query?: {
5746
- /** Market codes, comma separated */
5747
- market?: string;
5748
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError>>;
5663
+ getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
5749
5664
  /**
5750
- * @description CreateOrUpdateMarketSchedule market schedule
5751
- * @tags MarketDates
5752
- * @name CreateOrUpdateMarketSchedule
5753
- * @summary CreateOrUpdateMarketSchedule market schedule
5754
- * @request POST:/market-dates/schedule
5665
+ * @description get pre ipo company funding rounds
5666
+ * @tags PreIPOCompanies
5667
+ * @name GetPreIpoCompanyFundingRounds
5668
+ * @summary get pre ipo company funding rounds
5669
+ * @request GET:/ipos/pre-ipo-company-funding-rounds
5755
5670
  * @secure
5756
5671
  */
5757
- createOrUpdateMarketSchedule(market: InsightCreateOrUpdateMarketScheduleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
5672
+ getPreIpoCompanyFundingRounds(query: {
5673
+ /** company id */
5674
+ pre_ipo_company_id?: string;
5675
+ /** search by round name */
5676
+ round_name?: string;
5677
+ /** how many records to return. Max value is 50 */
5678
+ limit: number;
5679
+ /** how many records to skip */
5680
+ offset: number;
5681
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
5758
5682
  /**
5759
- * @description Get market schedule
5760
- * @tags MarketDates
5761
- * @name GetMarketSchedule
5762
- * @summary Get market schedule
5763
- * @request GET:/market-dates/schedule/{market}
5683
+ * @description get pre ipo company funding round by id
5684
+ * @tags PreIPOCompanies
5685
+ * @name GetPreIpoCompanyFundingRoundsById
5686
+ * @summary get pre ipo company funding round by id
5687
+ * @request GET:/ipos/pre-ipo-company-funding-rounds/{id}
5688
+ * @originalName getPreIpoCompanyFundingRounds
5689
+ * @duplicate
5764
5690
  * @secure
5765
5691
  */
5766
- getMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
5692
+ getPreIpoCompanyFundingRoundsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyFundingRound, HandleError>>;
5767
5693
  /**
5768
- * @description Remove market schedule
5769
- * @tags MarketDates
5770
- * @name RemoveMarketSchedule
5771
- * @summary Remove market schedule
5772
- * @request DELETE:/market-dates/schedule/{market}
5694
+ * @description get pre ipo company investments
5695
+ * @tags PreIPOCompanies
5696
+ * @name GetPreIpoCompanyInvestments
5697
+ * @summary get pre ipo company investments
5698
+ * @request GET:/ipos/pre-ipo-company-investments
5773
5699
  * @secure
5774
5700
  */
5775
- removeMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5701
+ getPreIpoCompanyInvestments(query: {
5702
+ /** company id */
5703
+ pre_ipo_company_id?: string;
5704
+ /** company name */
5705
+ company_name?: string;
5706
+ /** how many records to return. Max value is 50 */
5707
+ limit: number;
5708
+ /** how many records to skip */
5709
+ offset: number;
5710
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
5776
5711
  /**
5777
- * @description Get todays market hours
5778
- * @tags MarketDates
5779
- * @name GetTodaysMarketHours
5780
- * @summary Get todays market hours
5781
- * @request GET:/market-dates/today
5712
+ * @description get pre ipo company investment by id
5713
+ * @tags PreIPOCompanies
5714
+ * @name GetPreIpoCompanyInvestmentsById
5715
+ * @summary get pre ipo company investment by id
5716
+ * @request GET:/ipos/pre-ipo-company-investments/{id}
5717
+ * @originalName getPreIpoCompanyInvestments
5718
+ * @duplicate
5782
5719
  * @secure
5783
5720
  */
5784
- getTodaysMarketHours(query: {
5785
- /** Market */
5786
- market: string;
5787
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
5788
- }
5789
- export class News<HandleError extends boolean = boolean> {
5790
- protected readonly apiClient: JwtClient<HandleError>;
5791
- constructor(apiClient: JwtClient<HandleError>);
5721
+ getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
5792
5722
  /**
5793
- * @description Returns available authors in DB
5794
- * @tags News
5795
- * @name NewsAvailableAuthors
5796
- * @summary Get available authors in DB (for filters)
5797
- * @request POST:/news/authors
5723
+ * @description get pre ipo company news
5724
+ * @tags PreIPOCompanies
5725
+ * @name GetPreIpoCompanyNews
5726
+ * @summary get pre ipo company news
5727
+ * @request GET:/ipos/pre-ipo-company-news
5798
5728
  * @secure
5799
5729
  */
5800
- newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5730
+ getPreIpoCompanyNews(query: {
5731
+ /** company id */
5732
+ pre_ipo_company_id?: string;
5733
+ /** search by headline */
5734
+ headline?: string;
5735
+ /** how many records to return. Max value is 50 */
5736
+ limit: number;
5737
+ /** how many records to skip */
5738
+ offset: number;
5739
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
5801
5740
  /**
5802
- * @description Returns available channels in DB
5803
- * @tags News
5804
- * @name NewsAvailableChannels
5805
- * @summary Get available channels in DB (for filters)
5806
- * @request POST:/news/channels
5741
+ * @description get pre ipo company news by id
5742
+ * @tags PreIPOCompanies
5743
+ * @name GetPreIpoCompanyNewsById
5744
+ * @summary get pre ipo company news by id
5745
+ * @request GET:/ipos/pre-ipo-company-news/{id}
5746
+ * @originalName getPreIpoCompanyNews
5747
+ * @duplicate
5807
5748
  * @secure
5808
5749
  */
5809
- newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5750
+ getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
5810
5751
  /**
5811
- * @description Get featured articles
5812
- * @tags News
5813
- * @name GetFeaturedArticles
5814
- * @summary Get featured articles
5815
- * @request GET:/news/featured-articles
5752
+ * @description get pre ipo company research documents
5753
+ * @tags PreIPOCompanies
5754
+ * @name GetPreIpoCompanyResearchDocuments
5755
+ * @summary get pre ipo company research documents
5756
+ * @request GET:/ipos/pre-ipo-company-research-documents
5816
5757
  * @secure
5817
5758
  */
5818
- getFeaturedArticles(query: {
5819
- /** Limit */
5759
+ getPreIpoCompanyResearchDocuments(query: {
5760
+ /** company id */
5761
+ pre_ipo_company_id?: string;
5762
+ /** search by title */
5763
+ title?: string;
5764
+ /** how many records to return. Max value is 50 */
5820
5765
  limit: number;
5821
- /** Offset */
5766
+ /** how many records to skip */
5822
5767
  offset: number;
5823
- /** Start date */
5824
- start_date?: string;
5825
- /** End date */
5826
- end_date?: string;
5827
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
5768
+ /** search by research type */
5769
+ research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
5770
+ /** search by relation */
5771
+ relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
5772
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
5828
5773
  /**
5829
- * @description Update featured articles
5830
- * @tags News
5831
- * @name UpdateFeaturedArticles
5832
- * @summary Update featured articles
5833
- * @request PUT:/news/featured-articles
5774
+ * @description get pre ipo company research document by id
5775
+ * @tags PreIPOCompanies
5776
+ * @name GetPreIpoCompanyResearchDocumentsById
5777
+ * @summary get pre ipo company research document by id
5778
+ * @request GET:/ipos/pre-ipo-company-research-documents/{id}
5779
+ * @originalName getPreIpoCompanyResearchDocuments
5780
+ * @duplicate
5834
5781
  * @secure
5835
5782
  */
5836
- updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5783
+ getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
5837
5784
  /**
5838
- * @description Create featured articles
5839
- * @tags News
5840
- * @name CreateFeaturedArticles
5841
- * @summary Create featured articles
5842
- * @request POST:/news/featured-articles
5785
+ * @description get pre ipo company spvs with investor id
5786
+ * @tags PreIPOCompanies
5787
+ * @name GetInvestor
5788
+ * @summary get pre ipo company spvs with investor id
5789
+ * @request GET:/ipos/pre-ipo-company-spv/investor/{investor_id}
5843
5790
  * @secure
5844
5791
  */
5845
- createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5792
+ getInvestor(investorId: string, query: {
5793
+ /** search by monark stage */
5794
+ monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
5795
+ /** Optional param to filter returned spv's based on the exemptions claimed */
5796
+ exemptions_claimed?: string[];
5797
+ /** Optional param to filter returned spv's based on the name */
5798
+ name_filter?: string;
5799
+ /** investment id */
5800
+ pre_ipo_company_id?: string;
5801
+ /** investment id */
5802
+ pre_ipo_company_investment_id?: string;
5803
+ /** page number */
5804
+ page: number;
5805
+ /** page size */
5806
+ page_size: number;
5807
+ /** sort direction */
5808
+ sort_order?: InsightGetInvestorParamsSortOrderEnum;
5809
+ /** sort field */
5810
+ sort_by?: InsightGetInvestorParamsSortByEnum;
5811
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
5846
5812
  /**
5847
- * @description Get active featured articles
5848
- * @tags News
5849
- * @name GetActiveFeaturedArticles
5850
- * @summary Get active featured articles
5851
- * @request GET:/news/featured-articles/active
5852
- * @secure
5853
- */
5854
- getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
5855
- /**
5856
- * @description Set featured articles
5857
- * @tags News
5858
- * @name SetFeaturedArticles
5859
- * @summary Set featured articles
5860
- * @request POST:/news/featured-articles/set
5813
+ * @description get pre ipo company spv by id with investor id
5814
+ * @tags PreIPOCompanies
5815
+ * @name GetInvestorByIdAndInvestorId
5816
+ * @summary get pre ipo company spv by id with investor id
5817
+ * @request GET:/ipos/pre-ipo-company-spv/{id}/investor/{investor_id}
5818
+ * @originalName getInvestor
5819
+ * @duplicate
5861
5820
  * @secure
5862
5821
  */
5863
- setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5822
+ getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
5823
+ /** default is false, if true documents will be included in the response */
5824
+ include_documents?: boolean;
5825
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
5864
5826
  /**
5865
- * @description Get featured article
5866
- * @tags News
5867
- * @name GetFeaturedArticle
5868
- * @summary Get featured article
5869
- * @request GET:/news/featured-articles/{id}
5827
+ * @description get pre ipo company spvs
5828
+ * @tags PreIPOCompanies
5829
+ * @name GetPreIpoCompanySpvs
5830
+ * @summary get pre ipo company spvs
5831
+ * @request GET:/ipos/pre-ipo-company-spvs
5870
5832
  * @secure
5871
5833
  */
5872
- getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
5834
+ getPreIpoCompanySpvs(query: {
5835
+ /** company id */
5836
+ pre_ipo_company_id?: string;
5837
+ /** investment id */
5838
+ investment_id?: string;
5839
+ /** search by name */
5840
+ name?: string;
5841
+ /** search by company name */
5842
+ company_name?: string;
5843
+ /** how many records to return. Max value is 50 */
5844
+ limit: number;
5845
+ /** how many records to skip */
5846
+ offset: number;
5847
+ /** search by monark stage */
5848
+ monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
5849
+ /** sort direction */
5850
+ direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
5851
+ /** sort field */
5852
+ field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
5853
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
5873
5854
  /**
5874
- * @description Returns news by filters
5875
- * @tags News
5876
- * @name NewsFiltered
5877
- * @summary Get filtered news
5878
- * @request POST:/news/filter
5855
+ * @description get pre ipo company spv by id
5856
+ * @tags PreIPOCompanies
5857
+ * @name GetPreIpoCompanySpvsById
5858
+ * @summary get pre ipo company spv by id
5859
+ * @request GET:/ipos/pre-ipo-company-spvs/{id}
5860
+ * @originalName getPreIpoCompanySpvs
5861
+ * @duplicate
5879
5862
  * @secure
5880
5863
  */
5881
- newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
5864
+ getPreIpoCompanySpvsById(id: string, query?: {
5865
+ /** default is false, if true documents will be included in the response */
5866
+ include_documents?: boolean;
5867
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
5868
+ }
5869
+ export class Ipos<HandleError extends boolean = boolean> {
5870
+ protected readonly apiClient: JwtClient<HandleError>;
5871
+ constructor(apiClient: JwtClient<HandleError>);
5882
5872
  /**
5883
- * @description Returns news by id
5884
- * @tags News
5885
- * @name NewsById
5886
- * @summary Get news by id
5887
- * @request POST:/news/id
5873
+ * @description get recent ipos info
5874
+ * @tags Ipos
5875
+ * @name PostRecent
5876
+ * @summary get recent ipos info
5877
+ * @request POST:/ipos/recent
5888
5878
  * @secure
5889
5879
  */
5890
- newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
5880
+ postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5891
5881
  /**
5892
- * @description Returns news previews
5893
- * @tags News
5894
- * @name NewsPreviewsFiltered
5895
- * @summary Get news previews
5896
- * @request GET:/news/previews
5882
+ * @description get upcoming ipos info
5883
+ * @tags Ipos
5884
+ * @name GetUpcoming
5885
+ * @summary get upcoming ipos info
5886
+ * @request GET:/ipos/upcoming
5897
5887
  * @secure
5898
5888
  */
5899
- newsPreviewsFiltered(query: {
5900
- /** Start date */
5901
- start_date?: string;
5902
- /** End date */
5903
- end_date?: string;
5904
- /** Symbol */
5905
- symbol?: string;
5889
+ getUpcoming(query: {
5906
5890
  /** how many records to return. Max value is 50 */
5907
5891
  limit: number;
5908
5892
  /** how many records to skip */
5909
5893
  offset: number;
5910
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
5911
- /**
5912
- * @description Returns available stocks in DB
5913
- * @tags News
5914
- * @name NewsAvailableStocks
5915
- * @summary Get available stocks in DB (for filters)
5916
- * @request GET:/news/symbols
5917
- * @secure
5918
- */
5919
- newsAvailableStocks(query?: {
5920
- /** Limit */
5921
- limit?: number;
5922
- /** Offset */
5923
- offset?: number;
5924
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5894
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5925
5895
  /**
5926
- * @description Returns available tags in DB
5927
- * @tags News
5928
- * @name NewsAvailableTags
5929
- * @summary Get available tags in DB (for filters)
5930
- * @request POST:/news/tags
5896
+ * @description get ipo info by symbol
5897
+ * @tags Ipos
5898
+ * @name GetIpos
5899
+ * @summary get ipo info by symbol
5900
+ * @request GET:/ipos/{symbol}
5931
5901
  * @secure
5932
5902
  */
5933
- newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5903
+ getIpos(symbol: string, query?: {
5904
+ /** load quotes */
5905
+ load_quotes?: boolean;
5906
+ /** statuses */
5907
+ statuses?: string[];
5908
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
5934
5909
  }
5935
- export class OptionGreeks<HandleError extends boolean = boolean> {
5910
+ export class Logos<HandleError extends boolean = boolean> {
5936
5911
  protected readonly apiClient: JwtClient<HandleError>;
5937
5912
  constructor(apiClient: JwtClient<HandleError>);
5938
5913
  /**
5939
- * @description Returns calculated matrix
5940
- * @tags OptionGreeks
5941
- * @name OgCalculateMatrix
5942
- * @summary Calculate matrix
5943
- * @request POST:/og/calculate-matrix
5914
+ * @description Returns converted logo for crypto symbol
5915
+ * @tags Logos
5916
+ * @name LogosConvertedCryptoSymbolLogo
5917
+ * @summary Get converted logo for crypto symbol
5918
+ * @request POST:/logos/converted-crypto-symbol-logo
5944
5919
  * @secure
5945
5920
  */
5946
- ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
5921
+ logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5947
5922
  /**
5948
- * @description Returns calculated params
5949
- * @tags OptionGreeks
5950
- * @name OgCalculateParams
5951
- * @summary Calculate params
5952
- * @request POST:/og/calculate-params
5923
+ * @description Returns converted logo for symbol
5924
+ * @tags Logos
5925
+ * @name LogosConvertedSymbolLogo
5926
+ * @summary Get converted logo for symbol
5927
+ * @request POST:/logos/converted-symbol-logo
5953
5928
  * @secure
5954
5929
  */
5955
- ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
5956
- }
5957
- export class Ownerships<HandleError extends boolean = boolean> {
5958
- protected readonly apiClient: JwtClient<HandleError>;
5959
- constructor(apiClient: JwtClient<HandleError>);
5930
+ logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5960
5931
  /**
5961
- * @description get ownerships by id datadata
5962
- * @tags Ownerships
5963
- * @name GetOwnershipsByIdData
5964
- * @summary get ownerships by id data
5965
- * @request POST:/ownerships
5932
+ * @description Returns logo for crypto symbol
5933
+ * @tags Logos
5934
+ * @name LogosCryptoSymbolLogo
5935
+ * @summary Get logo for crypto symbol
5936
+ * @request GET:/logos/crypto-symbol-logo
5966
5937
  * @secure
5967
5938
  */
5968
- getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5939
+ logosCryptoSymbolLogo(query: {
5940
+ /** Company symbol */
5941
+ symbol: string;
5942
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
5969
5943
  /**
5970
- * @description get ownerships by symbol data
5971
- * @tags Ownerships
5972
- * @name GetOwnershipsBySymbolData
5973
- * @summary get ownerships by symbol data
5974
- * @request POST:/symbol-ownerships
5944
+ * @description Returns direct logo for crypto symbol
5945
+ * @tags Logos
5946
+ * @name LogosDirectCryptoSymbolLogo
5947
+ * @summary Get direct logo for crypto symbol
5948
+ * @request GET:/logos/direct-crypto-symbol-logo
5975
5949
  * @secure
5976
5950
  */
5977
- getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5978
- }
5979
- export class Passport<HandleError extends boolean = boolean> {
5980
- protected readonly apiClient: JwtClient<HandleError>;
5981
- constructor(apiClient: JwtClient<HandleError>);
5951
+ logosDirectCryptoSymbolLogo(query: {
5952
+ /** Company symbol */
5953
+ symbol: string;
5954
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5982
5955
  /**
5983
- * @description Returns article by id
5984
- * @tags Passport
5985
- * @name PassportArticleById
5986
- * @summary Get article by id
5987
- * @request POST:/passport/article-by-id
5956
+ * @description Returns direct logo for symbol
5957
+ * @tags Logos
5958
+ * @name LogosDirectSymbolLogo
5959
+ * @summary Get direct logo for symbol
5960
+ * @request GET:/logos/direct-symbol-logo
5988
5961
  * @secure
5989
5962
  */
5990
- passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
5963
+ logosDirectSymbolLogo(query: {
5964
+ /** Company symbol */
5965
+ symbol: string;
5966
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5991
5967
  /**
5992
- * @description Returns articles
5993
- * @tags Passport
5994
- * @name PassportArticles
5995
- * @summary Get articles
5996
- * @request POST:/passport/articles
5968
+ * @description Returns logos for multiple symbols
5969
+ * @tags Logos
5970
+ * @name LogosMultipleCryptoSymbolLogo
5971
+ * @summary Get logos for multiple symbols
5972
+ * @request POST:/logos/multiple-crypto-symbol-logo
5997
5973
  * @secure
5998
5974
  */
5999
- passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
5975
+ logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
6000
5976
  /**
6001
- * @description Returns author profile
6002
- * @tags Passport
6003
- * @name PassportAuthorProfile
6004
- * @summary Get author profile
6005
- * @request POST:/passport/author-profile
5977
+ * @description Returns logos for multiple symbol
5978
+ * @tags Logos
5979
+ * @name LogosMultipleSymbolLogos
5980
+ * @summary Get logos for multiple symbols
5981
+ * @request POST:/logos/multiple-symbol-logos
6006
5982
  * @secure
6007
5983
  */
6008
- passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
5984
+ logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
6009
5985
  /**
6010
- * @description Returns most popular tags
6011
- * @tags Passport
6012
- * @name PassportMostPopularTags
6013
- * @summary Get most popular tags
6014
- * @request POST:/passport/most-popular-tags
5986
+ * @description Returns links of socials logos for symbol
5987
+ * @tags Logos
5988
+ * @name LogosSocialSymbolLogos
5989
+ * @summary Get social logos for symbol
5990
+ * @request GET:/logos/social-symbol-logos
6015
5991
  * @secure
6016
5992
  */
6017
- passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
5993
+ logosSocialSymbolLogos(query: {
5994
+ /** Company symbol */
5995
+ symbol: string;
5996
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
6018
5997
  /**
6019
- * @description Returns news feed
6020
- * @tags Passport
6021
- * @name PassportNewsFeed
6022
- * @summary Get news feed
6023
- * @request POST:/passport/newsfeed
6024
- * @secure
6025
- */
6026
- passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
6027
- /**
6028
- * @description Returns article by parameters
6029
- * @tags Passport
6030
- * @name PassportSearchArticle
6031
- * @summary Search article by parameters
6032
- * @request POST:/passport/search-article
5998
+ * @description Returns logos for company symbol
5999
+ * @tags Logos
6000
+ * @name LogosSymbolLogos
6001
+ * @summary Get symbol logos
6002
+ * @request GET:/logos/symbol-logos
6033
6003
  * @secure
6034
6004
  */
6035
- passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6005
+ logosSymbolLogos(query: {
6006
+ /** Company symbol */
6007
+ symbol: string;
6008
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
6036
6009
  }
6037
- export class PreIpoCompanies<HandleError extends boolean = boolean> {
6010
+ export class MarketDates<HandleError extends boolean = boolean> {
6038
6011
  protected readonly apiClient: JwtClient<HandleError>;
6039
6012
  constructor(apiClient: JwtClient<HandleError>);
6040
6013
  /**
6041
- * @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
6042
- * @tags PreIPOCompanies
6043
- * @name MonarkOghlcDataForSymbol
6044
- * @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
6045
- * @request GET:/ipos/market-data/ohlc/{symbol}
6014
+ * @description Create or update market date
6015
+ * @tags MarketDates
6016
+ * @name CreateOrUpdateMarketDate
6017
+ * @summary Create or update market date
6018
+ * @request POST:/market-dates
6046
6019
  * @secure
6047
6020
  */
6048
- monarkOghlcDataForSymbol(symbol: string, query?: {
6049
- /** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
6050
- from?: string;
6051
- /** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
6052
- to?: string;
6053
- /** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
6054
- interval?: string;
6055
- /** Limit the number of OHLC data points returned. Default is 100. */
6056
- limit?: number;
6057
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
6058
- close?: number;
6059
- high?: number;
6060
- low?: number;
6061
- open?: number;
6062
- time?: string;
6063
- volume?: number;
6064
- }[], HandleError>>;
6021
+ createOrUpdateMarketDate(market: InsightMarketDates[], config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate[], HandleError>>;
6065
6022
  /**
6066
- * @description Retrieves all symbols available in the market data
6067
- * @tags PreIPOCompanies
6068
- * @name MonarkAllAvailableSymbols
6069
- * @summary Retrieves all symbols available in the market data
6070
- * @request GET:/ipos/market-data/symbols
6023
+ * @description Remove market date
6024
+ * @tags MarketDates
6025
+ * @name RemoveMarketDate
6026
+ * @summary Remove market date
6027
+ * @request DELETE:/market-dates
6071
6028
  * @secure
6072
6029
  */
6073
- monarkAllAvailableSymbols(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6030
+ removeMarketDate(input: InsightRemoveMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6074
6031
  /**
6075
- * @description get pre ipo companies Avaliable categories: on-demand business-video reverse-etl modern-data-stack video-api global-payroll banking-as-a-service ultrafast-delivery online-grocery website-builder fintech b2b venture-capital ecommerce creator-economy productivity real-estate private-markets-exchanges fpa vertical-saas card-issuing connected-fitness gig-marketplaces cms soc-2 analytics cap-table-management contractor-payroll social-media design online-whiteboard conversational-marketing expense-management stock-option-financing customer-onboarding crypto help-desk payroll documents databases mortgage-lending crypto-exchange marketing-automation payments operations checkout cybersecurity messaging investing marketplaces climate-tech robotics data-security online-education gaming universal-api automation biotechnology contact-center defense machine-learning logistics prefab-tech materials telehealth b2c alternative-proteins b2b-marketplaces wealth-management web3 neobank managed-marketplaces plg-crm jamstack public-safety background-checks identity-verification construction home-services sales blockchain-developer-platform space financial-data-aggregation ai writing-assistant autonomous-driving 401k-provider vector-databases ai-models devtools payroll-api internal-tools mlops bookkeeping cloud-infrastructure data-backups personal-finance ai-frameworks generative-ai cloud-gpus micromobility ai-avatars ai-chips life-sciences partnerships wearables fitness-tracking ai-search ai-medical-scribes networking quantum-computing code-editors
6076
- * @tags PreIPOCompanies
6077
- * @name GetPreIpoCompanies
6078
- * @summary get pre ipo companies
6079
- * @request GET:/ipos/pre-ipo-companies
6032
+ * @description Get market dates history
6033
+ * @tags MarketDates
6034
+ * @name GetMarketDatesHistory
6035
+ * @summary Get market dates history
6036
+ * @request POST:/market-dates/history
6080
6037
  * @secure
6081
6038
  */
6082
- getPreIpoCompanies(query: {
6083
- /** search by company name */
6084
- name?: string;
6085
- /** search by categories */
6086
- categories?: string;
6087
- /** search by listing type */
6088
- listing_type?: string;
6089
- /** filter by active status */
6090
- is_active?: InsightGetPreIpoCompaniesParamsIsActiveEnum;
6091
- /** filter by minimum last valuation */
6092
- min_last_valuation?: number;
6093
- /** filter by maximum last valuation */
6094
- max_last_valuation?: number;
6095
- /** filter by minimum total funding */
6096
- min_total_funding?: number;
6097
- /** filter by maximum total funding */
6098
- max_total_funding?: number;
6099
- /** how many records to return. Max value is 50 */
6100
- limit: number;
6101
- /** how many records to skip */
6102
- offset: number;
6103
- /** sort field */
6104
- order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
6105
- /** sort direction */
6106
- order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
6107
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
6039
+ getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
6108
6040
  /**
6109
- * @description get pre ipo company by id
6110
- * @tags PreIPOCompanies
6111
- * @name GetPreIpoCompaniesById
6112
- * @summary get pre ipo company by id
6113
- * @request GET:/ipos/pre-ipo-companies/{id}
6114
- * @originalName getPreIpoCompanies
6115
- * @duplicate
6041
+ * @description Search locode data by search string and field
6042
+ * @tags MarketDates
6043
+ * @name SearchLocodeData
6044
+ * @summary Search locode data
6045
+ * @request GET:/market-dates/locode
6116
6046
  * @secure
6117
6047
  */
6118
- getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
6048
+ searchLocodeData(query?: {
6049
+ /** Search string */
6050
+ search?: string;
6051
+ /** Search field */
6052
+ field?: InsightSearchLocodeDataParamsFieldEnum;
6053
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchLocodeDataResponse, HandleError>>;
6119
6054
  /**
6120
- * @description get pre ipo company funding rounds
6121
- * @tags PreIPOCompanies
6122
- * @name GetPreIpoCompanyFundingRounds
6123
- * @summary get pre ipo company funding rounds
6124
- * @request GET:/ipos/pre-ipo-company-funding-rounds
6055
+ * @description Get markets
6056
+ * @tags MarketDates
6057
+ * @name GetMarkets
6058
+ * @summary Get markets
6059
+ * @request GET:/market-dates/markets
6125
6060
  * @secure
6126
6061
  */
6127
- getPreIpoCompanyFundingRounds(query: {
6128
- /** company id */
6129
- pre_ipo_company_id?: string;
6130
- /** search by round name */
6131
- round_name?: string;
6132
- /** how many records to return. Max value is 50 */
6133
- limit: number;
6134
- /** how many records to skip */
6135
- offset: number;
6136
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
6062
+ getMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketsResponse, HandleError>>;
6137
6063
  /**
6138
- * @description get pre ipo company funding round by id
6139
- * @tags PreIPOCompanies
6140
- * @name GetPreIpoCompanyFundingRoundsById
6141
- * @summary get pre ipo company funding round by id
6142
- * @request GET:/ipos/pre-ipo-company-funding-rounds/{id}
6143
- * @originalName getPreIpoCompanyFundingRounds
6144
- * @duplicate
6064
+ * @description Create or update market
6065
+ * @tags MarketDates
6066
+ * @name CreateOrUpdateMarket
6067
+ * @summary Create or update market
6068
+ * @request POST:/market-dates/markets
6145
6069
  * @secure
6146
6070
  */
6147
- getPreIpoCompanyFundingRoundsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyFundingRound, HandleError>>;
6071
+ createOrUpdateMarket(market: InsightCreateOrUpdateMarketRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
6148
6072
  /**
6149
- * @description get pre ipo company investments
6150
- * @tags PreIPOCompanies
6151
- * @name GetPreIpoCompanyInvestments
6152
- * @summary get pre ipo company investments
6153
- * @request GET:/ipos/pre-ipo-company-investments
6073
+ * @description Get market
6074
+ * @tags MarketDates
6075
+ * @name GetMarket
6076
+ * @summary Get market
6077
+ * @request GET:/market-dates/markets/{market}
6154
6078
  * @secure
6155
6079
  */
6156
- getPreIpoCompanyInvestments(query: {
6157
- /** company id */
6158
- pre_ipo_company_id?: string;
6159
- /** company name */
6160
- company_name?: string;
6161
- /** how many records to return. Max value is 50 */
6162
- limit: number;
6163
- /** how many records to skip */
6164
- offset: number;
6165
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
6080
+ getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketWithSchedule, HandleError>>;
6166
6081
  /**
6167
- * @description get pre ipo company investment by id
6168
- * @tags PreIPOCompanies
6169
- * @name GetPreIpoCompanyInvestmentsById
6170
- * @summary get pre ipo company investment by id
6171
- * @request GET:/ipos/pre-ipo-company-investments/{id}
6172
- * @originalName getPreIpoCompanyInvestments
6173
- * @duplicate
6082
+ * @description Remove market
6083
+ * @tags MarketDates
6084
+ * @name RemoveMarket
6085
+ * @summary Remove market
6086
+ * @request DELETE:/market-dates/markets/{market}
6174
6087
  * @secure
6175
6088
  */
6176
- getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
6089
+ removeMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6177
6090
  /**
6178
- * @description get pre ipo company news
6179
- * @tags PreIPOCompanies
6180
- * @name GetPreIpoCompanyNews
6181
- * @summary get pre ipo company news
6182
- * @request GET:/ipos/pre-ipo-company-news
6091
+ * @description Get market schedules
6092
+ * @tags MarketDates
6093
+ * @name GetMarketSchedules
6094
+ * @summary Get market schedules
6095
+ * @request GET:/market-dates/schedule
6183
6096
  * @secure
6184
6097
  */
6185
- getPreIpoCompanyNews(query: {
6186
- /** company id */
6187
- pre_ipo_company_id?: string;
6188
- /** search by headline */
6189
- headline?: string;
6190
- /** how many records to return. Max value is 50 */
6191
- limit: number;
6192
- /** how many records to skip */
6193
- offset: number;
6194
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
6098
+ getMarketSchedules(query?: {
6099
+ /** Market codes, comma separated */
6100
+ market?: string;
6101
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError>>;
6195
6102
  /**
6196
- * @description get pre ipo company news by id
6197
- * @tags PreIPOCompanies
6198
- * @name GetPreIpoCompanyNewsById
6199
- * @summary get pre ipo company news by id
6200
- * @request GET:/ipos/pre-ipo-company-news/{id}
6201
- * @originalName getPreIpoCompanyNews
6202
- * @duplicate
6103
+ * @description CreateOrUpdateMarketSchedule market schedule
6104
+ * @tags MarketDates
6105
+ * @name CreateOrUpdateMarketSchedule
6106
+ * @summary CreateOrUpdateMarketSchedule market schedule
6107
+ * @request POST:/market-dates/schedule
6203
6108
  * @secure
6204
6109
  */
6205
- getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
6110
+ createOrUpdateMarketSchedule(market: InsightCreateOrUpdateMarketScheduleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
6206
6111
  /**
6207
- * @description get pre ipo company research documents
6208
- * @tags PreIPOCompanies
6209
- * @name GetPreIpoCompanyResearchDocuments
6210
- * @summary get pre ipo company research documents
6211
- * @request GET:/ipos/pre-ipo-company-research-documents
6112
+ * @description Get market schedule
6113
+ * @tags MarketDates
6114
+ * @name GetMarketSchedule
6115
+ * @summary Get market schedule
6116
+ * @request GET:/market-dates/schedule/{market}
6212
6117
  * @secure
6213
6118
  */
6214
- getPreIpoCompanyResearchDocuments(query: {
6215
- /** company id */
6216
- pre_ipo_company_id?: string;
6217
- /** search by title */
6218
- title?: string;
6219
- /** how many records to return. Max value is 50 */
6220
- limit: number;
6221
- /** how many records to skip */
6222
- offset: number;
6223
- /** search by research type */
6224
- research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
6225
- /** search by relation */
6226
- relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
6227
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
6119
+ getMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
6228
6120
  /**
6229
- * @description get pre ipo company research document by id
6230
- * @tags PreIPOCompanies
6231
- * @name GetPreIpoCompanyResearchDocumentsById
6232
- * @summary get pre ipo company research document by id
6233
- * @request GET:/ipos/pre-ipo-company-research-documents/{id}
6234
- * @originalName getPreIpoCompanyResearchDocuments
6235
- * @duplicate
6121
+ * @description Remove market schedule
6122
+ * @tags MarketDates
6123
+ * @name RemoveMarketSchedule
6124
+ * @summary Remove market schedule
6125
+ * @request DELETE:/market-dates/schedule/{market}
6236
6126
  * @secure
6237
6127
  */
6238
- getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
6128
+ removeMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6239
6129
  /**
6240
- * @description get pre ipo company spvs with investor id
6241
- * @tags PreIPOCompanies
6242
- * @name GetInvestor
6243
- * @summary get pre ipo company spvs with investor id
6244
- * @request GET:/ipos/pre-ipo-company-spv/investor/{investor_id}
6130
+ * @description Get todays market hours
6131
+ * @tags MarketDates
6132
+ * @name GetTodaysMarketHours
6133
+ * @summary Get todays market hours
6134
+ * @request GET:/market-dates/today
6245
6135
  * @secure
6246
6136
  */
6247
- getInvestor(investorId: string, query: {
6248
- /** search by monark stage */
6249
- monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
6250
- /** Optional param to filter returned spv's based on the exemptions claimed */
6251
- exemptions_claimed?: string[];
6252
- /** Optional param to filter returned spv's based on the name */
6253
- name_filter?: string;
6254
- /** investment id */
6255
- pre_ipo_company_id?: string;
6256
- /** investment id */
6257
- pre_ipo_company_investment_id?: string;
6258
- /** page number */
6259
- page: number;
6260
- /** page size */
6261
- page_size: number;
6262
- /** sort direction */
6263
- sort_order?: InsightGetInvestorParamsSortOrderEnum;
6264
- /** sort field */
6265
- sort_by?: InsightGetInvestorParamsSortByEnum;
6266
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
6137
+ getTodaysMarketHours(query: {
6138
+ /** Market */
6139
+ market: string;
6140
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
6141
+ }
6142
+ export class News<HandleError extends boolean = boolean> {
6143
+ protected readonly apiClient: JwtClient<HandleError>;
6144
+ constructor(apiClient: JwtClient<HandleError>);
6267
6145
  /**
6268
- * @description get pre ipo company spv by id with investor id
6269
- * @tags PreIPOCompanies
6270
- * @name GetInvestorByIdAndInvestorId
6271
- * @summary get pre ipo company spv by id with investor id
6272
- * @request GET:/ipos/pre-ipo-company-spv/{id}/investor/{investor_id}
6273
- * @originalName getInvestor
6274
- * @duplicate
6146
+ * @description Returns available authors in DB
6147
+ * @tags News
6148
+ * @name NewsAvailableAuthors
6149
+ * @summary Get available authors in DB (for filters)
6150
+ * @request POST:/news/authors
6275
6151
  * @secure
6276
6152
  */
6277
- getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
6278
- /** default is false, if true documents will be included in the response */
6279
- include_documents?: boolean;
6280
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
6153
+ newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6281
6154
  /**
6282
- * @description get pre ipo company spvs
6283
- * @tags PreIPOCompanies
6284
- * @name GetPreIpoCompanySpvs
6285
- * @summary get pre ipo company spvs
6286
- * @request GET:/ipos/pre-ipo-company-spvs
6155
+ * @description Returns available channels in DB
6156
+ * @tags News
6157
+ * @name NewsAvailableChannels
6158
+ * @summary Get available channels in DB (for filters)
6159
+ * @request POST:/news/channels
6287
6160
  * @secure
6288
6161
  */
6289
- getPreIpoCompanySpvs(query: {
6290
- /** company id */
6291
- pre_ipo_company_id?: string;
6292
- /** investment id */
6293
- investment_id?: string;
6294
- /** search by name */
6295
- name?: string;
6296
- /** search by company name */
6297
- company_name?: string;
6298
- /** how many records to return. Max value is 50 */
6162
+ newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6163
+ /**
6164
+ * @description Get featured articles
6165
+ * @tags News
6166
+ * @name GetFeaturedArticles
6167
+ * @summary Get featured articles
6168
+ * @request GET:/news/featured-articles
6169
+ * @secure
6170
+ */
6171
+ getFeaturedArticles(query: {
6172
+ /** Limit */
6299
6173
  limit: number;
6300
- /** how many records to skip */
6174
+ /** Offset */
6301
6175
  offset: number;
6302
- /** search by monark stage */
6303
- monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
6304
- /** sort direction */
6305
- direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
6306
- /** sort field */
6307
- field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
6308
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
6176
+ /** Start date */
6177
+ start_date?: string;
6178
+ /** End date */
6179
+ end_date?: string;
6180
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
6309
6181
  /**
6310
- * @description get pre ipo company spv by id
6311
- * @tags PreIPOCompanies
6312
- * @name GetPreIpoCompanySpvsById
6313
- * @summary get pre ipo company spv by id
6314
- * @request GET:/ipos/pre-ipo-company-spvs/{id}
6315
- * @originalName getPreIpoCompanySpvs
6316
- * @duplicate
6182
+ * @description Update featured articles
6183
+ * @tags News
6184
+ * @name UpdateFeaturedArticles
6185
+ * @summary Update featured articles
6186
+ * @request PUT:/news/featured-articles
6317
6187
  * @secure
6318
6188
  */
6319
- getPreIpoCompanySpvsById(id: string, query?: {
6320
- /** default is false, if true documents will be included in the response */
6321
- include_documents?: boolean;
6322
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
6323
- }
6324
- export class Public<HandleError extends boolean = boolean> {
6325
- protected readonly apiClient: JwtClient<HandleError>;
6326
- constructor(apiClient: JwtClient<HandleError>);
6189
+ updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6327
6190
  /**
6328
- * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
6329
- * @tags Public
6330
- * @name CalculateEstimatedReturns
6331
- * @summary Calculate Estimated Returns
6332
- * @request GET:/public/estimated-returns
6191
+ * @description Create featured articles
6192
+ * @tags News
6193
+ * @name CreateFeaturedArticles
6194
+ * @summary Create featured articles
6195
+ * @request POST:/news/featured-articles
6333
6196
  * @secure
6334
6197
  */
6335
- calculateEstimatedReturns(query: {
6336
- /** Single symbol */
6337
- symbol: string;
6338
- /**
6339
- * Non-zero amount
6340
- * @format float64
6341
- */
6342
- amount: number;
6343
- /** Start date for calculations */
6344
- start_date: string;
6345
- /** End date for calculations */
6346
- end_date: string;
6347
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
6198
+ createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6348
6199
  /**
6349
- * @description Returns an expert forecast
6350
- * @tags Public
6351
- * @name ExpertForecast
6352
- * @summary Expert forecast
6353
- * @request GET:/public/expert-forecast
6200
+ * @description Get active featured articles
6201
+ * @tags News
6202
+ * @name GetActiveFeaturedArticles
6203
+ * @summary Get active featured articles
6204
+ * @request GET:/news/featured-articles/active
6354
6205
  * @secure
6355
6206
  */
6356
- expertForecast(query: {
6357
- /** Comma separated symbols */
6358
- symbols: string;
6359
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
6207
+ getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
6360
6208
  /**
6361
- * @description get fundamentals by symbol data
6362
- * @tags Public
6363
- * @name GetPublicFundamentalsBySymbolData
6364
- * @summary get fundamentals by symbol data
6365
- * @request GET:/public/fundamentals/{symbol}
6209
+ * @description Set featured articles
6210
+ * @tags News
6211
+ * @name SetFeaturedArticles
6212
+ * @summary Set featured articles
6213
+ * @request POST:/news/featured-articles/set
6366
6214
  * @secure
6367
6215
  */
6368
- getPublicFundamentalsBySymbolData(symbol: string, query: {
6369
- /** Annual or quarterly */
6370
- mode: string;
6371
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
6216
+ setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6372
6217
  /**
6373
- * @description Daily price history
6374
- * @tags Public
6375
- * @name DailyPriceHistory
6376
- * @summary Daily price history
6377
- * @request GET:/public/price-history/daily
6218
+ * @description Get featured article
6219
+ * @tags News
6220
+ * @name GetFeaturedArticle
6221
+ * @summary Get featured article
6222
+ * @request GET:/news/featured-articles/{id}
6378
6223
  * @secure
6379
6224
  */
6380
- dailyPriceHistory(query: {
6381
- /** Single symbol */
6382
- symbol: string;
6383
- /** Target date */
6384
- date: string;
6385
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
6225
+ getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
6386
6226
  /**
6387
- * @description Public quote profile
6388
- * @tags Public
6389
- * @name PublicQuoteProfile
6390
- * @summary Public quote profile
6391
- * @request GET:/public/quote-profile/{symbol}
6227
+ * @description Returns news by filters
6228
+ * @tags News
6229
+ * @name NewsFiltered
6230
+ * @summary Get filtered news
6231
+ * @request POST:/news/filter
6392
6232
  * @secure
6393
6233
  */
6394
- publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
6234
+ newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
6395
6235
  /**
6396
- * @description get ratios by symbol data
6397
- * @tags Public
6398
- * @name GetPublicRatiosBySymbolData
6399
- * @summary get ratios by symbol data
6400
- * @request GET:/public/ratios/{symbol}
6236
+ * @description Returns news by id
6237
+ * @tags News
6238
+ * @name NewsById
6239
+ * @summary Get news by id
6240
+ * @request POST:/news/id
6401
6241
  * @secure
6402
6242
  */
6403
- getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
6243
+ newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
6404
6244
  /**
6405
- * @description find a symbol by name or description
6406
- * @tags Public
6407
- * @name QuoteFundamentalsSearch
6408
- * @summary find a symbol by name or description
6409
- * @request GET:/public/symbol-search
6245
+ * @description Returns news previews
6246
+ * @tags News
6247
+ * @name NewsPreviewsFiltered
6248
+ * @summary Get news previews
6249
+ * @request GET:/news/previews
6410
6250
  * @secure
6411
6251
  */
6412
- quoteFundamentalsSearch(query: {
6413
- /** Search query */
6414
- search_query: string;
6252
+ newsPreviewsFiltered(query: {
6253
+ /** Start date */
6254
+ start_date?: string;
6255
+ /** End date */
6256
+ end_date?: string;
6257
+ /** Symbol */
6258
+ symbol?: string;
6415
6259
  /** how many records to return. Max value is 50 */
6416
6260
  limit: number;
6417
6261
  /** how many records to skip */
6418
6262
  offset: number;
6419
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
6263
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
6420
6264
  /**
6421
- * @description Get top gainers
6422
- * @tags Public
6423
- * @name TopGainers
6424
- * @summary Top Gainers
6425
- * @request GET:/public/top-gainers
6426
- * @secure
6427
- */
6428
- topGainers(query: {
6429
- /** sort direction - asc or desc */
6430
- order_direction?: string;
6431
- /** how many records to return. Max value is 50 */
6432
- limit: number;
6433
- /** how many records to skip */
6434
- offset: number;
6435
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6436
- /**
6437
- * @description Get top stocks
6438
- * @tags Public
6439
- * @name TopStocks
6440
- * @summary Top Stocks
6441
- * @request GET:/public/top-stocks
6442
- * @secure
6443
- */
6444
- topStocks(query: {
6445
- /** EQUITY|ETF|CRYPTO */
6446
- stock_type: InsightTopStocksParamsStockTypeEnum;
6447
- /** how many records to return. Max value is 50 */
6448
- limit: number;
6449
- /** how many records to skip */
6450
- offset: number;
6451
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6452
- }
6453
- export class Quotes<HandleError extends boolean = boolean> {
6454
- protected readonly apiClient: JwtClient<HandleError>;
6455
- constructor(apiClient: JwtClient<HandleError>);
6456
- /**
6457
- * @description Get single historical quote
6458
- * @tags Quotes
6459
- * @name GitHistoricalQuote
6460
- * @summary Get single historical quote
6461
- * @request GET:/historical/quote
6462
- * @secure
6463
- */
6464
- gitHistoricalQuote(query: {
6465
- /** Symbol */
6466
- symbol: string;
6467
- /** Date */
6468
- date: string;
6469
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
6470
- /**
6471
- * @description get quote history by symbol
6472
- * @tags Quotes
6473
- * @name GitQuoteHistory
6474
- * @summary Get quote history
6475
- * @request POST:/quote-history
6265
+ * @description Returns available stocks in DB
6266
+ * @tags News
6267
+ * @name NewsAvailableStocks
6268
+ * @summary Get available stocks in DB (for filters)
6269
+ * @request GET:/news/symbols
6476
6270
  * @secure
6477
6271
  */
6478
- gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
6272
+ newsAvailableStocks(query?: {
6273
+ /** Limit */
6274
+ limit?: number;
6275
+ /** Offset */
6276
+ offset?: number;
6277
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6479
6278
  /**
6480
- * @description Returns a list of quotes equity info for specified symbols.
6481
- * @tags Quotes
6482
- * @name GetQuotesEquityData
6483
- * @summary Get Quotes Equity data
6484
- * @request GET:/quotes/equity
6279
+ * @description Returns available tags in DB
6280
+ * @tags News
6281
+ * @name NewsAvailableTags
6282
+ * @summary Get available tags in DB (for filters)
6283
+ * @request POST:/news/tags
6485
6284
  * @secure
6486
6285
  */
6487
- getQuotesEquityData(query: {
6488
- /** Comma separated symbols */
6489
- symbols: string;
6490
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
6286
+ newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6491
6287
  }
6492
- export class StockScreener<HandleError extends boolean = boolean> {
6288
+ export class OptionGreeks<HandleError extends boolean = boolean> {
6493
6289
  protected readonly apiClient: JwtClient<HandleError>;
6494
6290
  constructor(apiClient: JwtClient<HandleError>);
6495
6291
  /**
6496
- * @description data for visual heat map
6497
- * @tags StockScreener
6498
- * @name StockMarketHeatmap
6499
- * @summary data for visual heat map
6500
- * @request GET:/heatmaps
6501
- * @secure
6502
- */
6503
- stockMarketHeatmap(query?: {
6504
- /** Name of symbol list to fetch details for. Empty is default */
6505
- heatmap_name?: string;
6506
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
6507
- /**
6508
- * @description create or update heat map preset
6509
- * @tags StockScreener
6510
- * @name CreateStockMarketHeatmapPreset
6511
- * @summary create or update heat map preset
6512
- * @request POST:/heatmaps
6513
- * @secure
6514
- */
6515
- createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6516
- /**
6517
- * @description Sector and Industry Group performance
6518
- * @tags StockScreener
6519
- * @name IndustriesPerformance
6520
- * @summary get industries performance
6521
- * @request POST:/industries-performance
6522
- * @secure
6523
- */
6524
- industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
6525
- /**
6526
- * @description filter stocks by params
6527
- * @tags StockScreener
6528
- * @name StockScreener
6529
- * @summary filter stocks by params
6530
- * @request POST:/stock-screener
6531
- * @secure
6532
- */
6533
- stockScreener(filter: InsightStockScreenerV1Request, headers?: {
6534
- /** Authorization */
6535
- Authorization?: string;
6536
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
6537
- /**
6538
- * @description get screener presets
6539
- * @tags StockScreener
6540
- * @name GetScreenerPresets
6541
- * @summary get screener presets
6542
- * @request GET:/stock-screener/presets
6543
- * @secure
6544
- */
6545
- getScreenerPresets(query: {
6546
- /** how many records to return */
6547
- limit: number;
6548
- /** how many records to skip */
6549
- offset: number;
6550
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
6551
- /**
6552
- * @description update screener preset
6553
- * @tags StockScreener
6554
- * @name UpdateScreenerPreset
6555
- * @summary update screener preset
6556
- * @request PUT:/stock-screener/presets
6557
- * @secure
6558
- */
6559
- updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
6560
- /**
6561
- * @description create screener preset
6562
- * @tags StockScreener
6563
- * @name CreateOrScreenerPreset
6564
- * @summary create screener preset
6565
- * @request POST:/stock-screener/presets
6566
- * @secure
6567
- */
6568
- createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
6569
- /**
6570
- * @description remove screener preset
6571
- * @tags StockScreener
6572
- * @name RemoveScreenerPreset
6573
- * @summary remove screener preset
6574
- * @request DELETE:/stock-screener/presets
6292
+ * @description Returns calculated matrix
6293
+ * @tags OptionGreeks
6294
+ * @name OgCalculateMatrix
6295
+ * @summary Calculate matrix
6296
+ * @request POST:/og/calculate-matrix
6575
6297
  * @secure
6576
6298
  */
6577
- removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6299
+ ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
6578
6300
  /**
6579
- * @description get top symbols
6580
- * @tags StockScreener
6581
- * @name GetTopSymbols
6582
- * @summary get top symbols
6583
- * @request POST:/stock-screener/top
6301
+ * @description Returns calculated params
6302
+ * @tags OptionGreeks
6303
+ * @name OgCalculateParams
6304
+ * @summary Calculate params
6305
+ * @request POST:/og/calculate-params
6584
6306
  * @secure
6585
6307
  */
6586
- getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
6308
+ ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
6587
6309
  }
6588
- export class StockScreenerV2<HandleError extends boolean = boolean> {
6310
+ export class Ownerships<HandleError extends boolean = boolean> {
6589
6311
  protected readonly apiClient: JwtClient<HandleError>;
6590
6312
  constructor(apiClient: JwtClient<HandleError>);
6591
6313
  /**
6592
- * @description filter stocks by params
6593
- * @tags StockScreener
6594
- * @name StockScreener
6595
- * @summary filter stocks by params
6596
- * @request POST:/stock-screener
6314
+ * @description get ownerships by id datadata
6315
+ * @tags Ownerships
6316
+ * @name GetOwnershipsByIdData
6317
+ * @summary get ownerships by id data
6318
+ * @request POST:/ownerships
6597
6319
  * @secure
6598
6320
  */
6599
- stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
6321
+ getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6600
6322
  /**
6601
- * @description get top symbols
6602
- * @tags StockScreener
6603
- * @name GetTopSymbols
6604
- * @summary get top symbols
6605
- * @request POST:/stock-screener/top
6323
+ * @description get ownerships by symbol data
6324
+ * @tags Ownerships
6325
+ * @name GetOwnershipsBySymbolData
6326
+ * @summary get ownerships by symbol data
6327
+ * @request POST:/symbol-ownerships
6606
6328
  * @secure
6607
6329
  */
6608
- getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
6330
+ getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6609
6331
  }
6610
6332
  export class TipRank<HandleError extends boolean = boolean> {
6611
6333
  protected readonly apiClient: JwtClient<HandleError>;
@@ -6986,187 +6708,478 @@ export class UsageTracking<HandleError extends boolean = boolean> {
6986
6708
  */
6987
6709
  getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
6988
6710
  }
6989
- export class WorldMarkets<HandleError extends boolean = boolean> {
6711
+ export class Passport<HandleError extends boolean = boolean> {
6990
6712
  protected readonly apiClient: JwtClient<HandleError>;
6991
6713
  constructor(apiClient: JwtClient<HandleError>);
6992
6714
  /**
6993
- * @description Get continents
6994
- * @tags World Markets
6995
- * @name ContinentGet
6996
- * @summary Get continents
6997
- * @request GET:/continents
6715
+ * @description Returns article by id
6716
+ * @tags Passport
6717
+ * @name PassportArticleById
6718
+ * @summary Get article by id
6719
+ * @request POST:/passport/article-by-id
6998
6720
  * @secure
6999
6721
  */
7000
- continentGet(query: {
7001
- /** Query limit */
7002
- limit: number;
7003
- /** Query offset */
7004
- offset: number;
7005
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
6722
+ passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
7006
6723
  /**
7007
- * @description Edit continent
7008
- * @tags World Markets
7009
- * @name ContinentEdit
7010
- * @summary Edit continent
7011
- * @request PUT:/continents
6724
+ * @description Returns articles
6725
+ * @tags Passport
6726
+ * @name PassportArticles
6727
+ * @summary Get articles
6728
+ * @request POST:/passport/articles
7012
6729
  * @secure
7013
6730
  */
7014
- continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6731
+ passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
7015
6732
  /**
7016
- * @description Create continents
7017
- * @tags World Markets
7018
- * @name ContinentCreate
7019
- * @summary Create continents
7020
- * @request POST:/continents
6733
+ * @description Returns author profile
6734
+ * @tags Passport
6735
+ * @name PassportAuthorProfile
6736
+ * @summary Get author profile
6737
+ * @request POST:/passport/author-profile
7021
6738
  * @secure
7022
6739
  */
7023
- continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
6740
+ passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
7024
6741
  /**
7025
- * @description Delete continent
7026
- * @tags World Markets
7027
- * @name ContinentDelete
7028
- * @summary Delete continent
7029
- * @request DELETE:/continents
6742
+ * @description Returns most popular tags
6743
+ * @tags Passport
6744
+ * @name PassportMostPopularTags
6745
+ * @summary Get most popular tags
6746
+ * @request POST:/passport/most-popular-tags
7030
6747
  * @secure
7031
6748
  */
7032
- continentDelete(query: {
7033
- /** continent id */
7034
- id: string;
7035
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6749
+ passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
7036
6750
  /**
7037
- * @description Get country codes
7038
- * @tags World Markets
7039
- * @name CountryCodeGet
7040
- * @summary Get country codes
7041
- * @request GET:/country-codes
6751
+ * @description Returns news feed
6752
+ * @tags Passport
6753
+ * @name PassportNewsFeed
6754
+ * @summary Get news feed
6755
+ * @request POST:/passport/newsfeed
7042
6756
  * @secure
7043
6757
  */
7044
- countryCodeGet(query: {
7045
- /** Query limit */
7046
- limit: number;
7047
- /** Query offset */
7048
- offset: number;
7049
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
6758
+ passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
7050
6759
  /**
7051
- * @description Edit country code
7052
- * @tags World Markets
7053
- * @name CountryCodeEdit
7054
- * @summary Edit country code
7055
- * @request PUT:/country-codes
6760
+ * @description Returns article by parameters
6761
+ * @tags Passport
6762
+ * @name PassportSearchArticle
6763
+ * @summary Search article by parameters
6764
+ * @request POST:/passport/search-article
7056
6765
  * @secure
7057
6766
  */
7058
- countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6767
+ passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6768
+ }
6769
+ export class AlphaTools<HandleError extends boolean = boolean> {
6770
+ protected readonly apiClient: JwtClient<HandleError>;
6771
+ constructor(apiClient: JwtClient<HandleError>);
7059
6772
  /**
7060
- * @description Add country codes
7061
- * @tags World Markets
7062
- * @name CountryCodeAdd
7063
- * @summary Add country codes
7064
- * @request POST:/country-codes
6773
+ * @description get seasonlity data with comparison to benchmark
6774
+ * @tags AlphaTools
6775
+ * @name GetMomentumRatioGraph
6776
+ * @summary get seasonlity data
6777
+ * @request POST:/rst
7065
6778
  * @secure
7066
6779
  */
7067
- countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
6780
+ getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
7068
6781
  /**
7069
- * @description Delete country code
7070
- * @tags World Markets
7071
- * @name CountryCodeDelete
7072
- * @summary Delete country code
7073
- * @request DELETE:/country-codes
6782
+ * @description get seasonlity data with comparison to benchmark
6783
+ * @tags AlphaTools
6784
+ * @name GetSeasonality
6785
+ * @summary get seasonlity data
6786
+ * @request POST:/seasonality
7074
6787
  * @secure
7075
6788
  */
7076
- countryCodeDelete(query: {
7077
- /** a3 code */
7078
- a3code: string;
7079
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6789
+ getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
6790
+ }
6791
+ export class Public<HandleError extends boolean = boolean> {
6792
+ protected readonly apiClient: JwtClient<HandleError>;
6793
+ constructor(apiClient: JwtClient<HandleError>);
7080
6794
  /**
7081
- * @description Get global indexes
7082
- * @tags World Markets
7083
- * @name GlobalIndexGet
7084
- * @summary Get global indexes
7085
- * @request GET:/global-indexes
6795
+ * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
6796
+ * @tags Public
6797
+ * @name CalculateEstimatedReturns
6798
+ * @summary Calculate Estimated Returns
6799
+ * @request GET:/public/estimated-returns
7086
6800
  * @secure
7087
6801
  */
7088
- globalIndexGet(query: {
7089
- /** Query limit */
7090
- limit: number;
7091
- /** Query offset */
7092
- offset: number;
7093
- /** Continent code for filtering */
7094
- continent?: string;
7095
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
6802
+ calculateEstimatedReturns(query: {
6803
+ /** Single symbol */
6804
+ symbol: string;
6805
+ /**
6806
+ * Non-zero amount
6807
+ * @format float64
6808
+ */
6809
+ amount: number;
6810
+ /** Start date for calculations */
6811
+ start_date: string;
6812
+ /** End date for calculations */
6813
+ end_date: string;
6814
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
7096
6815
  /**
7097
- * @description Edit global index
7098
- * @tags World Markets
7099
- * @name GlobalIndexEdit
7100
- * @summary Edit global index
7101
- * @request PUT:/global-indexes
6816
+ * @description Returns an expert forecast
6817
+ * @tags Public
6818
+ * @name ExpertForecast
6819
+ * @summary Expert forecast
6820
+ * @request GET:/public/expert-forecast
7102
6821
  * @secure
7103
6822
  */
7104
- globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6823
+ expertForecast(query: {
6824
+ /** Comma separated symbols */
6825
+ symbols: string;
6826
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
7105
6827
  /**
7106
- * @description Add global indexes
7107
- * @tags World Markets
7108
- * @name GlobalIndexAdd
7109
- * @summary Add global indexes
7110
- * @request POST:/global-indexes
6828
+ * @description get fundamentals by symbol data
6829
+ * @tags Public
6830
+ * @name GetPublicFundamentalsBySymbolData
6831
+ * @summary get fundamentals by symbol data
6832
+ * @request GET:/public/fundamentals/{symbol}
7111
6833
  * @secure
7112
6834
  */
7113
- globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
6835
+ getPublicFundamentalsBySymbolData(symbol: string, query: {
6836
+ /** Annual or quarterly */
6837
+ mode: string;
6838
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
7114
6839
  /**
7115
- * @description Edit global index
7116
- * @tags World Markets
7117
- * @name GlobalIndexDelete
7118
- * @summary Delete global index
7119
- * @request DELETE:/global-indexes
6840
+ * @description Daily price history
6841
+ * @tags Public
6842
+ * @name DailyPriceHistory
6843
+ * @summary Daily price history
6844
+ * @request GET:/public/price-history/daily
7120
6845
  * @secure
7121
6846
  */
7122
- globalIndexDelete(query: {
7123
- /** a3 code */
7124
- a3code: string;
7125
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6847
+ dailyPriceHistory(query: {
6848
+ /** Single symbol */
6849
+ symbol: string;
6850
+ /** Target date */
6851
+ date: string;
6852
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
7126
6853
  /**
7127
- * @description Get regions
7128
- * @tags World Markets
7129
- * @name RegionGet
7130
- * @summary Get regions
7131
- * @request GET:/regions
6854
+ * @description Public quote profile
6855
+ * @tags Public
6856
+ * @name PublicQuoteProfile
6857
+ * @summary Public quote profile
6858
+ * @request GET:/public/quote-profile/{symbol}
7132
6859
  * @secure
7133
6860
  */
7134
- regionGet(query: {
7135
- /** Query limit */
6861
+ publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
6862
+ /**
6863
+ * @description get ratios by symbol data
6864
+ * @tags Public
6865
+ * @name GetPublicRatiosBySymbolData
6866
+ * @summary get ratios by symbol data
6867
+ * @request GET:/public/ratios/{symbol}
6868
+ * @secure
6869
+ */
6870
+ getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
6871
+ /**
6872
+ * @description find a symbol by name or description
6873
+ * @tags Public
6874
+ * @name QuoteFundamentalsSearch
6875
+ * @summary find a symbol by name or description
6876
+ * @request GET:/public/symbol-search
6877
+ * @secure
6878
+ */
6879
+ quoteFundamentalsSearch(query: {
6880
+ /** Search query */
6881
+ search_query: string;
6882
+ /** how many records to return. Max value is 50 */
7136
6883
  limit: number;
7137
- /** Query offset */
6884
+ /** how many records to skip */
7138
6885
  offset: number;
7139
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
6886
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
7140
6887
  /**
7141
- * @description Edit region
7142
- * @tags World Markets
7143
- * @name RegionEdit
7144
- * @summary Edit region
7145
- * @request PUT:/regions
6888
+ * @description Get top gainers
6889
+ * @tags Public
6890
+ * @name TopGainers
6891
+ * @summary Top Gainers
6892
+ * @request GET:/public/top-gainers
7146
6893
  * @secure
7147
6894
  */
7148
- regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6895
+ topGainers(query: {
6896
+ /** sort direction - asc or desc */
6897
+ order_direction?: string;
6898
+ /** how many records to return. Max value is 50 */
6899
+ limit: number;
6900
+ /** how many records to skip */
6901
+ offset: number;
6902
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
7149
6903
  /**
7150
- * @description Create regions
7151
- * @tags World Markets
7152
- * @name RegionCreate
7153
- * @summary Create regions
7154
- * @request POST:/regions
6904
+ * @description Get top stocks
6905
+ * @tags Public
6906
+ * @name TopStocks
6907
+ * @summary Top Stocks
6908
+ * @request GET:/public/top-stocks
7155
6909
  * @secure
7156
6910
  */
7157
- regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
6911
+ topStocks(query: {
6912
+ /** EQUITY|ETF|CRYPTO */
6913
+ stock_type: InsightTopStocksParamsStockTypeEnum;
6914
+ /** how many records to return. Max value is 50 */
6915
+ limit: number;
6916
+ /** how many records to skip */
6917
+ offset: number;
6918
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6919
+ }
6920
+ export interface InsightBeforeAndAfterV2 {
6921
+ after?: string;
6922
+ before?: string;
6923
+ }
6924
+ export interface InsightFixedIncomeV2 {
6925
+ a144: boolean;
6926
+ accrued_interest: number;
6927
+ bank_qualified: boolean;
6928
+ bond_warrant: boolean;
6929
+ call_type: string;
6930
+ callable: boolean;
6931
+ close_price: number;
6932
+ close_price_asof: string;
6933
+ close_ytw: number;
6934
+ convertible: boolean;
6935
+ country: string;
6936
+ country_code: string;
6937
+ country_domicile: string;
6938
+ country_issue: string;
6939
+ coupon: number;
6940
+ coupon_frequency: string;
6941
+ coupon_type: string;
6942
+ currency: string;
6943
+ cusip: string;
6944
+ dated_date: string;
6945
+ daycount: string;
6946
+ description: string;
6947
+ description_short: string;
6948
+ duration: number;
6949
+ first_coupon_date: string;
6950
+ insured: boolean;
6951
+ isin: string;
6952
+ issue_date: string;
6953
+ issue_minimum_denomination: number;
6954
+ issue_price: number;
6955
+ issue_size: number;
6956
+ issuer: string;
6957
+ last_coupon_date: string;
6958
+ liquidity_institutional_aggregate: number;
6959
+ liquidity_institutional_buy: number;
6960
+ liquidity_institutional_sell: number;
6961
+ liquidity_micro_aggregate: number;
6962
+ liquidity_micro_buy: number;
6963
+ liquidity_micro_sell: number;
6964
+ liquidity_retail_aggregate: number;
6965
+ liquidity_retail_buy: number;
6966
+ liquidity_retail_sell: number;
6967
+ maturity_date: string;
6968
+ municipal_state: string;
6969
+ municipal_taxable_federal: boolean;
6970
+ municipal_type: string;
6971
+ next_call_date: string;
6972
+ next_call_price: number;
6973
+ next_coupon_date: string;
6974
+ par_value: number;
6975
+ perpetual: boolean;
6976
+ private_placement: boolean;
6977
+ purpose: string;
6978
+ puttable: boolean;
6979
+ reg_s: boolean;
6980
+ sector: string;
6981
+ seniority: string;
6982
+ settlement_convention: string;
6983
+ sinking_fund: boolean;
6984
+ sp_creditwatch: string;
6985
+ sp_creditwatch_date: string;
6986
+ sp_outlook: string;
6987
+ sp_outlook_date: string;
6988
+ sp_rating: string;
6989
+ sp_rating_date: string;
6990
+ status: string;
6991
+ ticker: string;
6992
+ treasury_subtype: string;
6993
+ type: string;
6994
+ updated_at: string;
6995
+ }
6996
+ export interface InsightGetFixedIncomeEntriesResponseV2 {
6997
+ count: number;
6998
+ data: InsightFixedIncomeV2[];
6999
+ }
7000
+ export interface InsightGetFixedIncomeEntriesRequestV2 {
7001
+ /** @example true */
7002
+ bank_qualified?: boolean;
7003
+ /** @example true */
7004
+ callable?: boolean;
7005
+ /** @example true */
7006
+ convertible?: boolean;
7007
+ /** @example ["USA"] */
7008
+ country_codes?: string[];
7009
+ coupon?: InsightLessAndMoreV2;
7010
+ /** @example ["quarterly","zero"] */
7011
+ coupon_frequencies?: string[];
7012
+ /** @example ["655664AH3","9128286R6"] */
7013
+ cusip?: string[];
7158
7014
  /**
7159
- * @description Delete region
7160
- * @tags World Markets
7161
- * @name RegionDelete
7162
- * @summary Delete region
7163
- * @request DELETE:/regions
7015
+ * @maxLength 100
7016
+ * @example "Donald's"
7017
+ */
7018
+ description?: string;
7019
+ /** @example true */
7020
+ has_ticker?: boolean;
7021
+ /** @example true */
7022
+ insured?: boolean;
7023
+ /** @example ["US655664AH33","US9128286R69"] */
7024
+ isin?: string[];
7025
+ issue_date?: InsightBeforeAndAfterV2;
7026
+ /**
7027
+ * @maxLength 100
7028
+ * @example "Donald's"
7029
+ */
7030
+ issuer?: string;
7031
+ maturity?: InsightBeforeAndAfterV2;
7032
+ /** @example ["NY"] */
7033
+ municipal_states?: string[];
7034
+ /** @example true */
7035
+ municipal_tax?: boolean;
7036
+ /** @example ["general_obligation"] */
7037
+ municipal_types?: string[];
7038
+ pagination: InsightPaginationV2;
7039
+ purposes?: string[];
7040
+ /** @example ["SOVEREIGN"] */
7041
+ sectors?: string[];
7042
+ sorts?: InsightOrderingV2[];
7043
+ /** @example ["AAA"] */
7044
+ sp_ratings?: string[];
7045
+ /** @example ["called","outstanding"] */
7046
+ statuses?: string[];
7047
+ tickers?: string[];
7048
+ /** @example ["corporate"] */
7049
+ types?: string[];
7050
+ }
7051
+ export interface InsightGetTopSymbolsRequestV2 {
7052
+ exchange?: string[];
7053
+ market_cap?: InsightLessAndMoreV2;
7054
+ pagination?: InsightPaginationV2;
7055
+ price?: InsightLessAndMoreV2;
7056
+ sorts?: InsightOrderingV2[];
7057
+ volume?: InsightLessAndMoreV2;
7058
+ }
7059
+ export interface InsightIncludeExcludeV2 {
7060
+ exclude?: string[];
7061
+ include?: string[];
7062
+ }
7063
+ export interface InsightLessAndMoreV2 {
7064
+ less_than?: number;
7065
+ more_than?: number;
7066
+ }
7067
+ export enum InsightOrderDirectionV2 {
7068
+ OrderASC = "asc",
7069
+ OrderDESC = "desc"
7070
+ }
7071
+ export interface InsightOrderingV2 {
7072
+ /**
7073
+ * @default "asc"
7074
+ * @example "asc"
7075
+ */
7076
+ direction: InsightOrderingDirectionEnumV2;
7077
+ /**
7078
+ * Sort direction:
7079
+ * * asc - Ascending, from A to Z.
7080
+ * * desc - Descending, from Z to A.
7081
+ * @example "name"
7082
+ */
7083
+ field: string;
7084
+ }
7085
+ export interface InsightPaginationV2 {
7086
+ /**
7087
+ * @min 1
7088
+ * @example 1
7089
+ */
7090
+ page: number;
7091
+ /**
7092
+ * @min 1
7093
+ * @max 50
7094
+ * @example 10
7095
+ */
7096
+ size: number;
7097
+ }
7098
+ export interface InsightStockScreenerQuoteV2 {
7099
+ average_volume_30d: number;
7100
+ company_name: string;
7101
+ dividend_ex_date: string;
7102
+ dividend_pay_date: string;
7103
+ dividend_percent: number;
7104
+ exchange: string;
7105
+ exchange_name: string;
7106
+ gap: number;
7107
+ industry: string;
7108
+ industry_code: string;
7109
+ last_price: number;
7110
+ market_cap: number;
7111
+ pe_ratio: number;
7112
+ price_change: number;
7113
+ price_change_percent: number;
7114
+ symbol: string;
7115
+ volume: number;
7116
+ }
7117
+ export interface InsightStockScreenerRequestV2 {
7118
+ average_volume_30d?: InsightLessAndMoreV2;
7119
+ dividend_ex_date?: InsightBeforeAndAfterV2;
7120
+ dividend_pay_date?: InsightBeforeAndAfterV2;
7121
+ dividend_percent?: InsightLessAndMoreV2;
7122
+ exchange?: InsightIncludeExcludeV2;
7123
+ gap?: InsightLessAndMoreV2;
7124
+ industry?: InsightIncludeExcludeV2;
7125
+ market_cap?: InsightLessAndMoreV2;
7126
+ pagination: InsightPaginationV2;
7127
+ pe_ratio?: InsightLessAndMoreV2;
7128
+ price?: InsightLessAndMoreV2;
7129
+ sorts?: InsightOrderingV2[];
7130
+ /** @example "ADR" */
7131
+ stock_type?: string;
7132
+ volume?: InsightLessAndMoreV2;
7133
+ }
7134
+ export interface InsightStockScreenerResponseV2 {
7135
+ current_page: number;
7136
+ data: InsightStockScreenerQuoteV2[];
7137
+ page_count: number;
7138
+ status: number;
7139
+ total_records: number;
7140
+ }
7141
+ /**
7142
+ * @default "asc"
7143
+ * @example "asc"
7144
+ */
7145
+ export enum InsightOrderingDirectionEnumV2 {
7146
+ Asc = "asc",
7147
+ Desc = "desc"
7148
+ }
7149
+ export class FixedIncomeV2<HandleError extends boolean = boolean> {
7150
+ protected readonly apiClient: JwtClient<HandleError>;
7151
+ constructor(apiClient: JwtClient<HandleError>);
7152
+ /**
7153
+ * @description get fixed income entries
7154
+ * @tags FixedIncome
7155
+ * @name GetFixedIncomeEntries
7156
+ * @summary get fixed income entries
7157
+ * @request POST:/fixed-income
7164
7158
  * @secure
7165
7159
  */
7166
- regionDelete(query: {
7167
- /** region id */
7168
- id: string;
7169
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7160
+ getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
7161
+ }
7162
+ export class StockScreenerV2<HandleError extends boolean = boolean> {
7163
+ protected readonly apiClient: JwtClient<HandleError>;
7164
+ constructor(apiClient: JwtClient<HandleError>);
7165
+ /**
7166
+ * @description filter stocks by params
7167
+ * @tags StockScreener
7168
+ * @name StockScreener
7169
+ * @summary filter stocks by params
7170
+ * @request POST:/stock-screener
7171
+ * @secure
7172
+ */
7173
+ stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
7174
+ /**
7175
+ * @description get top symbols
7176
+ * @tags StockScreener
7177
+ * @name GetTopSymbols
7178
+ * @summary get top symbols
7179
+ * @request POST:/stock-screener/top
7180
+ * @secure
7181
+ */
7182
+ getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
7170
7183
  }
7171
7184
  export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
7172
7185
  readonly config: JwtClientConfig<HandleError>;