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

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 (42) hide show
  1. package/dist/aesmidas/index.d.ts +233 -207
  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 +6486 -5422
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/index.d.ts.map +1 -1
  14. package/dist/index.esm.js +1 -1
  15. package/dist/index.esm.js.map +1 -1
  16. package/dist/index.js +1 -1
  17. package/dist/index.js.map +1 -1
  18. package/dist/insight/index.d.ts +1255 -1246
  19. package/dist/insight/index.d.ts.map +1 -1
  20. package/dist/insight/index.esm.js +1 -1
  21. package/dist/insight/index.esm.js.map +1 -1
  22. package/dist/insight/index.js +1 -1
  23. package/dist/insight/index.js.map +1 -1
  24. package/dist/middleware/index.d.ts +99 -99
  25. package/dist/middleware/index.d.ts.map +1 -1
  26. package/dist/middleware/index.esm.js +1 -1
  27. package/dist/middleware/index.esm.js.map +1 -1
  28. package/dist/middleware/index.js +1 -1
  29. package/dist/middleware/index.js.map +1 -1
  30. package/dist/orbis/index.d.ts +4031 -4031
  31. package/dist/orbis/index.d.ts.map +1 -1
  32. package/dist/orbis/index.esm.js +1 -1
  33. package/dist/orbis/index.esm.js.map +1 -1
  34. package/dist/orbis/index.js +1 -1
  35. package/dist/orbis/index.js.map +1 -1
  36. package/dist/uma/index.d.ts +699 -730
  37. package/dist/uma/index.d.ts.map +1 -1
  38. package/dist/uma/index.esm.js +1 -1
  39. package/dist/uma/index.esm.js.map +1 -1
  40. package/dist/uma/index.js +1 -1
  41. package/dist/uma/index.js.map +1 -1
  42. package/package.json +154 -154
