@orbis-systems/orbis-api-clients 0.7.2 → 0.7.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/dist/aesmidas/index.d.ts +132 -132
  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 +553 -553
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/insight/index.d.ts +1156 -1156
  14. package/dist/insight/index.d.ts.map +1 -1
  15. package/dist/insight/index.esm.js +1 -1
  16. package/dist/insight/index.esm.js.map +1 -1
  17. package/dist/insight/index.js +1 -1
  18. package/dist/insight/index.js.map +1 -1
  19. package/dist/middleware/index.d.ts +101 -101
  20. package/dist/middleware/index.d.ts.map +1 -1
  21. package/dist/middleware/index.esm.js +1 -1
  22. package/dist/middleware/index.esm.js.map +1 -1
  23. package/dist/middleware/index.js +1 -1
  24. package/dist/middleware/index.js.map +1 -1
  25. package/dist/orbis/index.d.ts +4299 -4264
  26. package/dist/orbis/index.d.ts.map +1 -1
  27. package/dist/orbis/index.esm.js +1 -1
  28. package/dist/orbis/index.esm.js.map +1 -1
  29. package/dist/orbis/index.js +1 -1
  30. package/dist/orbis/index.js.map +1 -1
  31. package/dist/uma/index.d.ts +660 -660
  32. package/dist/uma/index.d.ts.map +1 -1
  33. package/dist/uma/index.esm.js +1 -1
  34. package/dist/uma/index.esm.js.map +1 -1
  35. package/dist/uma/index.js +1 -1
  36. package/dist/uma/index.js.map +1 -1
  37. package/dist/zerohash/index.d.ts +713 -713
  38. package/dist/zerohash/index.d.ts.map +1 -1
  39. package/dist/zerohash/index.esm.js +1 -1
  40. package/dist/zerohash/index.esm.js.map +1 -1
  41. package/dist/zerohash/index.js +1 -1
  42. package/dist/zerohash/index.js.map +1 -1
  43. package/package.json +1 -1
@@ -4280,28 +4280,6 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
4280
4280
  Date = "date",
4281
4281
  Rank = "rank"
4282
4282
  }
4283
- export class AlphaTools<HandleError extends boolean = boolean> {
4284
- protected readonly apiClient: JwtClient<HandleError>;
4285
- constructor(apiClient: JwtClient<HandleError>);
4286
- /**
4287
- * @description get seasonlity data with comparison to benchmark
4288
- * @tags AlphaTools
4289
- * @name GetMomentumRatioGraph
4290
- * @summary get seasonlity data
4291
- * @request POST:/rst
4292
- * @secure
4293
- */
4294
- getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
4295
- /**
4296
- * @description get seasonlity data with comparison to benchmark
4297
- * @tags AlphaTools
4298
- * @name GetSeasonality
4299
- * @summary get seasonlity data
4300
- * @request POST:/seasonality
4301
- * @secure
4302
- */
4303
- getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
4304
- }
4305
4283
  export class CompanyProfile<HandleError extends boolean = boolean> {
4306
4284
  protected readonly apiClient: JwtClient<HandleError>;
4307
4285
  constructor(apiClient: JwtClient<HandleError>);
@@ -4341,6 +4319,188 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
4341
4319
  */
4342
4320
  getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
4343
4321
  }
