@orbis-systems/orbis-api-clients 0.6.5 → 0.6.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/dist/aesmidas/index.d.ts +1038 -984
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +694 -694
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +693 -693
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +360 -361
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +914 -914
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +913 -913
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/insight/index.d.ts +1271 -1051
  14. package/dist/insight/index.d.ts.map +1 -1
  15. package/dist/insight/index.esm.js +1594 -1433
  16. package/dist/insight/index.esm.js.map +1 -1
  17. package/dist/insight/index.js +1593 -1432
  18. package/dist/insight/index.js.map +1 -1
  19. package/dist/middleware/index.d.ts +73 -73
  20. package/dist/middleware/index.d.ts.map +1 -1
  21. package/dist/middleware/index.esm.js +203 -203
  22. package/dist/middleware/index.esm.js.map +1 -1
  23. package/dist/middleware/index.js +202 -202
  24. package/dist/middleware/index.js.map +1 -1
  25. package/dist/orbis/index.d.ts +3935 -3935
  26. package/dist/orbis/index.d.ts.map +1 -1
  27. package/dist/orbis/index.esm.js +3349 -3349
  28. package/dist/orbis/index.esm.js.map +1 -1
  29. package/dist/orbis/index.js +3348 -3348
  30. package/dist/orbis/index.js.map +1 -1
  31. package/dist/uma/index.d.ts +573 -573
  32. package/dist/uma/index.d.ts.map +1 -1
  33. package/dist/uma/index.esm.js +2920 -2920
  34. package/dist/uma/index.esm.js.map +1 -1
  35. package/dist/uma/index.js +2919 -2919
  36. package/dist/uma/index.js.map +1 -1
  37. package/package.json +1 -1
