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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/dist/aesmidas/index.d.ts +156 -138
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +248 -248
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +247 -247
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +408 -409
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +826 -826
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +825 -825
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/insight/index.d.ts +908 -688
  14. package/dist/insight/index.d.ts.map +1 -1
  15. package/dist/insight/index.esm.js +1431 -1270
  16. package/dist/insight/index.esm.js.map +1 -1
  17. package/dist/insight/index.js +1430 -1269
  18. package/dist/insight/index.js.map +1 -1
  19. package/dist/middleware/index.d.ts +144 -144
  20. package/dist/middleware/index.d.ts.map +1 -1
  21. package/dist/middleware/index.esm.js +317 -317
  22. package/dist/middleware/index.esm.js.map +1 -1
  23. package/dist/middleware/index.js +316 -316
  24. package/dist/middleware/index.js.map +1 -1
  25. package/dist/orbis/index.d.ts +4068 -4068
  26. package/dist/orbis/index.d.ts.map +1 -1
  27. package/dist/orbis/index.esm.js +3394 -3394
  28. package/dist/orbis/index.esm.js.map +1 -1
  29. package/dist/orbis/index.js +3393 -3393
  30. package/dist/orbis/index.js.map +1 -1
  31. package/dist/uma/index.d.ts +654 -654
  32. package/dist/uma/index.d.ts.map +1 -1
  33. package/dist/uma/index.esm.js +2973 -2973
  34. package/dist/uma/index.esm.js.map +1 -1
  35. package/dist/uma/index.js +2972 -2972
  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,27 +4188,187 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
4086
4188
  Date = "date",
4087
4189
  Rank = "rank"
4088
4190
  }