4322
+ export class WorldMarkets<HandleError extends boolean = boolean> {
4323
+ protected readonly apiClient: JwtClient<HandleError>;
4324
+ constructor(apiClient: JwtClient<HandleError>);
4325
+ /**
4326
+ * @description Get continents
4327
+ * @tags World Markets
4328
+ * @name ContinentGet
4329
+ * @summary Get continents
4330
+ * @request GET:/continents
4331
+ * @secure
4332
+ */
4333
+ continentGet(query: {
4334
+ /** Query limit */
4335
+ limit: number;
4336
+ /** Query offset */
4337
+ offset: number;
4338
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
4339
+ /**
4340
+ * @description Edit continent
4341
+ * @tags World Markets
4342
+ * @name ContinentEdit
4343
+ * @summary Edit continent
4344
+ * @request PUT:/continents
4345
+ * @secure
4346
+ */
4347
+ continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4348
+ /**
4349
+ * @description Create continents
4350
+ * @tags World Markets
4351
+ * @name ContinentCreate
4352
+ * @summary Create continents
4353
+ * @request POST:/continents
4354
+ * @secure
4355
+ */
4356
+ continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
4357
+ /**
4358
+ * @description Delete continent
4359
+ * @tags World Markets
4360
+ * @name ContinentDelete
4361
+ * @summary Delete continent
4362
+ * @request DELETE:/continents
4363
+ * @secure
4364
+ */
4365
+ continentDelete(query: {
4366
+ /** continent id */
4367
+ id: string;
4368
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4369
+ /**
4370
+ * @description Get country codes
4371
+ * @tags World Markets
4372
+ * @name CountryCodeGet
4373
+ * @summary Get country codes
4374
+ * @request GET:/country-codes
4375
+ * @secure
4376
+ */
4377
+ countryCodeGet(query: {
4378
+ /** Query limit */
4379
+ limit: number;
4380
+ /** Query offset */
4381
+ offset: number;
4382
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
4383
+ /**
4384
+ * @description Edit country code
4385
+ * @tags World Markets
4386
+ * @name CountryCodeEdit
4387
+ * @summary Edit country code
4388
+ * @request PUT:/country-codes
4389
+ * @secure
4390
+ */
4391
+ countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4392
+ /**
4393
+ * @description Add country codes
4394
+ * @tags World Markets
4395
+ * @name CountryCodeAdd
4396
+ * @summary Add country codes
4397
+ * @request POST:/country-codes
4398
+ * @secure
4399
+ */
4400
+ countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
4401
+ /**
4402
+ * @description Delete country code
4403
+ * @tags World Markets
4404
+ * @name CountryCodeDelete
4405
+ * @summary Delete country code
4406
+ * @request DELETE:/country-codes
4407
+ * @secure
4408
+ */
4409
+ countryCodeDelete(query: {
4410
+ /** a3 code */
4411
+ a3code: string;
4412
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4413
+ /**
4414
+ * @description Get global indexes
4415
+ * @tags World Markets
4416
+ * @name GlobalIndexGet
4417
+ * @summary Get global indexes
4418
+ * @request GET:/global-indexes
4419
+ * @secure
4420
+ */
4421
+ globalIndexGet(query: {
4422
+ /** Query limit */
4423
+ limit: number;
4424
+ /** Query offset */
4425
+ offset: number;
4426
+ /** Continent code for filtering */
4427
+ continent?: string;
4428
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
4429
+ /**
4430
+ * @description Edit global index
4431
+ * @tags World Markets
4432
+ * @name GlobalIndexEdit
4433
+ * @summary Edit global index
4434
+ * @request PUT:/global-indexes
4435
+ * @secure
4436
+ */
4437
+ globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4438
+ /**
4439
+ * @description Add global indexes
4440
+ * @tags World Markets
4441
+ * @name GlobalIndexAdd
4442
+ * @summary Add global indexes
4443
+ * @request POST:/global-indexes
4444
+ * @secure
4445
+ */
4446
+ globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
4447
+ /**
4448
+ * @description Edit global index
4449
+ * @tags World Markets
4450
+ * @name GlobalIndexDelete
4451
+ * @summary Delete global index
4452
+ * @request DELETE:/global-indexes
4453
+ * @secure
4454
+ */
4455
+ globalIndexDelete(query: {
4456
+ /** a3 code */
4457
+ a3code: string;
4458
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4459
+ /**
4460
+ * @description Get regions
4461
+ * @tags World Markets
4462
+ * @name RegionGet
4463
+ * @summary Get regions
4464
+ * @request GET:/regions
4465
+ * @secure
4466
+ */
4467
+ regionGet(query: {
4468
+ /** Query limit */
4469
+ limit: number;
4470
+ /** Query offset */
4471
+ offset: number;
4472
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
4473
+ /**
4474
+ * @description Edit region
4475
+ * @tags World Markets
4476
+ * @name RegionEdit
4477
+ * @summary Edit region
4478
+ * @request PUT:/regions
4479
+ * @secure
4480
+ */
4481
+ regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4482
+ /**
4483
+ * @description Create regions
4484
+ * @tags World Markets
4485
+ * @name RegionCreate
4486
+ * @summary Create regions
4487
+ * @request POST:/regions
4488
+ * @secure
4489
+ */
4490
+ regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
4491
+ /**
4492
+ * @description Delete region
4493
+ * @tags World Markets
4494
+ * @name RegionDelete
4495
+ * @summary Delete region
4496
+ * @request DELETE:/regions
4497
+ * @secure
4498
+ */
4499
+ regionDelete(query: {
4500
+ /** region id */
4501
+ id: string;
4502
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4503
+ }
4344
4504
  export class CustomLists<HandleError extends boolean = boolean> {
4345
4505
  protected readonly apiClient: JwtClient<HandleError>;
4346
4506
  constructor(apiClient: JwtClient<HandleError>);
@@ -4585,257 +4745,6 @@ export class FixedIncome<HandleError extends boolean = boolean> {
4585
4745
  */
4586
4746
  getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
4587
4747
  }
4588
- export interface InsightBeforeAndAfterV2 {
4589
- after?: string;
4590
- before?: string;
4591
- }
4592
- export interface InsightFixedIncomeV2 {
4593
- a144: boolean;
4594
- accrued_interest: number;
4595
- bank_qualified: boolean;
4596
- bond_warrant: boolean;
4597
- call_type: string;
4598
- callable: boolean;
4599
- close_price: number;
4600
- close_price_asof: string;
4601
- close_ytw: number;
4602
- convertible: boolean;
4603
- country: string;
4604
- country_code: string;
4605
- country_domicile: string;
4606
- country_issue: string;
4607
- coupon: number;
4608
- coupon_frequency: string;
4609
- coupon_type: string;
4610
- currency: string;
4611
- cusip: string;
4612
- dated_date: string;
4613
- daycount: string;
4614
- description: string;
4615
- description_short: string;
4616
- duration: number;
4617
- first_coupon_date: string;
4618
- insured: boolean;
4619
- isin: string;
4620
- issue_date: string;
4621
- issue_minimum_denomination: number;
4622
- issue_price: number;
4623
- issue_size: number;
4624
- issuer: string;
4625
- last_coupon_date: string;
4626
- liquidity_institutional_aggregate: number;
4627
- liquidity_institutional_buy: number;
4628
- liquidity_institutional_sell: number;
4629
- liquidity_micro_aggregate: number;
4630
- liquidity_micro_buy: number;
4631
- liquidity_micro_sell: number;
4632
- liquidity_retail_aggregate: number;
4633
- liquidity_retail_buy: number;
4634
- liquidity_retail_sell: number;
4635
- maturity_date: string;
4636
- municipal_state: string;
4637
- municipal_taxable_federal: boolean;
4638
- municipal_type: string;
4639
- next_call_date: string;
4640
- next_call_price: number;
4641
- next_coupon_date: string;
4642
- par_value: number;
4643
- perpetual: boolean;
4644
- private_placement: boolean;
4645
- purpose: string;
4646
- puttable: boolean;
4647
- reg_s: boolean;
4648
- sector: string;
4649
- seniority: string;
4650
- settlement_convention: string;
4651
- sinking_fund: boolean;
4652
- sp_creditwatch: string;
4653
- sp_creditwatch_date: string;
4654
- sp_outlook: string;
4655
- sp_outlook_date: string;
4656
- sp_rating: string;
4657
- sp_rating_date: string;
4658
- status: string;
4659
- ticker: string;
4660
- treasury_subtype: string;
4661
- type: string;
4662
- updated_at: string;
4663
- }
4664
- export interface InsightGetFixedIncomeEntriesResponseV2 {
4665
- count: number;
4666
- data: InsightFixedIncomeV2[];
4667
- }
4668
- export interface InsightGetFixedIncomeEntriesRequestV2 {
4669
- /** @example true */
4670
- bank_qualified?: boolean;
4671
- /** @example true */
4672
- callable?: boolean;
4673
- /** @example true */
4674
- convertible?: boolean;
4675
- /** @example ["USA"] */
4676
- country_codes?: string[];
4677
- coupon?: InsightLessAndMoreV2;
4678
- /** @example ["quarterly","zero"] */
4679
- coupon_frequencies?: string[];
4680
- /** @example ["655664AH3","9128286R6"] */
4681
- cusip?: string[];
4682
- /**
4683
- * @maxLength 100
4684
- * @example "Donald's"
4685
- */
4686
- description?: string;
4687
- /** @example true */
4688
- has_ticker?: boolean;
4689
- /** @example true */
4690
- insured?: boolean;
4691
- /** @example ["US655664AH33","US9128286R69"] */
4692
- isin?: string[];
4693
- issue_date?: InsightBeforeAndAfterV2;
4694
- /**
4695
- * @maxLength 100
4696
- * @example "Donald's"
4697
- */
4698
- issuer?: string;
4699
- maturity?: InsightBeforeAndAfterV2;
4700
- /** @example ["NY"] */
4701
- municipal_states?: string[];
4702
- /** @example true */
4703
- municipal_tax?: boolean;
4704
- /** @example ["general_obligation"] */
4705
- municipal_types?: string[];
4706
- pagination: InsightPaginationV2;
4707
- purposes?: string[];
4708
- /** @example ["SOVEREIGN"] */
4709
- sectors?: string[];
4710
- sorts?: InsightOrderingV2[];
4711
- /** @example ["AAA"] */
4712
- sp_ratings?: string[];
4713
- /** @example ["called","outstanding"] */
4714
- statuses?: string[];
4715
- tickers?: string[];
4716
- /** @example ["corporate"] */
4717
- types?: string[];
4718
- }
4719
- export interface InsightGetTopSymbolsRequestV2 {
4720
- exchange?: string[];
4721
- market_cap?: InsightLessAndMoreV2;
4722
- pagination?: InsightPaginationV2;
4723
- price?: InsightLessAndMoreV2;
4724
- sorts?: InsightOrderingV2[];
4725
- volume?: InsightLessAndMoreV2;
4726
- }
4727
- export interface InsightIncludeExcludeV2 {
4728
- exclude?: string[];
4729
- include?: string[];
4730
- }
4731
- export interface InsightLessAndMoreV2 {
4732
- less_than?: number;
4733
- more_than?: number;
4734
- }
4735
- export interface InsightOrderingV2 {
4736
- /**
4737
- * @default "asc"
4738
- * @example "asc"
4739
- */
4740
- direction: InsightOrderingDirectionEnumV2;
4741
- /**
4742
- * Sort direction:
4743
- * * asc - Ascending, from A to Z.
4744
- * * desc - Descending, from Z to A.
4745
- * @example "name"
4746
- */
4747
- field: string;
4748
- }
4749
- export interface InsightPaginationV2 {
4750
- /**
4751
- * @min 1
4752
- * @example 1
4753
- */
4754
- page: number;
4755
- /**
4756
- * @min 1
4757
- * @max 50
4758
- * @example 10
4759
- */
4760
- size: number;
4761
- }
4762
- export interface InsightStockScreenerQuoteV2 {
4763
- average_volume_30d: number;
4764
- company_name: string;
4765
- dividend_ex_date: string;
4766
- dividend_pay_date: string;
4767
- dividend_percent: number;
4768
- exchange: string;
4769
- exchange_name: string;
4770
- gap: number;
4771
- industry: string;
4772
- industry_code: string;
4773
- last_price: number;
4774
- market_cap: number;
4775
- pe_ratio: number;
4776
- price_change: number;
4777
- price_change_percent: number;
4778
- symbol: string;
4779
- volume: number;
4780
- }
4781
- export interface InsightStockScreenerRequestV2 {
4782
- average_volume_30d?: InsightLessAndMoreV2;
4783
- dividend_ex_date?: InsightBeforeAndAfterV2;
4784
- dividend_pay_date?: InsightBeforeAndAfterV2;
4785
- dividend_percent?: InsightLessAndMoreV2;
4786
- exchange?: InsightIncludeExcludeV2;
4787
- gap?: InsightLessAndMoreV2;
4788
- industry?: InsightIncludeExcludeV2;
4789
- market_cap?: InsightLessAndMoreV2;
4790
- pagination: InsightPaginationV2;
4791
- pe_ratio?: InsightLessAndMoreV2;
4792
- price?: InsightLessAndMoreV2;
4793
- sorts?: InsightOrderingV2[];
4794
- /** @example "ADR" */
4795
- stock_type?: string;
4796
- volume?: InsightLessAndMoreV2;
4797
- }
4798
- export interface InsightStockScreenerResponseV2 {
4799
- current_page: number;
4800
- data: InsightStockScreenerQuoteV2[];
4801
- page_count: number;
4802
- status: number;
4803
- total_records: number;
4804
- }
4805
- /**
4806
- * @default "asc"
4807
- * @example "asc"
4808
- */
4809
- export enum InsightOrderingDirectionEnumV2 {
4810
- Asc = "asc",
4811
- Desc = "desc"
4812
- }
4813
- export class FixedIncomeV2<HandleError extends boolean = boolean> {
4814
- protected readonly apiClient: JwtClient<HandleError>;
4815
- constructor(apiClient: JwtClient<HandleError>);
4816
- /**
4817
- * @description get fixed income entries
4818
- * @tags FixedIncome
4819
- * @name GetFixedIncomeEntries
4820
- * @summary get fixed income entries
4821
- * @request POST:/fixed-income
4822
- * @secure
4823
- */
4824
- getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
4825
- }
4826
- export class Fundamentals<HandleError extends boolean = boolean> {
4827
- protected readonly apiClient: JwtClient<HandleError>;
4828
- constructor(apiClient: JwtClient<HandleError>);
4829
- /**
4830
- * @description get fundamentals by symbol data
4831
- * @tags Fundamentals
4832
- * @name GetFundamentalsBySymbolData
4833
- * @summary get fundamentals by symbol data
4834
- * @request POST:/fundamentals
4835
- * @secure
4836
- */
4837
- getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
4838
- }
4839
4748
  export class Funds<HandleError extends boolean = boolean> {
4840
4749
  protected readonly apiClient: JwtClient<HandleError>;
4841
4750
  constructor(apiClient: JwtClient<HandleError>);
@@ -4950,6 +4859,58 @@ export class Funds<HandleError extends boolean = boolean> {
4950
4859
  Authorization?: string;
4951
4860
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
4952
4861
  }
4862
+ export class Fundamentals<HandleError extends boolean = boolean> {
4863
+ protected readonly apiClient: JwtClient<HandleError>;
4864
+ constructor(apiClient: JwtClient<HandleError>);
4865
+ /**
4866
+ * @description get fundamentals by symbol data
4867
+ * @tags Fundamentals
4868
+ * @name GetFundamentalsBySymbolData
4869
+ * @summary get fundamentals by symbol data
4870
+ * @request POST:/fundamentals
4871
+ * @secure
4872
+ */
4873
+ getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
4874
+ }
4875
+ export class Quotes<HandleError extends boolean = boolean> {
4876
+ protected readonly apiClient: JwtClient<HandleError>;
4877
+ constructor(apiClient: JwtClient<HandleError>);
4878
+ /**
4879
+ * @description Get single historical quote
4880
+ * @tags Quotes
4881
+ * @name GitHistoricalQuote
4882
+ * @summary Get single historical quote
4883
+ * @request GET:/historical/quote
4884
+ * @secure
4885
+ */
4886
+ gitHistoricalQuote(query: {
4887
+ /** Symbol */
4888
+ symbol: string;
4889
+ /** Date */
4890
+ date: string;
4891
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
4892
+ /**
4893
+ * @description get quote history by symbol
4894
+ * @tags Quotes
4895
+ * @name GitQuoteHistory
4896
+ * @summary Get quote history
4897
+ * @request POST:/quote-history
4898
+ * @secure
4899
+ */
4900
+ gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
4901
+ /**
4902
+ * @description Returns a list of quotes equity info for specified symbols.
4903
+ * @tags Quotes
4904
+ * @name GetQuotesEquityData
4905
+ * @summary Get Quotes Equity data
4906
+ * @request GET:/quotes/equity
4907
+ * @secure
4908
+ */
4909
+ getQuotesEquityData(query: {
4910
+ /** Comma separated symbols */
4911
+ symbols: string;
4912
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
4913
+ }
4953
4914
  export class Intraday<HandleError extends boolean = boolean> {
4954
4915
  protected readonly apiClient: JwtClient<HandleError>;
4955
4916
  constructor(apiClient: JwtClient<HandleError>);
@@ -4963,929 +4924,684 @@ export class Intraday<HandleError extends boolean = boolean> {
4963
4924
  */
4964
4925
  intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
4965
4926
  }
4966
- export class Ipos<HandleError extends boolean = boolean> {
4927
+ export class StockScreener<HandleError extends boolean = boolean> {
4967
4928
  protected readonly apiClient: JwtClient<HandleError>;
4968
4929
  constructor(apiClient: JwtClient<HandleError>);
4969
4930
  /**
4970
- * @description get recent ipos info
4971
- * @tags Ipos
4972
- * @name PostRecent
4973
- * @summary get recent ipos info
4974
- * @request POST:/ipos/recent
4975
- * @secure
4976
- */
4977
- postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
4978
- /**
4979
- * @description get upcoming ipos info
4980
- * @tags Ipos
4981
- * @name GetUpcoming
4982
- * @summary get upcoming ipos info
4983
- * @request GET:/ipos/upcoming
4984
- * @secure
4985
- */
4986
- getUpcoming(query: {
4987
- /** how many records to return. Max value is 50 */
4988
- limit: number;
4989
- /** how many records to skip */
4990
- offset: number;
4991
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
4992
- /**
4993
- * @description get ipo info by symbol
4994
- * @tags Ipos
4995
- * @name GetIpos
4996
- * @summary get ipo info by symbol
4997
- * @request GET:/ipos/{symbol}
4998
- * @secure
4999
- */
5000
- getIpos(symbol: string, query?: {
5001
- /** load quotes */
5002
- load_quotes?: boolean;
5003
- /** statuses */
5004
- statuses?: string[];
5005
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
5006
- }
5007
- export class Logos<HandleError extends boolean = boolean> {
5008
- protected readonly apiClient: JwtClient<HandleError>;
5009
- constructor(apiClient: JwtClient<HandleError>);
5010
- /**
5011
- * @description Returns converted logo for crypto symbol
5012
- * @tags Logos
5013
- * @name LogosConvertedCryptoSymbolLogo
5014
- * @summary Get converted logo for crypto symbol
5015
- * @request POST:/logos/converted-crypto-symbol-logo
4931
+ * @description data for visual heat map
4932
+ * @tags StockScreener
4933
+ * @name StockMarketHeatmap
4934
+ * @summary data for visual heat map
4935
+ * @request GET:/heatmaps
5016
4936
  * @secure
5017
4937
  */
5018
- logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
4938
+ stockMarketHeatmap(query?: {
4939
+ /** Name of symbol list to fetch details for. Empty is default */
4940
+ heatmap_name?: string;
4941
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
5019
4942
  /**
5020
- * @description Returns converted logo for symbol
5021
- * @tags Logos
5022
- * @name LogosConvertedSymbolLogo
5023
- * @summary Get converted logo for symbol
5024
- * @request POST:/logos/converted-symbol-logo
4943
+ * @description create or update heat map preset
4944
+ * @tags StockScreener
4945
+ * @name CreateStockMarketHeatmapPreset
4946
+ * @summary create or update heat map preset
4947
+ * @request POST:/heatmaps
5025
4948
  * @secure
5026
4949
  */
5027
- logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
4950
+ createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5028
4951
  /**
5029
- * @description Returns logo for crypto symbol
5030
- * @tags Logos
5031
- * @name LogosCryptoSymbolLogo
5032
- * @summary Get logo for crypto symbol
5033
- * @request GET:/logos/crypto-symbol-logo
4952
+ * @description Sector and Industry Group performance
4953
+ * @tags StockScreener
4954
+ * @name IndustriesPerformance
4955
+ * @summary get industries performance
4956
+ * @request POST:/industries-performance
5034
4957
  * @secure
5035
4958
  */
5036
- logosCryptoSymbolLogo(query: {
5037
- /** Company symbol */
5038
- symbol: string;
5039
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
4959
+ industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
5040
4960
  /**
5041
- * @description Returns direct logo for crypto symbol
5042
- * @tags Logos
5043
- * @name LogosDirectCryptoSymbolLogo
5044
- * @summary Get direct logo for crypto symbol
5045
- * @request GET:/logos/direct-crypto-symbol-logo
4961
+ * @description filter stocks by params
4962
+ * @tags StockScreener
4963
+ * @name StockScreener
4964
+ * @summary filter stocks by params
4965
+ * @request POST:/stock-screener
5046
4966
  * @secure
5047
4967
  */
5048
- logosDirectCryptoSymbolLogo(query: {
5049
- /** Company symbol */
5050
- symbol: string;
5051
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
4968
+ stockScreener(filter: InsightStockScreenerV1Request, headers?: {
4969
+ /** Authorization */
4970
+ Authorization?: string;
4971
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5052
4972
  /**
5053
- * @description Returns direct logo for symbol
5054
- * @tags Logos
5055
- * @name LogosDirectSymbolLogo
5056
- * @summary Get direct logo for symbol
5057
- * @request GET:/logos/direct-symbol-logo
4973
+ * @description get screener presets
4974
+ * @tags StockScreener
4975
+ * @name GetScreenerPresets
4976
+ * @summary get screener presets
4977
+ * @request GET:/stock-screener/presets
5058
4978
  * @secure
5059
4979
  */
5060
- logosDirectSymbolLogo(query: {
5061
- /** Company symbol */
5062
- symbol: string;
5063
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
4980
+ getScreenerPresets(query: {
4981
+ /** how many records to return */
4982
+ limit: number;
4983
+ /** how many records to skip */
4984
+ offset: number;
4985
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
5064
4986
  /**
5065
- * @description Returns logos for multiple symbols
5066
- * @tags Logos
5067
- * @name LogosMultipleCryptoSymbolLogo
5068
- * @summary Get logos for multiple symbols
5069
- * @request POST:/logos/multiple-crypto-symbol-logo
4987
+ * @description update screener preset
4988
+ * @tags StockScreener
4989
+ * @name UpdateScreenerPreset
4990
+ * @summary update screener preset
4991
+ * @request PUT:/stock-screener/presets
5070
4992
  * @secure
5071
4993
  */
5072
- logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
4994
+ updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5073
4995
  /**
5074
- * @description Returns logos for multiple symbol
5075
- * @tags Logos
5076
- * @name LogosMultipleSymbolLogos
5077
- * @summary Get logos for multiple symbols
5078
- * @request POST:/logos/multiple-symbol-logos
4996
+ * @description create screener preset
4997
+ * @tags StockScreener
4998
+ * @name CreateOrScreenerPreset
4999
+ * @summary create screener preset
5000
+ * @request POST:/stock-screener/presets
5079
5001
  * @secure
5080
5002
  */
5081
- logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
5003
+ createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5082
5004
  /**
5083
- * @description Returns links of socials logos for symbol
5084
- * @tags Logos
5085
- * @name LogosSocialSymbolLogos
5086
- * @summary Get social logos for symbol
5087
- * @request GET:/logos/social-symbol-logos
5005
+ * @description remove screener preset
5006
+ * @tags StockScreener
5007
+ * @name RemoveScreenerPreset
5008
+ * @summary remove screener preset
5009
+ * @request DELETE:/stock-screener/presets
5088
5010
  * @secure
5089
5011
  */
5090
- logosSocialSymbolLogos(query: {
5091
- /** Company symbol */
5092
- symbol: string;
5093
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
5012
+ removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5094
5013
  /**
5095
- * @description Returns logos for company symbol
5096
- * @tags Logos
5097
- * @name LogosSymbolLogos
5098
- * @summary Get symbol logos
5099
- * @request GET:/logos/symbol-logos
5014
+ * @description get top symbols
5015
+ * @tags StockScreener
5016
+ * @name GetTopSymbols
5017
+ * @summary get top symbols
5018
+ * @request POST:/stock-screener/top
5100
5019
  * @secure
5101
5020
  */
5102
- logosSymbolLogos(query: {
5103
- /** Company symbol */
5104
- symbol: string;
5105
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
5021
+ getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5106
5022
  }
5107
- export class MarketDates<HandleError extends boolean = boolean> {
5023
+ export class PreIpoCompanies<HandleError extends boolean = boolean> {
5108
5024
  protected readonly apiClient: JwtClient<HandleError>;
5109
5025
  constructor(apiClient: JwtClient<HandleError>);
5110
5026
  /**
5111
- * @description get market dates history
5112
- * @tags MarketDates
5113
- * @name GetMarketDatesHistory
5114
- * @summary get market dates history
5115
- * @request POST:/market-dates/history
5027
+ * @description get pre ipo companies Avaliable categories: on-demand business-video reverse-etl modern-data-stack video-api global-payroll banking-as-a-service ultrafast-delivery online-grocery website-builder fintech b2b venture-capital ecommerce creator-economy productivity real-estate private-markets-exchanges fpa vertical-saas card-issuing connected-fitness gig-marketplaces cms soc-2 analytics cap-table-management contractor-payroll social-media design online-whiteboard conversational-marketing expense-management stock-option-financing customer-onboarding crypto help-desk payroll documents databases mortgage-lending crypto-exchange marketing-automation payments operations checkout cybersecurity messaging investing marketplaces climate-tech robotics data-security online-education gaming universal-api automation biotechnology contact-center defense machine-learning logistics prefab-tech materials telehealth b2c alternative-proteins b2b-marketplaces wealth-management web3 neobank managed-marketplaces plg-crm jamstack public-safety background-checks identity-verification construction home-services sales blockchain-developer-platform space financial-data-aggregation ai writing-assistant autonomous-driving 401k-provider vector-databases ai-models devtools payroll-api internal-tools mlops bookkeeping cloud-infrastructure data-backups personal-finance ai-frameworks generative-ai cloud-gpus micromobility ai-avatars ai-chips life-sciences partnerships wearables fitness-tracking ai-search ai-medical-scribes networking quantum-computing code-editors
5028
+ * @tags PreIPOCompanies
5029
+ * @name GetPreIpoCompanies
5030
+ * @summary get pre ipo companies
5031
+ * @request GET:/ipos/pre-ipo-companies
5116
5032
  * @secure
5117
5033
  */
5118
- getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
5034
+ getPreIpoCompanies(query: {
5035
+ /** search by company name */
5036
+ name?: string;
5037
+ /** search by categories */
5038
+ categories?: string;
5039
+ /** how many records to return. Max value is 50 */
5040
+ limit: number;
5041
+ /** how many records to skip */
5042
+ offset: number;
5043
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
5119
5044
  /**
5120
- * @description get todays market hours
5121
- * @tags MarketDates
5122
- * @name GetTodaysMarketHours
5123
- * @summary get todays market hours
5124
- * @request GET:/market-dates/today
5045
+ * @description get pre ipo company by id
5046
+ * @tags PreIPOCompanies
5047
+ * @name GetPreIpoCompaniesById
5048
+ * @summary get pre ipo company by id
5049
+ * @request GET:/ipos/pre-ipo-companies/{id}
5050
+ * @originalName getPreIpoCompanies
5051
+ * @duplicate
5125
5052
  * @secure
5126
5053
  */
5127
- getTodaysMarketHours(query: {
5128
- /** Market */
5129
- market: string;
5130
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
5131
- }
5132
- export class News<HandleError extends boolean = boolean> {
5133
- protected readonly apiClient: JwtClient<HandleError>;
5134
- constructor(apiClient: JwtClient<HandleError>);
5054
+ getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
5135
5055
  /**
5136
- * @description Returns available authors in DB
5137
- * @tags News
5138
- * @name NewsAvailableAuthors
5139
- * @summary Get available authors in DB (for filters)
5140
- * @request POST:/news/authors
5056
+ * @description get pre ipo company funding rounds
5057
+ * @tags PreIPOCompanies
5058
+ * @name GetPreIpoCompanyFundingRounds
5059
+ * @summary get pre ipo company funding rounds
5060
+ * @request GET:/ipos/pre-ipo-company-funding-rounds
5141
5061
  * @secure
5142
5062
  */
5143
- newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5063
+ getPreIpoCompanyFundingRounds(query: {
5064
+ /** company id */
5065
+ pre_ipo_company_id?: string;
5066
+ /** search by round name */
5067
+ round_name?: string;
5068
+ /** how many records to return. Max value is 50 */
5069
+ limit: number;
5070
+ /** how many records to skip */
5071
+ offset: number;
5072
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
5144
5073
  /**
5145
- * @description Returns available channels in DB
5146
- * @tags News
5147
- * @name NewsAvailableChannels
5148
- * @summary Get available channels in DB (for filters)
5149
- * @request POST:/news/channels
5074
+ * @description get pre ipo company funding round by id
5075
+ * @tags PreIPOCompanies
5076
+ * @name GetPreIpoCompanyFundingRoundsById
5077
+ * @summary get pre ipo company funding round by id
5078
+ * @request GET:/ipos/pre-ipo-company-funding-rounds/{id}
5079
+ * @originalName getPreIpoCompanyFundingRounds
5080
+ * @duplicate
5150
5081
  * @secure
5151
5082
  */
5152
- newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5083
+ getPreIpoCompanyFundingRoundsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyFundingRound, HandleError>>;
5153
5084
  /**
5154
- * @description Get featured articles
5155
- * @tags News
5156
- * @name GetFeaturedArticles
5157
- * @summary Get featured articles
5158
- * @request GET:/news/featured-articles
5085
+ * @description get pre ipo company investments
5086
+ * @tags PreIPOCompanies
5087
+ * @name GetPreIpoCompanyInvestments
5088
+ * @summary get pre ipo company investments
5089
+ * @request GET:/ipos/pre-ipo-company-investments
5159
5090
  * @secure
5160
5091
  */
5161
- getFeaturedArticles(query: {
5162
- /** Limit */
5092
+ getPreIpoCompanyInvestments(query: {
5093
+ /** company id */
5094
+ pre_ipo_company_id?: string;
5095
+ /** company name */
5096
+ company_name?: string;
5097
+ /** how many records to return. Max value is 50 */
5163
5098
  limit: number;
5164
- /** Offset */
5099
+ /** how many records to skip */
5165
5100
  offset: number;
5166
- /** Start date */
5167
- start_date?: string;
5168
- /** End date */
5169
- end_date?: string;
5170
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
5171
- /**
5172
- * @description Update featured articles
5173
- * @tags News
5174
- * @name UpdateFeaturedArticles
5175
- * @summary Update featured articles
5176
- * @request PUT:/news/featured-articles
5177
- * @secure
5178
- */
5179
- updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5180
- /**
5181
- * @description Create featured articles
5182
- * @tags News
5183
- * @name CreateFeaturedArticles
5184
- * @summary Create featured articles
5185
- * @request POST:/news/featured-articles
5186
- * @secure
5187
- */
5188
- createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5101
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
5189
5102
  /**
5190
- * @description Get active featured articles
5191
- * @tags News
5192
- * @name GetActiveFeaturedArticles
5193
- * @summary Get active featured articles
5194
- * @request GET:/news/featured-articles/active
5103
+ * @description get pre ipo company investment by id
5104
+ * @tags PreIPOCompanies
5105
+ * @name GetPreIpoCompanyInvestmentsById
5106
+ * @summary get pre ipo company investment by id
5107
+ * @request GET:/ipos/pre-ipo-company-investments/{id}
5108
+ * @originalName getPreIpoCompanyInvestments
5109
+ * @duplicate
5195
5110
  * @secure
5196
5111
  */
5197
- getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
5112
+ getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
5198
5113
  /**
5199
- * @description Set featured articles
5200
- * @tags News
5201
- * @name SetFeaturedArticles
5202
- * @summary Set featured articles
5203
- * @request POST:/news/featured-articles/set
5114
+ * @description get pre ipo company news
5115
+ * @tags PreIPOCompanies
5116
+ * @name GetPreIpoCompanyNews
5117
+ * @summary get pre ipo company news
5118
+ * @request GET:/ipos/pre-ipo-company-news
5204
5119
  * @secure
5205
5120
  */
5206
- setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5121
+ getPreIpoCompanyNews(query: {
5122
+ /** company id */
5123
+ pre_ipo_company_id?: string;
5124
+ /** search by headline */
5125
+ headline?: string;
5126
+ /** how many records to return. Max value is 50 */
5127
+ limit: number;
5128
+ /** how many records to skip */
5129
+ offset: number;
5130
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
5207
5131
  /**
5208
- * @description Get featured article
5209
- * @tags News
5210
- * @name GetFeaturedArticle
5211
- * @summary Get featured article
5212
- * @request GET:/news/featured-articles/{id}
5132
+ * @description get pre ipo company news by id
5133
+ * @tags PreIPOCompanies
5134
+ * @name GetPreIpoCompanyNewsById
5135
+ * @summary get pre ipo company news by id
5136
+ * @request GET:/ipos/pre-ipo-company-news/{id}
5137
+ * @originalName getPreIpoCompanyNews
5138
+ * @duplicate
5213
5139
  * @secure
5214
5140
  */
5215
- getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
5141
+ getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
5216
5142
  /**
5217
- * @description Returns news by filters
5218
- * @tags News
5219
- * @name NewsFiltered
5220
- * @summary Get filtered news
5221
- * @request POST:/news/filter
5143
+ * @description get pre ipo company research documents
5144
+ * @tags PreIPOCompanies
5145
+ * @name GetPreIpoCompanyResearchDocuments
5146
+ * @summary get pre ipo company research documents
5147
+ * @request GET:/ipos/pre-ipo-company-research-documents
5222
5148
  * @secure
5223
5149
  */
5224
- newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
5150
+ getPreIpoCompanyResearchDocuments(query: {
5151
+ /** company id */
5152
+ pre_ipo_company_id?: string;
5153
+ /** search by title */
5154
+ title?: string;
5155
+ /** how many records to return. Max value is 50 */
5156
+ limit: number;
5157
+ /** how many records to skip */
5158
+ offset: number;
5159
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
5225
5160
  /**
5226
- * @description Returns news by id
5227
- * @tags News
5228
- * @name NewsById
5229
- * @summary Get news by id
5230
- * @request POST:/news/id
5161
+ * @description get pre ipo company research document by id
5162
+ * @tags PreIPOCompanies
5163
+ * @name GetPreIpoCompanyResearchDocumentsById
5164
+ * @summary get pre ipo company research document by id
5165
+ * @request GET:/ipos/pre-ipo-company-research-documents/{id}
5166
+ * @originalName getPreIpoCompanyResearchDocuments
5167
+ * @duplicate
5231
5168
  * @secure
5232
5169
  */
5233
- newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
5170
+ getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
5234
5171
  /**
5235
- * @description Returns news previews
5236
- * @tags News
5237
- * @name NewsPreviewsFiltered
5238
- * @summary Get news previews
5239
- * @request GET:/news/previews
5172
+ * @description get pre ipo company spvs
5173
+ * @tags PreIPOCompanies
5174
+ * @name GetPreIpoCompanySpvs
5175
+ * @summary get pre ipo company spvs
5176
+ * @request GET:/ipos/pre-ipo-company-spvs
5240
5177
  * @secure
5241
5178
  */
5242
- newsPreviewsFiltered(query: {
5243
- /** Start date */
5244
- start_date?: string;
5245
- /** End date */
5246
- end_date?: string;
5247
- /** Symbol */
5248
- symbol?: string;
5179
+ getPreIpoCompanySpvs(query: {
5180
+ /** company id */
5181
+ pre_ipo_company_id?: string;
5182
+ /** investment id */
5183
+ investment_id?: string;
5184
+ /** search by name */
5185
+ name?: string;
5186
+ /** search by company name */
5187
+ company_name?: string;
5249
5188
  /** how many records to return. Max value is 50 */
5250
5189
  limit: number;
5251
5190
  /** how many records to skip */
5252
5191
  offset: number;
5253
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
5254
- /**
5255
- * @description Returns available stocks in DB
5256
- * @tags News
5257
- * @name NewsAvailableStocks
5258
- * @summary Get available stocks in DB (for filters)
5259
- * @request GET:/news/symbols
5260
- * @secure
5261
- */
5262
- newsAvailableStocks(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5192
+ /** sort direction */
5193
+ direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
5194
+ /** sort field */
5195
+ field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
5196
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
5263
5197
  /**
5264
- * @description Returns available tags in DB
5265
- * @tags News
5266
- * @name NewsAvailableTags
5267
- * @summary Get available tags in DB (for filters)
5268
- * @request POST:/news/tags
5198
+ * @description get pre ipo company spv by id
5199
+ * @tags PreIPOCompanies
5200
+ * @name GetPreIpoCompanySpvsById
5201
+ * @summary get pre ipo company spv by id
5202
+ * @request GET:/ipos/pre-ipo-company-spvs/{id}
5203
+ * @originalName getPreIpoCompanySpvs
5204
+ * @duplicate
5269
5205
  * @secure
5270
5206
  */
5271
- newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5207
+ getPreIpoCompanySpvsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
5272
5208
  }
5273
- export class OptionGreeks<HandleError extends boolean = boolean> {
5209
+ export class Ipos<HandleError extends boolean = boolean> {
5274
5210
  protected readonly apiClient: JwtClient<HandleError>;
5275
5211
  constructor(apiClient: JwtClient<HandleError>);
5276
5212
  /**
5277
- * @description Returns calculated matrix
5278
- * @tags OptionGreeks
5279
- * @name OgCalculateMatrix
5280
- * @summary Calculate matrix
5281
- * @request POST:/og/calculate-matrix
5282
- * @secure
5283
- */
5284
- ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
5285
- /**
5286
- * @description Returns calculated params
5287
- * @tags OptionGreeks
5288
- * @name OgCalculateParams
5289
- * @summary Calculate params
5290
- * @request POST:/og/calculate-params
5213
+ * @description get recent ipos info
5214
+ * @tags Ipos
5215
+ * @name PostRecent
5216
+ * @summary get recent ipos info
5217
+ * @request POST:/ipos/recent
5291
5218
  * @secure
5292
5219
  */
5293
- ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
5294
- }
5295
- export class Ownerships<HandleError extends boolean = boolean> {
5296
- protected readonly apiClient: JwtClient<HandleError>;
5297
- constructor(apiClient: JwtClient<HandleError>);
5220
+ postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5298
5221
  /**
5299
- * @description get ownerships by id datadata
5300
- * @tags Ownerships
5301
- * @name GetOwnershipsByIdData
5302
- * @summary get ownerships by id data
5303
- * @request POST:/ownerships
5222
+ * @description get upcoming ipos info
5223
+ * @tags Ipos
5224
+ * @name GetUpcoming
5225
+ * @summary get upcoming ipos info
5226
+ * @request GET:/ipos/upcoming
5304
5227
  * @secure
5305
5228
  */
5306
- getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5229
+ getUpcoming(query: {
5230
+ /** how many records to return. Max value is 50 */
5231
+ limit: number;
5232
+ /** how many records to skip */
5233
+ offset: number;
5234
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5307
5235
  /**
5308
- * @description get ownerships by symbol data
5309
- * @tags Ownerships
5310
- * @name GetOwnershipsBySymbolData
5311
- * @summary get ownerships by symbol data
5312
- * @request POST:/symbol-ownerships
5236
+ * @description get ipo info by symbol
5237
+ * @tags Ipos
5238
+ * @name GetIpos
5239
+ * @summary get ipo info by symbol
5240
+ * @request GET:/ipos/{symbol}
5313
5241
  * @secure
5314
5242
  */
5315
- getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5243
+ getIpos(symbol: string, query?: {
5244
+ /** load quotes */
5245
+ load_quotes?: boolean;
5246
+ /** statuses */
5247
+ statuses?: string[];
5248
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
5316
5249
  }
5317
- export class Passport<HandleError extends boolean = boolean> {
5250
+ export class Logos<HandleError extends boolean = boolean> {
5318
5251
  protected readonly apiClient: JwtClient<HandleError>;
5319
5252
  constructor(apiClient: JwtClient<HandleError>);
5320
5253
  /**
5321
- * @description Returns article by id
5322
- * @tags Passport
5323
- * @name PassportArticleById
5324
- * @summary Get article by id
5325
- * @request POST:/passport/article-by-id
5254
+ * @description Returns converted logo for crypto symbol
5255
+ * @tags Logos
5256
+ * @name LogosConvertedCryptoSymbolLogo
5257
+ * @summary Get converted logo for crypto symbol
5258
+ * @request POST:/logos/converted-crypto-symbol-logo
5326
5259
  * @secure
5327
5260
  */
5328
- passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
5261
+ logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5329
5262
  /**
5330
- * @description Returns articles
5331
- * @tags Passport
5332
- * @name PassportArticles
5333
- * @summary Get articles
5334
- * @request POST:/passport/articles
5263
+ * @description Returns converted logo for symbol
5264
+ * @tags Logos
5265
+ * @name LogosConvertedSymbolLogo
5266
+ * @summary Get converted logo for symbol
5267
+ * @request POST:/logos/converted-symbol-logo
5335
5268
  * @secure
5336
5269
  */
5337
- passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
5270
+ logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5338
5271
  /**
5339
- * @description Returns author profile
5340
- * @tags Passport
5341
- * @name PassportAuthorProfile
5342
- * @summary Get author profile
5343
- * @request POST:/passport/author-profile
5272
+ * @description Returns logo for crypto symbol
5273
+ * @tags Logos
5274
+ * @name LogosCryptoSymbolLogo
5275
+ * @summary Get logo for crypto symbol
5276
+ * @request GET:/logos/crypto-symbol-logo
5344
5277
  * @secure
5345
5278
  */
5346
- passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
5279
+ logosCryptoSymbolLogo(query: {
5280
+ /** Company symbol */
5281
+ symbol: string;
5282
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
5347
5283
  /**
5348
- * @description Returns most popular tags
5349
- * @tags Passport
5350
- * @name PassportMostPopularTags
5351
- * @summary Get most popular tags
5352
- * @request POST:/passport/most-popular-tags
5284
+ * @description Returns direct logo for crypto symbol
5285
+ * @tags Logos
5286
+ * @name LogosDirectCryptoSymbolLogo
5287
+ * @summary Get direct logo for crypto symbol
5288
+ * @request GET:/logos/direct-crypto-symbol-logo
5353
5289
  * @secure
5354
5290
  */
5355
- passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
5291
+ logosDirectCryptoSymbolLogo(query: {
5292
+ /** Company symbol */
5293
+ symbol: string;
5294
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5356
5295
  /**
5357
- * @description Returns news feed
5358
- * @tags Passport
5359
- * @name PassportNewsFeed
5360
- * @summary Get news feed
5361
- * @request POST:/passport/newsfeed
5296
+ * @description Returns direct logo for symbol
5297
+ * @tags Logos
5298
+ * @name LogosDirectSymbolLogo
5299
+ * @summary Get direct logo for symbol
5300
+ * @request GET:/logos/direct-symbol-logo
5362
5301
  * @secure
5363
5302
  */
5364
- passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
5303
+ logosDirectSymbolLogo(query: {
5304
+ /** Company symbol */
5305
+ symbol: string;
5306
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5365
5307
  /**
5366
- * @description Returns article by parameters
5367
- * @tags Passport
5368
- * @name PassportSearchArticle
5369
- * @summary Search article by parameters
5370
- * @request POST:/passport/search-article
5308
+ * @description Returns logos for multiple symbols
5309
+ * @tags Logos
5310
+ * @name LogosMultipleCryptoSymbolLogo
5311
+ * @summary Get logos for multiple symbols
5312
+ * @request POST:/logos/multiple-crypto-symbol-logo
5371
5313
  * @secure
5372
5314
  */
5373
- passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
5315
+ logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
5316
+ /**
5317
+ * @description Returns logos for multiple symbol
5318
+ * @tags Logos
5319
+ * @name LogosMultipleSymbolLogos
5320
+ * @summary Get logos for multiple symbols
5321
+ * @request POST:/logos/multiple-symbol-logos
5322
+ * @secure
5323
+ */
5324
+ logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
5325
+ /**
5326
+ * @description Returns links of socials logos for symbol
5327
+ * @tags Logos
5328
+ * @name LogosSocialSymbolLogos
5329
+ * @summary Get social logos for symbol
5330
+ * @request GET:/logos/social-symbol-logos
5331
+ * @secure
5332
+ */
5333
+ logosSocialSymbolLogos(query: {
5334
+ /** Company symbol */
5335
+ symbol: string;
5336
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
5337
+ /**
5338
+ * @description Returns logos for company symbol
5339
+ * @tags Logos
5340
+ * @name LogosSymbolLogos
5341
+ * @summary Get symbol logos
5342
+ * @request GET:/logos/symbol-logos
5343
+ * @secure
5344
+ */
5345
+ logosSymbolLogos(query: {
5346
+ /** Company symbol */
5347
+ symbol: string;
5348
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
5374
5349
  }
5375
- export class PreIpoCompanies<HandleError extends boolean = boolean> {
5350
+ export class MarketDates<HandleError extends boolean = boolean> {
5376
5351
  protected readonly apiClient: JwtClient<HandleError>;
5377
5352
  constructor(apiClient: JwtClient<HandleError>);
5378
5353
  /**
5379
- * @description get pre ipo companies Avaliable categories: on-demand business-video reverse-etl modern-data-stack video-api global-payroll banking-as-a-service ultrafast-delivery online-grocery website-builder fintech b2b venture-capital ecommerce creator-economy productivity real-estate private-markets-exchanges fpa vertical-saas card-issuing connected-fitness gig-marketplaces cms soc-2 analytics cap-table-management contractor-payroll social-media design online-whiteboard conversational-marketing expense-management stock-option-financing customer-onboarding crypto help-desk payroll documents databases mortgage-lending crypto-exchange marketing-automation payments operations checkout cybersecurity messaging investing marketplaces climate-tech robotics data-security online-education gaming universal-api automation biotechnology contact-center defense machine-learning logistics prefab-tech materials telehealth b2c alternative-proteins b2b-marketplaces wealth-management web3 neobank managed-marketplaces plg-crm jamstack public-safety background-checks identity-verification construction home-services sales blockchain-developer-platform space financial-data-aggregation ai writing-assistant autonomous-driving 401k-provider vector-databases ai-models devtools payroll-api internal-tools mlops bookkeeping cloud-infrastructure data-backups personal-finance ai-frameworks generative-ai cloud-gpus micromobility ai-avatars ai-chips life-sciences partnerships wearables fitness-tracking ai-search ai-medical-scribes networking quantum-computing code-editors
5380
- * @tags PreIPOCompanies
5381
- * @name GetPreIpoCompanies
5382
- * @summary get pre ipo companies
5383
- * @request GET:/ipos/pre-ipo-companies
5354
+ * @description get market dates history
5355
+ * @tags MarketDates
5356
+ * @name GetMarketDatesHistory
5357
+ * @summary get market dates history
5358
+ * @request POST:/market-dates/history
5384
5359
  * @secure
5385
5360
  */
5386
- getPreIpoCompanies(query: {
5387
- /** search by company name */
5388
- name?: string;
5389
- /** search by categories */
5390
- categories?: string;
5391
- /** how many records to return. Max value is 50 */
5392
- limit: number;
5393
- /** how many records to skip */
5394
- offset: number;
5395
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
5361
+ getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
5396
5362
  /**
5397
- * @description get pre ipo company by id
5398
- * @tags PreIPOCompanies
5399
- * @name GetPreIpoCompaniesById
5400
- * @summary get pre ipo company by id
5401
- * @request GET:/ipos/pre-ipo-companies/{id}
5402
- * @originalName getPreIpoCompanies
5403
- * @duplicate
5363
+ * @description get todays market hours
5364
+ * @tags MarketDates
5365
+ * @name GetTodaysMarketHours
5366
+ * @summary get todays market hours
5367
+ * @request GET:/market-dates/today
5404
5368
  * @secure
5405
5369
  */
5406
- getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
5370
+ getTodaysMarketHours(query: {
5371
+ /** Market */
5372
+ market: string;
5373
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
5374
+ }
5375
+ export class News<HandleError extends boolean = boolean> {
5376
+ protected readonly apiClient: JwtClient<HandleError>;
5377
+ constructor(apiClient: JwtClient<HandleError>);
5407
5378
  /**
5408
- * @description get pre ipo company funding rounds
5409
- * @tags PreIPOCompanies
5410
- * @name GetPreIpoCompanyFundingRounds
5411
- * @summary get pre ipo company funding rounds
5412
- * @request GET:/ipos/pre-ipo-company-funding-rounds
5379
+ * @description Returns available authors in DB
5380
+ * @tags News
5381
+ * @name NewsAvailableAuthors
5382
+ * @summary Get available authors in DB (for filters)
5383
+ * @request POST:/news/authors
5413
5384
  * @secure
5414
5385
  */
5415
- getPreIpoCompanyFundingRounds(query: {
5416
- /** company id */
5417
- pre_ipo_company_id?: string;
5418
- /** search by round name */
5419
- round_name?: string;
5420
- /** how many records to return. Max value is 50 */
5421
- limit: number;
5422
- /** how many records to skip */
5423
- offset: number;
5424
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
5386
+ newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5425
5387
  /**
5426
- * @description get pre ipo company funding round by id
5427
- * @tags PreIPOCompanies
5428
- * @name GetPreIpoCompanyFundingRoundsById
5429
- * @summary get pre ipo company funding round by id
5430
- * @request GET:/ipos/pre-ipo-company-funding-rounds/{id}
5431
- * @originalName getPreIpoCompanyFundingRounds
5432
- * @duplicate
5388
+ * @description Returns available channels in DB
5389
+ * @tags News
5390
+ * @name NewsAvailableChannels
5391
+ * @summary Get available channels in DB (for filters)
5392
+ * @request POST:/news/channels
5433
5393
  * @secure
5434
5394
  */
5435
- getPreIpoCompanyFundingRoundsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyFundingRound, HandleError>>;
5395
+ newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5436
5396
  /**
5437
- * @description get pre ipo company investments
5438
- * @tags PreIPOCompanies
5439
- * @name GetPreIpoCompanyInvestments
5440
- * @summary get pre ipo company investments
5441
- * @request GET:/ipos/pre-ipo-company-investments
5397
+ * @description Get featured articles
5398
+ * @tags News
5399
+ * @name GetFeaturedArticles
5400
+ * @summary Get featured articles
5401
+ * @request GET:/news/featured-articles
5442
5402
  * @secure
5443
5403
  */
5444
- getPreIpoCompanyInvestments(query: {
5445
- /** company id */
5446
- pre_ipo_company_id?: string;
5447
- /** company name */
5448
- company_name?: string;
5449
- /** how many records to return. Max value is 50 */
5404
+ getFeaturedArticles(query: {
5405
+ /** Limit */
5450
5406
  limit: number;
5451
- /** how many records to skip */
5407
+ /** Offset */
5452
5408
  offset: number;
5453
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
5409
+ /** Start date */
5410
+ start_date?: string;
5411
+ /** End date */
5412
+ end_date?: string;
5413
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
5454
5414
  /**
5455
- * @description get pre ipo company investment by id
5456
- * @tags PreIPOCompanies
5457
- * @name GetPreIpoCompanyInvestmentsById
5458
- * @summary get pre ipo company investment by id
5459
- * @request GET:/ipos/pre-ipo-company-investments/{id}
5460
- * @originalName getPreIpoCompanyInvestments
5461
- * @duplicate
5415
+ * @description Update featured articles
5416
+ * @tags News
5417
+ * @name UpdateFeaturedArticles
5418
+ * @summary Update featured articles
5419
+ * @request PUT:/news/featured-articles
5462
5420
  * @secure
5463
5421
  */
5464
- getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
5422
+ updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5465
5423
  /**
5466
- * @description get pre ipo company news
5467
- * @tags PreIPOCompanies
5468
- * @name GetPreIpoCompanyNews
5469
- * @summary get pre ipo company news
5470
- * @request GET:/ipos/pre-ipo-company-news
5424
+ * @description Create featured articles
5425
+ * @tags News
5426
+ * @name CreateFeaturedArticles
5427
+ * @summary Create featured articles
5428
+ * @request POST:/news/featured-articles
5471
5429
  * @secure
5472
5430
  */
5473
- getPreIpoCompanyNews(query: {
5474
- /** company id */
5475
- pre_ipo_company_id?: string;
5476
- /** search by headline */
5477
- headline?: string;
5478
- /** how many records to return. Max value is 50 */
5479
- limit: number;
5480
- /** how many records to skip */
5481
- offset: number;
5482
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
5431
+ createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5483
5432
  /**
5484
- * @description get pre ipo company news by id
5485
- * @tags PreIPOCompanies
5486
- * @name GetPreIpoCompanyNewsById
5487
- * @summary get pre ipo company news by id
5488
- * @request GET:/ipos/pre-ipo-company-news/{id}
5489
- * @originalName getPreIpoCompanyNews
5490
- * @duplicate
5433
+ * @description Get active featured articles
5434
+ * @tags News
5435
+ * @name GetActiveFeaturedArticles
5436
+ * @summary Get active featured articles
5437
+ * @request GET:/news/featured-articles/active
5491
5438
  * @secure
5492
5439
  */
5493
- getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
5440
+ getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
5494
5441
  /**
5495
- * @description get pre ipo company research documents
5496
- * @tags PreIPOCompanies
5497
- * @name GetPreIpoCompanyResearchDocuments
5498
- * @summary get pre ipo company research documents
5499
- * @request GET:/ipos/pre-ipo-company-research-documents
5442
+ * @description Set featured articles
5443
+ * @tags News
5444
+ * @name SetFeaturedArticles
5445
+ * @summary Set featured articles
5446
+ * @request POST:/news/featured-articles/set
5500
5447
  * @secure
5501
5448
  */
5502
- getPreIpoCompanyResearchDocuments(query: {
5503
- /** company id */
5504
- pre_ipo_company_id?: string;
5505
- /** search by title */
5506
- title?: string;
5507
- /** how many records to return. Max value is 50 */
5508
- limit: number;
5509
- /** how many records to skip */
5510
- offset: number;
5511
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
5449
+ setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5512
5450
  /**
5513
- * @description get pre ipo company research document by id
5514
- * @tags PreIPOCompanies
5515
- * @name GetPreIpoCompanyResearchDocumentsById
5516
- * @summary get pre ipo company research document by id
5517
- * @request GET:/ipos/pre-ipo-company-research-documents/{id}
5518
- * @originalName getPreIpoCompanyResearchDocuments
5519
- * @duplicate
5451
+ * @description Get featured article
5452
+ * @tags News
5453
+ * @name GetFeaturedArticle
5454
+ * @summary Get featured article
5455
+ * @request GET:/news/featured-articles/{id}
5520
5456
  * @secure
5521
5457
  */
5522
- getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
5458
+ getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
5523
5459
  /**
5524
- * @description get pre ipo company spvs
5525
- * @tags PreIPOCompanies
5526
- * @name GetPreIpoCompanySpvs
5527
- * @summary get pre ipo company spvs
5528
- * @request GET:/ipos/pre-ipo-company-spvs
5460
+ * @description Returns news by filters
5461
+ * @tags News
5462
+ * @name NewsFiltered
5463
+ * @summary Get filtered news
5464
+ * @request POST:/news/filter
5529
5465
  * @secure
5530
5466
  */
5531
- getPreIpoCompanySpvs(query: {
5532
- /** company id */
5533
- pre_ipo_company_id?: string;
5534
- /** investment id */
5535
- investment_id?: string;
5536
- /** search by name */
5537
- name?: string;
5538
- /** search by company name */
5539
- company_name?: string;
5467
+ newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
5468
+ /**
5469
+ * @description Returns news by id
5470
+ * @tags News
5471
+ * @name NewsById
5472
+ * @summary Get news by id
5473
+ * @request POST:/news/id
5474
+ * @secure
5475
+ */
5476
+ newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
5477
+ /**
5478
+ * @description Returns news previews
5479
+ * @tags News
5480
+ * @name NewsPreviewsFiltered
5481
+ * @summary Get news previews
5482
+ * @request GET:/news/previews
5483
+ * @secure
5484
+ */
5485
+ newsPreviewsFiltered(query: {
5486
+ /** Start date */
5487
+ start_date?: string;
5488
+ /** End date */
5489
+ end_date?: string;
5490
+ /** Symbol */
5491
+ symbol?: string;
5540
5492
  /** how many records to return. Max value is 50 */
5541
5493
  limit: number;
5542
5494
  /** how many records to skip */
5543
5495
  offset: number;
5544
- /** sort direction */
5545
- direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
5546
- /** sort field */
5547
- field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
5548
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
5496
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
5549
5497
  /**
5550
- * @description get pre ipo company spv by id
5551
- * @tags PreIPOCompanies
5552
- * @name GetPreIpoCompanySpvsById
5553
- * @summary get pre ipo company spv by id
5554
- * @request GET:/ipos/pre-ipo-company-spvs/{id}
5555
- * @originalName getPreIpoCompanySpvs
5556
- * @duplicate
5498
+ * @description Returns available stocks in DB
5499
+ * @tags News
5500
+ * @name NewsAvailableStocks
5501
+ * @summary Get available stocks in DB (for filters)
5502
+ * @request GET:/news/symbols
5557
5503
  * @secure
5558
5504
  */
5559
- getPreIpoCompanySpvsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
5505
+ newsAvailableStocks(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5506
+ /**
5507
+ * @description Returns available tags in DB
5508
+ * @tags News
5509
+ * @name NewsAvailableTags
5510
+ * @summary Get available tags in DB (for filters)
5511
+ * @request POST:/news/tags
5512
+ * @secure
5513
+ */
5514
+ newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5560
5515
  }
5561
- export class Public<HandleError extends boolean = boolean> {
5516
+ export class OptionGreeks<HandleError extends boolean = boolean> {
5562
5517
  protected readonly apiClient: JwtClient<HandleError>;
5563
5518
  constructor(apiClient: JwtClient<HandleError>);
5564
5519
  /**
5565
- * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
5566
- * @tags Public
5567
- * @name CalculateEstimatedReturns
5568
- * @summary Calculate Estimated Returns
5569
- * @request GET:/public/estimated-returns
5520
+ * @description Returns calculated matrix
5521
+ * @tags OptionGreeks
5522
+ * @name OgCalculateMatrix
5523
+ * @summary Calculate matrix
5524
+ * @request POST:/og/calculate-matrix
5570
5525
  * @secure
5571
5526
  */
5572
- calculateEstimatedReturns(query: {
5573
- /** Single symbol */
5574
- symbol: string;
5575
- /** Non-zero amount */
5576
- amount: number;
5577
- /** Start date for calculations */
5578
- start_date: string;
5579
- /** End date for calculations */
5580
- end_date: string;
5581
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
5527
+ ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
5582
5528
  /**
5583
- * @description Returns an expert forecast
5584
- * @tags Public
5585
- * @name ExpertForecast
5586
- * @summary Expert forecast
5587
- * @request GET:/public/expert-forecast
5529
+ * @description Returns calculated params
5530
+ * @tags OptionGreeks
5531
+ * @name OgCalculateParams
5532
+ * @summary Calculate params
5533
+ * @request POST:/og/calculate-params
5588
5534
  * @secure
5589
5535
  */
5590
- expertForecast(query: {
5591
- /** Comma separated symbols */
5592
- symbols: string;
5593
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
5536
+ ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
5537
+ }
5538
+ export class Ownerships<HandleError extends boolean = boolean> {
5539
+ protected readonly apiClient: JwtClient<HandleError>;
5540
+ constructor(apiClient: JwtClient<HandleError>);
5594
5541
  /**
5595
- * @description get fundamentals by symbol data
5596
- * @tags Public
5597
- * @name GetPublicFundamentalsBySymbolData
5598
- * @summary get fundamentals by symbol data
5599
- * @request GET:/public/fundamentals/{symbol}
5542
+ * @description get ownerships by id datadata
5543
+ * @tags Ownerships
5544
+ * @name GetOwnershipsByIdData
5545
+ * @summary get ownerships by id data
5546
+ * @request POST:/ownerships
5600
5547
  * @secure
5601
5548
  */
5602
- getPublicFundamentalsBySymbolData(symbol: string, query: {
5603
- /** Annual or quarterly */
5604
- mode: string;
5605
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
5549
+ getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5606
5550
  /**
5607
- * @description Daily price history
5608
- * @tags Public
5609
- * @name DailyPriceHistory
5610
- * @summary Daily price history
5611
- * @request GET:/public/price-history/daily
5551
+ * @description get ownerships by symbol data
5552
+ * @tags Ownerships
5553
+ * @name GetOwnershipsBySymbolData
5554
+ * @summary get ownerships by symbol data
5555
+ * @request POST:/symbol-ownerships
5612
5556
  * @secure
5613
5557
  */
5614
- dailyPriceHistory(query: {
5615
- /** Single symbol */
5616
- symbol: string;
5617
- /** Target date */
5618
- date: string;
5619
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
5558
+ getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5559
+ }
5560
+ export class TipRank<HandleError extends boolean = boolean> {
5561
+ protected readonly apiClient: JwtClient<HandleError>;
5562
+ constructor(apiClient: JwtClient<HandleError>);
5620
5563
  /**
5621
- * @description Public quote profile
5622
- * @tags Public
5623
- * @name PublicQuoteProfile
5624
- * @summary Public quote profile
5625
- * @request GET:/public/quote-profile/{symbol}
5564
+ * @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
5565
+ * @tags TipRank
5566
+ * @name TiprankAnalystConsensus
5567
+ * @summary Get tiprank AnalystConsensus
5568
+ * @request POST:/tipranks/analyst-consensus
5626
5569
  * @secure
5627
5570
  */
5628
- publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
5571
+ tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
5629
5572
  /**
5630
- * @description get ratios by symbol data
5631
- * @tags Public
5632
- * @name GetPublicRatiosBySymbolData
5633
- * @summary get ratios by symbol data
5634
- * @request GET:/public/ratios/{symbol}
5573
+ * @description Returns the latest analyst ratings on a given stock or multiple stocks.
5574
+ * @tags TipRank
5575
+ * @name TiprankLatestAnalystRatingsOnStock
5576
+ * @summary Get tiprank LatestAnalystRatingsOnStock
5577
+ * @request POST:/tipranks/analyst-multi
5635
5578
  * @secure
5636
5579
  */
5637
- getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
5580
+ tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError>>;
5638
5581
  /**
5639
- * @description find a symbol by name or description
5640
- * @tags Public
5641
- * @name QuoteFundamentalsSearch
5642
- * @summary find a symbol by name or description
5643
- * @request GET:/public/symbol-search
5582
+ * @description Returns the latest analyst portfolio items.
5583
+ * @tags TipRank
5584
+ * @name TiprankPortfolios
5585
+ * @summary Get the latest analyst portfolio items
5586
+ * @request POST:/tipranks/analyst-portfolio
5644
5587
  * @secure
5645
5588
  */
5646
- quoteFundamentalsSearch(query: {
5647
- /** Search query */
5648
- search_query: string;
5649
- /** how many records to return. Max value is 50 */
5650
- limit: number;
5651
- /** how many records to skip */
5652
- offset: number;
5653
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
5589
+ tiprankPortfolios(filter: InsightPortfoliosRequest, headers?: {
5590
+ /** Authorization */
5591
+ Authorization?: string;
5592
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError>>;
5654
5593
  /**
5655
- * @description Get top gainers
5656
- * @tags Public
5657
- * @name TopGainers
5658
- * @summary Top Gainers
5659
- * @request GET:/public/top-gainers
5594
+ * @description Returns the analyst profile information
5595
+ * @tags TipRank
5596
+ * @name TiprankAnalystProfile
5597
+ * @summary Get tiprank AnalystProfile
5598
+ * @request GET:/tipranks/analyst-profile
5660
5599
  * @secure
5661
5600
  */
5662
- topGainers(query: {
5663
- /** sort direction - asc or desc */
5664
- order_direction?: string;
5665
- /** how many records to return. Max value is 50 */
5666
- limit: number;
5667
- /** how many records to skip */
5668
- offset: number;
5669
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
5670
- /**
5671
- * @description Get top stocks
5672
- * @tags Public
5673
- * @name TopStocks
5674
- * @summary Top Stocks
5675
- * @request GET:/public/top-stocks
5676
- * @secure
5677
- */
5678
- topStocks(query: {
5679
- /** EQUITY|ETF|CRYPTO */
5680
- stock_type: InsightTopStocksParamsStockTypeEnum;
5681
- /** how many records to return. Max value is 50 */
5682
- limit: number;
5683
- /** how many records to skip */
5684
- offset: number;
5685
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
5686
- }
5687
- export class Quotes<HandleError extends boolean = boolean> {
5688
- protected readonly apiClient: JwtClient<HandleError>;
5689
- constructor(apiClient: JwtClient<HandleError>);
5690
- /**
5691
- * @description Get single historical quote
5692
- * @tags Quotes
5693
- * @name GitHistoricalQuote
5694
- * @summary Get single historical quote
5695
- * @request GET:/historical/quote
5696
- * @secure
5697
- */
5698
- gitHistoricalQuote(query: {
5699
- /** Symbol */
5700
- symbol: string;
5701
- /** Date */
5702
- date: string;
5703
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
5704
- /**
5705
- * @description get quote history by symbol
5706
- * @tags Quotes
5707
- * @name GitQuoteHistory
5708
- * @summary Get quote history
5709
- * @request POST:/quote-history
5710
- * @secure
5711
- */
5712
- gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
5713
- /**
5714
- * @description Returns a list of quotes equity info for specified symbols.
5715
- * @tags Quotes
5716
- * @name GetQuotesEquityData
5717
- * @summary Get Quotes Equity data
5718
- * @request GET:/quotes/equity
5719
- * @secure
5720
- */
5721
- getQuotesEquityData(query: {
5722
- /** Comma separated symbols */
5723
- symbols: string;
5724
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
5725
- }
5726
- export class StockScreener<HandleError extends boolean = boolean> {
5727
- protected readonly apiClient: JwtClient<HandleError>;
5728
- constructor(apiClient: JwtClient<HandleError>);
5729
- /**
5730
- * @description data for visual heat map
5731
- * @tags StockScreener
5732
- * @name StockMarketHeatmap
5733
- * @summary data for visual heat map
5734
- * @request GET:/heatmaps
5735
- * @secure
5736
- */
5737
- stockMarketHeatmap(query?: {
5738
- /** Name of symbol list to fetch details for. Empty is default */
5739
- heatmap_name?: string;
5740
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
5741
- /**
5742
- * @description create or update heat map preset
5743
- * @tags StockScreener
5744
- * @name CreateStockMarketHeatmapPreset
5745
- * @summary create or update heat map preset
5746
- * @request POST:/heatmaps
5747
- * @secure
5748
- */
5749
- createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5750
- /**
5751
- * @description Sector and Industry Group performance
5752
- * @tags StockScreener
5753
- * @name IndustriesPerformance
5754
- * @summary get industries performance
5755
- * @request POST:/industries-performance
5756
- * @secure
5757
- */
5758
- industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
5759
- /**
5760
- * @description filter stocks by params
5761
- * @tags StockScreener
5762
- * @name StockScreener
5763
- * @summary filter stocks by params
5764
- * @request POST:/stock-screener
5765
- * @secure
5766
- */
5767
- stockScreener(filter: InsightStockScreenerV1Request, headers?: {
5768
- /** Authorization */
5769
- Authorization?: string;
5770
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5771
- /**
5772
- * @description get screener presets
5773
- * @tags StockScreener
5774
- * @name GetScreenerPresets
5775
- * @summary get screener presets
5776
- * @request GET:/stock-screener/presets
5777
- * @secure
5778
- */
5779
- getScreenerPresets(query: {
5780
- /** how many records to return */
5781
- limit: number;
5782
- /** how many records to skip */
5783
- offset: number;
5784
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
5785
- /**
5786
- * @description update screener preset
5787
- * @tags StockScreener
5788
- * @name UpdateScreenerPreset
5789
- * @summary update screener preset
5790
- * @request PUT:/stock-screener/presets
5791
- * @secure
5792
- */
5793
- updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5794
- /**
5795
- * @description create screener preset
5796
- * @tags StockScreener
5797
- * @name CreateOrScreenerPreset
5798
- * @summary create screener preset
5799
- * @request POST:/stock-screener/presets
5800
- * @secure
5801
- */
5802
- createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5803
- /**
5804
- * @description remove screener preset
5805
- * @tags StockScreener
5806
- * @name RemoveScreenerPreset
5807
- * @summary remove screener preset
5808
- * @request DELETE:/stock-screener/presets
5809
- * @secure
5810
- */
5811
- removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5812
- /**
5813
- * @description get top symbols
5814
- * @tags StockScreener
5815
- * @name GetTopSymbols
5816
- * @summary get top symbols
5817
- * @request POST:/stock-screener/top
5818
- * @secure
5819
- */
5820
- getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5821
- }
5822
- export class StockScreenerV2<HandleError extends boolean = boolean> {
5823
- protected readonly apiClient: JwtClient<HandleError>;
5824
- constructor(apiClient: JwtClient<HandleError>);
5825
- /**
5826
- * @description filter stocks by params
5827
- * @tags StockScreener
5828
- * @name StockScreener
5829
- * @summary filter stocks by params
5830
- * @request POST:/stock-screener
5831
- * @secure
5832
- */
5833
- stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
5834
- /**
5835
- * @description get top symbols
5836
- * @tags StockScreener
5837
- * @name GetTopSymbols
5838
- * @summary get top symbols
5839
- * @request POST:/stock-screener/top
5840
- * @secure
5841
- */
5842
- getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
5843
- }
5844
- export class TipRank<HandleError extends boolean = boolean> {
5845
- protected readonly apiClient: JwtClient<HandleError>;
5846
- constructor(apiClient: JwtClient<HandleError>);
5847
- /**
5848
- * @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
5849
- * @tags TipRank
5850
- * @name TiprankAnalystConsensus
5851
- * @summary Get tiprank AnalystConsensus
5852
- * @request POST:/tipranks/analyst-consensus
5853
- * @secure
5854
- */
5855
- tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
5856
- /**
5857
- * @description Returns the latest analyst ratings on a given stock or multiple stocks.
5858
- * @tags TipRank
5859
- * @name TiprankLatestAnalystRatingsOnStock
5860
- * @summary Get tiprank LatestAnalystRatingsOnStock
5861
- * @request POST:/tipranks/analyst-multi
5862
- * @secure
5863
- */
5864
- tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError>>;
5865
- /**
5866
- * @description Returns the latest analyst portfolio items.
5867
- * @tags TipRank
5868
- * @name TiprankPortfolios
5869
- * @summary Get the latest analyst portfolio items
5870
- * @request POST:/tipranks/analyst-portfolio
5871
- * @secure
5872
- */
5873
- tiprankPortfolios(filter: InsightPortfoliosRequest, headers?: {
5874
- /** Authorization */
5875
- Authorization?: string;
5876
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError>>;
5877
- /**
5878
- * @description Returns the analyst profile information
5879
- * @tags TipRank
5880
- * @name TiprankAnalystProfile
5881
- * @summary Get tiprank AnalystProfile
5882
- * @request GET:/tipranks/analyst-profile
5883
- * @secure
5884
- */
5885
- tiprankAnalystProfile(query: {
5886
- /** ID of tiprank analyst profile */
5887
- id: string;
5888
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystProfileResponse, HandleError>>;
5601
+ tiprankAnalystProfile(query: {
5602
+ /** ID of tiprank analyst profile */
5603
+ id: string;
5604
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystProfileResponse, HandleError>>;
5889
5605
  /**
5890
5606
  * @description Returns the URL prefix to the expertPictureUrl field.
5891
5607
  * @tags TipRank
@@ -6207,200 +5923,484 @@ export class TipRank<HandleError extends boolean = boolean> {
6207
5923
  Authorization?: string;
6208
5924
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
6209
5925
  }
6210
- export class UsageTracking<HandleError extends boolean = boolean> {
5926
+ export class Public<HandleError extends boolean = boolean> {
6211
5927
  protected readonly apiClient: JwtClient<HandleError>;
6212
5928
  constructor(apiClient: JwtClient<HandleError>);
6213
5929
  /**
6214
- * @description get usage date per branch for a period
6215
- * @tags UsageTracking
6216
- * @name GetUsageData
6217
- * @summary get insight usage data
6218
- * @request POST:/tracking/usage
5930
+ * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
5931
+ * @tags Public
5932
+ * @name CalculateEstimatedReturns
5933
+ * @summary Calculate Estimated Returns
5934
+ * @request GET:/public/estimated-returns
6219
5935
  * @secure
6220
5936
  */
6221
- getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
6222
- }
6223
- export class WorldMarkets<HandleError extends boolean = boolean> {
6224
- protected readonly apiClient: JwtClient<HandleError>;
6225
- constructor(apiClient: JwtClient<HandleError>);
5937
+ calculateEstimatedReturns(query: {
5938
+ /** Single symbol */
5939
+ symbol: string;
5940
+ /** Non-zero amount */
5941
+ amount: number;
5942
+ /** Start date for calculations */
5943
+ start_date: string;
5944
+ /** End date for calculations */
5945
+ end_date: string;
5946
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
6226
5947
  /**
6227
- * @description Get continents
6228
- * @tags World Markets
6229
- * @name ContinentGet
6230
- * @summary Get continents
6231
- * @request GET:/continents
5948
+ * @description Returns an expert forecast
5949
+ * @tags Public
5950
+ * @name ExpertForecast
5951
+ * @summary Expert forecast
5952
+ * @request GET:/public/expert-forecast
6232
5953
  * @secure
6233
5954
  */
6234
- continentGet(query: {
6235
- /** Query limit */
6236
- limit: number;
6237
- /** Query offset */
6238
- offset: number;
6239
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
5955
+ expertForecast(query: {
5956
+ /** Comma separated symbols */
5957
+ symbols: string;
5958
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
6240
5959
  /**
6241
- * @description Edit continent
6242
- * @tags World Markets
6243
- * @name ContinentEdit
6244
- * @summary Edit continent
6245
- * @request PUT:/continents
5960
+ * @description get fundamentals by symbol data
5961
+ * @tags Public
5962
+ * @name GetPublicFundamentalsBySymbolData
5963
+ * @summary get fundamentals by symbol data
5964
+ * @request GET:/public/fundamentals/{symbol}
6246
5965
  * @secure
6247
5966
  */
6248
- continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5967
+ getPublicFundamentalsBySymbolData(symbol: string, query: {
5968
+ /** Annual or quarterly */
5969
+ mode: string;
5970
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
6249
5971
  /**
6250
- * @description Create continents
6251
- * @tags World Markets
6252
- * @name ContinentCreate
6253
- * @summary Create continents
6254
- * @request POST:/continents
5972
+ * @description Daily price history
5973
+ * @tags Public
5974
+ * @name DailyPriceHistory
5975
+ * @summary Daily price history
5976
+ * @request GET:/public/price-history/daily
6255
5977
  * @secure
6256
5978
  */
6257
- continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
5979
+ dailyPriceHistory(query: {
5980
+ /** Single symbol */
5981
+ symbol: string;
5982
+ /** Target date */
5983
+ date: string;
5984
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
6258
5985
  /**
6259
- * @description Delete continent
6260
- * @tags World Markets
6261
- * @name ContinentDelete
6262
- * @summary Delete continent
6263
- * @request DELETE:/continents
5986
+ * @description Public quote profile
5987
+ * @tags Public
5988
+ * @name PublicQuoteProfile
5989
+ * @summary Public quote profile
5990
+ * @request GET:/public/quote-profile/{symbol}
6264
5991
  * @secure
6265
5992
  */
6266
- continentDelete(query: {
6267
- /** continent id */
6268
- id: string;
6269
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5993
+ publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
6270
5994
  /**
6271
- * @description Get country codes
6272
- * @tags World Markets
6273
- * @name CountryCodeGet
6274
- * @summary Get country codes
6275
- * @request GET:/country-codes
5995
+ * @description get ratios by symbol data
5996
+ * @tags Public
5997
+ * @name GetPublicRatiosBySymbolData
5998
+ * @summary get ratios by symbol data
5999
+ * @request GET:/public/ratios/{symbol}
6276
6000
  * @secure
6277
6001
  */
6278
- countryCodeGet(query: {
6279
- /** Query limit */
6002
+ getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
6003
+ /**
6004
+ * @description find a symbol by name or description
6005
+ * @tags Public
6006
+ * @name QuoteFundamentalsSearch
6007
+ * @summary find a symbol by name or description
6008
+ * @request GET:/public/symbol-search
6009
+ * @secure
6010
+ */
6011
+ quoteFundamentalsSearch(query: {
6012
+ /** Search query */
6013
+ search_query: string;
6014
+ /** how many records to return. Max value is 50 */
6280
6015
  limit: number;
6281
- /** Query offset */
6016
+ /** how many records to skip */
6282
6017
  offset: number;
6283
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
6018
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
6284
6019
  /**
6285
- * @description Edit country code
6286
- * @tags World Markets
6287
- * @name CountryCodeEdit
6288
- * @summary Edit country code
6289
- * @request PUT:/country-codes
6020
+ * @description Get top gainers
6021
+ * @tags Public
6022
+ * @name TopGainers
6023
+ * @summary Top Gainers
6024
+ * @request GET:/public/top-gainers
6290
6025
  * @secure
6291
6026
  */
6292
- countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6027
+ topGainers(query: {
6028
+ /** sort direction - asc or desc */
6029
+ order_direction?: string;
6030
+ /** how many records to return. Max value is 50 */
6031
+ limit: number;
6032
+ /** how many records to skip */
6033
+ offset: number;
6034
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6293
6035
  /**
6294
- * @description Add country codes
6295
- * @tags World Markets
6296
- * @name CountryCodeAdd
6297
- * @summary Add country codes
6298
- * @request POST:/country-codes
6036
+ * @description Get top stocks
6037
+ * @tags Public
6038
+ * @name TopStocks
6039
+ * @summary Top Stocks
6040
+ * @request GET:/public/top-stocks
6299
6041
  * @secure
6300
6042
  */
6301
- countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
6043
+ topStocks(query: {
6044
+ /** EQUITY|ETF|CRYPTO */
6045
+ stock_type: InsightTopStocksParamsStockTypeEnum;
6046
+ /** how many records to return. Max value is 50 */
6047
+ limit: number;
6048
+ /** how many records to skip */
6049
+ offset: number;
6050
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6051
+ }
6052
+ export class UsageTracking<HandleError extends boolean = boolean> {
6053
+ protected readonly apiClient: JwtClient<HandleError>;
6054
+ constructor(apiClient: JwtClient<HandleError>);
6302
6055
  /**
6303
- * @description Delete country code
6304
- * @tags World Markets
6305
- * @name CountryCodeDelete
6306
- * @summary Delete country code
6307
- * @request DELETE:/country-codes
6056
+ * @description get usage date per branch for a period
6057
+ * @tags UsageTracking
6058
+ * @name GetUsageData
6059
+ * @summary get insight usage data
6060
+ * @request POST:/tracking/usage
6308
6061
  * @secure
6309
6062
  */
6310
- countryCodeDelete(query: {
6311
- /** a3 code */
6312
- a3code: string;
6313
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6063
+ getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
6064
+ }
6065
+ export class AlphaTools<HandleError extends boolean = boolean> {
6066
+ protected readonly apiClient: JwtClient<HandleError>;
6067
+ constructor(apiClient: JwtClient<HandleError>);
6314
6068
  /**
6315
- * @description Get global indexes
6316
- * @tags World Markets
6317
- * @name GlobalIndexGet
6318
- * @summary Get global indexes
6319
- * @request GET:/global-indexes
6069
+ * @description get seasonlity data with comparison to benchmark
6070
+ * @tags AlphaTools
6071
+ * @name GetMomentumRatioGraph
6072
+ * @summary get seasonlity data
6073
+ * @request POST:/rst
6320
6074
  * @secure
6321
6075
  */
6322
- globalIndexGet(query: {
6323
- /** Query limit */
6324
- limit: number;
6325
- /** Query offset */
6326
- offset: number;
6327
- /** Continent code for filtering */
6328
- continent?: string;
6329
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
6076
+ getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
6330
6077
  /**
6331
- * @description Edit global index
6332
- * @tags World Markets
6333
- * @name GlobalIndexEdit
6334
- * @summary Edit global index
6335
- * @request PUT:/global-indexes
6078
+ * @description get seasonlity data with comparison to benchmark
6079
+ * @tags AlphaTools
6080
+ * @name GetSeasonality
6081
+ * @summary get seasonlity data
6082
+ * @request POST:/seasonality
6336
6083
  * @secure
6337
6084
  */
6338
- globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6085
+ getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
6086
+ }
6087
+ export class Passport<HandleError extends boolean = boolean> {
6088
+ protected readonly apiClient: JwtClient<HandleError>;
6089
+ constructor(apiClient: JwtClient<HandleError>);
6339
6090
  /**
6340
- * @description Add global indexes
6341
- * @tags World Markets
6342
- * @name GlobalIndexAdd
6343
- * @summary Add global indexes
6344
- * @request POST:/global-indexes
6091
+ * @description Returns article by id
6092
+ * @tags Passport
6093
+ * @name PassportArticleById
6094
+ * @summary Get article by id
6095
+ * @request POST:/passport/article-by-id
6345
6096
  * @secure
6346
6097
  */
6347
- globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
6098
+ passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
6348
6099
  /**
6349
- * @description Edit global index
6350
- * @tags World Markets
6351
- * @name GlobalIndexDelete
6352
- * @summary Delete global index
6353
- * @request DELETE:/global-indexes
6100
+ * @description Returns articles
6101
+ * @tags Passport
6102
+ * @name PassportArticles
6103
+ * @summary Get articles
6104
+ * @request POST:/passport/articles
6354
6105
  * @secure
6355
6106
  */
6356
- globalIndexDelete(query: {
6357
- /** a3 code */
6358
- a3code: string;
6359
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6107
+ passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6360
6108
  /**
6361
- * @description Get regions
6362
- * @tags World Markets
6363
- * @name RegionGet
6364
- * @summary Get regions
6365
- * @request GET:/regions
6109
+ * @description Returns author profile
6110
+ * @tags Passport
6111
+ * @name PassportAuthorProfile
6112
+ * @summary Get author profile
6113
+ * @request POST:/passport/author-profile
6366
6114
  * @secure
6367
6115
  */
6368
- regionGet(query: {
6369
- /** Query limit */
6370
- limit: number;
6371
- /** Query offset */
6372
- offset: number;
6373
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
6116
+ passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
6374
6117
  /**
6375
- * @description Edit region
6376
- * @tags World Markets
6377
- * @name RegionEdit
6378
- * @summary Edit region
6379
- * @request PUT:/regions
6118
+ * @description Returns most popular tags
6119
+ * @tags Passport
6120
+ * @name PassportMostPopularTags
6121
+ * @summary Get most popular tags
6122
+ * @request POST:/passport/most-popular-tags
6380
6123
  * @secure
6381
6124
  */
6382
- regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6125
+ passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
6383
6126
  /**
6384
- * @description Create regions
6385
- * @tags World Markets
6386
- * @name RegionCreate
6387
- * @summary Create regions
6388
- * @request POST:/regions
6127
+ * @description Returns news feed
6128
+ * @tags Passport
6129
+ * @name PassportNewsFeed
6130
+ * @summary Get news feed
6131
+ * @request POST:/passport/newsfeed
6389
6132
  * @secure
6390
6133
  */
6391
- regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
6134
+ passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
6392
6135
  /**
6393
- * @description Delete region
6394
- * @tags World Markets
6395
- * @name RegionDelete
6396
- * @summary Delete region
6397
- * @request DELETE:/regions
6136
+ * @description Returns article by parameters
6137
+ * @tags Passport
6138
+ * @name PassportSearchArticle
6139
+ * @summary Search article by parameters
6140
+ * @request POST:/passport/search-article
6398
6141
  * @secure
6399
6142
  */
6400
- regionDelete(query: {
6401
- /** region id */
6402
- id: string;
6403
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6143
+ passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6144
+ }
6145
+ export interface InsightBeforeAndAfterV2 {
6146
+ after?: string;
6147
+ before?: string;
6148
+ }
6149
+ export interface InsightFixedIncomeV2 {
6150
+ a144: boolean;
6151
+ accrued_interest: number;
6152
+ bank_qualified: boolean;
6153
+ bond_warrant: boolean;
6154
+ call_type: string;
6155
+ callable: boolean;
6156
+ close_price: number;
6157
+ close_price_asof: string;
6158
+ close_ytw: number;
6159
+ convertible: boolean;
6160
+ country: string;
6161
+ country_code: string;
6162
+ country_domicile: string;
6163
+ country_issue: string;
6164
+ coupon: number;
6165
+ coupon_frequency: string;
6166
+ coupon_type: string;
6167
+ currency: string;
6168
+ cusip: string;
6169
+ dated_date: string;
6170
+ daycount: string;
6171
+ description: string;
6172
+ description_short: string;
6173
+ duration: number;
6174
+ first_coupon_date: string;
6175
+ insured: boolean;
6176
+ isin: string;
6177
+ issue_date: string;
6178
+ issue_minimum_denomination: number;
6179
+ issue_price: number;
6180
+ issue_size: number;
6181
+ issuer: string;
6182
+ last_coupon_date: string;
6183
+ liquidity_institutional_aggregate: number;
6184
+ liquidity_institutional_buy: number;
6185
+ liquidity_institutional_sell: number;
6186
+ liquidity_micro_aggregate: number;
6187
+ liquidity_micro_buy: number;
6188
+ liquidity_micro_sell: number;
6189
+ liquidity_retail_aggregate: number;
6190
+ liquidity_retail_buy: number;
6191
+ liquidity_retail_sell: number;
6192
+ maturity_date: string;
6193
+ municipal_state: string;
6194
+ municipal_taxable_federal: boolean;
6195
+ municipal_type: string;
6196
+ next_call_date: string;
6197
+ next_call_price: number;
6198
+ next_coupon_date: string;
6199
+ par_value: number;
6200
+ perpetual: boolean;
6201
+ private_placement: boolean;
6202
+ purpose: string;
6203
+ puttable: boolean;
6204
+ reg_s: boolean;
6205
+ sector: string;
6206
+ seniority: string;
6207
+ settlement_convention: string;
6208
+ sinking_fund: boolean;
6209
+ sp_creditwatch: string;
6210
+ sp_creditwatch_date: string;
6211
+ sp_outlook: string;
6212
+ sp_outlook_date: string;
6213
+ sp_rating: string;
6214
+ sp_rating_date: string;
6215
+ status: string;
6216
+ ticker: string;
6217
+ treasury_subtype: string;
6218
+ type: string;
6219
+ updated_at: string;
6220
+ }
6221
+ export interface InsightGetFixedIncomeEntriesResponseV2 {
6222
+ count: number;
6223
+ data: InsightFixedIncomeV2[];
6224
+ }
6225
+ export interface InsightGetFixedIncomeEntriesRequestV2 {
6226
+ /** @example true */
6227
+ bank_qualified?: boolean;
6228
+ /** @example true */
6229
+ callable?: boolean;
6230
+ /** @example true */
6231
+ convertible?: boolean;
6232
+ /** @example ["USA"] */
6233
+ country_codes?: string[];
6234
+ coupon?: InsightLessAndMoreV2;
6235
+ /** @example ["quarterly","zero"] */
6236
+ coupon_frequencies?: string[];
6237
+ /** @example ["655664AH3","9128286R6"] */
6238
+ cusip?: string[];
6239
+ /**
6240
+ * @maxLength 100
6241
+ * @example "Donald's"
6242
+ */
6243
+ description?: string;
6244
+ /** @example true */
6245
+ has_ticker?: boolean;
6246
+ /** @example true */
6247
+ insured?: boolean;
6248
+ /** @example ["US655664AH33","US9128286R69"] */
6249
+ isin?: string[];
6250
+ issue_date?: InsightBeforeAndAfterV2;
6251
+ /**
6252
+ * @maxLength 100
6253
+ * @example "Donald's"
6254
+ */
6255
+ issuer?: string;
6256
+ maturity?: InsightBeforeAndAfterV2;
6257
+ /** @example ["NY"] */
6258
+ municipal_states?: string[];
6259
+ /** @example true */
6260
+ municipal_tax?: boolean;
6261
+ /** @example ["general_obligation"] */
6262
+ municipal_types?: string[];
6263
+ pagination: InsightPaginationV2;
6264
+ purposes?: string[];
6265
+ /** @example ["SOVEREIGN"] */
6266
+ sectors?: string[];
6267
+ sorts?: InsightOrderingV2[];
6268
+ /** @example ["AAA"] */
6269
+ sp_ratings?: string[];
6270
+ /** @example ["called","outstanding"] */
6271
+ statuses?: string[];
6272
+ tickers?: string[];
6273
+ /** @example ["corporate"] */
6274
+ types?: string[];
6275
+ }
6276
+ export interface InsightGetTopSymbolsRequestV2 {
6277
+ exchange?: string[];
6278
+ market_cap?: InsightLessAndMoreV2;
6279
+ pagination?: InsightPaginationV2;
6280
+ price?: InsightLessAndMoreV2;
6281
+ sorts?: InsightOrderingV2[];
6282
+ volume?: InsightLessAndMoreV2;
6283
+ }
6284
+ export interface InsightIncludeExcludeV2 {
6285
+ exclude?: string[];
6286
+ include?: string[];
6287
+ }
6288
+ export interface InsightLessAndMoreV2 {
6289
+ less_than?: number;
6290
+ more_than?: number;
6291
+ }
6292
+ export interface InsightOrderingV2 {
6293
+ /**
6294
+ * @default "asc"
6295
+ * @example "asc"
6296
+ */
6297
+ direction: InsightOrderingDirectionEnumV2;
6298
+ /**
6299
+ * Sort direction:
6300
+ * * asc - Ascending, from A to Z.
6301
+ * * desc - Descending, from Z to A.
6302
+ * @example "name"
6303
+ */
6304
+ field: string;
6305
+ }
6306
+ export interface InsightPaginationV2 {
6307
+ /**
6308
+ * @min 1
6309
+ * @example 1
6310
+ */
6311
+ page: number;
6312
+ /**
6313
+ * @min 1
6314
+ * @max 50
6315
+ * @example 10
6316
+ */
6317
+ size: number;
6318
+ }
6319
+ export interface InsightStockScreenerQuoteV2 {
6320
+ average_volume_30d: number;
6321
+ company_name: string;
6322
+ dividend_ex_date: string;
6323
+ dividend_pay_date: string;
6324
+ dividend_percent: number;
6325
+ exchange: string;
6326
+ exchange_name: string;
6327
+ gap: number;
6328
+ industry: string;
6329
+ industry_code: string;
6330
+ last_price: number;
6331
+ market_cap: number;
6332
+ pe_ratio: number;
6333
+ price_change: number;
6334
+ price_change_percent: number;
6335
+ symbol: string;
6336
+ volume: number;
6337
+ }
6338
+ export interface InsightStockScreenerRequestV2 {
6339
+ average_volume_30d?: InsightLessAndMoreV2;
6340
+ dividend_ex_date?: InsightBeforeAndAfterV2;
6341
+ dividend_pay_date?: InsightBeforeAndAfterV2;
6342
+ dividend_percent?: InsightLessAndMoreV2;
6343
+ exchange?: InsightIncludeExcludeV2;
6344
+ gap?: InsightLessAndMoreV2;
6345
+ industry?: InsightIncludeExcludeV2;
6346
+ market_cap?: InsightLessAndMoreV2;
6347
+ pagination: InsightPaginationV2;
6348
+ pe_ratio?: InsightLessAndMoreV2;
6349
+ price?: InsightLessAndMoreV2;
6350
+ sorts?: InsightOrderingV2[];
6351
+ /** @example "ADR" */
6352
+ stock_type?: string;
6353
+ volume?: InsightLessAndMoreV2;
6354
+ }
6355
+ export interface InsightStockScreenerResponseV2 {
6356
+ current_page: number;
6357
+ data: InsightStockScreenerQuoteV2[];
6358
+ page_count: number;
6359
+ status: number;
6360
+ total_records: number;
6361
+ }
6362
+ /**
6363
+ * @default "asc"
6364
+ * @example "asc"
6365
+ */
6366
+ export enum InsightOrderingDirectionEnumV2 {
6367
+ Asc = "asc",
6368
+ Desc = "desc"
6369
+ }
6370
+ export class FixedIncomeV2<HandleError extends boolean = boolean> {
6371
+ protected readonly apiClient: JwtClient<HandleError>;
6372
+ constructor(apiClient: JwtClient<HandleError>);
6373
+ /**
6374
+ * @description get fixed income entries
6375
+ * @tags FixedIncome
6376
+ * @name GetFixedIncomeEntries
6377
+ * @summary get fixed income entries
6378
+ * @request POST:/fixed-income
6379
+ * @secure
6380
+ */
6381
+ getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
6382
+ }
6383
+ export class StockScreenerV2<HandleError extends boolean = boolean> {
6384
+ protected readonly apiClient: JwtClient<HandleError>;
6385
+ constructor(apiClient: JwtClient<HandleError>);
6386
+ /**
6387
+ * @description filter stocks by params
6388
+ * @tags StockScreener
6389
+ * @name StockScreener
6390
+ * @summary filter stocks by params
6391
+ * @request POST:/stock-screener
6392
+ * @secure
6393
+ */
6394
+ stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
6395
+ /**
6396
+ * @description get top symbols
6397
+ * @tags StockScreener
6398
+ * @name GetTopSymbols
6399
+ * @summary get top symbols
6400
+ * @request POST:/stock-screener/top
6401
+ * @secure
6402
+ */
6403
+ getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
6404
6404
  }
6405
6405
  export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
6406
6406
  readonly config: JwtClientConfig<HandleError>;