@@ -953,11 +953,11 @@ export interface InsightFundScreenerRequest {
953
953
  assets?: string[];
954
954
  categories?: string[];
955
955
  /** @example "ETF" */
956
- fund_type: InsightFundScreenerRequestFundTypeEnum;
956
+ fund_type?: InsightFundScreenerRequestFundTypeEnum;
957
957
  /** @example "ANY" */
958
- inverse: InsightFundScreenerRequestInverseEnum;
958
+ inverse?: InsightFundScreenerRequestInverseEnum;
959
959
  /** @example "ANY" */
960
- leverage: InsightFundScreenerRequestLeverageEnum;
960
+ leverage?: InsightFundScreenerRequestLeverageEnum;
961
961
  market_cap?: InsightLessAndMore;
962
962
  paging: InsightPaging;
963
963
  sectors?: InsightSectorFilter[];
@@ -1270,6 +1270,22 @@ export interface InsightGetOwnershipsBySymbolWithoutSearchQueryRequest {
1270
1270
  /** @example ["AAPL","GOOGL"] */
1271
1271
  symbols: string[];
1272
1272
  }
1273
+ export interface InsightGetPreIPOCompaniesResponse {
1274
+ count: number;
1275
+ details: InsightPreIPOCompany[];
1276
+ }
1277
+ export interface InsightGetPreIPOCompanyInvestmentsResponse {
1278
+ count: number;
1279
+ details: InsightPreIPOCompanyInvestment[];
1280
+ }
1281
+ export interface InsightGetPreIPOCompanyNewsResponse {
1282
+ count: number;
1283
+ details: InsightPreIPOCompanyNews[];
1284
+ }
1285
+ export interface InsightGetPreIPOCompanyResearchDocumentsResponse {
1286
+ count: number;
1287
+ details: InsightPreIPOCompanyResearchDocument[];
1288
+ }
1273
1289
  export interface InsightGetScreenerPresetsResponse {
1274
1290
  count: number;
1275
1291
  default_presets: InsightScreenerPreset[];
@@ -3205,6 +3221,91 @@ export interface InsightPortfoliosResponse {
3205
3221
  status: string;
3206
3222
  stock_ticker: string;
3207
3223
  }
3224
+ export interface InsightPreIPOCompany {
3225
+ address: string;
3226
+ country: string;
3227
+ description: string;
3228
+ domain: string;
3229
+ executive_team: string[];
3230
+ facebook: string;
3231
+ founder: string;
3232
+ id: string;
3233
+ last_funding_date: string;
3234
+ last_funding_series: string;
3235
+ last_funding_total: number;
3236
+ last_funding_type: string;
3237
+ last_share_price: number;
3238
+ last_valuation: number;
3239
+ linkedin: string;
3240
+ logo_url: string;
3241
+ name: string;
3242
+ notable_investors_logos: string[];
3243
+ num_customers: number;
3244
+ num_investors: number;
3245
+ num_jobs: number;
3246
+ num_shares_outstanding: number;
3247
+ total_funding: number;
3248
+ total_funding_rounds: number;
3249
+ twelve_month_trailing_revenue: number;
3250
+ type: string;
3251
+ x: string;
3252
+ year_est: string;
3253
+ }
3254
+ export interface InsightPreIPOCompanyArticle {
3255
+ article_id: string;
3256
+ date_published: string;
3257
+ headline: string;
3258
+ id: string;
3259
+ link: string;
3260
+ pre_ipo_company_news_id: string;
3261
+ publication: string;
3262
+ short_summary: string;
3263
+ source: string;
3264
+ }
3265
+ export interface InsightPreIPOCompanyInvestment {
3266
+ carried_interest: number;
3267
+ company_name: string;
3268
+ created_at: string;
3269
+ fund_structure: string;
3270
+ gp_name: string;
3271
+ id: string;
3272
+ investment_size: number;
3273
+ lp_stake_percentage: number;
3274
+ lp_stake_share_count: number;
3275
+ management_fee: number;
3276
+ management_fee_frequency: string;
3277
+ number_of_shares: number;
3278
+ pre_ipo_company_id: string;
3279
+ price_per_share: number;
3280
+ share_class: string;
3281
+ share_type: string;
3282
+ spv_outstanding_share_count: number;
3283
+ total_capital_raise: number;
3284
+ transaction_type: string;
3285
+ updated_at: string;
3286
+ }
3287
+ export interface InsightPreIPOCompanyNews {
3288
+ articles: InsightPreIPOCompanyArticle[];
3289
+ description: string;
3290
+ headline: string;
3291
+ id: string;
3292
+ link: string;
3293
+ news_id: string;
3294
+ pre_ipo_company_id: string;
3295
+ release_date: string;
3296
+ source: string;
3297
+ }
3298
+ export interface InsightPreIPOCompanyResearchDocument {
3299
+ id: string;
3300
+ link: string;
3301
+ pre_ipo_company_id: string;
3302
+ preview_meta: string;
3303
+ relation: string;
3304
+ research_document_id: string;
3305
+ source: string;
3306
+ title: string;
3307
+ type: string;
3308
+ }
3208
3309
  export interface InsightPublicQuoteProfile {
3209
3310
  average_volume_30d: number;
3210
3311
  closing_price: number;
@@ -3960,6 +4061,7 @@ export enum InsightFundScreenerRequestInverseEnum {
3960
4061
  /** @example "ANY" */
3961
4062
  export enum InsightFundScreenerRequestLeverageEnum {
3962
4063
  ANY = "ANY",
4064
+ ALL = "ALL",
3963
4065
  LEVERAGE_I = "LEVERAGE_I",
3964
4066
  LEVERAGE_II = "LEVERAGE_II",
3965
4067
  LEVERAGE_III = "LEVERAGE_III"
@@ -4086,28 +4188,6 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
4086
4188
  Date = "date",
4087
4189
  Rank = "rank"
4088
4190
  }
4089
- export class AlphaTools<HandleError extends boolean = boolean> {
4090
- protected readonly apiClient: JwtClient<HandleError>;
4091
- constructor(apiClient: JwtClient<HandleError>);
4092
- /**
4093
- * @description get seasonlity data with comparison to benchmark
4094
- * @tags AlphaTools
4095
- * @name GetMomentumRatioGraph
4096
- * @summary get seasonlity data
4097
- * @request POST:/rst
4098
- * @secure
4099
- */
4100
- getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
4101
- /**
4102
- * @description get seasonlity data with comparison to benchmark
4103
- * @tags AlphaTools
4104
- * @name GetSeasonality
4105
- * @summary get seasonlity data
4106
- * @request POST:/seasonality
4107
- * @secure
4108
- */
4109
- getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
4110
- }
4111
4191
  export class CompanyProfile<HandleError extends boolean = boolean> {
4112
4192
  protected readonly apiClient: JwtClient<HandleError>;
4113
4193
  constructor(apiClient: JwtClient<HandleError>);
@@ -4147,6 +4227,188 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
4147
4227
  */
4148
4228
  getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
4149
4229
  }
4230
+ export class WorldMarkets<HandleError extends boolean = boolean> {
4231
+ protected readonly apiClient: JwtClient<HandleError>;
4232
+ constructor(apiClient: JwtClient<HandleError>);
4233
+ /**
4234
+ * @description Get continents
4235
+ * @tags World Markets
4236
+ * @name ContinentGet
4237
+ * @summary Get continents
4238
+ * @request GET:/continents
4239
+ * @secure
4240
+ */
4241
+ continentGet(query: {
4242
+ /** Query limit */
4243
+ limit: number;
4244
+ /** Query offset */
4245
+ offset: number;
4246
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
4247
+ /**
4248
+ * @description Edit continent
4249
+ * @tags World Markets
4250
+ * @name ContinentEdit
4251
+ * @summary Edit continent
4252
+ * @request PUT:/continents
4253
+ * @secure
4254
+ */
4255
+ continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4256
+ /**
4257
+ * @description Create continents
4258
+ * @tags World Markets
4259
+ * @name ContinentCreate
4260
+ * @summary Create continents
4261
+ * @request POST:/continents
4262
+ * @secure
4263
+ */
4264
+ continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
4265
+ /**
4266
+ * @description Delete continent
4267
+ * @tags World Markets
4268
+ * @name ContinentDelete
4269
+ * @summary Delete continent
4270
+ * @request DELETE:/continents
4271
+ * @secure
4272
+ */
4273
+ continentDelete(query: {
4274
+ /** continent id */
4275
+ id: string;
4276
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4277
+ /**
4278
+ * @description Get country codes
4279
+ * @tags World Markets
4280
+ * @name CountryCodeGet
4281
+ * @summary Get country codes
4282
+ * @request GET:/country-codes
4283
+ * @secure
4284
+ */
4285
+ countryCodeGet(query: {
4286
+ /** Query limit */
4287
+ limit: number;
4288
+ /** Query offset */
4289
+ offset: number;
4290
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
4291
+ /**
4292
+ * @description Edit country code
4293
+ * @tags World Markets
4294
+ * @name CountryCodeEdit
4295
+ * @summary Edit country code
4296
+ * @request PUT:/country-codes
4297
+ * @secure
4298
+ */
4299
+ countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4300
+ /**
4301
+ * @description Add country codes
4302
+ * @tags World Markets
4303
+ * @name CountryCodeAdd
4304
+ * @summary Add country codes
4305
+ * @request POST:/country-codes
4306
+ * @secure
4307
+ */
4308
+ countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
4309
+ /**
4310
+ * @description Delete country code
4311
+ * @tags World Markets
4312
+ * @name CountryCodeDelete
4313
+ * @summary Delete country code
4314
+ * @request DELETE:/country-codes
4315
+ * @secure
4316
+ */
4317
+ countryCodeDelete(query: {
4318
+ /** a3 code */
4319
+ a3code: string;
4320
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4321
+ /**
4322
+ * @description Get global indexes
4323
+ * @tags World Markets
4324
+ * @name GlobalIndexGet
4325
+ * @summary Get global indexes
4326
+ * @request GET:/global-indexes
4327
+ * @secure
4328
+ */
4329
+ globalIndexGet(query: {
4330
+ /** Query limit */
4331
+ limit: number;
4332
+ /** Query offset */
4333
+ offset: number;
4334
+ /** Continent code for filtering */
4335
+ continent?: string;
4336
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
4337
+ /**
4338
+ * @description Edit global index
4339
+ * @tags World Markets
4340
+ * @name GlobalIndexEdit
4341
+ * @summary Edit global index
4342
+ * @request PUT:/global-indexes
4343
+ * @secure
4344
+ */
4345
+ globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4346
+ /**
4347
+ * @description Add global indexes
4348
+ * @tags World Markets
4349
+ * @name GlobalIndexAdd
4350
+ * @summary Add global indexes
4351
+ * @request POST:/global-indexes
4352
+ * @secure
4353
+ */
4354
+ globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
4355
+ /**
4356
+ * @description Edit global index
4357
+ * @tags World Markets
4358
+ * @name GlobalIndexDelete
4359
+ * @summary Delete global index
4360
+ * @request DELETE:/global-indexes
4361
+ * @secure
4362
+ */
4363
+ globalIndexDelete(query: {
4364
+ /** a3 code */
4365
+ a3code: string;
4366
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4367
+ /**
4368
+ * @description Get regions
4369
+ * @tags World Markets
4370
+ * @name RegionGet
4371
+ * @summary Get regions
4372
+ * @request GET:/regions
4373
+ * @secure
4374
+ */
4375
+ regionGet(query: {
4376
+ /** Query limit */
4377
+ limit: number;
4378
+ /** Query offset */
4379
+ offset: number;
4380
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
4381
+ /**
4382
+ * @description Edit region
4383
+ * @tags World Markets
4384
+ * @name RegionEdit
4385
+ * @summary Edit region
4386
+ * @request PUT:/regions
4387
+ * @secure
4388
+ */
4389
+ regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4390
+ /**
4391
+ * @description Create regions
4392
+ * @tags World Markets
4393
+ * @name RegionCreate
4394
+ * @summary Create regions
4395
+ * @request POST:/regions
4396
+ * @secure
4397
+ */
4398
+ regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
4399
+ /**
4400
+ * @description Delete region
4401
+ * @tags World Markets
4402
+ * @name RegionDelete
4403
+ * @summary Delete region
4404
+ * @request DELETE:/regions
4405
+ * @secure
4406
+ */
4407
+ regionDelete(query: {
4408
+ /** region id */
4409
+ id: string;
4410
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4411
+ }
4150
4412
  export class CustomLists<HandleError extends boolean = boolean> {
4151
4413
  protected readonly apiClient: JwtClient<HandleError>;
4152
4414
  constructor(apiClient: JwtClient<HandleError>);
@@ -4319,6 +4581,19 @@ export class Earnings<HandleError extends boolean = boolean> {
4319
4581
  */
4320
4582
  getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
4321
4583
  }
4584
+ export class Fundamentals<HandleError extends boolean = boolean> {
4585
+ protected readonly apiClient: JwtClient<HandleError>;
4586
+ constructor(apiClient: JwtClient<HandleError>);
4587
+ /**
4588
+ * @description get fundamentals by symbol data
4589
+ * @tags Fundamentals
4590
+ * @name GetFundamentalsBySymbolData
4591
+ * @summary get fundamentals by symbol data
4592
+ * @request POST:/fundamentals
4593
+ * @secure
4594
+ */
4595
+ getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
4596
+ }
4322
4597
  export class FixedIncome<HandleError extends boolean = boolean> {
4323
4598
  protected readonly apiClient: JwtClient<HandleError>;
4324
4599
  constructor(apiClient: JwtClient<HandleError>);
@@ -4391,257 +4666,6 @@ export class FixedIncome<HandleError extends boolean = boolean> {
4391
4666
  */
4392
4667
  getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
4393
4668
  }
4394
- export interface InsightBeforeAndAfterV2 {
4395
- after?: string;
4396
- before?: string;
4397
- }
4398
- export interface InsightFixedIncomeV2 {
4399
- a144: boolean;
4400
- accrued_interest: number;
4401
- bank_qualified: boolean;
4402
- bond_warrant: boolean;
4403
- call_type: string;
4404
- callable: boolean;
4405
- close_price: number;
4406
- close_price_asof: string;
4407
- close_ytw: number;
4408
- convertible: boolean;
4409
- country: string;
4410
- country_code: string;
4411
- country_domicile: string;
4412
- country_issue: string;
4413
- coupon: number;
4414
- coupon_frequency: string;
4415
- coupon_type: string;
4416
- currency: string;
4417
- cusip: string;
4418
- dated_date: string;
4419
- daycount: string;
4420
- description: string;
4421
- description_short: string;
4422
- duration: number;
4423
- first_coupon_date: string;
4424
- insured: boolean;
4425
- isin: string;
4426
- issue_date: string;
4427
- issue_minimum_denomination: number;
4428
- issue_price: number;
4429
- issue_size: number;
4430
- issuer: string;
4431
- last_coupon_date: string;
4432
- liquidity_institutional_aggregate: number;
4433
- liquidity_institutional_buy: number;
4434
- liquidity_institutional_sell: number;
4435
- liquidity_micro_aggregate: number;
4436
- liquidity_micro_buy: number;
4437
- liquidity_micro_sell: number;
4438
- liquidity_retail_aggregate: number;
4439
- liquidity_retail_buy: number;
4440
- liquidity_retail_sell: number;
4441
- maturity_date: string;
4442
- municipal_state: string;
4443
- municipal_taxable_federal: boolean;
4444
- municipal_type: string;
4445
- next_call_date: string;
4446
- next_call_price: number;
4447
- next_coupon_date: string;
4448
- par_value: number;
4449
- perpetual: boolean;
4450
- private_placement: boolean;
4451
- purpose: string;
4452
- puttable: boolean;
4453
- reg_s: boolean;
4454
- sector: string;
4455
- seniority: string;
4456
- settlement_convention: string;
4457
- sinking_fund: boolean;
4458
- sp_creditwatch: string;
4459
- sp_creditwatch_date: string;
4460
- sp_outlook: string;
4461
- sp_outlook_date: string;
4462
- sp_rating: string;
4463
- sp_rating_date: string;
4464
- status: string;
4465
- ticker: string;
4466
- treasury_subtype: string;
4467
- type: string;
4468
- updated_at: string;
4469
- }
4470
- export interface InsightGetFixedIncomeEntriesResponseV2 {
4471
- count: number;
4472
- data: InsightFixedIncomeV2[];
4473
- }
4474
- export interface InsightGetFixedIncomeEntriesRequestV2 {
4475
- /** @example true */
4476
- bank_qualified?: boolean;
4477
- /** @example true */
4478
- callable?: boolean;
4479
- /** @example true */
4480
- convertible?: boolean;
4481
- /** @example ["USA"] */
4482
- country_codes?: string[];
4483
- coupon?: InsightLessAndMoreV2;
4484
- /** @example ["quarterly","zero"] */
4485
- coupon_frequencies?: string[];
4486
- /** @example ["655664AH3","9128286R6"] */
4487
- cusip?: string[];
4488
- /**
4489
- * @maxLength 100
4490
- * @example "Donald's"
4491
- */
4492
- description?: string;
4493
- /** @example true */
4494
- has_ticker?: boolean;
4495
- /** @example true */
4496
- insured?: boolean;
4497
- /** @example ["US655664AH33","US9128286R69"] */
4498
- isin?: string[];
4499
- issue_date?: InsightBeforeAndAfterV2;
4500
- /**
4501
- * @maxLength 100
4502
- * @example "Donald's"
4503
- */
4504
- issuer?: string;
4505
- maturity?: InsightBeforeAndAfterV2;
4506
- /** @example ["NY"] */
4507
- municipal_states?: string[];
4508
- /** @example true */
4509
- municipal_tax?: boolean;
4510
- /** @example ["general_obligation"] */
4511
- municipal_types?: string[];
4512
- pagination: InsightPaginationV2;
4513
- purposes?: string[];
4514
- /** @example ["SOVEREIGN"] */
4515
- sectors?: string[];
4516
- sorts?: InsightOrderingV2[];
4517
- /** @example ["AAA"] */
4518
- sp_ratings?: string[];
4519
- /** @example ["called","outstanding"] */
4520
- statuses?: string[];
4521
- tickers?: string[];
4522
- /** @example ["corporate"] */
4523
- types?: string[];
4524
- }
4525
- export interface InsightGetTopSymbolsRequestV2 {
4526
- exchange?: string[];
4527
- market_cap?: InsightLessAndMoreV2;
4528
- pagination?: InsightPaginationV2;
4529
- price?: InsightLessAndMoreV2;
4530
- sorts?: InsightOrderingV2[];
4531
- volume?: InsightLessAndMoreV2;
4532
- }
4533
- export interface InsightIncludeExcludeV2 {
4534
- exclude?: string[];
4535
- include?: string[];
4536
- }
4537
- export interface InsightLessAndMoreV2 {
4538
- less_than?: number;
4539
- more_than?: number;
4540
- }
4541
- export interface InsightOrderingV2 {
4542
- /**
4543
- * @default "asc"
4544
- * @example "asc"
4545
- */
4546
- direction: InsightOrderingDirectionEnumV2;
4547
- /**
4548
- * Sort direction:
4549
- * * asc - Ascending, from A to Z.
4550
- * * desc - Descending, from Z to A.
4551
- * @example "name"
4552
- */
4553
- field: string;
4554
- }
4555
- export interface InsightPaginationV2 {
4556
- /**
4557
- * @min 1
4558
- * @example 1
4559
- */
4560
- page: number;
4561
- /**
4562
- * @min 1
4563
- * @max 50
4564
- * @example 10
4565
- */
4566
- size: number;
4567
- }
4568
- export interface InsightStockScreenerQuoteV2 {
4569
- average_volume_30d: number;
4570
- company_name: string;
4571
- dividend_ex_date: string;
4572
- dividend_pay_date: string;
4573
- dividend_percent: number;
4574
- exchange: string;
4575
- exchange_name: string;
4576
- gap: number;
4577
- industry: string;
4578
- industry_code: string;
4579
- last_price: number;
4580
- market_cap: number;
4581
- pe_ratio: number;
4582
- price_change: number;
4583
- price_change_percent: number;
4584
- symbol: string;
4585
- volume: number;
4586
- }
4587
- export interface InsightStockScreenerRequestV2 {
4588
- average_volume_30d?: InsightLessAndMoreV2;
4589
- dividend_ex_date?: InsightBeforeAndAfterV2;
4590
- dividend_pay_date?: InsightBeforeAndAfterV2;
4591
- dividend_percent?: InsightLessAndMoreV2;
4592
- exchange?: InsightIncludeExcludeV2;
4593
- gap?: InsightLessAndMoreV2;
4594
- industry?: InsightIncludeExcludeV2;
4595
- market_cap?: InsightLessAndMoreV2;
4596
- pagination: InsightPaginationV2;
4597
- pe_ratio?: InsightLessAndMoreV2;
4598
- price?: InsightLessAndMoreV2;
4599
- sorts?: InsightOrderingV2[];
4600
- /** @example "ADR" */
4601
- stock_type?: string;
4602
- volume?: InsightLessAndMoreV2;
4603
- }
4604
- export interface InsightStockScreenerResponseV2 {
4605
- current_page: number;
4606
- data: InsightStockScreenerQuoteV2[];
4607
- page_count: number;
4608
- status: number;
4609
- total_records: number;
4610
- }
4611
- /**
4612
- * @default "asc"
4613
- * @example "asc"
4614
- */
4615
- export enum InsightOrderingDirectionEnumV2 {
4616
- Asc = "asc",
4617
- Desc = "desc"
4618
- }
4619
- export class FixedIncomeV2<HandleError extends boolean = boolean> {
4620
- protected readonly apiClient: JwtClient<HandleError>;
4621
- constructor(apiClient: JwtClient<HandleError>);
4622
- /**
4623
- * @description get fixed income entries
4624
- * @tags FixedIncome
4625
- * @name GetFixedIncomeEntries
4626
- * @summary get fixed income entries
4627
- * @request POST:/fixed-income
4628
- * @secure
4629
- */
4630
- getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
4631
- }
4632
- export class Fundamentals<HandleError extends boolean = boolean> {
4633
- protected readonly apiClient: JwtClient<HandleError>;
4634
- constructor(apiClient: JwtClient<HandleError>);
4635
- /**
4636
- * @description get fundamentals by symbol data
4637
- * @tags Fundamentals
4638
- * @name GetFundamentalsBySymbolData
4639
- * @summary get fundamentals by symbol data
4640
- * @request POST:/fundamentals
4641
- * @secure
4642
- */
4643
- getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
4644
- }
4645
4669
  export class Funds<HandleError extends boolean = boolean> {
4646
4670
  protected readonly apiClient: JwtClient<HandleError>;
4647
4671
  constructor(apiClient: JwtClient<HandleError>);
@@ -4715,45 +4739,271 @@ export class Funds<HandleError extends boolean = boolean> {
4715
4739
  Authorization?: string;
4716
4740
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
4717
4741
  }
4718
- export class Intraday<HandleError extends boolean = boolean> {
4742
+ export class StockScreener<HandleError extends boolean = boolean> {
4719
4743
  protected readonly apiClient: JwtClient<HandleError>;
4720
4744
  constructor(apiClient: JwtClient<HandleError>);
4721
4745
  /**
4722
- * @description Returns an array of intraday chart data values for the given ticker.
4723
- * @tags Intraday
4724
- * @name IntradayQuotes
4725
- * @summary Get an array of intraday chart data values for the given ticker
4726
- * @request POST:/intraday/quotes
4727
- * @secure
4746
+ * @description data for visual heat map
4747
+ * @tags StockScreener
4748
+ * @name StockMarketHeatmap
4749
+ * @summary data for visual heat map
4750
+ * @request GET:/heatmaps
4751
+ * @secure
4752
+ */
4753
+ stockMarketHeatmap(query?: {
4754
+ /** Name of symbol list to fetch details for. Empty is default */
4755
+ heatmap_name?: string;
4756
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
4757
+ /**
4758
+ * @description create or update heat map preset
4759
+ * @tags StockScreener
4760
+ * @name CreateStockMarketHeatmapPreset
4761
+ * @summary create or update heat map preset
4762
+ * @request POST:/heatmaps
4763
+ * @secure
4764
+ */
4765
+ createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4766
+ /**
4767
+ * @description Sector and Industry Group performance
4768
+ * @tags StockScreener
4769
+ * @name IndustriesPerformance
4770
+ * @summary get industries performance
4771
+ * @request POST:/industries-performance
4772
+ * @secure
4773
+ */
4774
+ industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
4775
+ /**
4776
+ * @description filter stocks by params
4777
+ * @tags StockScreener
4778
+ * @name StockScreener
4779
+ * @summary filter stocks by params
4780
+ * @request POST:/stock-screener
4781
+ * @secure
4782
+ */
4783
+ stockScreener(filter: InsightStockScreenerV1Request, headers?: {
4784
+ /** Authorization */
4785
+ Authorization?: string;
4786
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
4787
+ /**
4788
+ * @description get screener presets
4789
+ * @tags StockScreener
4790
+ * @name GetScreenerPresets
4791
+ * @summary get screener presets
4792
+ * @request GET:/stock-screener/presets
4793
+ * @secure
4794
+ */
4795
+ getScreenerPresets(query: {
4796
+ /** how many records to return */
4797
+ limit: number;
4798
+ /** how many records to skip */
4799
+ offset: number;
4800
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
4801
+ /**
4802
+ * @description update screener preset
4803
+ * @tags StockScreener
4804
+ * @name UpdateScreenerPreset
4805
+ * @summary update screener preset
4806
+ * @request PUT:/stock-screener/presets
4807
+ * @secure
4808
+ */
4809
+ updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
4810
+ /**
4811
+ * @description create screener preset
4812
+ * @tags StockScreener
4813
+ * @name CreateOrScreenerPreset
4814
+ * @summary create screener preset
4815
+ * @request POST:/stock-screener/presets
4816
+ * @secure
4817
+ */
4818
+ createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
4819
+ /**
4820
+ * @description remove screener preset
4821
+ * @tags StockScreener
4822
+ * @name RemoveScreenerPreset
4823
+ * @summary remove screener preset
4824
+ * @request DELETE:/stock-screener/presets
4825
+ * @secure
4826
+ */
4827
+ removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4828
+ /**
4829
+ * @description get top symbols
4830
+ * @tags StockScreener
4831
+ * @name GetTopSymbols
4832
+ * @summary get top symbols
4833
+ * @request POST:/stock-screener/top
4834
+ * @secure
4835
+ */
4836
+ getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
4837
+ }
4838
+ export class Quotes<HandleError extends boolean = boolean> {
4839
+ protected readonly apiClient: JwtClient<HandleError>;
4840
+ constructor(apiClient: JwtClient<HandleError>);
4841
+ /**
4842
+ * @description Get single historical quote
4843
+ * @tags Quotes
4844
+ * @name GitHistoricalQuote
4845
+ * @summary Get single historical quote
4846
+ * @request GET:/historical/quote
4847
+ * @secure
4848
+ */
4849
+ gitHistoricalQuote(query: {
4850
+ /** Symbol */
4851
+ symbol: string;
4852
+ /** Date */
4853
+ date: string;
4854
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
4855
+ /**
4856
+ * @description get quote history by symbol
4857
+ * @tags Quotes
4858
+ * @name GitQuoteHistory
4859
+ * @summary Get quote history
4860
+ * @request POST:/quote-history
4861
+ * @secure
4862
+ */
4863
+ gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
4864
+ /**
4865
+ * @description Returns a list of quotes equity info for specified symbols.
4866
+ * @tags Quotes
4867
+ * @name GetQuotesEquityData
4868
+ * @summary Get Quotes Equity data
4869
+ * @request GET:/quotes/equity
4870
+ * @secure
4871
+ */
4872
+ getQuotesEquityData(query: {
4873
+ /** Comma separated symbols */
4874
+ symbols: string;
4875
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
4876
+ }
4877
+ export class Intraday<HandleError extends boolean = boolean> {
4878
+ protected readonly apiClient: JwtClient<HandleError>;
4879
+ constructor(apiClient: JwtClient<HandleError>);
4880
+ /**
4881
+ * @description Returns an array of intraday chart data values for the given ticker.
4882
+ * @tags Intraday
4883
+ * @name IntradayQuotes
4884
+ * @summary Get an array of intraday chart data values for the given ticker
4885
+ * @request POST:/intraday/quotes
4886
+ * @secure
4728
4887
  */
4729
4888
  intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
4730
4889
  }
4731
- export class Ipos<HandleError extends boolean = boolean> {
4890
+ export class PreIpoCompanies<HandleError extends boolean = boolean> {
4732
4891
  protected readonly apiClient: JwtClient<HandleError>;
4733
4892
  constructor(apiClient: JwtClient<HandleError>);
4734
4893
  /**
4735
- * @description get recent ipos info
4736
- * @tags Ipos
4737
- * @name PostRecent
4738
- * @summary get recent ipos info
4739
- * @request POST:/ipos/recent
4894
+ * @description get pre ipo companies
4895
+ * @tags PreIPOCompanies
4896
+ * @name GetPreIpoCompanies
4897
+ * @summary get pre ipo companies
4898
+ * @request GET:/ipos/pre-ipo-companies
4740
4899
  * @secure
4741
4900
  */
4742
- postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
4901
+ getPreIpoCompanies(query: {
4902
+ /** search by company name */
4903
+ name?: string;
4904
+ /** how many records to return. Max value is 50 */
4905
+ limit: number;
4906
+ /** how many records to skip */
4907
+ offset: number;
4908
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
4743
4909
  /**
4744
- * @description get upcoming ipos info
4745
- * @tags Ipos
4746
- * @name GetUpcoming
4747
- * @summary get upcoming ipos info
4748
- * @request GET:/ipos/upcoming
4910
+ * @description get pre ipo company by id
4911
+ * @tags PreIPOCompanies
4912
+ * @name GetPreIpoCompanies2
4913
+ * @summary get pre ipo company by id
4914
+ * @request GET:/ipos/pre-ipo-companies/{id}
4915
+ * @originalName getPreIpoCompanies
4916
+ * @duplicate
4749
4917
  * @secure
4750
4918
  */
4751
- getUpcoming(query: {
4919
+ getPreIpoCompanies2(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
4920
+ /**
4921
+ * @description get pre ipo company investments
4922
+ * @tags PreIPOCompanies
4923
+ * @name GetPreIpoCompanyInvestments
4924
+ * @summary get pre ipo company investments
4925
+ * @request GET:/ipos/pre-ipo-company-investments
4926
+ * @secure
4927
+ */
4928
+ getPreIpoCompanyInvestments(query: {
4929
+ /** company id */
4930
+ pre_ipo_company_id?: string;
4931
+ /** company name */
4932
+ company_name?: string;
4752
4933
  /** how many records to return. Max value is 50 */
4753
4934
  limit: number;
4754
4935
  /** how many records to skip */
4755
4936
  offset: number;
4756
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
4937
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
4938
+ /**
4939
+ * @description get pre ipo company investment by id
4940
+ * @tags PreIPOCompanies
4941
+ * @name GetPreIpoCompanyInvestments2
4942
+ * @summary get pre ipo company investment by id
4943
+ * @request GET:/ipos/pre-ipo-company-investments/{id}
4944
+ * @originalName getPreIpoCompanyInvestments
4945
+ * @duplicate
4946
+ * @secure
4947
+ */
4948
+ getPreIpoCompanyInvestments2(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
4949
+ /**
4950
+ * @description get pre ipo company news
4951
+ * @tags PreIPOCompanies
4952
+ * @name GetPreIpoCompanyNews
4953
+ * @summary get pre ipo company news
4954
+ * @request GET:/ipos/pre-ipo-company-news
4955
+ * @secure
4956
+ */
4957
+ getPreIpoCompanyNews(query: {
4958
+ /** company id */
4959
+ pre_ipo_company_id?: string;
4960
+ /** search by headline */
4961
+ headline?: string;
4962
+ /** how many records to return. Max value is 50 */
4963
+ limit: number;
4964
+ /** how many records to skip */
4965
+ offset: number;
4966
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
4967
+ /**
4968
+ * @description get pre ipo company news by id
4969
+ * @tags PreIPOCompanies
4970
+ * @name GetPreIpoCompanyNews2
4971
+ * @summary get pre ipo company news by id
4972
+ * @request GET:/ipos/pre-ipo-company-news/{id}
4973
+ * @originalName getPreIpoCompanyNews
4974
+ * @duplicate
4975
+ * @secure
4976
+ */
4977
+ getPreIpoCompanyNews2(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
4978
+ /**
4979
+ * @description get pre ipo company research documents
4980
+ * @tags PreIPOCompanies
4981
+ * @name GetPreIpoCompanyResearchDocuments
4982
+ * @summary get pre ipo company research documents
4983
+ * @request GET:/ipos/pre-ipo-company-research-documents
4984
+ * @secure
4985
+ */
4986
+ getPreIpoCompanyResearchDocuments(query: {
4987
+ /** company id */
4988
+ pre_ipo_company_id?: string;
4989
+ /** search by title */
4990
+ title?: string;
4991
+ /** how many records to return. Max value is 50 */
4992
+ limit: number;
4993
+ /** how many records to skip */
4994
+ offset: number;
4995
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
4996
+ /**
4997
+ * @description get pre ipo company research document by id
4998
+ * @tags PreIPOCompanies
4999
+ * @name GetPreIpoCompanyResearchDocuments2
5000
+ * @summary get pre ipo company research document by id
5001
+ * @request GET:/ipos/pre-ipo-company-research-documents/{id}
5002
+ * @originalName getPreIpoCompanyResearchDocuments
5003
+ * @duplicate
5004
+ * @secure
5005
+ */
5006
+ getPreIpoCompanyResearchDocuments2(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
4757
5007
  }
4758
5008
  export class Logos<HandleError extends boolean = boolean> {
4759
5009
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4855,31 +5105,6 @@ export class Logos<HandleError extends boolean = boolean> {
4855
5105
  symbol: string;
4856
5106
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
4857
5107
  }
4858
- export class MarketDates<HandleError extends boolean = boolean> {
4859
- protected readonly apiClient: JwtClient<HandleError>;
4860
- constructor(apiClient: JwtClient<HandleError>);
4861
- /**
4862
- * @description get market dates history
4863
- * @tags MarketDates
4864
- * @name GetMarketDatesHistory
4865
- * @summary get market dates history
4866
- * @request POST:/market-dates/history
4867
- * @secure
4868
- */
4869
- getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
4870
- /**
4871
- * @description get todays market hours
4872
- * @tags MarketDates
4873
- * @name GetTodaysMarketHours
4874
- * @summary get todays market hours
4875
- * @request GET:/market-dates/today
4876
- * @secure
4877
- */
4878
- getTodaysMarketHours(query: {
4879
- /** Market */
4880
- market: string;
4881
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
4882
- }
4883
5108
  export class News<HandleError extends boolean = boolean> {
4884
5109
  protected readonly apiClient: JwtClient<HandleError>;
4885
5110
  constructor(apiClient: JwtClient<HandleError>);
@@ -5021,951 +5246,946 @@ export class News<HandleError extends boolean = boolean> {
5021
5246
  */
5022
5247
  newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5023
5248
  }
5024
- export class OptionGreeks<HandleError extends boolean = boolean> {
5249
+ export class Ipos<HandleError extends boolean = boolean> {
5025
5250
  protected readonly apiClient: JwtClient<HandleError>;
5026
5251
  constructor(apiClient: JwtClient<HandleError>);
5027
5252
  /**
5028
- * @description Returns calculated matrix
5029
- * @tags OptionGreeks
5030
- * @name OgCalculateMatrix
5031
- * @summary Calculate matrix
5032
- * @request POST:/og/calculate-matrix
5253
+ * @description get recent ipos info
5254
+ * @tags Ipos
5255
+ * @name PostRecent
5256
+ * @summary get recent ipos info
5257
+ * @request POST:/ipos/recent
5033
5258
  * @secure
5034
5259
  */
5035
- ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
5260
+ postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5036
5261
  /**
5037
- * @description Returns calculated params
5038
- * @tags OptionGreeks
5039
- * @name OgCalculateParams
5040
- * @summary Calculate params
5041
- * @request POST:/og/calculate-params
5262
+ * @description get upcoming ipos info
5263
+ * @tags Ipos
5264
+ * @name GetUpcoming
5265
+ * @summary get upcoming ipos info
5266
+ * @request GET:/ipos/upcoming
5042
5267
  * @secure
5043
5268
  */
5044
- ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
5269
+ getUpcoming(query: {
5270
+ /** how many records to return. Max value is 50 */
5271
+ limit: number;
5272
+ /** how many records to skip */
5273
+ offset: number;
5274
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5045
5275
  }
5046
- export class Ownerships<HandleError extends boolean = boolean> {
5276
+ export class MarketDates<HandleError extends boolean = boolean> {
5047
5277
  protected readonly apiClient: JwtClient<HandleError>;
5048
5278
  constructor(apiClient: JwtClient<HandleError>);
5049
5279
  /**
5050
- * @description get ownerships by id datadata
5051
- * @tags Ownerships
5052
- * @name GetOwnershipsByIdData
5053
- * @summary get ownerships by id data
5054
- * @request POST:/ownerships
5280
+ * @description get market dates history
5281
+ * @tags MarketDates
5282
+ * @name GetMarketDatesHistory
5283
+ * @summary get market dates history
5284
+ * @request POST:/market-dates/history
5055
5285
  * @secure
5056
5286
  */
5057
- getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5287
+ getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
5058
5288
  /**
5059
- * @description get ownerships by symbol data
5060
- * @tags Ownerships
5061
- * @name GetOwnershipsBySymbolData
5062
- * @summary get ownerships by symbol data
5063
- * @request POST:/symbol-ownerships
5289
+ * @description get todays market hours
5290
+ * @tags MarketDates
5291
+ * @name GetTodaysMarketHours
5292
+ * @summary get todays market hours
5293
+ * @request GET:/market-dates/today
5064
5294
  * @secure
5065
5295
  */
5066
- getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5296
+ getTodaysMarketHours(query: {
5297
+ /** Market */
5298
+ market: string;
5299
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
5067
5300
  }
5068
- export class Passport<HandleError extends boolean = boolean> {
5301
+ export class OptionGreeks<HandleError extends boolean = boolean> {
5069
5302
  protected readonly apiClient: JwtClient<HandleError>;
5070
5303
  constructor(apiClient: JwtClient<HandleError>);
5071
5304
  /**
5072
- * @description Returns article by id
5073
- * @tags Passport
5074
- * @name PassportArticleById
5075
- * @summary Get article by id
5076
- * @request POST:/passport/article-by-id
5305
+ * @description Returns calculated matrix
5306
+ * @tags OptionGreeks
5307
+ * @name OgCalculateMatrix
5308
+ * @summary Calculate matrix
5309
+ * @request POST:/og/calculate-matrix
5077
5310
  * @secure
5078
5311
  */
5079
- passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
5312
+ ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
5080
5313
  /**
5081
- * @description Returns articles
5082
- * @tags Passport
5083
- * @name PassportArticles
5084
- * @summary Get articles
5085
- * @request POST:/passport/articles
5314
+ * @description Returns calculated params
5315
+ * @tags OptionGreeks
5316
+ * @name OgCalculateParams
5317
+ * @summary Calculate params
5318
+ * @request POST:/og/calculate-params
5086
5319
  * @secure
5087
5320
  */
5088
- passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
5321
+ ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
5322
+ }
5323
+ export class AlphaTools<HandleError extends boolean = boolean> {
5324
+ protected readonly apiClient: JwtClient<HandleError>;
5325
+ constructor(apiClient: JwtClient<HandleError>);
5089
5326
  /**
5090
- * @description Returns author profile
5091
- * @tags Passport
5092
- * @name PassportAuthorProfile
5093
- * @summary Get author profile
5094
- * @request POST:/passport/author-profile
5327
+ * @description get seasonlity data with comparison to benchmark
5328
+ * @tags AlphaTools
5329
+ * @name GetMomentumRatioGraph
5330
+ * @summary get seasonlity data
5331
+ * @request POST:/rst
5095
5332
  * @secure
5096
5333
  */
5097
- passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
5334
+ getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
5098
5335
  /**
5099
- * @description Returns most popular tags
5100
- * @tags Passport
5101
- * @name PassportMostPopularTags
5102
- * @summary Get most popular tags
5103
- * @request POST:/passport/most-popular-tags
5336
+ * @description get seasonlity data with comparison to benchmark
5337
+ * @tags AlphaTools
5338
+ * @name GetSeasonality
5339
+ * @summary get seasonlity data
5340
+ * @request POST:/seasonality
5104
5341
  * @secure
5105
5342
  */
5106
- passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
5343
+ getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
5344
+ }
5345
+ export class TipRank<HandleError extends boolean = boolean> {
5346
+ protected readonly apiClient: JwtClient<HandleError>;
5347
+ constructor(apiClient: JwtClient<HandleError>);
5107
5348
  /**
5108
- * @description Returns news feed
5109
- * @tags Passport
5110
- * @name PassportNewsFeed
5111
- * @summary Get news feed
5112
- * @request POST:/passport/newsfeed
5349
+ * @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
5350
+ * @tags TipRank
5351
+ * @name TiprankAnalystConsensus
5352
+ * @summary Get tiprank AnalystConsensus
5353
+ * @request POST:/tipranks/analyst-consensus
5113
5354
  * @secure
5114
5355
  */
5115
- passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
5356
+ tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
5116
5357
  /**
5117
- * @description Returns article by parameters
5118
- * @tags Passport
5119
- * @name PassportSearchArticle
5120
- * @summary Search article by parameters
5121
- * @request POST:/passport/search-article
5358
+ * @description Returns the latest analyst ratings on a given stock or multiple stocks.
5359
+ * @tags TipRank
5360
+ * @name TiprankLatestAnalystRatingsOnStock
5361
+ * @summary Get tiprank LatestAnalystRatingsOnStock
5362
+ * @request POST:/tipranks/analyst-multi
5122
5363
  * @secure
5123
5364
  */
5124
- passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
5125
- }
5126
- export class Public<HandleError extends boolean = boolean> {
5127
- protected readonly apiClient: JwtClient<HandleError>;
5128
- constructor(apiClient: JwtClient<HandleError>);
5365
+ tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError>>;
5129
5366
  /**
5130
- * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
5131
- * @tags Public
5132
- * @name CalculateEstimatedReturns
5133
- * @summary Calculate Estimated Returns
5134
- * @request GET:/public/estimated-returns
5367
+ * @description Returns the latest analyst portfolio items.
5368
+ * @tags TipRank
5369
+ * @name TiprankPortfolios
5370
+ * @summary Get the latest analyst portfolio items
5371
+ * @request POST:/tipranks/analyst-portfolio
5135
5372
  * @secure
5136
5373
  */
5137
- calculateEstimatedReturns(query: {
5138
- /** Single symbol */
5139
- symbol: string;
5140
- /** Non-zero amount */
5141
- amount: number;
5142
- /** Start date for calculations */
5143
- start_date: string;
5144
- /** End date for calculations */
5145
- end_date: string;
5146
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
5374
+ tiprankPortfolios(filter: InsightPortfoliosRequest, headers?: {
5375
+ /** Authorization */
5376
+ Authorization?: string;
5377
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError>>;
5147
5378
  /**
5148
- * @description Returns an expert forecast
5149
- * @tags Public
5150
- * @name ExpertForecast
5151
- * @summary Expert forecast
5152
- * @request GET:/public/expert-forecast
5379
+ * @description Returns the analyst profile information
5380
+ * @tags TipRank
5381
+ * @name TiprankAnalystProfile
5382
+ * @summary Get tiprank AnalystProfile
5383
+ * @request GET:/tipranks/analyst-profile
5153
5384
  * @secure
5154
5385
  */
5155
- expertForecast(query: {
5156
- /** Comma separated symbols */
5157
- symbols: string;
5158
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
5386
+ tiprankAnalystProfile(query: {
5387
+ /** ID of tiprank analyst profile */
5388
+ id: string;
5389
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystProfileResponse, HandleError>>;
5159
5390
  /**
5160
- * @description get fundamentals by symbol data
5161
- * @tags Public
5162
- * @name GetPublicFundamentalsBySymbolData
5163
- * @summary get fundamentals by symbol data
5164
- * @request GET:/public/fundamentals/{symbol}
5391
+ * @description Returns the URL prefix to the expertPictureUrl field.
5392
+ * @tags TipRank
5393
+ * @name TiprankAnalystsExpertPictureStore
5394
+ * @summary Get tiprank AnalystsExpertPictureStore
5395
+ * @request GET:/tipranks/analysts-expert-picture-store
5165
5396
  * @secure
5166
5397
  */
5167
- getPublicFundamentalsBySymbolData(symbol: string, query: {
5168
- /** Annual or quarterly */
5169
- mode: string;
5170
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
5398
+ tiprankAnalystsExpertPictureStore(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystsExpertPictureStoreResponse, HandleError>>;
5171
5399
  /**
5172
- * @description Daily price history
5173
- * @tags Public
5174
- * @name DailyPriceHistory
5175
- * @summary Daily price history
5176
- * @request GET:/public/price-history/daily
5400
+ * @description Returns a list of top-ranked analysts.
5401
+ * @tags TipRank
5402
+ * @name TiprankBestPerformingExperts
5403
+ * @summary Get tiprank BestPerformingExperts
5404
+ * @request GET:/tipranks/best-performing-experts
5177
5405
  * @secure
5178
5406
  */
5179
- dailyPriceHistory(query: {
5180
- /** Single symbol */
5181
- symbol: string;
5182
- /** Target date */
5183
- date: string;
5184
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
5407
+ tiprankBestPerformingExperts(query?: {
5408
+ /** The number of analysts to return */
5409
+ num?: number;
5410
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBestPerformingExpertsResponse[], HandleError>>;
5185
5411
  /**
5186
- * @description Public quote profile
5187
- * @tags Public
5188
- * @name PublicQuoteProfile
5189
- * @summary Public quote profile
5190
- * @request GET:/public/quote-profile/{symbol}
5412
+ * @description Returns the blogger consensus on the stock along with the blogger opinion distribution by site.
5413
+ * @tags TipRank
5414
+ * @name TiprankBloggerConsensusOnStock
5415
+ * @summary Get tiprank BloggerConsensusOnStock
5416
+ * @request GET:/tipranks/blogger-consensus-on-stock
5191
5417
  * @secure
5192
5418
  */
5193
- publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
5419
+ tiprankBloggerConsensusOnStock(query: {
5420
+ /** The ticker of the stock */
5421
+ ticker: string;
5422
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBloggerConsensusOnStockResponse[], HandleError>>;
5194
5423
  /**
5195
- * @description get ratios by symbol data
5196
- * @tags Public
5197
- * @name GetPublicRatiosBySymbolData
5198
- * @summary get ratios by symbol data
5199
- * @request GET:/public/ratios/{symbol}
5424
+ * @description Returns a list of the upcoming IPOs and recent IPOs that have already been priced
5425
+ * @tags TipRank
5426
+ * @name TiprankCalendarsIpos
5427
+ * @summary Get tiprank CalendarsIPOS
5428
+ * @request GET:/tipranks/calendars-ipos
5200
5429
  * @secure
5201
5430
  */
5202
- getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
5431
+ tiprankCalendarsIpos(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalendarsIPOSResponse[], HandleError>>;
5203
5432
  /**
5204
- * @description find a symbol by name or description
5205
- * @tags Public
5206
- * @name QuoteFundamentalsSearch
5207
- * @summary find a symbol by name or description
5208
- * @request GET:/public/symbol-search
5433
+ * @description Returns all stocks that have been updated since a specified UTC time.
5434
+ * @tags TipRank
5435
+ * @name TiprankGeneralStockUpdates
5436
+ * @summary Get tiprank GeneralStockUpdates
5437
+ * @request GET:/tipranks/general-stock-updates
5209
5438
  * @secure
5210
5439
  */
5211
- quoteFundamentalsSearch(query: {
5212
- /** Search query */
5213
- search_query: string;
5214
- /** how many records to return. Max value is 50 */
5215
- limit: number;
5216
- /** how many records to skip */
5217
- offset: number;
5218
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
5440
+ tiprankGeneralStockUpdates(query?: {
5441
+ /** The specific requested time */
5442
+ utc_time?: string;
5443
+ /** Level of detail on updated stocks */
5444
+ details?: InsightTiprankGeneralStockUpdatesParamsDetailsEnum;
5445
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGeneralStockUpdatesResponse, HandleError>>;
5219
5446
  /**
5220
- * @description Get top gainers
5221
- * @tags Public
5222
- * @name TopGainers
5223
- * @summary Top Gainers
5224
- * @request GET:/public/top-gainers
5447
+ * @description Returns all hedge funds that have a position on a given stock along with the hedge fund activity trends and consensus.
5448
+ * @tags TipRank
5449
+ * @name TiprankHedgefunds
5450
+ * @summary Get tiprank HedgeFunds
5451
+ * @request GET:/tipranks/hedgefunds
5225
5452
  * @secure
5226
5453
  */
5227
- topGainers(query: {
5228
- /** sort direction - asc or desc */
5229
- order_direction?: string;
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<InsightTopStocksResponse, HandleError>>;
5454
+ tiprankHedgefunds(query: {
5455
+ /** The ticker of the stock */
5456
+ ticker: string;
5457
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsResponse[], HandleError>>;
5235
5458
  /**
5236
- * @description Get top stocks
5237
- * @tags Public
5238
- * @name TopStocks
5239
- * @summary Top Stocks
5240
- * @request GET:/public/top-stocks
5241
- * @secure
5459
+ * @description Returns a list of top-ranked hedge fund managers.
5460
+ * @tags TipRank
5461
+ * @name TiprankHedgefundsBestPerformingExperts
5462
+ * @summary Get tiprank HedgeFundsBestPerformingExperts
5463
+ * @request GET:/tipranks/hedgefunds-best-performing-experts
5464
+ * @secure
5242
5465
  */
5243
- topStocks(query: {
5244
- /** EQUITY|ETF|CRYPTO */
5245
- stock_type: InsightTopStocksParamsStockTypeEnum;
5246
- /** how many records to return. Max value is 50 */
5247
- limit: number;
5248
- /** how many records to skip */
5249
- offset: number;
5250
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
5251
- }
5252
- export class Quotes<HandleError extends boolean = boolean> {
5253
- protected readonly apiClient: JwtClient<HandleError>;
5254
- constructor(apiClient: JwtClient<HandleError>);
5466
+ tiprankHedgefundsBestPerformingExperts(query?: {
5467
+ /** The number of hedge fund managers to return */
5468
+ num?: number;
5469
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsBestPerformingExpertsResponse[], HandleError>>;
5255
5470
  /**
5256
- * @description Get single historical quote
5257
- * @tags Quotes
5258
- * @name GitHistoricalQuote
5259
- * @summary Get single historical quote
5260
- * @request GET:/historical/quote
5471
+ * @description Returns the biggest 200 hedge fund transactions from the last quarter filtered based on minStars. Returns at most 50 transactions, sorted by size (biggest on top).
5472
+ * @tags TipRank
5473
+ * @name TiprankHedgefundsRecentTransactions
5474
+ * @summary Get tiprank HedgefundsRecentTransactions
5475
+ * @request GET:/tipranks/hedgefunds-recent-transactions
5261
5476
  * @secure
5262
5477
  */
5263
- gitHistoricalQuote(query: {
5264
- /** Symbol */
5265
- symbol: string;
5266
- /** Date */
5267
- date: string;
5268
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
5478
+ tiprankHedgefundsRecentTransactions(query?: {
5479
+ /** Show only managers with these number of stars or higher */
5480
+ min_stars?: number;
5481
+ /** The order of the latest insider transactions */
5482
+ sort?: InsightTiprankHedgefundsRecentTransactionsParamsSortEnum;
5483
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsRecentTransactionsResponse[], HandleError>>;
5269
5484
  /**
5270
- * @description get quote history by symbol
5271
- * @tags Quotes
5272
- * @name GitQuoteHistory
5273
- * @summary Get quote history
5274
- * @request POST:/quote-history
5485
+ * @description Returns the latest insider transactions and an overall sentiment on a given stock.
5486
+ * @tags TipRank
5487
+ * @name TiprankInsiders
5488
+ * @summary Get tiprank Insiders
5489
+ * @request GET:/tipranks/insiders
5275
5490
  * @secure
5276
5491
  */
5277
- gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
5492
+ tiprankInsiders(query: {
5493
+ /** The ticker of the stock */
5494
+ ticker: string;
5495
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersResponse[], HandleError>>;
5278
5496
  /**
5279
- * @description Returns a list of quotes equity info for specified symbols.
5280
- * @tags Quotes
5281
- * @name GetQuotesEquityData
5282
- * @summary Get Quotes Equity data
5283
- * @request GET:/quotes/equity
5497
+ * @description Returns a list of top ranked insiders.
5498
+ * @tags TipRank
5499
+ * @name TiprankInsidersBestPerformingExperts
5500
+ * @summary Get tiprank InsidersBestPerformingExperts
5501
+ * @request GET:/tipranks/insiders-best-performing-experts
5284
5502
  * @secure
5285
5503
  */
5286
- getQuotesEquityData(query: {
5287
- /** Comma separated symbols */
5288
- symbols: string;
5289
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
5290
- }
5291
- export class StockScreener<HandleError extends boolean = boolean> {
5292
- protected readonly apiClient: JwtClient<HandleError>;
5293
- constructor(apiClient: JwtClient<HandleError>);
5504
+ tiprankInsidersBestPerformingExperts(query?: {
5505
+ /** The number of insiders to return */
5506
+ num?: number;
5507
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersBestPerformingExpertsResponse[], HandleError>>;
5294
5508
  /**
5295
- * @description data for visual heat map
5296
- * @tags StockScreener
5297
- * @name StockMarketHeatmap
5298
- * @summary data for visual heat map
5299
- * @request GET:/heatmaps
5509
+ * @description Returns all the information required to build TipRanks Insider Hot Stocks.
5510
+ * @tags TipRank
5511
+ * @name TiprankInsidersHotstocks
5512
+ * @summary Get tiprank InsidersHotstocks
5513
+ * @request GET:/tipranks/insiders-hotstocks
5300
5514
  * @secure
5301
5515
  */
5302
- stockMarketHeatmap(query?: {
5303
- /** Name of symbol list to fetch details for. Empty is default */
5304
- heatmap_name?: string;
5305
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
5516
+ tiprankInsidersHotstocks(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersHotstocksResponse[], HandleError>>;
5306
5517
  /**
5307
- * @description create or update heat map preset
5308
- * @tags StockScreener
5309
- * @name CreateStockMarketHeatmapPreset
5310
- * @summary create or update heat map preset
5311
- * @request POST:/heatmaps
5518
+ * @description Returns a feed of the latest insider transactions reported to the SEC.
5519
+ * @tags TipRank
5520
+ * @name TiprankInsidersLiveFeed
5521
+ * @summary Get tiprank InsidersLiveFeed
5522
+ * @request GET:/tipranks/insiders-live-feed
5312
5523
  * @secure
5313
5524
  */
5314
- createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5525
+ tiprankInsidersLiveFeed(query?: {
5526
+ /** Return the latest X transactions */
5527
+ num?: number;
5528
+ /** The order of the latest insider transactions */
5529
+ sort?: InsightTiprankInsidersLiveFeedParamsSortEnum;
5530
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersLiveFeedResponse[], HandleError>>;
5315
5531
  /**
5316
- * @description Sector and Industry Group performance
5317
- * @tags StockScreener
5318
- * @name IndustriesPerformance
5319
- * @summary get industries performance
5320
- * @request POST:/industries-performance
5532
+ * @description Returns the insider profile information.
5533
+ * @tags TipRank
5534
+ * @name TiprankInsidersOverview
5535
+ * @summary Get tiprank InsidersOverview
5536
+ * @request GET:/tipranks/insiders-overview
5321
5537
  * @secure
5322
5538
  */
5323
- industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
5539
+ tiprankInsidersOverview(query?: {
5540
+ /** The UID of the expert */
5541
+ expert_uid?: string;
5542
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersOverviewResponse, HandleError>>;
5324
5543
  /**
5325
- * @description filter stocks by params
5326
- * @tags StockScreener
5327
- * @name StockScreener
5328
- * @summary filter stocks by params
5329
- * @request POST:/stock-screener
5544
+ * @description Returns the sentiment of TipRanks users on the stock.
5545
+ * @tags TipRank
5546
+ * @name TiprankInvestorSentiment
5547
+ * @summary Get tiprank InvestorSentiment
5548
+ * @request GET:/tipranks/investor-sentiment
5330
5549
  * @secure
5331
5550
  */
5332
- stockScreener(filter: InsightStockScreenerV1Request, headers?: {
5333
- /** Authorization */
5334
- Authorization?: string;
5335
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5551
+ tiprankInvestorSentiment(query: {
5552
+ /** The ticker of the stock */
5553
+ ticker: string;
5554
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInvestorSentimentResponse, HandleError>>;
5336
5555
  /**
5337
- * @description get screener presets
5338
- * @tags StockScreener
5339
- * @name GetScreenerPresets
5340
- * @summary get screener presets
5341
- * @request GET:/stock-screener/presets
5556
+ * @description Returns the latest analyst ratings.
5557
+ * @tags TipRank
5558
+ * @name TiprankLiveFeed
5559
+ * @summary Get tiprank LiveFeed
5560
+ * @request POST:/tipranks/live-feed
5342
5561
  * @secure
5343
5562
  */
5344
- getScreenerPresets(query: {
5345
- /** how many records to return */
5346
- limit: number;
5347
- /** how many records to skip */
5348
- offset: number;
5349
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
5563
+ tiprankLiveFeed(filter: InsightLiveFeedRequest, headers?: {
5564
+ /** Authorization */
5565
+ Authorization?: string;
5566
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLiveFeedResponse[], HandleError>>;
5350
5567
  /**
5351
- * @description update screener preset
5352
- * @tags StockScreener
5353
- * @name UpdateScreenerPreset
5354
- * @summary update screener preset
5355
- * @request PUT:/stock-screener/presets
5568
+ * @description Returns the latest news articles on the stock and their sentiment (bullish / neutral or bearish).
5569
+ * @tags TipRank
5570
+ * @name TiprankNewsArticles
5571
+ * @summary Get tiprank NewsArticles
5572
+ * @request GET:/tipranks/news-articles
5356
5573
  * @secure
5357
5574
  */
5358
- updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5575
+ tiprankNewsArticles(query: {
5576
+ /** The ticker of the stock */
5577
+ ticker: string;
5578
+ /** Limit to number of articles 1-200 */
5579
+ num?: number;
5580
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsArticlesResponse[], HandleError>>;
5359
5581
  /**
5360
- * @description create screener preset
5361
- * @tags StockScreener
5362
- * @name CreateOrScreenerPreset
5363
- * @summary create screener preset
5364
- * @request POST:/stock-screener/presets
5582
+ * @description Returns the overall sentiment, buzz score and word cloud for the stock.
5583
+ * @tags TipRank
5584
+ * @name TiprankNewsSentiment
5585
+ * @summary Get tiprank NewsSentiment
5586
+ * @request GET:/tipranks/news-sentiment
5365
5587
  * @secure
5366
5588
  */
5367
- createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5589
+ tiprankNewsSentiment(query: {
5590
+ /** The ticker of the stock */
5591
+ ticker: string;
5592
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsSentimentResponse, HandleError>>;
5368
5593
  /**
5369
- * @description remove screener preset
5370
- * @tags StockScreener
5371
- * @name RemoveScreenerPreset
5372
- * @summary remove screener preset
5373
- * @request DELETE:/stock-screener/presets
5594
+ * @description Returns the list of sectors and for each sector the distribution of stocks by analyst consensus (Strong Buy / Moderate Buy / Neutral / Moderate Sell / Strong Sell).
5595
+ * @tags TipRank
5596
+ * @name TiprankSectorConsensus
5597
+ * @summary Get tiprank SectorConsensus
5598
+ * @request GET:/tipranks/sector-consensus
5374
5599
  * @secure
5375
5600
  */
5376
- removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5601
+ tiprankSectorConsensus(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSectorConsensusResponse, HandleError>>;
5377
5602
  /**
5378
- * @description get top symbols
5379
- * @tags StockScreener
5380
- * @name GetTopSymbols
5381
- * @summary get top symbols
5382
- * @request POST:/stock-screener/top
5603
+ * @description Returns the stock analysis overview: which is derived from 8 unique data sets including Analyst recommendations, Crowd Wisdom, Hedge Fund Activity, Media Sentiment, Blogger Opinions, Insider Transactions, Technical and Fundamental stock factors.
5604
+ * @tags TipRank
5605
+ * @name TiprankSmartScore
5606
+ * @summary Get tiprank SmartScore
5607
+ * @request POST:/tipranks/smart-score
5383
5608
  * @secure
5384
5609
  */
5385
- getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5386
- }
5387
- export class StockScreenerV2<HandleError extends boolean = boolean> {
5388
- protected readonly apiClient: JwtClient<HandleError>;
5389
- constructor(apiClient: JwtClient<HandleError>);
5610
+ tiprankSmartScore(filter: InsightSmartScoreRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError>>;
5390
5611
  /**
5391
- * @description filter stocks by params
5392
- * @tags StockScreener
5393
- * @name StockScreener
5394
- * @summary filter stocks by params
5395
- * @request POST:/stock-screener
5612
+ * @description Returns the historical daily and yearly performance of a portfolio that contains all the top smart score stocks (rebalanced daily) and the historical performance of S&P-500 (SPY) for benchmarking purposes.
5613
+ * @tags TipRank
5614
+ * @name TiprankSmartScorePerformance
5615
+ * @summary Get tiprank SmartScorePerformance
5616
+ * @request GET:/tipranks/smart-score-performance
5396
5617
  * @secure
5397
5618
  */
5398
- stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
5619
+ tiprankSmartScorePerformance(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScorePerformanceResponse, HandleError>>;
5399
5620
  /**
5400
- * @description get top symbols
5401
- * @tags StockScreener
5402
- * @name GetTopSymbols
5403
- * @summary get top symbols
5404
- * @request POST:/stock-screener/top
5621
+ * @description Returns a list of stocks with the top Smart Score of 10.
5622
+ * @tags TipRank
5623
+ * @name TiprankSmartScoreTopStocks
5624
+ * @summary Get tiprank SmartScoreTopStocks
5625
+ * @request POST:/tipranks/smart-score-top-stocks
5405
5626
  * @secure
5406
5627
  */
5407
- getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
5408
- }
5409
- export class TipRank<HandleError extends boolean = boolean> {
5410
- protected readonly apiClient: JwtClient<HandleError>;
5411
- constructor(apiClient: JwtClient<HandleError>);
5628
+ tiprankSmartScoreTopStocks(filter: InsightSmartScoreTopStocksRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError>>;
5412
5629
  /**
5413
- * @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
5630
+ * @description Returns a list of top-ranked analysts.
5414
5631
  * @tags TipRank
5415
- * @name TiprankAnalystConsensus
5416
- * @summary Get tiprank AnalystConsensus
5417
- * @request POST:/tipranks/analyst-consensus
5632
+ * @name TiprankStocksConsensusOverTime
5633
+ * @summary Get tiprank StocksConsensusOverTime
5634
+ * @request POST:/tipranks/stocks-consensus-over-time
5418
5635
  * @secure
5419
5636
  */
5420
- tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
5637
+ tiprankStocksConsensusOverTime(filter: InsightStocksConsensusOverTimeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksConsensusOverTimeResponse[], HandleError>>;
5421
5638
  /**
5422
- * @description Returns the latest analyst ratings on a given stock or multiple stocks.
5639
+ * @description Returns the latest events per a specific stock, these include sell side analyst ratings, blogger opinions and corporate insider transactions
5423
5640
  * @tags TipRank
5424
- * @name TiprankLatestAnalystRatingsOnStock
5425
- * @summary Get tiprank LatestAnalystRatingsOnStock
5426
- * @request POST:/tipranks/analyst-multi
5641
+ * @name TiprankStocksEvents
5642
+ * @summary Get tiprank StocksEvents
5643
+ * @request POST:/tipranks/stocks-events
5427
5644
  * @secure
5428
5645
  */
5429
- tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError>>;
5646
+ tiprankStocksEvents(filter: InsightStocksEventsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksEventsResponse[], HandleError>>;
5430
5647
  /**
5431
- * @description Returns the latest analyst portfolio items.
5648
+ * @description Returns a list of stocks similar to the given ticker.
5432
5649
  * @tags TipRank
5433
- * @name TiprankPortfolios
5434
- * @summary Get the latest analyst portfolio items
5435
- * @request POST:/tipranks/analyst-portfolio
5650
+ * @name TiprankStocksSimilarStocks
5651
+ * @summary Get tiprank StocksSimilarStocks
5652
+ * @request GET:/tipranks/stocks-similar-stocks
5436
5653
  * @secure
5437
5654
  */
5438
- tiprankPortfolios(filter: InsightPortfoliosRequest, headers?: {
5439
- /** Authorization */
5440
- Authorization?: string;
5441
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError>>;
5655
+ tiprankStocksSimilarStocks(query: {
5656
+ /** The ticker of the stock */
5657
+ ticker: string;
5658
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5442
5659
  /**
5443
- * @description Returns the analyst profile information
5660
+ * @description Returns the stocks with the highest share price increase / decrease and volume. Note that the API call only returns the list of stocks that make it to the top movers list, the real time price action for these stocks should be pulled by the web page to provide the most up to date values.
5444
5661
  * @tags TipRank
5445
- * @name TiprankAnalystProfile
5446
- * @summary Get tiprank AnalystProfile
5447
- * @request GET:/tipranks/analyst-profile
5662
+ * @name TiprankStocksTopMovers
5663
+ * @summary Get tiprank StocksTopMovers
5664
+ * @request GET:/tipranks/stocks-top-movers
5448
5665
  * @secure
5449
5666
  */
5450
- tiprankAnalystProfile(query: {
5451
- /** ID of tiprank analyst profile */
5452
- id: string;
5453
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystProfileResponse, HandleError>>;
5667
+ tiprankStocksTopMovers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksTopMoversResponse[], HandleError>>;
5454
5668
  /**
5455
- * @description Returns the URL prefix to the expertPictureUrl field.
5669
+ * @description Returns the stock symbols covered by TipRanks.
5456
5670
  * @tags TipRank
5457
- * @name TiprankAnalystsExpertPictureStore
5458
- * @summary Get tiprank AnalystsExpertPictureStore
5459
- * @request GET:/tipranks/analysts-expert-picture-store
5671
+ * @name TiprankSupportedTickers
5672
+ * @summary Get tiprank SupportedTickers
5673
+ * @request GET:/tipranks/supported-tickers
5460
5674
  * @secure
5461
5675
  */
5462
- tiprankAnalystsExpertPictureStore(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystsExpertPictureStoreResponse, HandleError>>;
5676
+ tiprankSupportedTickers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSupportedTickersResponse, HandleError>>;
5463
5677
  /**
5464
- * @description Returns a list of top-ranked analysts.
5678
+ * @description Returns a list of stocks that have the strongest consensus ratings (Strong Buy or Strong Sell) amongst top-ranked analysts (ranked 3.5 stars or higher).
5465
5679
  * @tags TipRank
5466
- * @name TiprankBestPerformingExperts
5467
- * @summary Get tiprank BestPerformingExperts
5468
- * @request GET:/tipranks/best-performing-experts
5680
+ * @name TiprankTopRateStocks
5681
+ * @summary Get tiprank TopRateStocks
5682
+ * @request GET:/tipranks/top-rate-stocks
5469
5683
  * @secure
5470
5684
  */
5471
- tiprankBestPerformingExperts(query?: {
5472
- /** The number of analysts to return */
5685
+ tiprankTopRateStocks(query?: {
5686
+ /** Return the most trending X stocks */
5473
5687
  num?: number;
5474
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBestPerformingExpertsResponse[], HandleError>>;
5688
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopRateStocksResponse, HandleError>>;
5475
5689
  /**
5476
- * @description Returns the blogger consensus on the stock along with the blogger opinion distribution by site.
5690
+ * @description Returns the top-rated stocks by the sector of the given ticker. The API call returns top stocks by analysts, bloggers, insiders, hedge funds, news sentiment and individual investor sentiment.
5477
5691
  * @tags TipRank
5478
- * @name TiprankBloggerConsensusOnStock
5479
- * @summary Get tiprank BloggerConsensusOnStock
5480
- * @request GET:/tipranks/blogger-consensus-on-stock
5692
+ * @name TiprankTopStocksBySectors
5693
+ * @summary Get tiprank TopStocksBySectors
5694
+ * @request POST:/tipranks/top-stocks-by-sectors
5481
5695
  * @secure
5482
5696
  */
5483
- tiprankBloggerConsensusOnStock(query: {
5484
- /** The ticker of the stock */
5485
- ticker: string;
5486
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBloggerConsensusOnStockResponse[], HandleError>>;
5697
+ tiprankTopStocksBySectors(filter: InsightTopStocksBySectorsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksBySectorsResponse, HandleError>>;
5487
5698
  /**
5488
- * @description Returns a list of the upcoming IPOs and recent IPOs that have already been priced
5699
+ * @description Returns a list of stocks with the highest number of analyst ratings in the last 7 days.
5489
5700
  * @tags TipRank
5490
- * @name TiprankCalendarsIpos
5491
- * @summary Get tiprank CalendarsIPOS
5492
- * @request GET:/tipranks/calendars-ipos
5701
+ * @name TiprankTrendingStocks
5702
+ * @summary Get tiprank TrendingStocks
5703
+ * @request POST:/tipranks/trending-stocks
5493
5704
  * @secure
5494
5705
  */
5495
- tiprankCalendarsIpos(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalendarsIPOSResponse[], HandleError>>;
5706
+ tiprankTrendingStocks(filter: InsightTrendingStocksRequest, headers?: {
5707
+ /** Authorization */
5708
+ Authorization?: string;
5709
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
5710
+ }
5711
+ export class UsageTracking<HandleError extends boolean = boolean> {
5712
+ protected readonly apiClient: JwtClient<HandleError>;
5713
+ constructor(apiClient: JwtClient<HandleError>);
5496
5714
  /**
5497
- * @description Returns all stocks that have been updated since a specified UTC time.
5498
- * @tags TipRank
5499
- * @name TiprankGeneralStockUpdates
5500
- * @summary Get tiprank GeneralStockUpdates
5501
- * @request GET:/tipranks/general-stock-updates
5715
+ * @description get usage date per branch for a period
5716
+ * @tags UsageTracking
5717
+ * @name GetUsageData
5718
+ * @summary get insight usage data
5719
+ * @request POST:/tracking/usage
5502
5720
  * @secure
5503
5721
  */
5504
- tiprankGeneralStockUpdates(query?: {
5505
- /** The specific requested time */
5506
- utc_time?: string;
5507
- /** Level of detail on updated stocks */
5508
- details?: InsightTiprankGeneralStockUpdatesParamsDetailsEnum;
5509
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGeneralStockUpdatesResponse, HandleError>>;
5722
+ getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
5723
+ }
5724
+ export class Ownerships<HandleError extends boolean = boolean> {
5725
+ protected readonly apiClient: JwtClient<HandleError>;
5726
+ constructor(apiClient: JwtClient<HandleError>);
5510
5727
  /**
5511
- * @description Returns all hedge funds that have a position on a given stock along with the hedge fund activity trends and consensus.
5512
- * @tags TipRank
5513
- * @name TiprankHedgefunds
5514
- * @summary Get tiprank HedgeFunds
5515
- * @request GET:/tipranks/hedgefunds
5728
+ * @description get ownerships by id datadata
5729
+ * @tags Ownerships
5730
+ * @name GetOwnershipsByIdData
5731
+ * @summary get ownerships by id data
5732
+ * @request POST:/ownerships
5516
5733
  * @secure
5517
5734
  */
5518
- tiprankHedgefunds(query: {
5519
- /** The ticker of the stock */
5520
- ticker: string;
5521
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsResponse[], HandleError>>;
5735
+ getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5522
5736
  /**
5523
- * @description Returns a list of top-ranked hedge fund managers.
5524
- * @tags TipRank
5525
- * @name TiprankHedgefundsBestPerformingExperts
5526
- * @summary Get tiprank HedgeFundsBestPerformingExperts
5527
- * @request GET:/tipranks/hedgefunds-best-performing-experts
5737
+ * @description get ownerships by symbol data
5738
+ * @tags Ownerships
5739
+ * @name GetOwnershipsBySymbolData
5740
+ * @summary get ownerships by symbol data
5741
+ * @request POST:/symbol-ownerships
5528
5742
  * @secure
5529
5743
  */
5530
- tiprankHedgefundsBestPerformingExperts(query?: {
5531
- /** The number of hedge fund managers to return */
5532
- num?: number;
5533
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsBestPerformingExpertsResponse[], HandleError>>;
5744
+ getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5745
+ }
5746
+ export class Public<HandleError extends boolean = boolean> {
5747
+ protected readonly apiClient: JwtClient<HandleError>;
5748
+ constructor(apiClient: JwtClient<HandleError>);
5534
5749
  /**
5535
- * @description Returns the biggest 200 hedge fund transactions from the last quarter filtered based on minStars. Returns at most 50 transactions, sorted by size (biggest on top).
5536
- * @tags TipRank
5537
- * @name TiprankHedgefundsRecentTransactions
5538
- * @summary Get tiprank HedgefundsRecentTransactions
5539
- * @request GET:/tipranks/hedgefunds-recent-transactions
5750
+ * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
5751
+ * @tags Public
5752
+ * @name CalculateEstimatedReturns
5753
+ * @summary Calculate Estimated Returns
5754
+ * @request GET:/public/estimated-returns
5540
5755
  * @secure
5541
5756
  */
5542
- tiprankHedgefundsRecentTransactions(query?: {
5543
- /** Show only managers with these number of stars or higher */
5544
- min_stars?: number;
5545
- /** The order of the latest insider transactions */
5546
- sort?: InsightTiprankHedgefundsRecentTransactionsParamsSortEnum;
5547
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsRecentTransactionsResponse[], HandleError>>;
5757
+ calculateEstimatedReturns(query: {
5758
+ /** Single symbol */
5759
+ symbol: string;
5760
+ /** Non-zero amount */
5761
+ amount: number;
5762
+ /** Start date for calculations */
5763
+ start_date: string;
5764
+ /** End date for calculations */
5765
+ end_date: string;
5766
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
5548
5767
  /**
5549
- * @description Returns the latest insider transactions and an overall sentiment on a given stock.
5550
- * @tags TipRank
5551
- * @name TiprankInsiders
5552
- * @summary Get tiprank Insiders
5553
- * @request GET:/tipranks/insiders
5768
+ * @description Returns an expert forecast
5769
+ * @tags Public
5770
+ * @name ExpertForecast
5771
+ * @summary Expert forecast
5772
+ * @request GET:/public/expert-forecast
5554
5773
  * @secure
5555
5774
  */
5556
- tiprankInsiders(query: {
5557
- /** The ticker of the stock */
5558
- ticker: string;
5559
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersResponse[], HandleError>>;
5775
+ expertForecast(query: {
5776
+ /** Comma separated symbols */
5777
+ symbols: string;
5778
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
5560
5779
  /**
5561
- * @description Returns a list of top ranked insiders.
5562
- * @tags TipRank
5563
- * @name TiprankInsidersBestPerformingExperts
5564
- * @summary Get tiprank InsidersBestPerformingExperts
5565
- * @request GET:/tipranks/insiders-best-performing-experts
5780
+ * @description get fundamentals by symbol data
5781
+ * @tags Public
5782
+ * @name GetPublicFundamentalsBySymbolData
5783
+ * @summary get fundamentals by symbol data
5784
+ * @request GET:/public/fundamentals/{symbol}
5566
5785
  * @secure
5567
5786
  */
5568
- tiprankInsidersBestPerformingExperts(query?: {
5569
- /** The number of insiders to return */
5570
- num?: number;
5571
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersBestPerformingExpertsResponse[], HandleError>>;
5787
+ getPublicFundamentalsBySymbolData(symbol: string, query: {
5788
+ /** Annual or quarterly */
5789
+ mode: string;
5790
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
5572
5791
  /**
5573
- * @description Returns all the information required to build TipRanks Insider Hot Stocks.
5574
- * @tags TipRank
5575
- * @name TiprankInsidersHotstocks
5576
- * @summary Get tiprank InsidersHotstocks
5577
- * @request GET:/tipranks/insiders-hotstocks
5792
+ * @description Daily price history
5793
+ * @tags Public
5794
+ * @name DailyPriceHistory
5795
+ * @summary Daily price history
5796
+ * @request GET:/public/price-history/daily
5578
5797
  * @secure
5579
5798
  */
5580
- tiprankInsidersHotstocks(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersHotstocksResponse[], HandleError>>;
5799
+ dailyPriceHistory(query: {
5800
+ /** Single symbol */
5801
+ symbol: string;
5802
+ /** Target date */
5803
+ date: string;
5804
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
5581
5805
  /**
5582
- * @description Returns a feed of the latest insider transactions reported to the SEC.
5583
- * @tags TipRank
5584
- * @name TiprankInsidersLiveFeed
5585
- * @summary Get tiprank InsidersLiveFeed
5586
- * @request GET:/tipranks/insiders-live-feed
5806
+ * @description Public quote profile
5807
+ * @tags Public
5808
+ * @name PublicQuoteProfile
5809
+ * @summary Public quote profile
5810
+ * @request GET:/public/quote-profile/{symbol}
5587
5811
  * @secure
5588
5812
  */
5589
- tiprankInsidersLiveFeed(query?: {
5590
- /** Return the latest X transactions */
5591
- num?: number;
5592
- /** The order of the latest insider transactions */
5593
- sort?: InsightTiprankInsidersLiveFeedParamsSortEnum;
5594
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersLiveFeedResponse[], HandleError>>;
5813
+ publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
5595
5814
  /**
5596
- * @description Returns the insider profile information.
5597
- * @tags TipRank
5598
- * @name TiprankInsidersOverview
5599
- * @summary Get tiprank InsidersOverview
5600
- * @request GET:/tipranks/insiders-overview
5601
- * @secure
5602
- */
5603
- tiprankInsidersOverview(query?: {
5604
- /** The UID of the expert */
5605
- expert_uid?: string;
5606
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersOverviewResponse, HandleError>>;
5607
- /**
5608
- * @description Returns the sentiment of TipRanks users on the stock.
5609
- * @tags TipRank
5610
- * @name TiprankInvestorSentiment
5611
- * @summary Get tiprank InvestorSentiment
5612
- * @request GET:/tipranks/investor-sentiment
5613
- * @secure
5614
- */
5615
- tiprankInvestorSentiment(query: {
5616
- /** The ticker of the stock */
5617
- ticker: string;
5618
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInvestorSentimentResponse, HandleError>>;
5619
- /**
5620
- * @description Returns the latest analyst ratings.
5621
- * @tags TipRank
5622
- * @name TiprankLiveFeed
5623
- * @summary Get tiprank LiveFeed
5624
- * @request POST:/tipranks/live-feed
5625
- * @secure
5626
- */
5627
- tiprankLiveFeed(filter: InsightLiveFeedRequest, headers?: {
5628
- /** Authorization */
5629
- Authorization?: string;
5630
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLiveFeedResponse[], HandleError>>;
5631
- /**
5632
- * @description Returns the latest news articles on the stock and their sentiment (bullish / neutral or bearish).
5633
- * @tags TipRank
5634
- * @name TiprankNewsArticles
5635
- * @summary Get tiprank NewsArticles
5636
- * @request GET:/tipranks/news-articles
5637
- * @secure
5638
- */
5639
- tiprankNewsArticles(query: {
5640
- /** The ticker of the stock */
5641
- ticker: string;
5642
- /** Limit to number of articles 1-200 */
5643
- num?: number;
5644
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsArticlesResponse[], HandleError>>;
5645
- /**
5646
- * @description Returns the overall sentiment, buzz score and word cloud for the stock.
5647
- * @tags TipRank
5648
- * @name TiprankNewsSentiment
5649
- * @summary Get tiprank NewsSentiment
5650
- * @request GET:/tipranks/news-sentiment
5651
- * @secure
5652
- */
5653
- tiprankNewsSentiment(query: {
5654
- /** The ticker of the stock */
5655
- ticker: string;
5656
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsSentimentResponse, HandleError>>;
5657
- /**
5658
- * @description Returns the list of sectors and for each sector the distribution of stocks by analyst consensus (Strong Buy / Moderate Buy / Neutral / Moderate Sell / Strong Sell).
5659
- * @tags TipRank
5660
- * @name TiprankSectorConsensus
5661
- * @summary Get tiprank SectorConsensus
5662
- * @request GET:/tipranks/sector-consensus
5663
- * @secure
5664
- */
5665
- tiprankSectorConsensus(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSectorConsensusResponse, HandleError>>;
5666
- /**
5667
- * @description Returns the stock analysis overview: which is derived from 8 unique data sets including Analyst recommendations, Crowd Wisdom, Hedge Fund Activity, Media Sentiment, Blogger Opinions, Insider Transactions, Technical and Fundamental stock factors.
5668
- * @tags TipRank
5669
- * @name TiprankSmartScore
5670
- * @summary Get tiprank SmartScore
5671
- * @request POST:/tipranks/smart-score
5672
- * @secure
5673
- */
5674
- tiprankSmartScore(filter: InsightSmartScoreRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError>>;
5675
- /**
5676
- * @description Returns the historical daily and yearly performance of a portfolio that contains all the top smart score stocks (rebalanced daily) and the historical performance of S&P-500 (SPY) for benchmarking purposes.
5677
- * @tags TipRank
5678
- * @name TiprankSmartScorePerformance
5679
- * @summary Get tiprank SmartScorePerformance
5680
- * @request GET:/tipranks/smart-score-performance
5815
+ * @description get ratios by symbol data
5816
+ * @tags Public
5817
+ * @name GetPublicRatiosBySymbolData
5818
+ * @summary get ratios by symbol data
5819
+ * @request GET:/public/ratios/{symbol}
5681
5820
  * @secure
5682
5821
  */
5683
- tiprankSmartScorePerformance(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScorePerformanceResponse, HandleError>>;
5822
+ getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
5684
5823
  /**
5685
- * @description Returns a list of stocks with the top Smart Score of 10.
5686
- * @tags TipRank
5687
- * @name TiprankSmartScoreTopStocks
5688
- * @summary Get tiprank SmartScoreTopStocks
5689
- * @request POST:/tipranks/smart-score-top-stocks
5824
+ * @description find a symbol by name or description
5825
+ * @tags Public
5826
+ * @name QuoteFundamentalsSearch
5827
+ * @summary find a symbol by name or description
5828
+ * @request GET:/public/symbol-search
5690
5829
  * @secure
5691
5830
  */
5692
- tiprankSmartScoreTopStocks(filter: InsightSmartScoreTopStocksRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError>>;
5831
+ quoteFundamentalsSearch(query: {
5832
+ /** Search query */
5833
+ search_query: string;
5834
+ /** how many records to return. Max value is 50 */
5835
+ limit: number;
5836
+ /** how many records to skip */
5837
+ offset: number;
5838
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
5693
5839
  /**
5694
- * @description Returns a list of top-ranked analysts.
5695
- * @tags TipRank
5696
- * @name TiprankStocksConsensusOverTime
5697
- * @summary Get tiprank StocksConsensusOverTime
5698
- * @request POST:/tipranks/stocks-consensus-over-time
5840
+ * @description Get top gainers
5841
+ * @tags Public
5842
+ * @name TopGainers
5843
+ * @summary Top Gainers
5844
+ * @request GET:/public/top-gainers
5699
5845
  * @secure
5700
5846
  */
5701
- tiprankStocksConsensusOverTime(filter: InsightStocksConsensusOverTimeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksConsensusOverTimeResponse[], HandleError>>;
5847
+ topGainers(query: {
5848
+ /** sort direction - asc or desc */
5849
+ order_direction?: string;
5850
+ /** how many records to return. Max value is 50 */
5851
+ limit: number;
5852
+ /** how many records to skip */
5853
+ offset: number;
5854
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
5702
5855
  /**
5703
- * @description Returns the latest events per a specific stock, these include sell side analyst ratings, blogger opinions and corporate insider transactions
5704
- * @tags TipRank
5705
- * @name TiprankStocksEvents
5706
- * @summary Get tiprank StocksEvents
5707
- * @request POST:/tipranks/stocks-events
5856
+ * @description Get top stocks
5857
+ * @tags Public
5858
+ * @name TopStocks
5859
+ * @summary Top Stocks
5860
+ * @request GET:/public/top-stocks
5708
5861
  * @secure
5709
5862
  */
5710
- tiprankStocksEvents(filter: InsightStocksEventsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksEventsResponse[], HandleError>>;
5863
+ topStocks(query: {
5864
+ /** EQUITY|ETF|CRYPTO */
5865
+ stock_type: InsightTopStocksParamsStockTypeEnum;
5866
+ /** how many records to return. Max value is 50 */
5867
+ limit: number;
5868
+ /** how many records to skip */
5869
+ offset: number;
5870
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
5871
+ }
5872
+ export class Passport<HandleError extends boolean = boolean> {
5873
+ protected readonly apiClient: JwtClient<HandleError>;
5874
+ constructor(apiClient: JwtClient<HandleError>);
5711
5875
  /**
5712
- * @description Returns a list of stocks similar to the given ticker.
5713
- * @tags TipRank
5714
- * @name TiprankStocksSimilarStocks
5715
- * @summary Get tiprank StocksSimilarStocks
5716
- * @request GET:/tipranks/stocks-similar-stocks
5876
+ * @description Returns article by id
5877
+ * @tags Passport
5878
+ * @name PassportArticleById
5879
+ * @summary Get article by id
5880
+ * @request POST:/passport/article-by-id
5717
5881
  * @secure
5718
5882
  */
5719
- tiprankStocksSimilarStocks(query: {
5720
- /** The ticker of the stock */
5721
- ticker: string;
5722
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5883
+ passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
5723
5884
  /**
5724
- * @description Returns the stocks with the highest share price increase / decrease and volume. Note that the API call only returns the list of stocks that make it to the top movers list, the real time price action for these stocks should be pulled by the web page to provide the most up to date values.
5725
- * @tags TipRank
5726
- * @name TiprankStocksTopMovers
5727
- * @summary Get tiprank StocksTopMovers
5728
- * @request GET:/tipranks/stocks-top-movers
5885
+ * @description Returns articles
5886
+ * @tags Passport
5887
+ * @name PassportArticles
5888
+ * @summary Get articles
5889
+ * @request POST:/passport/articles
5729
5890
  * @secure
5730
5891
  */
5731
- tiprankStocksTopMovers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksTopMoversResponse[], HandleError>>;
5892
+ passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
5732
5893
  /**
5733
- * @description Returns the stock symbols covered by TipRanks.
5734
- * @tags TipRank
5735
- * @name TiprankSupportedTickers
5736
- * @summary Get tiprank SupportedTickers
5737
- * @request GET:/tipranks/supported-tickers
5894
+ * @description Returns author profile
5895
+ * @tags Passport
5896
+ * @name PassportAuthorProfile
5897
+ * @summary Get author profile
5898
+ * @request POST:/passport/author-profile
5738
5899
  * @secure
5739
5900
  */
5740
- tiprankSupportedTickers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSupportedTickersResponse, HandleError>>;
5901
+ passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
5741
5902
  /**
5742
- * @description Returns a list of stocks that have the strongest consensus ratings (Strong Buy or Strong Sell) amongst top-ranked analysts (ranked 3.5 stars or higher).
5743
- * @tags TipRank
5744
- * @name TiprankTopRateStocks
5745
- * @summary Get tiprank TopRateStocks
5746
- * @request GET:/tipranks/top-rate-stocks
5903
+ * @description Returns most popular tags
5904
+ * @tags Passport
5905
+ * @name PassportMostPopularTags
5906
+ * @summary Get most popular tags
5907
+ * @request POST:/passport/most-popular-tags
5747
5908
  * @secure
5748
5909
  */
5749
- tiprankTopRateStocks(query?: {
5750
- /** Return the most trending X stocks */
5751
- num?: number;
5752
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopRateStocksResponse, HandleError>>;
5910
+ passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
5753
5911
  /**
5754
- * @description Returns the top-rated stocks by the sector of the given ticker. The API call returns top stocks by analysts, bloggers, insiders, hedge funds, news sentiment and individual investor sentiment.
5755
- * @tags TipRank
5756
- * @name TiprankTopStocksBySectors
5757
- * @summary Get tiprank TopStocksBySectors
5758
- * @request POST:/tipranks/top-stocks-by-sectors
5912
+ * @description Returns news feed
5913
+ * @tags Passport
5914
+ * @name PassportNewsFeed
5915
+ * @summary Get news feed
5916
+ * @request POST:/passport/newsfeed
5759
5917
  * @secure
5760
5918
  */
5761
- tiprankTopStocksBySectors(filter: InsightTopStocksBySectorsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksBySectorsResponse, HandleError>>;
5919
+ passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
5762
5920
  /**
5763
- * @description Returns a list of stocks with the highest number of analyst ratings in the last 7 days.
5764
- * @tags TipRank
5765
- * @name TiprankTrendingStocks
5766
- * @summary Get tiprank TrendingStocks
5767
- * @request POST:/tipranks/trending-stocks
5921
+ * @description Returns article by parameters
5922
+ * @tags Passport
5923
+ * @name PassportSearchArticle
5924
+ * @summary Search article by parameters
5925
+ * @request POST:/passport/search-article
5768
5926
  * @secure
5769
5927
  */
5770
- tiprankTrendingStocks(filter: InsightTrendingStocksRequest, headers?: {
5771
- /** Authorization */
5772
- Authorization?: string;
5773
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
5928
+ passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
5774
5929
  }
5775
- export class UsageTracking<HandleError extends boolean = boolean> {
5776
- protected readonly apiClient: JwtClient<HandleError>;
5777
- constructor(apiClient: JwtClient<HandleError>);
5778
- /**
5779
- * @description get usage date per branch for a period
5780
- * @tags UsageTracking
5781
- * @name GetUsageData
5782
- * @summary get insight usage data
5783
- * @request POST:/tracking/usage
5784
- * @secure
5785
- */
5786
- getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
5930
+ export interface InsightBeforeAndAfterV2 {
5931
+ after?: string;
5932
+ before?: string;
5787
5933
  }
5788
- export class WorldMarkets<HandleError extends boolean = boolean> {
5789
- protected readonly apiClient: JwtClient<HandleError>;
5790
- constructor(apiClient: JwtClient<HandleError>);
5791
- /**
5792
- * @description Get continents
5793
- * @tags World Markets
5794
- * @name ContinentGet
5795
- * @summary Get continents
5796
- * @request GET:/continents
5797
- * @secure
5798
- */
5799
- continentGet(query: {
5800
- /** Query limit */
5801
- limit: number;
5802
- /** Query offset */
5803
- offset: number;
5804
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
5805
- /**
5806
- * @description Edit continent
5807
- * @tags World Markets
5808
- * @name ContinentEdit
5809
- * @summary Edit continent
5810
- * @request PUT:/continents
5811
- * @secure
5812
- */
5813
- continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5814
- /**
5815
- * @description Create continents
5816
- * @tags World Markets
5817
- * @name ContinentCreate
5818
- * @summary Create continents
5819
- * @request POST:/continents
5820
- * @secure
5821
- */
5822
- continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
5823
- /**
5824
- * @description Delete continent
5825
- * @tags World Markets
5826
- * @name ContinentDelete
5827
- * @summary Delete continent
5828
- * @request DELETE:/continents
5829
- * @secure
5830
- */
5831
- continentDelete(query: {
5832
- /** continent id */
5833
- id: string;
5834
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5835
- /**
5836
- * @description Get country codes
5837
- * @tags World Markets
5838
- * @name CountryCodeGet
5839
- * @summary Get country codes
5840
- * @request GET:/country-codes
5841
- * @secure
5842
- */
5843
- countryCodeGet(query: {
5844
- /** Query limit */
5845
- limit: number;
5846
- /** Query offset */
5847
- offset: number;
5848
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
5849
- /**
5850
- * @description Edit country code
5851
- * @tags World Markets
5852
- * @name CountryCodeEdit
5853
- * @summary Edit country code
5854
- * @request PUT:/country-codes
5855
- * @secure
5856
- */
5857
- countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5858
- /**
5859
- * @description Add country codes
5860
- * @tags World Markets
5861
- * @name CountryCodeAdd
5862
- * @summary Add country codes
5863
- * @request POST:/country-codes
5864
- * @secure
5865
- */
5866
- countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
5934
+ export interface InsightFixedIncomeV2 {
5935
+ a144: boolean;
5936
+ accrued_interest: number;
5937
+ bank_qualified: boolean;
5938
+ bond_warrant: boolean;
5939
+ call_type: string;
5940
+ callable: boolean;
5941
+ close_price: number;
5942
+ close_price_asof: string;
5943
+ close_ytw: number;
5944
+ convertible: boolean;
5945
+ country: string;
5946
+ country_code: string;
5947
+ country_domicile: string;
5948
+ country_issue: string;
5949
+ coupon: number;
5950
+ coupon_frequency: string;
5951
+ coupon_type: string;
5952
+ currency: string;
5953
+ cusip: string;
5954
+ dated_date: string;
5955
+ daycount: string;
5956
+ description: string;
5957
+ description_short: string;
5958
+ duration: number;
5959
+ first_coupon_date: string;
5960
+ insured: boolean;
5961
+ isin: string;
5962
+ issue_date: string;
5963
+ issue_minimum_denomination: number;
5964
+ issue_price: number;
5965
+ issue_size: number;
5966
+ issuer: string;
5967
+ last_coupon_date: string;
5968
+ liquidity_institutional_aggregate: number;
5969
+ liquidity_institutional_buy: number;
5970
+ liquidity_institutional_sell: number;
5971
+ liquidity_micro_aggregate: number;
5972
+ liquidity_micro_buy: number;
5973
+ liquidity_micro_sell: number;
5974
+ liquidity_retail_aggregate: number;
5975
+ liquidity_retail_buy: number;
5976
+ liquidity_retail_sell: number;
5977
+ maturity_date: string;
5978
+ municipal_state: string;
5979
+ municipal_taxable_federal: boolean;
5980
+ municipal_type: string;
5981
+ next_call_date: string;
5982
+ next_call_price: number;
5983
+ next_coupon_date: string;
5984
+ par_value: number;
5985
+ perpetual: boolean;
5986
+ private_placement: boolean;
5987
+ purpose: string;
5988
+ puttable: boolean;
5989
+ reg_s: boolean;
5990
+ sector: string;
5991
+ seniority: string;
5992
+ settlement_convention: string;
5993
+ sinking_fund: boolean;
5994
+ sp_creditwatch: string;
5995
+ sp_creditwatch_date: string;
5996
+ sp_outlook: string;
5997
+ sp_outlook_date: string;
5998
+ sp_rating: string;
5999
+ sp_rating_date: string;
6000
+ status: string;
6001
+ ticker: string;
6002
+ treasury_subtype: string;
6003
+ type: string;
6004
+ updated_at: string;
6005
+ }
6006
+ export interface InsightGetFixedIncomeEntriesResponseV2 {
6007
+ count: number;
6008
+ data: InsightFixedIncomeV2[];
6009
+ }
6010
+ export interface InsightGetFixedIncomeEntriesRequestV2 {
6011
+ /** @example true */
6012
+ bank_qualified?: boolean;
6013
+ /** @example true */
6014
+ callable?: boolean;
6015
+ /** @example true */
6016
+ convertible?: boolean;
6017
+ /** @example ["USA"] */
6018
+ country_codes?: string[];
6019
+ coupon?: InsightLessAndMoreV2;
6020
+ /** @example ["quarterly","zero"] */
6021
+ coupon_frequencies?: string[];
6022
+ /** @example ["655664AH3","9128286R6"] */
6023
+ cusip?: string[];
5867
6024
  /**
5868
- * @description Delete country code
5869
- * @tags World Markets
5870
- * @name CountryCodeDelete
5871
- * @summary Delete country code
5872
- * @request DELETE:/country-codes
5873
- * @secure
6025
+ * @maxLength 100
6026
+ * @example "Donald's"
5874
6027
  */
5875
- countryCodeDelete(query: {
5876
- /** a3 code */
5877
- a3code: string;
5878
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6028
+ description?: string;
6029
+ /** @example true */
6030
+ has_ticker?: boolean;
6031
+ /** @example true */
6032
+ insured?: boolean;
6033
+ /** @example ["US655664AH33","US9128286R69"] */
6034
+ isin?: string[];
6035
+ issue_date?: InsightBeforeAndAfterV2;
5879
6036
  /**
5880
- * @description Get global indexes
5881
- * @tags World Markets
5882
- * @name GlobalIndexGet
5883
- * @summary Get global indexes
5884
- * @request GET:/global-indexes
5885
- * @secure
6037
+ * @maxLength 100
6038
+ * @example "Donald's"
5886
6039
  */
5887
- globalIndexGet(query: {
5888
- /** Query limit */
5889
- limit: number;
5890
- /** Query offset */
5891
- offset: number;
5892
- /** Continent code for filtering */
5893
- continent?: string;
5894
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
6040
+ issuer?: string;
6041
+ maturity?: InsightBeforeAndAfterV2;
6042
+ /** @example ["NY"] */
6043
+ municipal_states?: string[];
6044
+ /** @example true */
6045
+ municipal_tax?: boolean;
6046
+ /** @example ["general_obligation"] */
6047
+ municipal_types?: string[];
6048
+ pagination: InsightPaginationV2;
6049
+ purposes?: string[];
6050
+ /** @example ["SOVEREIGN"] */
6051
+ sectors?: string[];
6052
+ sorts?: InsightOrderingV2[];
6053
+ /** @example ["AAA"] */
6054
+ sp_ratings?: string[];
6055
+ /** @example ["called","outstanding"] */
6056
+ statuses?: string[];
6057
+ tickers?: string[];
6058
+ /** @example ["corporate"] */
6059
+ types?: string[];
6060
+ }
6061
+ export interface InsightGetTopSymbolsRequestV2 {
6062
+ exchange?: string[];
6063
+ market_cap?: InsightLessAndMoreV2;
6064
+ pagination?: InsightPaginationV2;
6065
+ price?: InsightLessAndMoreV2;
6066
+ sorts?: InsightOrderingV2[];
6067
+ volume?: InsightLessAndMoreV2;
6068
+ }
6069
+ export interface InsightIncludeExcludeV2 {
6070
+ exclude?: string[];
6071
+ include?: string[];
6072
+ }
6073
+ export interface InsightLessAndMoreV2 {
6074
+ less_than?: number;
6075
+ more_than?: number;
6076
+ }
6077
+ export interface InsightOrderingV2 {
5895
6078
  /**
5896
- * @description Edit global index
5897
- * @tags World Markets
5898
- * @name GlobalIndexEdit
5899
- * @summary Edit global index
5900
- * @request PUT:/global-indexes
5901
- * @secure
6079
+ * @default "asc"
6080
+ * @example "asc"
5902
6081
  */
5903
- globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6082
+ direction: InsightOrderingDirectionEnumV2;
5904
6083
  /**
5905
- * @description Add global indexes
5906
- * @tags World Markets
5907
- * @name GlobalIndexAdd
5908
- * @summary Add global indexes
5909
- * @request POST:/global-indexes
5910
- * @secure
6084
+ * Sort direction:
6085
+ * * asc - Ascending, from A to Z.
6086
+ * * desc - Descending, from Z to A.
6087
+ * @example "name"
5911
6088
  */
5912
- globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
6089
+ field: string;
6090
+ }
6091
+ export interface InsightPaginationV2 {
5913
6092
  /**
5914
- * @description Edit global index
5915
- * @tags World Markets
5916
- * @name GlobalIndexDelete
5917
- * @summary Delete global index
5918
- * @request DELETE:/global-indexes
5919
- * @secure
6093
+ * @min 1
6094
+ * @example 1
5920
6095
  */
5921
- globalIndexDelete(query: {
5922
- /** a3 code */
5923
- a3code: string;
5924
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6096
+ page: number;
5925
6097
  /**
5926
- * @description Get regions
5927
- * @tags World Markets
5928
- * @name RegionGet
5929
- * @summary Get regions
5930
- * @request GET:/regions
5931
- * @secure
6098
+ * @min 1
6099
+ * @max 50
6100
+ * @example 10
5932
6101
  */
5933
- regionGet(query: {
5934
- /** Query limit */
5935
- limit: number;
5936
- /** Query offset */
5937
- offset: number;
5938
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
6102
+ size: number;
6103
+ }
6104
+ export interface InsightStockScreenerQuoteV2 {
6105
+ average_volume_30d: number;
6106
+ company_name: string;
6107
+ dividend_ex_date: string;
6108
+ dividend_pay_date: string;
6109
+ dividend_percent: number;
6110
+ exchange: string;
6111
+ exchange_name: string;
6112
+ gap: number;
6113
+ industry: string;
6114
+ industry_code: string;
6115
+ last_price: number;
6116
+ market_cap: number;
6117
+ pe_ratio: number;
6118
+ price_change: number;
6119
+ price_change_percent: number;
6120
+ symbol: string;
6121
+ volume: number;
6122
+ }
6123
+ export interface InsightStockScreenerRequestV2 {
6124
+ average_volume_30d?: InsightLessAndMoreV2;
6125
+ dividend_ex_date?: InsightBeforeAndAfterV2;
6126
+ dividend_pay_date?: InsightBeforeAndAfterV2;
6127
+ dividend_percent?: InsightLessAndMoreV2;
6128
+ exchange?: InsightIncludeExcludeV2;
6129
+ gap?: InsightLessAndMoreV2;
6130
+ industry?: InsightIncludeExcludeV2;
6131
+ market_cap?: InsightLessAndMoreV2;
6132
+ pagination: InsightPaginationV2;
6133
+ pe_ratio?: InsightLessAndMoreV2;
6134
+ price?: InsightLessAndMoreV2;
6135
+ sorts?: InsightOrderingV2[];
6136
+ /** @example "ADR" */
6137
+ stock_type?: string;
6138
+ volume?: InsightLessAndMoreV2;
6139
+ }
6140
+ export interface InsightStockScreenerResponseV2 {
6141
+ current_page: number;
6142
+ data: InsightStockScreenerQuoteV2[];
6143
+ page_count: number;
6144
+ status: number;
6145
+ total_records: number;
6146
+ }
6147
+ /**
6148
+ * @default "asc"
6149
+ * @example "asc"
6150
+ */
6151
+ export enum InsightOrderingDirectionEnumV2 {
6152
+ Asc = "asc",
6153
+ Desc = "desc"
6154
+ }
6155
+ export class FixedIncomeV2<HandleError extends boolean = boolean> {
6156
+ protected readonly apiClient: JwtClient<HandleError>;
6157
+ constructor(apiClient: JwtClient<HandleError>);
5939
6158
  /**
5940
- * @description Edit region
5941
- * @tags World Markets
5942
- * @name RegionEdit
5943
- * @summary Edit region
5944
- * @request PUT:/regions
6159
+ * @description get fixed income entries
6160
+ * @tags FixedIncome
6161
+ * @name GetFixedIncomeEntries
6162
+ * @summary get fixed income entries
6163
+ * @request POST:/fixed-income
5945
6164
  * @secure
5946
6165
  */
5947
- regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6166
+ getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
6167
+ }
6168
+ export class StockScreenerV2<HandleError extends boolean = boolean> {
6169
+ protected readonly apiClient: JwtClient<HandleError>;
6170
+ constructor(apiClient: JwtClient<HandleError>);
5948
6171
  /**
5949
- * @description Create regions
5950
- * @tags World Markets
5951
- * @name RegionCreate
5952
- * @summary Create regions
5953
- * @request POST:/regions
6172
+ * @description filter stocks by params
6173
+ * @tags StockScreener
6174
+ * @name StockScreener
6175
+ * @summary filter stocks by params
6176
+ * @request POST:/stock-screener
5954
6177
  * @secure
5955
6178
  */
5956
- regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
6179
+ stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
5957
6180
  /**
5958
- * @description Delete region
5959
- * @tags World Markets
5960
- * @name RegionDelete
5961
- * @summary Delete region
5962
- * @request DELETE:/regions
6181
+ * @description get top symbols
6182
+ * @tags StockScreener
6183
+ * @name GetTopSymbols
6184
+ * @summary get top symbols
6185
+ * @request POST:/stock-screener/top
5963
6186
  * @secure
5964
6187
  */
5965
- regionDelete(query: {
5966
- /** region id */
5967
- id: string;
5968
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6188
+ getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
5969
6189
  }
5970
6190
  export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
5971
6191
  readonly config: JwtClientConfig<HandleError>;