4089
- export class AlphaTools<HandleError extends boolean = boolean> {
4191
+ export class WorldMarkets<HandleError extends boolean = boolean> {
4090
4192
  protected readonly apiClient: JwtClient<HandleError>;
4091
4193
  constructor(apiClient: JwtClient<HandleError>);
4092
4194
  /**
4093
- * @description get seasonlity data with comparison to benchmark
4094
- * @tags AlphaTools
4095
- * @name GetMomentumRatioGraph
4096
- * @summary get seasonlity data
4097
- * @request POST:/rst
4195
+ * @description Get continents
4196
+ * @tags World Markets
4197
+ * @name ContinentGet
4198
+ * @summary Get continents
4199
+ * @request GET:/continents
4098
4200
  * @secure
4099
4201
  */
4100
- getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
4202
+ continentGet(query: {
4203
+ /** Query limit */
4204
+ limit: number;
4205
+ /** Query offset */
4206
+ offset: number;
4207
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
4101
4208
  /**
4102
- * @description get seasonlity data with comparison to benchmark
4103
- * @tags AlphaTools
4104
- * @name GetSeasonality
4105
- * @summary get seasonlity data
4106
- * @request POST:/seasonality
4209
+ * @description Edit continent
4210
+ * @tags World Markets
4211
+ * @name ContinentEdit
4212
+ * @summary Edit continent
4213
+ * @request PUT:/continents
4107
4214
  * @secure
4108
4215
  */
4109
- getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
4216
+ continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4217
+ /**
4218
+ * @description Create continents
4219
+ * @tags World Markets
4220
+ * @name ContinentCreate
4221
+ * @summary Create continents
4222
+ * @request POST:/continents
4223
+ * @secure
4224
+ */
4225
+ continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
4226
+ /**
4227
+ * @description Delete continent
4228
+ * @tags World Markets
4229
+ * @name ContinentDelete
4230
+ * @summary Delete continent
4231
+ * @request DELETE:/continents
4232
+ * @secure
4233
+ */
4234
+ continentDelete(query: {
4235
+ /** continent id */
4236
+ id: string;
4237
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4238
+ /**
4239
+ * @description Get country codes
4240
+ * @tags World Markets
4241
+ * @name CountryCodeGet
4242
+ * @summary Get country codes
4243
+ * @request GET:/country-codes
4244
+ * @secure
4245
+ */
4246
+ countryCodeGet(query: {
4247
+ /** Query limit */
4248
+ limit: number;
4249
+ /** Query offset */
4250
+ offset: number;
4251
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
4252
+ /**
4253
+ * @description Edit country code
4254
+ * @tags World Markets
4255
+ * @name CountryCodeEdit
4256
+ * @summary Edit country code
4257
+ * @request PUT:/country-codes
4258
+ * @secure
4259
+ */
4260
+ countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4261
+ /**
4262
+ * @description Add country codes
4263
+ * @tags World Markets
4264
+ * @name CountryCodeAdd
4265
+ * @summary Add country codes
4266
+ * @request POST:/country-codes
4267
+ * @secure
4268
+ */
4269
+ countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
4270
+ /**
4271
+ * @description Delete country code
4272
+ * @tags World Markets
4273
+ * @name CountryCodeDelete
4274
+ * @summary Delete country code
4275
+ * @request DELETE:/country-codes
4276
+ * @secure
4277
+ */
4278
+ countryCodeDelete(query: {
4279
+ /** a3 code */
4280
+ a3code: string;
4281
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4282
+ /**
4283
+ * @description Get global indexes
4284
+ * @tags World Markets
4285
+ * @name GlobalIndexGet
4286
+ * @summary Get global indexes
4287
+ * @request GET:/global-indexes
4288
+ * @secure
4289
+ */
4290
+ globalIndexGet(query: {
4291
+ /** Query limit */
4292
+ limit: number;
4293
+ /** Query offset */
4294
+ offset: number;
4295
+ /** Continent code for filtering */
4296
+ continent?: string;
4297
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
4298
+ /**
4299
+ * @description Edit global index
4300
+ * @tags World Markets
4301
+ * @name GlobalIndexEdit
4302
+ * @summary Edit global index
4303
+ * @request PUT:/global-indexes
4304
+ * @secure
4305
+ */
4306
+ globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4307
+ /**
4308
+ * @description Add global indexes
4309
+ * @tags World Markets
4310
+ * @name GlobalIndexAdd
4311
+ * @summary Add global indexes
4312
+ * @request POST:/global-indexes
4313
+ * @secure
4314
+ */
4315
+ globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
4316
+ /**
4317
+ * @description Edit global index
4318
+ * @tags World Markets
4319
+ * @name GlobalIndexDelete
4320
+ * @summary Delete global index
4321
+ * @request DELETE:/global-indexes
4322
+ * @secure
4323
+ */
4324
+ globalIndexDelete(query: {
4325
+ /** a3 code */
4326
+ a3code: string;
4327
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4328
+ /**
4329
+ * @description Get regions
4330
+ * @tags World Markets
4331
+ * @name RegionGet
4332
+ * @summary Get regions
4333
+ * @request GET:/regions
4334
+ * @secure
4335
+ */
4336
+ regionGet(query: {
4337
+ /** Query limit */
4338
+ limit: number;
4339
+ /** Query offset */
4340
+ offset: number;
4341
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
4342
+ /**
4343
+ * @description Edit region
4344
+ * @tags World Markets
4345
+ * @name RegionEdit
4346
+ * @summary Edit region
4347
+ * @request PUT:/regions
4348
+ * @secure
4349
+ */
4350
+ regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4351
+ /**
4352
+ * @description Create regions
4353
+ * @tags World Markets
4354
+ * @name RegionCreate
4355
+ * @summary Create regions
4356
+ * @request POST:/regions
4357
+ * @secure
4358
+ */
4359
+ regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
4360
+ /**
4361
+ * @description Delete region
4362
+ * @tags World Markets
4363
+ * @name RegionDelete
4364
+ * @summary Delete region
4365
+ * @request DELETE:/regions
4366
+ * @secure
4367
+ */
4368
+ regionDelete(query: {
4369
+ /** region id */
4370
+ id: string;
4371
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4110
4372
  }
4111
4373
  export class CompanyProfile<HandleError extends boolean = boolean> {
4112
4374
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4391,256 +4653,18 @@ export class FixedIncome<HandleError extends boolean = boolean> {
4391
4653
  */
4392
4654
  getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
4393
4655
  }
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>>;
4656
+ export class Fundamentals<HandleError extends boolean = boolean> {
4657
+ protected readonly apiClient: JwtClient<HandleError>;
4658
+ constructor(apiClient: JwtClient<HandleError>);
4659
+ /**
4660
+ * @description get fundamentals by symbol data
4661
+ * @tags Fundamentals
4662
+ * @name GetFundamentalsBySymbolData
4663
+ * @summary get fundamentals by symbol data
4664
+ * @request POST:/fundamentals
4665
+ * @secure
4666
+ */
4667
+ getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
4644
4668
  }
4645
4669
  export class Funds<HandleError extends boolean = boolean> {
4646
4670
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4715,30 +4739,283 @@ 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
4746
+ * @description data for visual heat map
4747
+ * @tags StockScreener
4748
+ * @name StockMarketHeatmap
4749
+ * @summary data for visual heat map
4750
+ * @request GET:/heatmaps
4727
4751
  * @secure
4728
4752
  */
4729
- intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
4730
- }
4731
- export class Ipos<HandleError extends boolean = boolean> {
4732
- protected readonly apiClient: JwtClient<HandleError>;
4733
- constructor(apiClient: JwtClient<HandleError>);
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>>;
4734
4757
  /**
4735
- * @description get recent ipos info
4736
- * @tags Ipos
4737
- * @name PostRecent
4738
- * @summary get recent ipos info
4739
- * @request POST:/ipos/recent
4740
- * @secure
4741
- */
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
4887
+ */
4888
+ intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
4889
+ }
4890
+ export class PreIpoCompanies<HandleError extends boolean = boolean> {
4891
+ protected readonly apiClient: JwtClient<HandleError>;
4892
+ constructor(apiClient: JwtClient<HandleError>);
4893
+ /**
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
4899
+ * @secure
4900
+ */
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>>;
4909
+ /**
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
4917
+ * @secure
4918
+ */
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;
4933
+ /** how many records to return. Max value is 50 */
4934
+ limit: number;
4935
+ /** how many records to skip */
4936
+ offset: number;
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>>;
5007
+ }
5008
+ export class Ipos<HandleError extends boolean = boolean> {
5009
+ protected readonly apiClient: JwtClient<HandleError>;
5010
+ constructor(apiClient: JwtClient<HandleError>);
5011
+ /**
5012
+ * @description get recent ipos info
5013
+ * @tags Ipos
5014
+ * @name PostRecent
5015
+ * @summary get recent ipos info
5016
+ * @request POST:/ipos/recent
5017
+ * @secure
5018
+ */
4742
5019
  postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
4743
5020
  /**
4744
5021
  * @description get upcoming ipos info
@@ -4855,31 +5132,6 @@ export class Logos<HandleError extends boolean = boolean> {
4855
5132
  symbol: string;
4856
5133
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
4857
5134
  }
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
5135
  export class News<HandleError extends boolean = boolean> {
4884
5136
  protected readonly apiClient: JwtClient<HandleError>;
4885
5137
  constructor(apiClient: JwtClient<HandleError>);
@@ -5021,6 +5273,31 @@ export class News<HandleError extends boolean = boolean> {
5021
5273
  */
5022
5274
  newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5023
5275
  }
5276
+ export class MarketDates<HandleError extends boolean = boolean> {
5277
+ protected readonly apiClient: JwtClient<HandleError>;
5278
+ constructor(apiClient: JwtClient<HandleError>);
5279
+ /**
5280
+ * @description get market dates history
5281
+ * @tags MarketDates
5282
+ * @name GetMarketDatesHistory
5283
+ * @summary get market dates history
5284
+ * @request POST:/market-dates/history
5285
+ * @secure
5286
+ */
5287
+ getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
5288
+ /**
5289
+ * @description get todays market hours
5290
+ * @tags MarketDates
5291
+ * @name GetTodaysMarketHours
5292
+ * @summary get todays market hours
5293
+ * @request GET:/market-dates/today
5294
+ * @secure
5295
+ */
5296
+ getTodaysMarketHours(query: {
5297
+ /** Market */
5298
+ market: string;
5299
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
5300
+ }
5024
5301
  export class OptionGreeks<HandleError extends boolean = boolean> {
5025
5302
  protected readonly apiClient: JwtClient<HandleError>;
5026
5303
  constructor(apiClient: JwtClient<HandleError>);
@@ -5043,95 +5320,15 @@ export class OptionGreeks<HandleError extends boolean = boolean> {
5043
5320
  */
5044
5321
  ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
5045
5322
  }
5046
- export class Ownerships<HandleError extends boolean = boolean> {
5323
+ export class Public<HandleError extends boolean = boolean> {
5047
5324
  protected readonly apiClient: JwtClient<HandleError>;
5048
5325
  constructor(apiClient: JwtClient<HandleError>);
5049
5326
  /**
5050
- * @description get ownerships by id datadata
5051
- * @tags Ownerships
5052
- * @name GetOwnershipsByIdData
5053
- * @summary get ownerships by id data
5054
- * @request POST:/ownerships
5055
- * @secure
5056
- */
5057
- getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5058
- /**
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
5064
- * @secure
5065
- */
5066
- getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5067
- }
5068
- export class Passport<HandleError extends boolean = boolean> {
5069
- protected readonly apiClient: JwtClient<HandleError>;
5070
- constructor(apiClient: JwtClient<HandleError>);
5071
- /**
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
5077
- * @secure
5078
- */
5079
- passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
5080
- /**
5081
- * @description Returns articles
5082
- * @tags Passport
5083
- * @name PassportArticles
5084
- * @summary Get articles
5085
- * @request POST:/passport/articles
5086
- * @secure
5087
- */
5088
- passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
5089
- /**
5090
- * @description Returns author profile
5091
- * @tags Passport
5092
- * @name PassportAuthorProfile
5093
- * @summary Get author profile
5094
- * @request POST:/passport/author-profile
5095
- * @secure
5096
- */
5097
- passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
5098
- /**
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
5104
- * @secure
5105
- */
5106
- passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
5107
- /**
5108
- * @description Returns news feed
5109
- * @tags Passport
5110
- * @name PassportNewsFeed
5111
- * @summary Get news feed
5112
- * @request POST:/passport/newsfeed
5113
- * @secure
5114
- */
5115
- passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
5116
- /**
5117
- * @description Returns article by parameters
5118
- * @tags Passport
5119
- * @name PassportSearchArticle
5120
- * @summary Search article by parameters
5121
- * @request POST:/passport/search-article
5122
- * @secure
5123
- */
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>);
5129
- /**
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
5327
+ * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
5328
+ * @tags Public
5329
+ * @name CalculateEstimatedReturns
5330
+ * @summary Calculate Estimated Returns
5331
+ * @request GET:/public/estimated-returns
5135
5332
  * @secure
5136
5333
  */
5137
5334
  calculateEstimatedReturns(query: {
@@ -5249,163 +5446,6 @@ export class Public<HandleError extends boolean = boolean> {
5249
5446
  offset: number;
5250
5447
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
5251
5448
  }
5252
- export class Quotes<HandleError extends boolean = boolean> {
5253
- protected readonly apiClient: JwtClient<HandleError>;
5254
- constructor(apiClient: JwtClient<HandleError>);
5255
- /**
5256
- * @description Get single historical quote
5257
- * @tags Quotes
5258
- * @name GitHistoricalQuote
5259
- * @summary Get single historical quote
5260
- * @request GET:/historical/quote
5261
- * @secure
5262
- */
5263
- gitHistoricalQuote(query: {
5264
- /** Symbol */
5265
- symbol: string;
5266
- /** Date */
5267
- date: string;
5268
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
5269
- /**
5270
- * @description get quote history by symbol
5271
- * @tags Quotes
5272
- * @name GitQuoteHistory
5273
- * @summary Get quote history
5274
- * @request POST:/quote-history
5275
- * @secure
5276
- */
5277
- gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
5278
- /**
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
5284
- * @secure
5285
- */
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>);
5294
- /**
5295
- * @description data for visual heat map
5296
- * @tags StockScreener
5297
- * @name StockMarketHeatmap
5298
- * @summary data for visual heat map
5299
- * @request GET:/heatmaps
5300
- * @secure
5301
- */
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>>;
5306
- /**
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
5312
- * @secure
5313
- */
5314
- createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5315
- /**
5316
- * @description Sector and Industry Group performance
5317
- * @tags StockScreener
5318
- * @name IndustriesPerformance
5319
- * @summary get industries performance
5320
- * @request POST:/industries-performance
5321
- * @secure
5322
- */
5323
- industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
5324
- /**
5325
- * @description filter stocks by params
5326
- * @tags StockScreener
5327
- * @name StockScreener
5328
- * @summary filter stocks by params
5329
- * @request POST:/stock-screener
5330
- * @secure
5331
- */
5332
- stockScreener(filter: InsightStockScreenerV1Request, headers?: {
5333
- /** Authorization */
5334
- Authorization?: string;
5335
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5336
- /**
5337
- * @description get screener presets
5338
- * @tags StockScreener
5339
- * @name GetScreenerPresets
5340
- * @summary get screener presets
5341
- * @request GET:/stock-screener/presets
5342
- * @secure
5343
- */
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>>;
5350
- /**
5351
- * @description update screener preset
5352
- * @tags StockScreener
5353
- * @name UpdateScreenerPreset
5354
- * @summary update screener preset
5355
- * @request PUT:/stock-screener/presets
5356
- * @secure
5357
- */
5358
- updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5359
- /**
5360
- * @description create screener preset
5361
- * @tags StockScreener
5362
- * @name CreateOrScreenerPreset
5363
- * @summary create screener preset
5364
- * @request POST:/stock-screener/presets
5365
- * @secure
5366
- */
5367
- createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5368
- /**
5369
- * @description remove screener preset
5370
- * @tags StockScreener
5371
- * @name RemoveScreenerPreset
5372
- * @summary remove screener preset
5373
- * @request DELETE:/stock-screener/presets
5374
- * @secure
5375
- */
5376
- removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5377
- /**
5378
- * @description get top symbols
5379
- * @tags StockScreener
5380
- * @name GetTopSymbols
5381
- * @summary get top symbols
5382
- * @request POST:/stock-screener/top
5383
- * @secure
5384
- */
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>);
5390
- /**
5391
- * @description filter stocks by params
5392
- * @tags StockScreener
5393
- * @name StockScreener
5394
- * @summary filter stocks by params
5395
- * @request POST:/stock-screener
5396
- * @secure
5397
- */
5398
- stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
5399
- /**
5400
- * @description get top symbols
5401
- * @tags StockScreener
5402
- * @name GetTopSymbols
5403
- * @summary get top symbols
5404
- * @request POST:/stock-screener/top
5405
- * @secure
5406
- */
5407
- getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
5408
- }
5409
5449
  export class TipRank<HandleError extends boolean = boolean> {
5410
5450
  protected readonly apiClient: JwtClient<HandleError>;
5411
5451
  constructor(apiClient: JwtClient<HandleError>);
@@ -5772,6 +5812,28 @@ export class TipRank<HandleError extends boolean = boolean> {
5772
5812
  Authorization?: string;
5773
5813
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
5774
5814
  }
5815
+ export class AlphaTools<HandleError extends boolean = boolean> {
5816
+ protected readonly apiClient: JwtClient<HandleError>;
5817
+ constructor(apiClient: JwtClient<HandleError>);
5818
+ /**
5819
+ * @description get seasonlity data with comparison to benchmark
5820
+ * @tags AlphaTools
5821
+ * @name GetMomentumRatioGraph
5822
+ * @summary get seasonlity data
5823
+ * @request POST:/rst
5824
+ * @secure
5825
+ */
5826
+ getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
5827
+ /**
5828
+ * @description get seasonlity data with comparison to benchmark
5829
+ * @tags AlphaTools
5830
+ * @name GetSeasonality
5831
+ * @summary get seasonlity data
5832
+ * @request POST:/seasonality
5833
+ * @secure
5834
+ */
5835
+ getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
5836
+ }
5775
5837
  export class UsageTracking<HandleError extends boolean = boolean> {
5776
5838
  protected readonly apiClient: JwtClient<HandleError>;
5777
5839
  constructor(apiClient: JwtClient<HandleError>);
@@ -5785,187 +5847,345 @@ export class UsageTracking<HandleError extends boolean = boolean> {
5785
5847
  */
5786
5848
  getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
5787
5849
  }
5788
- export class WorldMarkets<HandleError extends boolean = boolean> {
5850
+ export class Passport<HandleError extends boolean = boolean> {
5789
5851
  protected readonly apiClient: JwtClient<HandleError>;
5790
5852
  constructor(apiClient: JwtClient<HandleError>);
5791
5853
  /**
5792
- * @description Get continents
5793
- * @tags World Markets
5794
- * @name ContinentGet
5795
- * @summary Get continents
5796
- * @request GET:/continents
5854
+ * @description Returns article by id
5855
+ * @tags Passport
5856
+ * @name PassportArticleById
5857
+ * @summary Get article by id
5858
+ * @request POST:/passport/article-by-id
5797
5859
  * @secure
5798
5860
  */
5799
- continentGet(query: {
5800
- /** Query limit */
5801
- limit: number;
5802
- /** Query offset */
5803
- offset: number;
5804
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
5861
+ passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
5805
5862
  /**
5806
- * @description Edit continent
5807
- * @tags World Markets
5808
- * @name ContinentEdit
5809
- * @summary Edit continent
5810
- * @request PUT:/continents
5863
+ * @description Returns articles
5864
+ * @tags Passport
5865
+ * @name PassportArticles
5866
+ * @summary Get articles
5867
+ * @request POST:/passport/articles
5811
5868
  * @secure
5812
5869
  */
5813
- continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5870
+ passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
5814
5871
  /**
5815
- * @description Create continents
5816
- * @tags World Markets
5817
- * @name ContinentCreate
5818
- * @summary Create continents
5819
- * @request POST:/continents
5872
+ * @description Returns author profile
5873
+ * @tags Passport
5874
+ * @name PassportAuthorProfile
5875
+ * @summary Get author profile
5876
+ * @request POST:/passport/author-profile
5820
5877
  * @secure
5821
5878
  */
5822
- continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
5879
+ passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
5823
5880
  /**
5824
- * @description Delete continent
5825
- * @tags World Markets
5826
- * @name ContinentDelete
5827
- * @summary Delete continent
5828
- * @request DELETE:/continents
5881
+ * @description Returns most popular tags
5882
+ * @tags Passport
5883
+ * @name PassportMostPopularTags
5884
+ * @summary Get most popular tags
5885
+ * @request POST:/passport/most-popular-tags
5829
5886
  * @secure
5830
5887
  */
5831
- continentDelete(query: {
5832
- /** continent id */
5833
- id: string;
5834
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5888
+ passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
5835
5889
  /**
5836
- * @description Get country codes
5837
- * @tags World Markets
5838
- * @name CountryCodeGet
5839
- * @summary Get country codes
5840
- * @request GET:/country-codes
5890
+ * @description Returns news feed
5891
+ * @tags Passport
5892
+ * @name PassportNewsFeed
5893
+ * @summary Get news feed
5894
+ * @request POST:/passport/newsfeed
5841
5895
  * @secure
5842
5896
  */
5843
- countryCodeGet(query: {
5844
- /** Query limit */
5845
- limit: number;
5846
- /** Query offset */
5847
- offset: number;
5848
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
5897
+ passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
5849
5898
  /**
5850
- * @description Edit country code
5851
- * @tags World Markets
5852
- * @name CountryCodeEdit
5853
- * @summary Edit country code
5854
- * @request PUT:/country-codes
5899
+ * @description Returns article by parameters
5900
+ * @tags Passport
5901
+ * @name PassportSearchArticle
5902
+ * @summary Search article by parameters
5903
+ * @request POST:/passport/search-article
5855
5904
  * @secure
5856
5905
  */
5857
- countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5906
+ passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
5907
+ }
5908
+ export class Ownerships<HandleError extends boolean = boolean> {
5909
+ protected readonly apiClient: JwtClient<HandleError>;
5910
+ constructor(apiClient: JwtClient<HandleError>);
5858
5911
  /**
5859
- * @description Add country codes
5860
- * @tags World Markets
5861
- * @name CountryCodeAdd
5862
- * @summary Add country codes
5863
- * @request POST:/country-codes
5912
+ * @description get ownerships by id datadata
5913
+ * @tags Ownerships
5914
+ * @name GetOwnershipsByIdData
5915
+ * @summary get ownerships by id data
5916
+ * @request POST:/ownerships
5864
5917
  * @secure
5865
5918
  */
5866
- countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
5919
+ getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5867
5920
  /**
5868
- * @description Delete country code
5869
- * @tags World Markets
5870
- * @name CountryCodeDelete
5871
- * @summary Delete country code
5872
- * @request DELETE:/country-codes
5921
+ * @description get ownerships by symbol data
5922
+ * @tags Ownerships
5923
+ * @name GetOwnershipsBySymbolData
5924
+ * @summary get ownerships by symbol data
5925
+ * @request POST:/symbol-ownerships
5873
5926
  * @secure
5874
5927
  */
5875
- countryCodeDelete(query: {
5876
- /** a3 code */
5877
- a3code: string;
5878
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5928
+ getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5929
+ }
5930
+ export interface InsightBeforeAndAfterV2 {
5931
+ after?: string;
5932
+ before?: string;
5933
+ }
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[];
5879
6024
  /**
5880
- * @description Get global indexes
5881
- * @tags World Markets
5882
- * @name GlobalIndexGet
5883
- * @summary Get global indexes
5884
- * @request GET:/global-indexes
5885
- * @secure
6025
+ * @maxLength 100
6026
+ * @example "Donald's"
5886
6027
  */
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>>;
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;
5895
6036
  /**
5896
- * @description Edit global index
5897
- * @tags World Markets
5898
- * @name GlobalIndexEdit
5899
- * @summary Edit global index
5900
- * @request PUT:/global-indexes
5901
- * @secure
6037
+ * @maxLength 100
6038
+ * @example "Donald's"
5902
6039
  */
5903
- globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, 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 {
5904
6078
  /**
5905
- * @description Add global indexes
5906
- * @tags World Markets
5907
- * @name GlobalIndexAdd
5908
- * @summary Add global indexes
5909
- * @request POST:/global-indexes
5910
- * @secure
6079
+ * @default "asc"
6080
+ * @example "asc"
5911
6081
  */
5912
- globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
6082
+ direction: InsightOrderingDirectionEnumV2;
5913
6083
  /**
5914
- * @description Edit global index
5915
- * @tags World Markets
5916
- * @name GlobalIndexDelete
5917
- * @summary Delete global index
5918
- * @request DELETE:/global-indexes
5919
- * @secure
6084
+ * Sort direction:
6085
+ * * asc - Ascending, from A to Z.
6086
+ * * desc - Descending, from Z to A.
6087
+ * @example "name"
5920
6088
  */
5921
- globalIndexDelete(query: {
5922
- /** a3 code */
5923
- a3code: string;
5924
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6089
+ field: string;
6090
+ }
6091
+ export interface InsightPaginationV2 {
5925
6092
  /**
5926
- * @description Get regions
5927
- * @tags World Markets
5928
- * @name RegionGet
5929
- * @summary Get regions
5930
- * @request GET:/regions
5931
- * @secure
6093
+ * @min 1
6094
+ * @example 1
5932
6095
  */
5933
- regionGet(query: {
5934
- /** Query limit */
5935
- limit: number;
5936
- /** Query offset */
5937
- offset: number;
5938
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
6096
+ page: number;
5939
6097
  /**
5940
- * @description Edit region
5941
- * @tags World Markets
5942
- * @name RegionEdit
5943
- * @summary Edit region
5944
- * @request PUT:/regions
6098
+ * @min 1
6099
+ * @max 50
6100
+ * @example 10
6101
+ */
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>);
6158
+ /**
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>;