@@ -1221,7 +1221,11 @@ export interface InsightGetFundDetailsResponse {
1221
1221
  long_description: string;
1222
1222
  market_caps: InsightMarketCapBreakdown[];
1223
1223
  maturities: InsightMaturityBreakdown[];
1224
+ month_end_nav: number;
1225
+ month_end_nav_date: string;
1224
1226
  phone: string;
1227
+ primary_benchmark: string;
1228
+ primary_index_beta_y1: number;
1225
1229
  sectors: InsightSectorBreakdown[];
1226
1230
  structure: string;
1227
1231
  symbol: string;
@@ -2831,6 +2835,7 @@ export interface InsightHedgeFundsResponse {
2831
2835
  }
2832
2836
  export interface InsightHelpRequestWithSymbol {
2833
2837
  paging?: InsightPaging;
2838
+ search_query?: string;
2834
2839
  symbol?: string;
2835
2840
  }
2836
2841
  export interface InsightHistoricalIPO {
@@ -3363,6 +3368,8 @@ export interface InsightNewsFilterRequest {
3363
3368
  symbols?: string[];
3364
3369
  /** @example ["Earnings","Market"] */
3365
3370
  tags?: string[];
3371
+ /** @example true */
3372
+ with_images_only?: boolean;
3366
3373
  }
3367
3374
  export interface InsightNewsImage {
3368
3375
  size: string;
@@ -4062,6 +4069,7 @@ export interface InsightStockScreenerRequest {
4062
4069
  paging?: InsightPaging;
4063
4070
  pe_ratio?: InsightLessAndMore;
4064
4071
  price?: InsightLessAndMore;
4072
+ price_change_percent?: InsightLessAndMore;
4065
4073
  sorts?: InsightOrdering[];
4066
4074
  /** @example "ADR" */
4067
4075
  stock_type?: string;
@@ -4084,6 +4092,7 @@ export interface InsightStockScreenerV1Request {
4084
4092
  paging: InsightPaging;
4085
4093
  pe_ratio?: InsightLessAndMore;
4086
4094
  price?: InsightLessAndMore;
4095
+ price_change_percent?: InsightLessAndMore;
4087
4096
  /** @example "ADR" */
4088
4097
  stock_type?: string;
4089
4098
  volume?: InsightLessAndMore;
@@ -4796,6 +4805,28 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
4796
4805
  Date = "date",
4797
4806
  Rank = "rank"
4798
4807
  }
4808
+ export class AlphaTools<HandleError extends boolean = boolean> {
4809
+ protected readonly apiClient: JwtClient<HandleError>;
4810
+ constructor(apiClient: JwtClient<HandleError>);
4811
+ /**
4812
+ * @description get seasonlity data with comparison to benchmark
4813
+ * @tags AlphaTools
4814
+ * @name GetMomentumRatioGraph
4815
+ * @summary get seasonlity data
4816
+ * @request POST:/rst
4817
+ * @secure
4818
+ */
4819
+ getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
4820
+ /**
4821
+ * @description get seasonlity data with comparison to benchmark
4822
+ * @tags AlphaTools
4823
+ * @name GetSeasonality
4824
+ * @summary get seasonlity data
4825
+ * @request POST:/seasonality
4826
+ * @secure
4827
+ */
4828
+ getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
4829
+ }
4799
4830
  export class CompanyProfile<HandleError extends boolean = boolean> {
4800
4831
  protected readonly apiClient: JwtClient<HandleError>;
4801
4832
  constructor(apiClient: JwtClient<HandleError>);
@@ -4835,188 +4866,6 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
4835
4866
  */
4836
4867
  getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
4837
4868
  }
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
- }
5020
4869
  export class CustomLists<HandleError extends boolean = boolean> {
5021
4870
  protected readonly apiClient: JwtClient<HandleError>;
5022
4871
  constructor(apiClient: JwtClient<HandleError>);
@@ -5304,280 +5153,911 @@ export class FixedIncome<HandleError extends boolean = boolean> {
5304
5153
  */
5305
5154
  getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
5306
5155
  }
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>>;
5156
+ export interface InsightBeforeAndAfterV2 {
5157
+ after?: string;
5158
+ before?: string;
5319
5159
  }
5320
- export class Funds<HandleError extends boolean = boolean> {
5321
- protected readonly apiClient: JwtClient<HandleError>;
5322
- constructor(apiClient: JwtClient<HandleError>);
5323
- /**
5324
- * @description get fund details
5325
- * @tags Funds
5326
- * @name GetFundDetails
5327
- * @summary get fund details
5328
- * @request GET:/funds/details
5329
- * @secure
5330
- */
5331
- getFundDetails(query: {
5332
- /** Fund symbol */
5333
- symbol: string;
5334
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError>>;
5335
- /**
5336
- * @description get funds for holding
5337
- * @tags Funds
5338
- * @name GetFundsForHolding
5339
- * @summary get funds for holding
5340
- * @request POST:/funds/funds-for-holding
5341
- * @secure
5342
- */
5343
- getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
5344
- /** Authorization */
5345
- Authorization?: string;
5346
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError>>;
5347
- /**
5348
- * @description filter funds by params
5349
- * @tags Funds
5350
- * @name FundScreener
5351
- * @summary filter funds by params
5352
- * @request POST:/funds/screener
5353
- * @secure
5354
- */
5160
+ export interface InsightFixedIncomeV2 {
5161
+ a144: boolean;
5162
+ accrued_interest: number;
5163
+ bank_qualified: boolean;
5164
+ bond_warrant: boolean;
5165
+ call_type: string;
5166
+ callable: boolean;
5167
+ close_price: number;
5168
+ close_price_asof: string;
5169
+ close_ytw: number;
5170
+ convertible: boolean;
5171
+ country: string;
5172
+ country_code: string;
5173
+ country_domicile: string;
5174
+ country_issue: string;
5175
+ coupon: number;
5176
+ coupon_frequency: string;
5177
+ coupon_type: string;
5178
+ currency: string;
5179
+ cusip: string;
5180
+ dated_date: string;
5181
+ daycount: string;
5182
+ description: string;
5183
+ description_short: string;
5184
+ duration: number;
5185
+ first_coupon_date: string;
5186
+ insured: boolean;
5187
+ isin: string;
5188
+ issue_date: string;
5189
+ issue_minimum_denomination: number;
5190
+ issue_price: number;
5191
+ issue_size: number;
5192
+ issuer: string;
5193
+ last_coupon_date: string;
5194
+ liquidity_institutional_aggregate: number;
5195
+ liquidity_institutional_buy: number;
5196
+ liquidity_institutional_sell: number;
5197
+ liquidity_micro_aggregate: number;
5198
+ liquidity_micro_buy: number;
5199
+ liquidity_micro_sell: number;
5200
+ liquidity_retail_aggregate: number;
5201
+ liquidity_retail_buy: number;
5202
+ liquidity_retail_sell: number;
5203
+ maturity_date: string;
5204
+ municipal_state: string;
5205
+ municipal_taxable_federal: boolean;
5206
+ municipal_type: string;
5207
+ next_call_date: string;
5208
+ next_call_price: number;
5209
+ next_coupon_date: string;
5210
+ par_value: number;
5211
+ perpetual: boolean;
5212
+ private_placement: boolean;
5213
+ purpose: string;
5214
+ puttable: boolean;
5215
+ reg_s: boolean;
5216
+ sector: string;
5217
+ seniority: string;
5218
+ settlement_convention: string;
5219
+ sinking_fund: boolean;
5220
+ sp_creditwatch: string;
5221
+ sp_creditwatch_date: string;
5222
+ sp_outlook: string;
5223
+ sp_outlook_date: string;
5224
+ sp_rating: string;
5225
+ sp_rating_date: string;
5226
+ status: string;
5227
+ ticker: string;
5228
+ treasury_subtype: string;
5229
+ type: string;
5230
+ updated_at: string;
5231
+ }
5232
+ export interface InsightGetFixedIncomeEntriesResponseV2 {
5233
+ count: number;
5234
+ data: InsightFixedIncomeV2[];
5235
+ }
5236
+ export interface InsightGetFixedIncomeEntriesRequestV2 {
5237
+ /** @example true */
5238
+ bank_qualified?: boolean;
5239
+ /** @example true */
5240
+ callable?: boolean;
5241
+ /** @example true */
5242
+ convertible?: boolean;
5243
+ /** @example ["USA"] */
5244
+ country_codes?: string[];
5245
+ coupon?: InsightLessAndMoreV2;
5246
+ /** @example ["quarterly","zero"] */
5247
+ coupon_frequencies?: string[];
5248
+ /** @example ["655664AH3","9128286R6"] */
5249
+ cusip?: string[];
5250
+ /**
5251
+ * @maxLength 100
5252
+ * @example "Donald's"
5253
+ */
5254
+ description?: string;
5255
+ /** @example true */
5256
+ has_ticker?: boolean;
5257
+ /** @example true */
5258
+ insured?: boolean;
5259
+ /** @example ["US655664AH33","US9128286R69"] */
5260
+ isin?: string[];
5261
+ issue_date?: InsightBeforeAndAfterV2;
5262
+ /**
5263
+ * @maxLength 100
5264
+ * @example "Donald's"
5265
+ */
5266
+ issuer?: string;
5267
+ maturity?: InsightBeforeAndAfterV2;
5268
+ /** @example ["NY"] */
5269
+ municipal_states?: string[];
5270
+ /** @example true */
5271
+ municipal_tax?: boolean;
5272
+ /** @example ["general_obligation"] */
5273
+ municipal_types?: string[];
5274
+ pagination: InsightPaginationV2;
5275
+ purposes?: string[];
5276
+ /** @example ["SOVEREIGN"] */
5277
+ sectors?: string[];
5278
+ sorts?: InsightOrderingV2[];
5279
+ /** @example ["AAA"] */
5280
+ sp_ratings?: string[];
5281
+ /** @example ["called","outstanding"] */
5282
+ statuses?: string[];
5283
+ tickers?: string[];
5284
+ /** @example ["corporate"] */
5285
+ types?: string[];
5286
+ }
5287
+ export interface InsightGetTopSymbolsRequestV2 {
5288
+ exchange?: string[];
5289
+ market_cap?: InsightLessAndMoreV2;
5290
+ pagination?: InsightPaginationV2;
5291
+ price?: InsightLessAndMoreV2;
5292
+ sorts?: InsightOrderingV2[];
5293
+ volume?: InsightLessAndMoreV2;
5294
+ }
5295
+ export interface InsightIncludeExcludeV2 {
5296
+ exclude?: string[];
5297
+ include?: string[];
5298
+ }
5299
+ export interface InsightLessAndMoreV2 {
5300
+ less_than?: number;
5301
+ more_than?: number;
5302
+ }
5303
+ export enum InsightOrderDirectionV2 {
5304
+ OrderASC = "asc",
5305
+ OrderDESC = "desc"
5306
+ }
5307
+ export interface InsightOrderingV2 {
5308
+ /**
5309
+ * @default "asc"
5310
+ * @example "asc"
5311
+ */
5312
+ direction: InsightOrderingDirectionEnumV2;
5313
+ /**
5314
+ * Sort direction:
5315
+ * * asc - Ascending, from A to Z.
5316
+ * * desc - Descending, from Z to A.
5317
+ * @example "name"
5318
+ */
5319
+ field: string;
5320
+ }
5321
+ export interface InsightPaginationV2 {
5322
+ /**
5323
+ * @min 1
5324
+ * @example 1
5325
+ */
5326
+ page: number;
5327
+ /**
5328
+ * @min 1
5329
+ * @max 50
5330
+ * @example 10
5331
+ */
5332
+ size: number;
5333
+ }
5334
+ export interface InsightStockScreenerQuoteV2 {
5335
+ average_volume_30d: number;
5336
+ company_name: string;
5337
+ dividend_ex_date: string;
5338
+ dividend_pay_date: string;
5339
+ dividend_percent: number;
5340
+ exchange: string;
5341
+ exchange_name: string;
5342
+ gap: number;
5343
+ industry: string;
5344
+ industry_code: string;
5345
+ last_price: number;
5346
+ market_cap: number;
5347
+ pe_ratio: number;
5348
+ price_change: number;
5349
+ price_change_percent: number;
5350
+ symbol: string;
5351
+ volume: number;
5352
+ }
5353
+ export interface InsightStockScreenerRequestV2 {
5354
+ average_volume_30d?: InsightLessAndMoreV2;
5355
+ dividend_ex_date?: InsightBeforeAndAfterV2;
5356
+ dividend_pay_date?: InsightBeforeAndAfterV2;
5357
+ dividend_percent?: InsightLessAndMoreV2;
5358
+ exchange?: InsightIncludeExcludeV2;
5359
+ gap?: InsightLessAndMoreV2;
5360
+ industry?: InsightIncludeExcludeV2;
5361
+ market_cap?: InsightLessAndMoreV2;
5362
+ pagination: InsightPaginationV2;
5363
+ pe_ratio?: InsightLessAndMoreV2;
5364
+ price?: InsightLessAndMoreV2;
5365
+ price_change_percent?: InsightLessAndMoreV2;
5366
+ sorts?: InsightOrderingV2[];
5367
+ /** @example "ADR" */
5368
+ stock_type?: string;
5369
+ volume?: InsightLessAndMoreV2;
5370
+ }
5371
+ export interface InsightStockScreenerResponseV2 {
5372
+ current_page: number;
5373
+ data: InsightStockScreenerQuoteV2[];
5374
+ page_count: number;
5375
+ status: number;
5376
+ total_records: number;
5377
+ }
5378
+ /**
5379
+ * @default "asc"
5380
+ * @example "asc"
5381
+ */
5382
+ export enum InsightOrderingDirectionEnumV2 {
5383
+ Asc = "asc",
5384
+ Desc = "desc"
5385
+ }
5386
+ export class FixedIncomeV2<HandleError extends boolean = boolean> {
5387
+ protected readonly apiClient: JwtClient<HandleError>;
5388
+ constructor(apiClient: JwtClient<HandleError>);
5389
+ /**
5390
+ * @description get fixed income entries
5391
+ * @tags FixedIncome
5392
+ * @name GetFixedIncomeEntries
5393
+ * @summary get fixed income entries
5394
+ * @request POST:/fixed-income
5395
+ * @secure
5396
+ */
5397
+ getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
5398
+ }
5399
+ export class Fundamentals<HandleError extends boolean = boolean> {
5400
+ protected readonly apiClient: JwtClient<HandleError>;
5401
+ constructor(apiClient: JwtClient<HandleError>);
5402
+ /**
5403
+ * @description get fundamentals by symbol data
5404
+ * @tags Fundamentals
5405
+ * @name GetFundamentalsBySymbolData
5406
+ * @summary get fundamentals by symbol data
5407
+ * @request POST:/fundamentals
5408
+ * @secure
5409
+ */
5410
+ getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
5411
+ }
5412
+ export class Funds<HandleError extends boolean = boolean> {
5413
+ protected readonly apiClient: JwtClient<HandleError>;
5414
+ constructor(apiClient: JwtClient<HandleError>);
5415
+ /**
5416
+ * @description get fund details
5417
+ * @tags Funds
5418
+ * @name GetFundDetails
5419
+ * @summary get fund details
5420
+ * @request GET:/funds/details
5421
+ * @secure
5422
+ */
5423
+ getFundDetails(query: {
5424
+ /** Fund symbol */
5425
+ symbol: string;
5426
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError>>;
5427
+ /**
5428
+ * @description get funds for holding
5429
+ * @tags Funds
5430
+ * @name GetFundsForHolding
5431
+ * @summary get funds for holding
5432
+ * @request POST:/funds/funds-for-holding
5433
+ * @secure
5434
+ */
5435
+ getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
5436
+ /** Authorization */
5437
+ Authorization?: string;
5438
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError>>;
5439
+ /**
5440
+ * @description filter funds by params
5441
+ * @tags Funds
5442
+ * @name FundScreener
5443
+ * @summary filter funds by params
5444
+ * @request POST:/funds/screener
5445
+ * @secure
5446
+ */
5355
5447
  fundScreener(filter: InsightFundScreenerRequest, headers?: {
5356
5448
  /** Authorization */
5357
5449
  Authorization?: string;
5358
5450
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
5359
5451
  /**
5360
- * @description get fund screener filters
5361
- * @tags Funds
5362
- * @name GetScreenerFilters
5363
- * @summary get fund screener filters
5364
- * @request GET:/funds/screener/filters
5452
+ * @description get fund screener filters
5453
+ * @tags Funds
5454
+ * @name GetScreenerFilters
5455
+ * @summary get fund screener filters
5456
+ * @request GET:/funds/screener/filters
5457
+ * @secure
5458
+ */
5459
+ getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError>>;
5460
+ /**
5461
+ * @description get fund screener presets
5462
+ * @tags Funds
5463
+ * @name GetFundScreenerPresets
5464
+ * @summary get fund screener presets
5465
+ * @request GET:/funds/screener/presets
5466
+ * @secure
5467
+ */
5468
+ getFundScreenerPresets(query: {
5469
+ /** how many records to return */
5470
+ limit: number;
5471
+ /** how many records to skip */
5472
+ offset: number;
5473
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
5474
+ /**
5475
+ * @description update fund screener preset
5476
+ * @tags Funds
5477
+ * @name UpdateFundScreenerPreset
5478
+ * @summary update fund screener preset
5479
+ * @request PUT:/funds/screener/presets
5480
+ * @secure
5481
+ */
5482
+ updateFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5483
+ /**
5484
+ * @description create fund screener preset
5485
+ * @tags Funds
5486
+ * @name CreateFundScreenerPreset
5487
+ * @summary create fund screener preset
5488
+ * @request POST:/funds/screener/presets
5489
+ * @secure
5490
+ */
5491
+ createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5492
+ /**
5493
+ * @description remove fund screener preset
5494
+ * @tags Funds
5495
+ * @name RemoveFundScreenerPreset
5496
+ * @summary remove fund screener preset
5497
+ * @request DELETE:/funds/screener/presets
5498
+ * @secure
5499
+ */
5500
+ removeFundScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5501
+ /**
5502
+ * @description filter funds by params
5503
+ * @tags Funds
5504
+ * @name FundSectorScreener
5505
+ * @summary filter funds by params
5506
+ * @request POST:/funds/sector-screener
5507
+ * @secure
5508
+ */
5509
+ fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
5510
+ /** Authorization */
5511
+ Authorization?: string;
5512
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
5513
+ /**
5514
+ * @description get top funds
5515
+ * @tags Funds
5516
+ * @name GetTopFunds
5517
+ * @summary get top funds
5518
+ * @request POST:/funds/top
5519
+ * @secure
5520
+ */
5521
+ getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
5522
+ /** Authorization */
5523
+ Authorization?: string;
5524
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
5525
+ }
5526
+ export class Intraday<HandleError extends boolean = boolean> {
5527
+ protected readonly apiClient: JwtClient<HandleError>;
5528
+ constructor(apiClient: JwtClient<HandleError>);
5529
+ /**
5530
+ * @description Returns an array of intraday chart data values for the given ticker.
5531
+ * @tags Intraday
5532
+ * @name IntradayQuotes
5533
+ * @summary Get an array of intraday chart data values for the given ticker
5534
+ * @request POST:/intraday/quotes
5535
+ * @secure
5536
+ */
5537
+ intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
5538
+ }
5539
+ export class Ipos<HandleError extends boolean = boolean> {
5540
+ protected readonly apiClient: JwtClient<HandleError>;
5541
+ constructor(apiClient: JwtClient<HandleError>);
5542
+ /**
5543
+ * @description get recent ipos info
5544
+ * @tags Ipos
5545
+ * @name PostRecent
5546
+ * @summary get recent ipos info
5547
+ * @request POST:/ipos/recent
5548
+ * @secure
5549
+ */
5550
+ postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5551
+ /**
5552
+ * @description get upcoming ipos info
5553
+ * @tags Ipos
5554
+ * @name GetUpcoming
5555
+ * @summary get upcoming ipos info
5556
+ * @request GET:/ipos/upcoming
5557
+ * @secure
5558
+ */
5559
+ getUpcoming(query: {
5560
+ /** how many records to return. Max value is 50 */
5561
+ limit: number;
5562
+ /** how many records to skip */
5563
+ offset: number;
5564
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5565
+ /**
5566
+ * @description get ipo info by symbol
5567
+ * @tags Ipos
5568
+ * @name GetIpos
5569
+ * @summary get ipo info by symbol
5570
+ * @request GET:/ipos/{symbol}
5571
+ * @secure
5572
+ */
5573
+ getIpos(symbol: string, query?: {
5574
+ /** load quotes */
5575
+ load_quotes?: boolean;
5576
+ /** statuses */
5577
+ statuses?: string[];
5578
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
5579
+ }
5580
+ export class Logos<HandleError extends boolean = boolean> {
5581
+ protected readonly apiClient: JwtClient<HandleError>;
5582
+ constructor(apiClient: JwtClient<HandleError>);
5583
+ /**
5584
+ * @description Returns converted logo for crypto symbol
5585
+ * @tags Logos
5586
+ * @name LogosConvertedCryptoSymbolLogo
5587
+ * @summary Get converted logo for crypto symbol
5588
+ * @request POST:/logos/converted-crypto-symbol-logo
5589
+ * @secure
5590
+ */
5591
+ logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5592
+ /**
5593
+ * @description Returns converted logo for symbol
5594
+ * @tags Logos
5595
+ * @name LogosConvertedSymbolLogo
5596
+ * @summary Get converted logo for symbol
5597
+ * @request POST:/logos/converted-symbol-logo
5598
+ * @secure
5599
+ */
5600
+ logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5601
+ /**
5602
+ * @description Returns logo for crypto symbol
5603
+ * @tags Logos
5604
+ * @name LogosCryptoSymbolLogo
5605
+ * @summary Get logo for crypto symbol
5606
+ * @request GET:/logos/crypto-symbol-logo
5607
+ * @secure
5608
+ */
5609
+ logosCryptoSymbolLogo(query: {
5610
+ /** Company symbol */
5611
+ symbol: string;
5612
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
5613
+ /**
5614
+ * @description Returns direct logo for crypto symbol
5615
+ * @tags Logos
5616
+ * @name LogosDirectCryptoSymbolLogo
5617
+ * @summary Get direct logo for crypto symbol
5618
+ * @request GET:/logos/direct-crypto-symbol-logo
5365
5619
  * @secure
5366
5620
  */
5367
- getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError>>;
5621
+ logosDirectCryptoSymbolLogo(query: {
5622
+ /** Company symbol */
5623
+ symbol: string;
5624
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5368
5625
  /**
5369
- * @description get fund screener presets
5370
- * @tags Funds
5371
- * @name GetFundScreenerPresets
5372
- * @summary get fund screener presets
5373
- * @request GET:/funds/screener/presets
5626
+ * @description Returns direct logo for symbol
5627
+ * @tags Logos
5628
+ * @name LogosDirectSymbolLogo
5629
+ * @summary Get direct logo for symbol
5630
+ * @request GET:/logos/direct-symbol-logo
5374
5631
  * @secure
5375
5632
  */
5376
- getFundScreenerPresets(query: {
5377
- /** how many records to return */
5378
- limit: number;
5379
- /** how many records to skip */
5380
- offset: number;
5381
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
5633
+ logosDirectSymbolLogo(query: {
5634
+ /** Company symbol */
5635
+ symbol: string;
5636
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5382
5637
  /**
5383
- * @description update fund screener preset
5384
- * @tags Funds
5385
- * @name UpdateFundScreenerPreset
5386
- * @summary update fund screener preset
5387
- * @request PUT:/funds/screener/presets
5638
+ * @description Returns logos for multiple symbols
5639
+ * @tags Logos
5640
+ * @name LogosMultipleCryptoSymbolLogo
5641
+ * @summary Get logos for multiple symbols
5642
+ * @request POST:/logos/multiple-crypto-symbol-logo
5388
5643
  * @secure
5389
5644
  */
5390
- updateFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5645
+ logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
5391
5646
  /**
5392
- * @description create fund screener preset
5393
- * @tags Funds
5394
- * @name CreateFundScreenerPreset
5395
- * @summary create fund screener preset
5396
- * @request POST:/funds/screener/presets
5647
+ * @description Returns logos for multiple symbol
5648
+ * @tags Logos
5649
+ * @name LogosMultipleSymbolLogos
5650
+ * @summary Get logos for multiple symbols
5651
+ * @request POST:/logos/multiple-symbol-logos
5397
5652
  * @secure
5398
5653
  */
5399
- createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5654
+ logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
5655
+ /**
5656
+ * @description Returns links of socials logos for symbol
5657
+ * @tags Logos
5658
+ * @name LogosSocialSymbolLogos
5659
+ * @summary Get social logos for symbol
5660
+ * @request GET:/logos/social-symbol-logos
5661
+ * @secure
5662
+ */
5663
+ logosSocialSymbolLogos(query: {
5664
+ /** Company symbol */
5665
+ symbol: string;
5666
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
5667
+ /**
5668
+ * @description Returns logos for company symbol
5669
+ * @tags Logos
5670
+ * @name LogosSymbolLogos
5671
+ * @summary Get symbol logos
5672
+ * @request GET:/logos/symbol-logos
5673
+ * @secure
5674
+ */
5675
+ logosSymbolLogos(query: {
5676
+ /** Company symbol */
5677
+ symbol: string;
5678
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
5679
+ }
5680
+ export class MarketDates<HandleError extends boolean = boolean> {
5681
+ protected readonly apiClient: JwtClient<HandleError>;
5682
+ constructor(apiClient: JwtClient<HandleError>);
5683
+ /**
5684
+ * @description Create or update market date
5685
+ * @tags MarketDates
5686
+ * @name CreateOrUpdateMarketDate
5687
+ * @summary Create or update market date
5688
+ * @request POST:/market-dates
5689
+ * @secure
5690
+ */
5691
+ createOrUpdateMarketDate(market: InsightMarketDates[], config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate[], HandleError>>;
5692
+ /**
5693
+ * @description Remove market date
5694
+ * @tags MarketDates
5695
+ * @name RemoveMarketDate
5696
+ * @summary Remove market date
5697
+ * @request DELETE:/market-dates
5698
+ * @secure
5699
+ */
5700
+ removeMarketDate(input: InsightRemoveMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5701
+ /**
5702
+ * @description Get market dates history
5703
+ * @tags MarketDates
5704
+ * @name GetMarketDatesHistory
5705
+ * @summary Get market dates history
5706
+ * @request POST:/market-dates/history
5707
+ * @secure
5708
+ */
5709
+ getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
5710
+ /**
5711
+ * @description Search locode data by search string and field
5712
+ * @tags MarketDates
5713
+ * @name SearchLocodeData
5714
+ * @summary Search locode data
5715
+ * @request GET:/market-dates/locode
5716
+ * @secure
5717
+ */
5718
+ searchLocodeData(query?: {
5719
+ /** Search string */
5720
+ search?: string;
5721
+ /** Search field */
5722
+ field?: InsightSearchLocodeDataParamsFieldEnum;
5723
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchLocodeDataResponse, HandleError>>;
5724
+ /**
5725
+ * @description Get markets
5726
+ * @tags MarketDates
5727
+ * @name GetMarkets
5728
+ * @summary Get markets
5729
+ * @request GET:/market-dates/markets
5730
+ * @secure
5731
+ */
5732
+ getMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketsResponse, HandleError>>;
5733
+ /**
5734
+ * @description Create or update market
5735
+ * @tags MarketDates
5736
+ * @name CreateOrUpdateMarket
5737
+ * @summary Create or update market
5738
+ * @request POST:/market-dates/markets
5739
+ * @secure
5740
+ */
5741
+ createOrUpdateMarket(market: InsightCreateOrUpdateMarketRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
5742
+ /**
5743
+ * @description Get market
5744
+ * @tags MarketDates
5745
+ * @name GetMarket
5746
+ * @summary Get market
5747
+ * @request GET:/market-dates/markets/{market}
5748
+ * @secure
5749
+ */
5750
+ getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketWithSchedule, HandleError>>;
5751
+ /**
5752
+ * @description Remove market
5753
+ * @tags MarketDates
5754
+ * @name RemoveMarket
5755
+ * @summary Remove market
5756
+ * @request DELETE:/market-dates/markets/{market}
5757
+ * @secure
5758
+ */
5759
+ removeMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5760
+ /**
5761
+ * @description Get market schedules
5762
+ * @tags MarketDates
5763
+ * @name GetMarketSchedules
5764
+ * @summary Get market schedules
5765
+ * @request GET:/market-dates/schedule
5766
+ * @secure
5767
+ */
5768
+ getMarketSchedules(query?: {
5769
+ /** Market codes, comma separated */
5770
+ market?: string;
5771
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError>>;
5772
+ /**
5773
+ * @description CreateOrUpdateMarketSchedule market schedule
5774
+ * @tags MarketDates
5775
+ * @name CreateOrUpdateMarketSchedule
5776
+ * @summary CreateOrUpdateMarketSchedule market schedule
5777
+ * @request POST:/market-dates/schedule
5778
+ * @secure
5779
+ */
5780
+ createOrUpdateMarketSchedule(market: InsightCreateOrUpdateMarketScheduleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
5781
+ /**
5782
+ * @description Get market schedule
5783
+ * @tags MarketDates
5784
+ * @name GetMarketSchedule
5785
+ * @summary Get market schedule
5786
+ * @request GET:/market-dates/schedule/{market}
5787
+ * @secure
5788
+ */
5789
+ getMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
5790
+ /**
5791
+ * @description Remove market schedule
5792
+ * @tags MarketDates
5793
+ * @name RemoveMarketSchedule
5794
+ * @summary Remove market schedule
5795
+ * @request DELETE:/market-dates/schedule/{market}
5796
+ * @secure
5797
+ */
5798
+ removeMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5799
+ /**
5800
+ * @description Get todays market hours
5801
+ * @tags MarketDates
5802
+ * @name GetTodaysMarketHours
5803
+ * @summary Get todays market hours
5804
+ * @request GET:/market-dates/today
5805
+ * @secure
5806
+ */
5807
+ getTodaysMarketHours(query: {
5808
+ /** Market */
5809
+ market: string;
5810
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
5811
+ }
5812
+ export class News<HandleError extends boolean = boolean> {
5813
+ protected readonly apiClient: JwtClient<HandleError>;
5814
+ constructor(apiClient: JwtClient<HandleError>);
5815
+ /**
5816
+ * @description Returns available authors in DB
5817
+ * @tags News
5818
+ * @name NewsAvailableAuthors
5819
+ * @summary Get available authors in DB (for filters)
5820
+ * @request POST:/news/authors
5821
+ * @secure
5822
+ */
5823
+ newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5824
+ /**
5825
+ * @description Returns available channels in DB
5826
+ * @tags News
5827
+ * @name NewsAvailableChannels
5828
+ * @summary Get available channels in DB (for filters)
5829
+ * @request POST:/news/channels
5830
+ * @secure
5831
+ */
5832
+ newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5833
+ /**
5834
+ * @description Get featured articles
5835
+ * @tags News
5836
+ * @name GetFeaturedArticles
5837
+ * @summary Get featured articles
5838
+ * @request GET:/news/featured-articles
5839
+ * @secure
5840
+ */
5841
+ getFeaturedArticles(query: {
5842
+ /** Limit */
5843
+ limit: number;
5844
+ /** Offset */
5845
+ offset: number;
5846
+ /** Start date */
5847
+ start_date?: string;
5848
+ /** End date */
5849
+ end_date?: string;
5850
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
5400
5851
  /**
5401
- * @description remove fund screener preset
5402
- * @tags Funds
5403
- * @name RemoveFundScreenerPreset
5404
- * @summary remove fund screener preset
5405
- * @request DELETE:/funds/screener/presets
5852
+ * @description Update featured articles
5853
+ * @tags News
5854
+ * @name UpdateFeaturedArticles
5855
+ * @summary Update featured articles
5856
+ * @request PUT:/news/featured-articles
5406
5857
  * @secure
5407
5858
  */
5408
- removeFundScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5859
+ updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5409
5860
  /**
5410
- * @description filter funds by params
5411
- * @tags Funds
5412
- * @name FundSectorScreener
5413
- * @summary filter funds by params
5414
- * @request POST:/funds/sector-screener
5861
+ * @description Create featured articles
5862
+ * @tags News
5863
+ * @name CreateFeaturedArticles
5864
+ * @summary Create featured articles
5865
+ * @request POST:/news/featured-articles
5415
5866
  * @secure
5416
5867
  */
5417
- fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
5418
- /** Authorization */
5419
- Authorization?: string;
5420
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
5868
+ createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5421
5869
  /**
5422
- * @description get top funds
5423
- * @tags Funds
5424
- * @name GetTopFunds
5425
- * @summary get top funds
5426
- * @request POST:/funds/top
5870
+ * @description Get active featured articles
5871
+ * @tags News
5872
+ * @name GetActiveFeaturedArticles
5873
+ * @summary Get active featured articles
5874
+ * @request GET:/news/featured-articles/active
5427
5875
  * @secure
5428
5876
  */
5429
- getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
5430
- /** Authorization */
5431
- Authorization?: string;
5432
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
5433
- }
5434
- export class StockScreener<HandleError extends boolean = boolean> {
5435
- protected readonly apiClient: JwtClient<HandleError>;
5436
- constructor(apiClient: JwtClient<HandleError>);
5877
+ getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
5437
5878
  /**
5438
- * @description data for visual heat map
5439
- * @tags StockScreener
5440
- * @name StockMarketHeatmap
5441
- * @summary data for visual heat map
5442
- * @request GET:/heatmaps
5879
+ * @description Set featured articles
5880
+ * @tags News
5881
+ * @name SetFeaturedArticles
5882
+ * @summary Set featured articles
5883
+ * @request POST:/news/featured-articles/set
5443
5884
  * @secure
5444
5885
  */
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>>;
5886
+ setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5449
5887
  /**
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
5888
+ * @description Get featured article
5889
+ * @tags News
5890
+ * @name GetFeaturedArticle
5891
+ * @summary Get featured article
5892
+ * @request GET:/news/featured-articles/{id}
5455
5893
  * @secure
5456
5894
  */
5457
- createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5895
+ getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
5458
5896
  /**
5459
- * @description Sector and Industry Group performance
5460
- * @tags StockScreener
5461
- * @name IndustriesPerformance
5462
- * @summary get industries performance
5463
- * @request POST:/industries-performance
5897
+ * @description Returns news by filters
5898
+ * @tags News
5899
+ * @name NewsFiltered
5900
+ * @summary Get filtered news
5901
+ * @request POST:/news/filter
5464
5902
  * @secure
5465
5903
  */
5466
- industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
5904
+ newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
5467
5905
  /**
5468
- * @description filter stocks by params
5469
- * @tags StockScreener
5470
- * @name StockScreener
5471
- * @summary filter stocks by params
5472
- * @request POST:/stock-screener
5906
+ * @description Returns news by id
5907
+ * @tags News
5908
+ * @name NewsById
5909
+ * @summary Get news by id
5910
+ * @request POST:/news/id
5473
5911
  * @secure
5474
5912
  */
5475
- stockScreener(filter: InsightStockScreenerV1Request, headers?: {
5476
- /** Authorization */
5477
- Authorization?: string;
5478
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5913
+ newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
5479
5914
  /**
5480
- * @description get screener presets
5481
- * @tags StockScreener
5482
- * @name GetScreenerPresets
5483
- * @summary get screener presets
5484
- * @request GET:/stock-screener/presets
5915
+ * @description Returns news previews
5916
+ * @tags News
5917
+ * @name NewsPreviewsFiltered
5918
+ * @summary Get news previews
5919
+ * @request GET:/news/previews
5485
5920
  * @secure
5486
5921
  */
5487
- getScreenerPresets(query: {
5488
- /** how many records to return */
5922
+ newsPreviewsFiltered(query: {
5923
+ /** Start date */
5924
+ start_date?: string;
5925
+ /** End date */
5926
+ end_date?: string;
5927
+ /** Symbol */
5928
+ symbol?: string;
5929
+ /** how many records to return. Max value is 50 */
5489
5930
  limit: number;
5490
5931
  /** how many records to skip */
5491
5932
  offset: number;
5492
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
5933
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
5493
5934
  /**
5494
- * @description update screener preset
5495
- * @tags StockScreener
5496
- * @name UpdateScreenerPreset
5497
- * @summary update screener preset
5498
- * @request PUT:/stock-screener/presets
5935
+ * @description Returns available stocks in DB
5936
+ * @tags News
5937
+ * @name NewsAvailableStocks
5938
+ * @summary Get available stocks in DB (for filters)
5939
+ * @request GET:/news/symbols
5499
5940
  * @secure
5500
5941
  */
5501
- updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5942
+ newsAvailableStocks(query?: {
5943
+ /** Limit */
5944
+ limit?: number;
5945
+ /** Offset */
5946
+ offset?: number;
5947
+ /** search query */
5948
+ search_query?: string;
5949
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5502
5950
  /**
5503
- * @description create screener preset
5504
- * @tags StockScreener
5505
- * @name CreateOrScreenerPreset
5506
- * @summary create screener preset
5507
- * @request POST:/stock-screener/presets
5951
+ * @description Returns available tags in DB
5952
+ * @tags News
5953
+ * @name NewsAvailableTags
5954
+ * @summary Get available tags in DB (for filters)
5955
+ * @request POST:/news/tags
5508
5956
  * @secure
5509
5957
  */
5510
- createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5958
+ newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5959
+ }
5960
+ export class OptionGreeks<HandleError extends boolean = boolean> {
5961
+ protected readonly apiClient: JwtClient<HandleError>;
5962
+ constructor(apiClient: JwtClient<HandleError>);
5511
5963
  /**
5512
- * @description remove screener preset
5513
- * @tags StockScreener
5514
- * @name RemoveScreenerPreset
5515
- * @summary remove screener preset
5516
- * @request DELETE:/stock-screener/presets
5964
+ * @description Returns calculated matrix
5965
+ * @tags OptionGreeks
5966
+ * @name OgCalculateMatrix
5967
+ * @summary Calculate matrix
5968
+ * @request POST:/og/calculate-matrix
5517
5969
  * @secure
5518
5970
  */
5519
- removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5971
+ ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
5520
5972
  /**
5521
- * @description get top symbols
5522
- * @tags StockScreener
5523
- * @name GetTopSymbols
5524
- * @summary get top symbols
5525
- * @request POST:/stock-screener/top
5973
+ * @description Returns calculated params
5974
+ * @tags OptionGreeks
5975
+ * @name OgCalculateParams
5976
+ * @summary Calculate params
5977
+ * @request POST:/og/calculate-params
5526
5978
  * @secure
5527
5979
  */
5528
- getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5980
+ ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
5529
5981
  }
5530
- export class Intraday<HandleError extends boolean = boolean> {
5982
+ export class Ownerships<HandleError extends boolean = boolean> {
5531
5983
  protected readonly apiClient: JwtClient<HandleError>;
5532
5984
  constructor(apiClient: JwtClient<HandleError>);
5533
5985
  /**
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
5986
+ * @description get ownerships by id datadata
5987
+ * @tags Ownerships
5988
+ * @name GetOwnershipsByIdData
5989
+ * @summary get ownerships by id data
5990
+ * @request POST:/ownerships
5539
5991
  * @secure
5540
5992
  */
5541
- intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
5993
+ getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5994
+ /**
5995
+ * @description get ownerships by symbol data
5996
+ * @tags Ownerships
5997
+ * @name GetOwnershipsBySymbolData
5998
+ * @summary get ownerships by symbol data
5999
+ * @request POST:/symbol-ownerships
6000
+ * @secure
6001
+ */
6002
+ getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5542
6003
  }
5543
- export class Quotes<HandleError extends boolean = boolean> {
6004
+ export class Passport<HandleError extends boolean = boolean> {
5544
6005
  protected readonly apiClient: JwtClient<HandleError>;
5545
6006
  constructor(apiClient: JwtClient<HandleError>);
5546
6007
  /**
5547
- * @description Get single historical quote
5548
- * @tags Quotes
5549
- * @name GitHistoricalQuote
5550
- * @summary Get single historical quote
5551
- * @request GET:/historical/quote
6008
+ * @description Returns article by id
6009
+ * @tags Passport
6010
+ * @name PassportArticleById
6011
+ * @summary Get article by id
6012
+ * @request POST:/passport/article-by-id
5552
6013
  * @secure
5553
6014
  */
5554
- gitHistoricalQuote(query: {
5555
- /** Symbol */
5556
- symbol: string;
5557
- /** Date */
5558
- date: string;
5559
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
6015
+ passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
5560
6016
  /**
5561
- * @description get quote history by symbol
5562
- * @tags Quotes
5563
- * @name GitQuoteHistory
5564
- * @summary Get quote history
5565
- * @request POST:/quote-history
6017
+ * @description Returns articles
6018
+ * @tags Passport
6019
+ * @name PassportArticles
6020
+ * @summary Get articles
6021
+ * @request POST:/passport/articles
6022
+ * @secure
6023
+ */
6024
+ passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6025
+ /**
6026
+ * @description Returns author profile
6027
+ * @tags Passport
6028
+ * @name PassportAuthorProfile
6029
+ * @summary Get author profile
6030
+ * @request POST:/passport/author-profile
6031
+ * @secure
6032
+ */
6033
+ passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
6034
+ /**
6035
+ * @description Returns most popular tags
6036
+ * @tags Passport
6037
+ * @name PassportMostPopularTags
6038
+ * @summary Get most popular tags
6039
+ * @request POST:/passport/most-popular-tags
6040
+ * @secure
6041
+ */
6042
+ passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
6043
+ /**
6044
+ * @description Returns news feed
6045
+ * @tags Passport
6046
+ * @name PassportNewsFeed
6047
+ * @summary Get news feed
6048
+ * @request POST:/passport/newsfeed
5566
6049
  * @secure
5567
6050
  */
5568
- gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
6051
+ passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
5569
6052
  /**
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
6053
+ * @description Returns article by parameters
6054
+ * @tags Passport
6055
+ * @name PassportSearchArticle
6056
+ * @summary Search article by parameters
6057
+ * @request POST:/passport/search-article
5575
6058
  * @secure
5576
6059
  */
5577
- getQuotesEquityData(query: {
5578
- /** Comma separated symbols */
5579
- symbols: string;
5580
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
6060
+ passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
5581
6061
  }
5582
6062
  export class PreIpoCompanies<HandleError extends boolean = boolean> {
5583
6063
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5866,468 +6346,288 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
5866
6346
  include_documents?: boolean;
5867
6347
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
5868
6348
  }
5869
- export class Ipos<HandleError extends boolean = boolean> {
5870
- protected readonly apiClient: JwtClient<HandleError>;
5871
- constructor(apiClient: JwtClient<HandleError>);
5872
- /**
5873
- * @description get recent ipos info
5874
- * @tags Ipos
5875
- * @name PostRecent
5876
- * @summary get recent ipos info
5877
- * @request POST:/ipos/recent
5878
- * @secure
5879
- */
5880
- postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5881
- /**
5882
- * @description get upcoming ipos info
5883
- * @tags Ipos
5884
- * @name GetUpcoming
5885
- * @summary get upcoming ipos info
5886
- * @request GET:/ipos/upcoming
5887
- * @secure
5888
- */
5889
- getUpcoming(query: {
5890
- /** how many records to return. Max value is 50 */
5891
- limit: number;
5892
- /** how many records to skip */
5893
- offset: number;
5894
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5895
- /**
5896
- * @description get ipo info by symbol
5897
- * @tags Ipos
5898
- * @name GetIpos
5899
- * @summary get ipo info by symbol
5900
- * @request GET:/ipos/{symbol}
5901
- * @secure
5902
- */
5903
- getIpos(symbol: string, query?: {
5904
- /** load quotes */
5905
- load_quotes?: boolean;
5906
- /** statuses */
5907
- statuses?: string[];
5908
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
5909
- }
5910
- export class Logos<HandleError extends boolean = boolean> {
6349
+ export class Public<HandleError extends boolean = boolean> {
5911
6350
  protected readonly apiClient: JwtClient<HandleError>;
5912
6351
  constructor(apiClient: JwtClient<HandleError>);
5913
6352
  /**
5914
- * @description Returns converted logo for crypto symbol
5915
- * @tags Logos
5916
- * @name LogosConvertedCryptoSymbolLogo
5917
- * @summary Get converted logo for crypto symbol
5918
- * @request POST:/logos/converted-crypto-symbol-logo
5919
- * @secure
5920
- */
5921
- logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5922
- /**
5923
- * @description Returns converted logo for symbol
5924
- * @tags Logos
5925
- * @name LogosConvertedSymbolLogo
5926
- * @summary Get converted logo for symbol
5927
- * @request POST:/logos/converted-symbol-logo
5928
- * @secure
5929
- */
5930
- logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5931
- /**
5932
- * @description Returns logo for crypto symbol
5933
- * @tags Logos
5934
- * @name LogosCryptoSymbolLogo
5935
- * @summary Get logo for crypto symbol
5936
- * @request GET:/logos/crypto-symbol-logo
5937
- * @secure
5938
- */
5939
- logosCryptoSymbolLogo(query: {
5940
- /** Company symbol */
5941
- symbol: string;
5942
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
5943
- /**
5944
- * @description Returns direct logo for crypto symbol
5945
- * @tags Logos
5946
- * @name LogosDirectCryptoSymbolLogo
5947
- * @summary Get direct logo for crypto symbol
5948
- * @request GET:/logos/direct-crypto-symbol-logo
5949
- * @secure
5950
- */
5951
- logosDirectCryptoSymbolLogo(query: {
5952
- /** Company symbol */
5953
- symbol: string;
5954
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5955
- /**
5956
- * @description Returns direct logo for symbol
5957
- * @tags Logos
5958
- * @name LogosDirectSymbolLogo
5959
- * @summary Get direct logo for symbol
5960
- * @request GET:/logos/direct-symbol-logo
5961
- * @secure
5962
- */
5963
- logosDirectSymbolLogo(query: {
5964
- /** Company symbol */
5965
- symbol: string;
5966
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5967
- /**
5968
- * @description Returns logos for multiple symbols
5969
- * @tags Logos
5970
- * @name LogosMultipleCryptoSymbolLogo
5971
- * @summary Get logos for multiple symbols
5972
- * @request POST:/logos/multiple-crypto-symbol-logo
5973
- * @secure
5974
- */
5975
- logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
5976
- /**
5977
- * @description Returns logos for multiple symbol
5978
- * @tags Logos
5979
- * @name LogosMultipleSymbolLogos
5980
- * @summary Get logos for multiple symbols
5981
- * @request POST:/logos/multiple-symbol-logos
5982
- * @secure
5983
- */
5984
- logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
5985
- /**
5986
- * @description Returns links of socials logos for symbol
5987
- * @tags Logos
5988
- * @name LogosSocialSymbolLogos
5989
- * @summary Get social logos for symbol
5990
- * @request GET:/logos/social-symbol-logos
5991
- * @secure
5992
- */
5993
- logosSocialSymbolLogos(query: {
5994
- /** Company symbol */
5995
- symbol: string;
5996
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
5997
- /**
5998
- * @description Returns logos for company symbol
5999
- * @tags Logos
6000
- * @name LogosSymbolLogos
6001
- * @summary Get symbol logos
6002
- * @request GET:/logos/symbol-logos
6353
+ * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
6354
+ * @tags Public
6355
+ * @name CalculateEstimatedReturns
6356
+ * @summary Calculate Estimated Returns
6357
+ * @request GET:/public/estimated-returns
6003
6358
  * @secure
6004
6359
  */
6005
- logosSymbolLogos(query: {
6006
- /** Company symbol */
6360
+ calculateEstimatedReturns(query: {
6361
+ /** Single symbol */
6007
6362
  symbol: string;
6008
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
6009
- }
6010
- export class MarketDates<HandleError extends boolean = boolean> {
6011
- protected readonly apiClient: JwtClient<HandleError>;
6012
- constructor(apiClient: JwtClient<HandleError>);
6013
- /**
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
6019
- * @secure
6020
- */
6021
- createOrUpdateMarketDate(market: InsightMarketDates[], config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate[], HandleError>>;
6022
- /**
6023
- * @description Remove market date
6024
- * @tags MarketDates
6025
- * @name RemoveMarketDate
6026
- * @summary Remove market date
6027
- * @request DELETE:/market-dates
6028
- * @secure
6029
- */
6030
- removeMarketDate(input: InsightRemoveMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6031
- /**
6032
- * @description Get market dates history
6033
- * @tags MarketDates
6034
- * @name GetMarketDatesHistory
6035
- * @summary Get market dates history
6036
- * @request POST:/market-dates/history
6037
- * @secure
6038
- */
6039
- getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
6040
- /**
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
6046
- * @secure
6047
- */
6048
- searchLocodeData(query?: {
6049
- /** Search string */
6050
- search?: string;
6051
- /** Search field */
6052
- field?: InsightSearchLocodeDataParamsFieldEnum;
6053
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchLocodeDataResponse, HandleError>>;
6054
- /**
6055
- * @description Get markets
6056
- * @tags MarketDates
6057
- * @name GetMarkets
6058
- * @summary Get markets
6059
- * @request GET:/market-dates/markets
6060
- * @secure
6061
- */
6062
- getMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketsResponse, HandleError>>;
6063
- /**
6064
- * @description Create or update market
6065
- * @tags MarketDates
6066
- * @name CreateOrUpdateMarket
6067
- * @summary Create or update market
6068
- * @request POST:/market-dates/markets
6069
- * @secure
6070
- */
6071
- createOrUpdateMarket(market: InsightCreateOrUpdateMarketRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
6072
- /**
6073
- * @description Get market
6074
- * @tags MarketDates
6075
- * @name GetMarket
6076
- * @summary Get market
6077
- * @request GET:/market-dates/markets/{market}
6078
- * @secure
6079
- */
6080
- getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketWithSchedule, HandleError>>;
6081
- /**
6082
- * @description Remove market
6083
- * @tags MarketDates
6084
- * @name RemoveMarket
6085
- * @summary Remove market
6086
- * @request DELETE:/market-dates/markets/{market}
6087
- * @secure
6088
- */
6089
- removeMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6363
+ /**
6364
+ * Non-zero amount
6365
+ * @format float64
6366
+ */
6367
+ amount: number;
6368
+ /** Start date for calculations */
6369
+ start_date: string;
6370
+ /** End date for calculations */
6371
+ end_date: string;
6372
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
6090
6373
  /**
6091
- * @description Get market schedules
6092
- * @tags MarketDates
6093
- * @name GetMarketSchedules
6094
- * @summary Get market schedules
6095
- * @request GET:/market-dates/schedule
6374
+ * @description Returns an expert forecast
6375
+ * @tags Public
6376
+ * @name ExpertForecast
6377
+ * @summary Expert forecast
6378
+ * @request GET:/public/expert-forecast
6096
6379
  * @secure
6097
6380
  */
6098
- getMarketSchedules(query?: {
6099
- /** Market codes, comma separated */
6100
- market?: string;
6101
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError>>;
6381
+ expertForecast(query: {
6382
+ /** Comma separated symbols */
6383
+ symbols: string;
6384
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
6102
6385
  /**
6103
- * @description CreateOrUpdateMarketSchedule market schedule
6104
- * @tags MarketDates
6105
- * @name CreateOrUpdateMarketSchedule
6106
- * @summary CreateOrUpdateMarketSchedule market schedule
6107
- * @request POST:/market-dates/schedule
6386
+ * @description get fundamentals by symbol data
6387
+ * @tags Public
6388
+ * @name GetPublicFundamentalsBySymbolData
6389
+ * @summary get fundamentals by symbol data
6390
+ * @request GET:/public/fundamentals/{symbol}
6108
6391
  * @secure
6109
6392
  */
6110
- createOrUpdateMarketSchedule(market: InsightCreateOrUpdateMarketScheduleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
6393
+ getPublicFundamentalsBySymbolData(symbol: string, query: {
6394
+ /** Annual or quarterly */
6395
+ mode: string;
6396
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
6111
6397
  /**
6112
- * @description Get market schedule
6113
- * @tags MarketDates
6114
- * @name GetMarketSchedule
6115
- * @summary Get market schedule
6116
- * @request GET:/market-dates/schedule/{market}
6398
+ * @description Daily price history
6399
+ * @tags Public
6400
+ * @name DailyPriceHistory
6401
+ * @summary Daily price history
6402
+ * @request GET:/public/price-history/daily
6117
6403
  * @secure
6118
6404
  */
6119
- getMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
6405
+ dailyPriceHistory(query: {
6406
+ /** Single symbol */
6407
+ symbol: string;
6408
+ /** Target date */
6409
+ date: string;
6410
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
6120
6411
  /**
6121
- * @description Remove market schedule
6122
- * @tags MarketDates
6123
- * @name RemoveMarketSchedule
6124
- * @summary Remove market schedule
6125
- * @request DELETE:/market-dates/schedule/{market}
6412
+ * @description Public quote profile
6413
+ * @tags Public
6414
+ * @name PublicQuoteProfile
6415
+ * @summary Public quote profile
6416
+ * @request GET:/public/quote-profile/{symbol}
6126
6417
  * @secure
6127
6418
  */
6128
- removeMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6419
+ publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
6129
6420
  /**
6130
- * @description Get todays market hours
6131
- * @tags MarketDates
6132
- * @name GetTodaysMarketHours
6133
- * @summary Get todays market hours
6134
- * @request GET:/market-dates/today
6421
+ * @description get ratios by symbol data
6422
+ * @tags Public
6423
+ * @name GetPublicRatiosBySymbolData
6424
+ * @summary get ratios by symbol data
6425
+ * @request GET:/public/ratios/{symbol}
6135
6426
  * @secure
6136
6427
  */
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>);
6428
+ getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
6145
6429
  /**
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
6430
+ * @description find a symbol by name or description
6431
+ * @tags Public
6432
+ * @name QuoteFundamentalsSearch
6433
+ * @summary find a symbol by name or description
6434
+ * @request GET:/public/symbol-search
6151
6435
  * @secure
6152
6436
  */
6153
- newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6437
+ quoteFundamentalsSearch(query: {
6438
+ /** Search query */
6439
+ search_query: string;
6440
+ /** how many records to return. Max value is 50 */
6441
+ limit: number;
6442
+ /** how many records to skip */
6443
+ offset: number;
6444
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
6154
6445
  /**
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
6446
+ * @description Get top gainers
6447
+ * @tags Public
6448
+ * @name TopGainers
6449
+ * @summary Top Gainers
6450
+ * @request GET:/public/top-gainers
6160
6451
  * @secure
6161
6452
  */
6162
- newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6453
+ topGainers(query: {
6454
+ /** sort direction - asc or desc */
6455
+ order_direction?: string;
6456
+ /** how many records to return. Max value is 50 */
6457
+ limit: number;
6458
+ /** how many records to skip */
6459
+ offset: number;
6460
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6163
6461
  /**
6164
- * @description Get featured articles
6165
- * @tags News
6166
- * @name GetFeaturedArticles
6167
- * @summary Get featured articles
6168
- * @request GET:/news/featured-articles
6462
+ * @description Get top stocks
6463
+ * @tags Public
6464
+ * @name TopStocks
6465
+ * @summary Top Stocks
6466
+ * @request GET:/public/top-stocks
6169
6467
  * @secure
6170
6468
  */
6171
- getFeaturedArticles(query: {
6172
- /** Limit */
6469
+ topStocks(query: {
6470
+ /** EQUITY|ETF|CRYPTO */
6471
+ stock_type: InsightTopStocksParamsStockTypeEnum;
6472
+ /** how many records to return. Max value is 50 */
6173
6473
  limit: number;
6174
- /** Offset */
6474
+ /** how many records to skip */
6175
6475
  offset: number;
6176
- /** Start date */
6177
- start_date?: string;
6178
- /** End date */
6179
- end_date?: string;
6180
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
6476
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6477
+ }
6478
+ export class Quotes<HandleError extends boolean = boolean> {
6479
+ protected readonly apiClient: JwtClient<HandleError>;
6480
+ constructor(apiClient: JwtClient<HandleError>);
6181
6481
  /**
6182
- * @description Update featured articles
6183
- * @tags News
6184
- * @name UpdateFeaturedArticles
6185
- * @summary Update featured articles
6186
- * @request PUT:/news/featured-articles
6482
+ * @description Get single historical quote
6483
+ * @tags Quotes
6484
+ * @name GitHistoricalQuote
6485
+ * @summary Get single historical quote
6486
+ * @request GET:/historical/quote
6187
6487
  * @secure
6188
6488
  */
6189
- updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6489
+ gitHistoricalQuote(query: {
6490
+ /** Symbol */
6491
+ symbol: string;
6492
+ /** Date */
6493
+ date: string;
6494
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
6190
6495
  /**
6191
- * @description Create featured articles
6192
- * @tags News
6193
- * @name CreateFeaturedArticles
6194
- * @summary Create featured articles
6195
- * @request POST:/news/featured-articles
6496
+ * @description get quote history by symbol
6497
+ * @tags Quotes
6498
+ * @name GitQuoteHistory
6499
+ * @summary Get quote history
6500
+ * @request POST:/quote-history
6196
6501
  * @secure
6197
6502
  */
6198
- createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6503
+ gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
6199
6504
  /**
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
6505
+ * @description Returns a list of quotes equity info for specified symbols.
6506
+ * @tags Quotes
6507
+ * @name GetQuotesEquityData
6508
+ * @summary Get Quotes Equity data
6509
+ * @request GET:/quotes/equity
6205
6510
  * @secure
6206
6511
  */
6207
- getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
6512
+ getQuotesEquityData(query: {
6513
+ /** Comma separated symbols */
6514
+ symbols: string;
6515
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
6516
+ }
6517
+ export class StockScreener<HandleError extends boolean = boolean> {
6518
+ protected readonly apiClient: JwtClient<HandleError>;
6519
+ constructor(apiClient: JwtClient<HandleError>);
6208
6520
  /**
6209
- * @description Set featured articles
6210
- * @tags News
6211
- * @name SetFeaturedArticles
6212
- * @summary Set featured articles
6213
- * @request POST:/news/featured-articles/set
6521
+ * @description data for visual heat map
6522
+ * @tags StockScreener
6523
+ * @name StockMarketHeatmap
6524
+ * @summary data for visual heat map
6525
+ * @request GET:/heatmaps
6214
6526
  * @secure
6215
6527
  */
6216
- setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6528
+ stockMarketHeatmap(query?: {
6529
+ /** Name of symbol list to fetch details for. Empty is default */
6530
+ heatmap_name?: string;
6531
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
6217
6532
  /**
6218
- * @description Get featured article
6219
- * @tags News
6220
- * @name GetFeaturedArticle
6221
- * @summary Get featured article
6222
- * @request GET:/news/featured-articles/{id}
6533
+ * @description create or update heat map preset
6534
+ * @tags StockScreener
6535
+ * @name CreateStockMarketHeatmapPreset
6536
+ * @summary create or update heat map preset
6537
+ * @request POST:/heatmaps
6223
6538
  * @secure
6224
6539
  */
6225
- getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
6540
+ createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6226
6541
  /**
6227
- * @description Returns news by filters
6228
- * @tags News
6229
- * @name NewsFiltered
6230
- * @summary Get filtered news
6231
- * @request POST:/news/filter
6542
+ * @description Sector and Industry Group performance
6543
+ * @tags StockScreener
6544
+ * @name IndustriesPerformance
6545
+ * @summary get industries performance
6546
+ * @request POST:/industries-performance
6232
6547
  * @secure
6233
6548
  */
6234
- newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
6549
+ industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
6235
6550
  /**
6236
- * @description Returns news by id
6237
- * @tags News
6238
- * @name NewsById
6239
- * @summary Get news by id
6240
- * @request POST:/news/id
6551
+ * @description filter stocks by params
6552
+ * @tags StockScreener
6553
+ * @name StockScreener
6554
+ * @summary filter stocks by params
6555
+ * @request POST:/stock-screener
6241
6556
  * @secure
6242
6557
  */
6243
- newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
6558
+ stockScreener(filter: InsightStockScreenerV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
6244
6559
  /**
6245
- * @description Returns news previews
6246
- * @tags News
6247
- * @name NewsPreviewsFiltered
6248
- * @summary Get news previews
6249
- * @request GET:/news/previews
6560
+ * @description get screener presets
6561
+ * @tags StockScreener
6562
+ * @name GetScreenerPresets
6563
+ * @summary get screener presets
6564
+ * @request GET:/stock-screener/presets
6250
6565
  * @secure
6251
6566
  */
6252
- newsPreviewsFiltered(query: {
6253
- /** Start date */
6254
- start_date?: string;
6255
- /** End date */
6256
- end_date?: string;
6257
- /** Symbol */
6258
- symbol?: string;
6259
- /** how many records to return. Max value is 50 */
6567
+ getScreenerPresets(query: {
6568
+ /** how many records to return */
6260
6569
  limit: number;
6261
6570
  /** how many records to skip */
6262
6571
  offset: number;
6263
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
6572
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
6264
6573
  /**
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
6574
+ * @description update screener preset
6575
+ * @tags StockScreener
6576
+ * @name UpdateScreenerPreset
6577
+ * @summary update screener preset
6578
+ * @request PUT:/stock-screener/presets
6270
6579
  * @secure
6271
6580
  */
6272
- newsAvailableStocks(query?: {
6273
- /** Limit */
6274
- limit?: number;
6275
- /** Offset */
6276
- offset?: number;
6277
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6581
+ updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
6278
6582
  /**
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
6583
+ * @description create screener preset
6584
+ * @tags StockScreener
6585
+ * @name CreateOrScreenerPreset
6586
+ * @summary create screener preset
6587
+ * @request POST:/stock-screener/presets
6284
6588
  * @secure
6285
6589
  */
6286
- newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6287
- }
6288
- export class OptionGreeks<HandleError extends boolean = boolean> {
6289
- protected readonly apiClient: JwtClient<HandleError>;
6290
- constructor(apiClient: JwtClient<HandleError>);
6590
+ createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
6291
6591
  /**
6292
- * @description Returns calculated matrix
6293
- * @tags OptionGreeks
6294
- * @name OgCalculateMatrix
6295
- * @summary Calculate matrix
6296
- * @request POST:/og/calculate-matrix
6592
+ * @description remove screener preset
6593
+ * @tags StockScreener
6594
+ * @name RemoveScreenerPreset
6595
+ * @summary remove screener preset
6596
+ * @request DELETE:/stock-screener/presets
6297
6597
  * @secure
6298
6598
  */
6299
- ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
6599
+ removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6300
6600
  /**
6301
- * @description Returns calculated params
6302
- * @tags OptionGreeks
6303
- * @name OgCalculateParams
6304
- * @summary Calculate params
6305
- * @request POST:/og/calculate-params
6601
+ * @description get top symbols
6602
+ * @tags StockScreener
6603
+ * @name GetTopSymbols
6604
+ * @summary get top symbols
6605
+ * @request POST:/stock-screener/top
6306
6606
  * @secure
6307
6607
  */
6308
- ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
6608
+ getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
6309
6609
  }
6310
- export class Ownerships<HandleError extends boolean = boolean> {
6610
+ export class StockScreenerV2<HandleError extends boolean = boolean> {
6311
6611
  protected readonly apiClient: JwtClient<HandleError>;
6312
6612
  constructor(apiClient: JwtClient<HandleError>);
6313
6613
  /**
6314
- * @description get ownerships by id datadata
6315
- * @tags Ownerships
6316
- * @name GetOwnershipsByIdData
6317
- * @summary get ownerships by id data
6318
- * @request POST:/ownerships
6614
+ * @description filter stocks by params
6615
+ * @tags StockScreener
6616
+ * @name StockScreener
6617
+ * @summary filter stocks by params
6618
+ * @request POST:/stock-screener
6319
6619
  * @secure
6320
6620
  */
6321
- getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6621
+ stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
6322
6622
  /**
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
6623
+ * @description get top symbols
6624
+ * @tags StockScreener
6625
+ * @name GetTopSymbols
6626
+ * @summary get top symbols
6627
+ * @request POST:/stock-screener/top
6328
6628
  * @secure
6329
6629
  */
6330
- getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6630
+ getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
6331
6631
  }
6332
6632
  export class TipRank<HandleError extends boolean = boolean> {
6333
6633
  protected readonly apiClient: JwtClient<HandleError>;
@@ -6651,535 +6951,244 @@ export class TipRank<HandleError extends boolean = boolean> {
6651
6951
  * @request GET:/tipranks/stocks-top-movers
6652
6952
  * @secure
6653
6953
  */
6654
- tiprankStocksTopMovers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksTopMoversResponse[], HandleError>>;
6655
- /**
6656
- * @description Returns the stock symbols covered by TipRanks.
6657
- * @tags TipRank
6658
- * @name TiprankSupportedTickers
6659
- * @summary Get tiprank SupportedTickers
6660
- * @request GET:/tipranks/supported-tickers
6661
- * @secure
6662
- */
6663
- tiprankSupportedTickers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSupportedTickersResponse, HandleError>>;
6664
- /**
6665
- * @description Returns a list of stocks that have the strongest consensus ratings (Strong Buy or Strong Sell) amongst top-ranked analysts (ranked 3.5 stars or higher).
6666
- * @tags TipRank
6667
- * @name TiprankTopRateStocks
6668
- * @summary Get tiprank TopRateStocks
6669
- * @request GET:/tipranks/top-rate-stocks
6670
- * @secure
6671
- */
6672
- tiprankTopRateStocks(query?: {
6673
- /** Return the most trending X stocks */
6674
- num?: number;
6675
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopRateStocksResponse, HandleError>>;
6676
- /**
6677
- * @description Returns the top-rated stocks by the sector of the given ticker. The API call returns top stocks by analysts, bloggers, insiders, hedge funds, news sentiment and individual investor sentiment.
6678
- * @tags TipRank
6679
- * @name TiprankTopStocksBySectors
6680
- * @summary Get tiprank TopStocksBySectors
6681
- * @request POST:/tipranks/top-stocks-by-sectors
6682
- * @secure
6683
- */
6684
- tiprankTopStocksBySectors(filter: InsightTopStocksBySectorsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksBySectorsResponse, HandleError>>;
6685
- /**
6686
- * @description Returns a list of stocks with the highest number of analyst ratings in the last 7 days.
6687
- * @tags TipRank
6688
- * @name TiprankTrendingStocks
6689
- * @summary Get tiprank TrendingStocks
6690
- * @request POST:/tipranks/trending-stocks
6691
- * @secure
6692
- */
6693
- tiprankTrendingStocks(filter: InsightTrendingStocksRequest, headers?: {
6694
- /** Authorization */
6695
- Authorization?: string;
6696
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
6697
- }
6698
- export class UsageTracking<HandleError extends boolean = boolean> {
6699
- protected readonly apiClient: JwtClient<HandleError>;
6700
- constructor(apiClient: JwtClient<HandleError>);
6701
- /**
6702
- * @description get usage date per branch for a period
6703
- * @tags UsageTracking
6704
- * @name GetUsageData
6705
- * @summary get insight usage data
6706
- * @request POST:/tracking/usage
6707
- * @secure
6708
- */
6709
- getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
6710
- }
6711
- export class Passport<HandleError extends boolean = boolean> {
6712
- protected readonly apiClient: JwtClient<HandleError>;
6713
- constructor(apiClient: JwtClient<HandleError>);
6714
- /**
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
6720
- * @secure
6721
- */
6722
- passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
6723
- /**
6724
- * @description Returns articles
6725
- * @tags Passport
6726
- * @name PassportArticles
6727
- * @summary Get articles
6728
- * @request POST:/passport/articles
6729
- * @secure
6730
- */
6731
- passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6732
- /**
6733
- * @description Returns author profile
6734
- * @tags Passport
6735
- * @name PassportAuthorProfile
6736
- * @summary Get author profile
6737
- * @request POST:/passport/author-profile
6738
- * @secure
6739
- */
6740
- passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
6741
- /**
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
6747
- * @secure
6748
- */
6749
- passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
6750
- /**
6751
- * @description Returns news feed
6752
- * @tags Passport
6753
- * @name PassportNewsFeed
6754
- * @summary Get news feed
6755
- * @request POST:/passport/newsfeed
6756
- * @secure
6757
- */
6758
- passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
6759
- /**
6760
- * @description Returns article by parameters
6761
- * @tags Passport
6762
- * @name PassportSearchArticle
6763
- * @summary Search article by parameters
6764
- * @request POST:/passport/search-article
6765
- * @secure
6766
- */
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>);
6772
- /**
6773
- * @description get seasonlity data with comparison to benchmark
6774
- * @tags AlphaTools
6775
- * @name GetMomentumRatioGraph
6776
- * @summary get seasonlity data
6777
- * @request POST:/rst
6778
- * @secure
6779
- */
6780
- getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
6781
- /**
6782
- * @description get seasonlity data with comparison to benchmark
6783
- * @tags AlphaTools
6784
- * @name GetSeasonality
6785
- * @summary get seasonlity data
6786
- * @request POST:/seasonality
6787
- * @secure
6788
- */
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>);
6794
- /**
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
6800
- * @secure
6801
- */
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>>;
6954
+ tiprankStocksTopMovers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksTopMoversResponse[], HandleError>>;
6815
6955
  /**
6816
- * @description Returns an expert forecast
6817
- * @tags Public
6818
- * @name ExpertForecast
6819
- * @summary Expert forecast
6820
- * @request GET:/public/expert-forecast
6956
+ * @description Returns the stock symbols covered by TipRanks.
6957
+ * @tags TipRank
6958
+ * @name TiprankSupportedTickers
6959
+ * @summary Get tiprank SupportedTickers
6960
+ * @request GET:/tipranks/supported-tickers
6821
6961
  * @secure
6822
6962
  */
6823
- expertForecast(query: {
6824
- /** Comma separated symbols */
6825
- symbols: string;
6826
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
6963
+ tiprankSupportedTickers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSupportedTickersResponse, HandleError>>;
6827
6964
  /**
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}
6965
+ * @description Returns a list of stocks that have the strongest consensus ratings (Strong Buy or Strong Sell) amongst top-ranked analysts (ranked 3.5 stars or higher).
6966
+ * @tags TipRank
6967
+ * @name TiprankTopRateStocks
6968
+ * @summary Get tiprank TopRateStocks
6969
+ * @request GET:/tipranks/top-rate-stocks
6833
6970
  * @secure
6834
6971
  */
6835
- getPublicFundamentalsBySymbolData(symbol: string, query: {
6836
- /** Annual or quarterly */
6837
- mode: string;
6838
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
6972
+ tiprankTopRateStocks(query?: {
6973
+ /** Return the most trending X stocks */
6974
+ num?: number;
6975
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopRateStocksResponse, HandleError>>;
6839
6976
  /**
6840
- * @description Daily price history
6841
- * @tags Public
6842
- * @name DailyPriceHistory
6843
- * @summary Daily price history
6844
- * @request GET:/public/price-history/daily
6977
+ * @description Returns the top-rated stocks by the sector of the given ticker. The API call returns top stocks by analysts, bloggers, insiders, hedge funds, news sentiment and individual investor sentiment.
6978
+ * @tags TipRank
6979
+ * @name TiprankTopStocksBySectors
6980
+ * @summary Get tiprank TopStocksBySectors
6981
+ * @request POST:/tipranks/top-stocks-by-sectors
6845
6982
  * @secure
6846
6983
  */
6847
- dailyPriceHistory(query: {
6848
- /** Single symbol */
6849
- symbol: string;
6850
- /** Target date */
6851
- date: string;
6852
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
6984
+ tiprankTopStocksBySectors(filter: InsightTopStocksBySectorsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksBySectorsResponse, HandleError>>;
6853
6985
  /**
6854
- * @description Public quote profile
6855
- * @tags Public
6856
- * @name PublicQuoteProfile
6857
- * @summary Public quote profile
6858
- * @request GET:/public/quote-profile/{symbol}
6986
+ * @description Returns a list of stocks with the highest number of analyst ratings in the last 7 days.
6987
+ * @tags TipRank
6988
+ * @name TiprankTrendingStocks
6989
+ * @summary Get tiprank TrendingStocks
6990
+ * @request POST:/tipranks/trending-stocks
6859
6991
  * @secure
6860
6992
  */
6861
- publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
6993
+ tiprankTrendingStocks(filter: InsightTrendingStocksRequest, headers?: {
6994
+ /** Authorization */
6995
+ Authorization?: string;
6996
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
6997
+ }
6998
+ export class UsageTracking<HandleError extends boolean = boolean> {
6999
+ protected readonly apiClient: JwtClient<HandleError>;
7000
+ constructor(apiClient: JwtClient<HandleError>);
6862
7001
  /**
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}
7002
+ * @description get usage date per branch for a period
7003
+ * @tags UsageTracking
7004
+ * @name GetUsageData
7005
+ * @summary get insight usage data
7006
+ * @request POST:/tracking/usage
6868
7007
  * @secure
6869
7008
  */
6870
- getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
7009
+ getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
7010
+ }
7011
+ export class WorldMarkets<HandleError extends boolean = boolean> {
7012
+ protected readonly apiClient: JwtClient<HandleError>;
7013
+ constructor(apiClient: JwtClient<HandleError>);
6871
7014
  /**
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
7015
+ * @description Get continents
7016
+ * @tags World Markets
7017
+ * @name ContinentGet
7018
+ * @summary Get continents
7019
+ * @request GET:/continents
6877
7020
  * @secure
6878
7021
  */
6879
- quoteFundamentalsSearch(query: {
6880
- /** Search query */
6881
- search_query: string;
6882
- /** how many records to return. Max value is 50 */
7022
+ continentGet(query: {
7023
+ /** Query limit */
6883
7024
  limit: number;
6884
- /** how many records to skip */
7025
+ /** Query offset */
6885
7026
  offset: number;
6886
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
7027
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
6887
7028
  /**
6888
- * @description Get top gainers
6889
- * @tags Public
6890
- * @name TopGainers
6891
- * @summary Top Gainers
6892
- * @request GET:/public/top-gainers
7029
+ * @description Edit continent
7030
+ * @tags World Markets
7031
+ * @name ContinentEdit
7032
+ * @summary Edit continent
7033
+ * @request PUT:/continents
6893
7034
  * @secure
6894
7035
  */
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>>;
7036
+ continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6903
7037
  /**
6904
- * @description Get top stocks
6905
- * @tags Public
6906
- * @name TopStocks
6907
- * @summary Top Stocks
6908
- * @request GET:/public/top-stocks
7038
+ * @description Create continents
7039
+ * @tags World Markets
7040
+ * @name ContinentCreate
7041
+ * @summary Create continents
7042
+ * @request POST:/continents
6909
7043
  * @secure
6910
7044
  */
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[];
7045
+ continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
7046
+ /**
7047
+ * @description Delete continent
7048
+ * @tags World Markets
7049
+ * @name ContinentDelete
7050
+ * @summary Delete continent
7051
+ * @request DELETE:/continents
7052
+ * @secure
7053
+ */
7054
+ continentDelete(query: {
7055
+ /** continent id */
7056
+ id: string;
7057
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7058
+ /**
7059
+ * @description Get country codes
7060
+ * @tags World Markets
7061
+ * @name CountryCodeGet
7062
+ * @summary Get country codes
7063
+ * @request GET:/country-codes
7064
+ * @secure
7065
+ */
7066
+ countryCodeGet(query: {
7067
+ /** Query limit */
7068
+ limit: number;
7069
+ /** Query offset */
7070
+ offset: number;
7071
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
7014
7072
  /**
7015
- * @maxLength 100
7016
- * @example "Donald's"
7073
+ * @description Edit country code
7074
+ * @tags World Markets
7075
+ * @name CountryCodeEdit
7076
+ * @summary Edit country code
7077
+ * @request PUT:/country-codes
7078
+ * @secure
7017
7079
  */
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;
7080
+ countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7026
7081
  /**
7027
- * @maxLength 100
7028
- * @example "Donald's"
7082
+ * @description Add country codes
7083
+ * @tags World Markets
7084
+ * @name CountryCodeAdd
7085
+ * @summary Add country codes
7086
+ * @request POST:/country-codes
7087
+ * @secure
7029
7088
  */
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 {
7089
+ countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
7072
7090
  /**
7073
- * @default "asc"
7074
- * @example "asc"
7091
+ * @description Delete country code
7092
+ * @tags World Markets
7093
+ * @name CountryCodeDelete
7094
+ * @summary Delete country code
7095
+ * @request DELETE:/country-codes
7096
+ * @secure
7075
7097
  */
7076
- direction: InsightOrderingDirectionEnumV2;
7098
+ countryCodeDelete(query: {
7099
+ /** a3 code */
7100
+ a3code: string;
7101
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7077
7102
  /**
7078
- * Sort direction:
7079
- * * asc - Ascending, from A to Z.
7080
- * * desc - Descending, from Z to A.
7081
- * @example "name"
7103
+ * @description Get global indexes
7104
+ * @tags World Markets
7105
+ * @name GlobalIndexGet
7106
+ * @summary Get global indexes
7107
+ * @request GET:/global-indexes
7108
+ * @secure
7082
7109
  */
7083
- field: string;
7084
- }
7085
- export interface InsightPaginationV2 {
7110
+ globalIndexGet(query: {
7111
+ /** Query limit */
7112
+ limit: number;
7113
+ /** Query offset */
7114
+ offset: number;
7115
+ /** Continent code for filtering */
7116
+ continent?: string;
7117
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
7086
7118
  /**
7087
- * @min 1
7088
- * @example 1
7119
+ * @description Edit global index
7120
+ * @tags World Markets
7121
+ * @name GlobalIndexEdit
7122
+ * @summary Edit global index
7123
+ * @request PUT:/global-indexes
7124
+ * @secure
7089
7125
  */
7090
- page: number;
7126
+ globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7091
7127
  /**
7092
- * @min 1
7093
- * @max 50
7094
- * @example 10
7128
+ * @description Add global indexes
7129
+ * @tags World Markets
7130
+ * @name GlobalIndexAdd
7131
+ * @summary Add global indexes
7132
+ * @request POST:/global-indexes
7133
+ * @secure
7095
7134
  */
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>);
7135
+ globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
7152
7136
  /**
7153
- * @description get fixed income entries
7154
- * @tags FixedIncome
7155
- * @name GetFixedIncomeEntries
7156
- * @summary get fixed income entries
7157
- * @request POST:/fixed-income
7137
+ * @description Edit global index
7138
+ * @tags World Markets
7139
+ * @name GlobalIndexDelete
7140
+ * @summary Delete global index
7141
+ * @request DELETE:/global-indexes
7158
7142
  * @secure
7159
7143
  */
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>);
7144
+ globalIndexDelete(query: {
7145
+ /** a3 code */
7146
+ a3code: string;
7147
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7165
7148
  /**
7166
- * @description filter stocks by params
7167
- * @tags StockScreener
7168
- * @name StockScreener
7169
- * @summary filter stocks by params
7170
- * @request POST:/stock-screener
7149
+ * @description Get regions
7150
+ * @tags World Markets
7151
+ * @name RegionGet
7152
+ * @summary Get regions
7153
+ * @request GET:/regions
7171
7154
  * @secure
7172
7155
  */
7173
- stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
7156
+ regionGet(query: {
7157
+ /** Query limit */
7158
+ limit: number;
7159
+ /** Query offset */
7160
+ offset: number;
7161
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
7174
7162
  /**
7175
- * @description get top symbols
7176
- * @tags StockScreener
7177
- * @name GetTopSymbols
7178
- * @summary get top symbols
7179
- * @request POST:/stock-screener/top
7163
+ * @description Edit region
7164
+ * @tags World Markets
7165
+ * @name RegionEdit
7166
+ * @summary Edit region
7167
+ * @request PUT:/regions
7180
7168
  * @secure
7181
7169
  */
7182
- getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
7170
+ regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7171
+ /**
7172
+ * @description Create regions
7173
+ * @tags World Markets
7174
+ * @name RegionCreate
7175
+ * @summary Create regions
7176
+ * @request POST:/regions
7177
+ * @secure
7178
+ */
7179
+ regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
7180
+ /**
7181
+ * @description Delete region
7182
+ * @tags World Markets
7183
+ * @name RegionDelete
7184
+ * @summary Delete region
7185
+ * @request DELETE:/regions
7186
+ * @secure
7187
+ */
7188
+ regionDelete(query: {
7189
+ /** region id */
7190
+ id: string;
7191
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7183
7192
  }
7184
7193
  export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
7185
7194
  readonly config: JwtClientConfig<HandleError>;