@orbis-systems/orbis-api-clients 0.7.7 → 0.7.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/dist/aesmidas/index.d.ts +257 -28
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +1 -1
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +1 -1
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +1777 -367
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/insight/index.d.ts +335 -299
  14. package/dist/insight/index.d.ts.map +1 -1
  15. package/dist/insight/index.esm.js +1 -1
  16. package/dist/insight/index.esm.js.map +1 -1
  17. package/dist/insight/index.js +1 -1
  18. package/dist/insight/index.js.map +1 -1
  19. package/dist/middleware/index.d.ts +34 -34
  20. package/dist/middleware/index.d.ts.map +1 -1
  21. package/dist/middleware/index.esm.js +1 -1
  22. package/dist/middleware/index.esm.js.map +1 -1
  23. package/dist/middleware/index.js +1 -1
  24. package/dist/middleware/index.js.map +1 -1
  25. package/dist/orbis/index.d.ts +78 -78
  26. package/dist/orbis/index.d.ts.map +1 -1
  27. package/dist/orbis/index.esm.js +1 -1
  28. package/dist/orbis/index.esm.js.map +1 -1
  29. package/dist/orbis/index.js +1 -1
  30. package/dist/orbis/index.js.map +1 -1
  31. package/dist/uma/index.d.ts +351 -349
  32. package/dist/uma/index.d.ts.map +1 -1
  33. package/dist/uma/index.esm.js +1 -1
  34. package/dist/uma/index.esm.js.map +1 -1
  35. package/dist/uma/index.js +1 -1
  36. package/dist/uma/index.js.map +1 -1
  37. package/dist/zerohash/index.d.ts +91 -91
  38. package/dist/zerohash/index.d.ts.map +1 -1
  39. package/dist/zerohash/index.esm.js +1 -1
  40. package/dist/zerohash/index.esm.js.map +1 -1
  41. package/dist/zerohash/index.js +1 -1
  42. package/dist/zerohash/index.js.map +1 -1
  43. package/package.json +1 -1
@@ -765,6 +765,7 @@ export interface InsightExtendedFundData {
765
765
  closing_price: number;
766
766
  expense_ratio: number;
767
767
  factsheet_url: string;
768
+ fund_net_assets: number;
768
769
  fund_type: string;
769
770
  inverse: boolean;
770
771
  last_price: number;
@@ -1219,7 +1220,7 @@ export interface InsightGetIndustriesPerformanceResponse {
1219
1220
  export interface InsightGetMarketDatesRequest {
1220
1221
  /** @example "2023-12-31" */
1221
1222
  end_date: string;
1222
- /** @example ["NYSE","NASDAQ"] */
1223
+ /** @example ["U","AU"] */
1223
1224
  markets?: string[];
1224
1225
  paging: InsightPaging;
1225
1226
  /** @example "2023-01-01" */
@@ -3254,6 +3255,7 @@ export interface InsightPreIPOCompany {
3254
3255
  num_shares_outstanding: number;
3255
3256
  reference_price: number;
3256
3257
  reference_price_date: string;
3258
+ symbol: string;
3257
3259
  total_funding: number;
3258
3260
  total_funding_rounds: number;
3259
3261
  twelve_month_trailing_revenue: number;
@@ -4332,45 +4334,6 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
4332
4334
  Date = "date",
4333
4335
  Rank = "rank"
4334
4336
  }
4335
- export class CompanyProfile<HandleError extends boolean = boolean> {
4336
- protected readonly apiClient: JwtClient<HandleError>;
4337
- constructor(apiClient: JwtClient<HandleError>);
4338
- /**
4339
- * @description get company profile, industries classification and closest earning release
4340
- * @tags CompanyProfile
4341
- * @name GetCompanyProfile
4342
- * @summary get company profile
4343
- * @request GET:/company-profile
4344
- * @secure
4345
- */
4346
- getCompanyProfile(query: {
4347
- /** Company symbol */
4348
- symbol: string;
4349
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
4350
- /**
4351
- * @description get combined profile, equities and funds
4352
- * @tags CompanyProfile
4353
- * @name GetCombinedProfile
4354
- * @summary get company profile
4355
- * @request GET:/quote-profile
4356
- * @secure
4357
- */
4358
- getCombinedProfile(query: {
4359
- /** Company symbol */
4360
- symbol: string;
4361
- /** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
4362
- symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
4363
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
4364
- /**
4365
- * @description sort input array of symbols by type
4366
- * @tags CompanyProfile
4367
- * @name GetSymbolsPerSymbolType
4368
- * @summary sort input array of symbols by type
4369
- * @request POST:/symbols-per-type
4370
- * @secure
4371
- */
4372
- getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
4373
- }
4374
4337
  export class WorldMarkets<HandleError extends boolean = boolean> {
4375
4338
  protected readonly apiClient: JwtClient<HandleError>;
4376
4339
  constructor(apiClient: JwtClient<HandleError>);
@@ -4553,89 +4516,44 @@ export class WorldMarkets<HandleError extends boolean = boolean> {
4553
4516
  id: string;
4554
4517
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4555
4518
  }
4556
- export class CustomLists<HandleError extends boolean = boolean> {
4519
+ export class CompanyProfile<HandleError extends boolean = boolean> {
4557
4520
  protected readonly apiClient: JwtClient<HandleError>;
4558
4521
  constructor(apiClient: JwtClient<HandleError>);
4559
4522
  /**
4560
- * @description get custom lists
4561
- * @tags Custom Lists
4562
- * @name GetCustomLists
4563
- * @summary get custom lists
4564
- * @request GET:/custom-lists
4565
- * @secure
4566
- */
4567
- getCustomLists(query: {
4568
- /** how many records to return. Max value is 50 */
4569
- limit: number;
4570
- /** how many records to skip */
4571
- offset: number;
4572
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
4573
- /**
4574
- * @description update custom list
4575
- * @tags Custom Lists
4576
- * @name UpdateCustomList
4577
- * @summary update custom list
4578
- * @request PUT:/custom-lists
4579
- * @secure
4580
- */
4581
- updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
4582
- /**
4583
- * @description create custom list
4584
- * @tags Custom Lists
4585
- * @name CreateCustomList
4586
- * @summary create custom list
4587
- * @request POST:/custom-lists
4588
- * @secure
4589
- */
4590
- createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
4591
- /**
4592
- * @description remove custom list
4593
- * @tags Custom Lists
4594
- * @name RemoveCustomList
4595
- * @summary remove custom list
4596
- * @request DELETE:/custom-lists
4597
- * @secure
4598
- */
4599
- removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4600
- /**
4601
- * @description filter custom lists
4602
- * @tags Custom Lists
4603
- * @name FilterCustomLists
4604
- * @summary filter custom lists
4605
- * @request POST:/custom-lists/filter
4523
+ * @description get company profile, industries classification and closest earning release
4524
+ * @tags CompanyProfile
4525
+ * @name GetCompanyProfile
4526
+ * @summary get company profile
4527
+ * @request GET:/company-profile
4606
4528
  * @secure
4607
4529
  */
4608
- filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
4530
+ getCompanyProfile(query: {
4531
+ /** Company symbol */
4532
+ symbol: string;
4533
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
4609
4534
  /**
4610
- * @description get custom list with quotes
4611
- * @tags Custom Lists
4612
- * @name GetCustomListWithQuotes
4613
- * @summary get custom list with quotes
4614
- * @request GET:/custom-lists/{id-or-slug}
4535
+ * @description get combined profile, equities and funds
4536
+ * @tags CompanyProfile
4537
+ * @name GetCombinedProfile
4538
+ * @summary get company profile
4539
+ * @request GET:/quote-profile
4615
4540
  * @secure
4616
4541
  */
4617
- getCustomListWithQuotes(idOrSlug: string, query: {
4618
- /** sort direction - asc or desc */
4619
- order_direction: string;
4620
- /** sort field - volume, symbol(alphabetical), market_cap, dividend_percent */
4621
- order_field: string;
4622
- /** how many equities records to return. Max value is 50 */
4623
- limit: number;
4624
- /** how many equities records to skip */
4625
- offset: number;
4626
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
4542
+ getCombinedProfile(query: {
4543
+ /** Company symbol */
4544
+ symbol: string;
4545
+ /** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
4546
+ symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
4547
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
4627
4548
  /**
4628
- * @description filter custom list
4629
- * @tags Custom Lists
4630
- * @name FilterCustomList
4631
- * @summary filter custom list
4632
- * @request GET:/custom-lists/{id-or-slug}/filter
4549
+ * @description sort input array of symbols by type
4550
+ * @tags CompanyProfile
4551
+ * @name GetSymbolsPerSymbolType
4552
+ * @summary sort input array of symbols by type
4553
+ * @request POST:/symbols-per-type
4633
4554
  * @secure
4634
4555
  */
4635
- filterCustomList(idOrSlug: string, query?: {
4636
- /** symbols to check inclusion */
4637
- symbols?: string[];
4638
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
4556
+ getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
4639
4557
  }
4640
4558
  export class Dashboard<HandleError extends boolean = boolean> {
4641
4559
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4797,6 +4715,90 @@ export class FixedIncome<HandleError extends boolean = boolean> {
4797
4715
  */
4798
4716
  getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
4799
4717
  }
4718
+ export class CustomLists<HandleError extends boolean = boolean> {
4719
+ protected readonly apiClient: JwtClient<HandleError>;
4720
+ constructor(apiClient: JwtClient<HandleError>);
4721
+ /**
4722
+ * @description get custom lists
4723
+ * @tags Custom Lists
4724
+ * @name GetCustomLists
4725
+ * @summary get custom lists
4726
+ * @request GET:/custom-lists
4727
+ * @secure
4728
+ */
4729
+ getCustomLists(query: {
4730
+ /** how many records to return. Max value is 50 */
4731
+ limit: number;
4732
+ /** how many records to skip */
4733
+ offset: number;
4734
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
4735
+ /**
4736
+ * @description update custom list
4737
+ * @tags Custom Lists
4738
+ * @name UpdateCustomList
4739
+ * @summary update custom list
4740
+ * @request PUT:/custom-lists
4741
+ * @secure
4742
+ */
4743
+ updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
4744
+ /**
4745
+ * @description create custom list
4746
+ * @tags Custom Lists
4747
+ * @name CreateCustomList
4748
+ * @summary create custom list
4749
+ * @request POST:/custom-lists
4750
+ * @secure
4751
+ */
4752
+ createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
4753
+ /**
4754
+ * @description remove custom list
4755
+ * @tags Custom Lists
4756
+ * @name RemoveCustomList
4757
+ * @summary remove custom list
4758
+ * @request DELETE:/custom-lists
4759
+ * @secure
4760
+ */
4761
+ removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4762
+ /**
4763
+ * @description filter custom lists
4764
+ * @tags Custom Lists
4765
+ * @name FilterCustomLists
4766
+ * @summary filter custom lists
4767
+ * @request POST:/custom-lists/filter
4768
+ * @secure
4769
+ */
4770
+ filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
4771
+ /**
4772
+ * @description get custom list with quotes
4773
+ * @tags Custom Lists
4774
+ * @name GetCustomListWithQuotes
4775
+ * @summary get custom list with quotes
4776
+ * @request GET:/custom-lists/{id-or-slug}
4777
+ * @secure
4778
+ */
4779
+ getCustomListWithQuotes(idOrSlug: string, query: {
4780
+ /** sort direction - asc or desc */
4781
+ order_direction: string;
4782
+ /** sort field - volume, symbol(alphabetical), market_cap, dividend_percent */
4783
+ order_field: string;
4784
+ /** how many equities records to return. Max value is 50 */
4785
+ limit: number;
4786
+ /** how many equities records to skip */
4787
+ offset: number;
4788
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
4789
+ /**
4790
+ * @description filter custom list
4791
+ * @tags Custom Lists
4792
+ * @name FilterCustomList
4793
+ * @summary filter custom list
4794
+ * @request GET:/custom-lists/{id-or-slug}/filter
4795
+ * @secure
4796
+ */
4797
+ filterCustomList(idOrSlug: string, query?: {
4798
+ /** symbols to check inclusion */
4799
+ symbols?: string[];
4800
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
4801
+ }
4800
4802
  export class Fundamentals<HandleError extends boolean = boolean> {
4801
4803
  protected readonly apiClient: JwtClient<HandleError>;
4802
4804
  constructor(apiClient: JwtClient<HandleError>);
@@ -5059,9 +5061,56 @@ export class Quotes<HandleError extends boolean = boolean> {
5059
5061
  symbols: string;
5060
5062
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
5061
5063
  }
5064
+ export class Intraday<HandleError extends boolean = boolean> {
5065
+ protected readonly apiClient: JwtClient<HandleError>;
5066
+ constructor(apiClient: JwtClient<HandleError>);
5067
+ /**
5068
+ * @description Returns an array of intraday chart data values for the given ticker.
5069
+ * @tags Intraday
5070
+ * @name IntradayQuotes
5071
+ * @summary Get an array of intraday chart data values for the given ticker
5072
+ * @request POST:/intraday/quotes
5073
+ * @secure
5074
+ */
5075
+ intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
5076
+ }
5062
5077
  export class PreIpoCompanies<HandleError extends boolean = boolean> {
5063
5078
  protected readonly apiClient: JwtClient<HandleError>;
5064
5079
  constructor(apiClient: JwtClient<HandleError>);
5080
+ /**
5081
+ * @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbola
5082
+ * @tags PreIPOCompanies
5083
+ * @name MonarkOghlcDataForSymbol
5084
+ * @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
5085
+ * @request GET:/ipos/market-data/ohlc/{symbol}
5086
+ * @secure
5087
+ */
5088
+ monarkOghlcDataForSymbol(symbol: string, query?: {
5089
+ /** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
5090
+ from?: string;
5091
+ /** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
5092
+ to?: string;
5093
+ /** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
5094
+ interval?: string;
5095
+ /** Limit the number of OHLC data points returned. Default is 100. */
5096
+ limit?: number;
5097
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
5098
+ close?: number;
5099
+ high?: number;
5100
+ low?: number;
5101
+ open?: number;
5102
+ time?: string;
5103
+ volume?: number;
5104
+ }[], HandleError>>;
5105
+ /**
5106
+ * @description Retrieves all symbols available in the market data
5107
+ * @tags PreIPOCompanies
5108
+ * @name MonarkAllAvailableSymbols
5109
+ * @summary Retrieves all symbols available in the market data
5110
+ * @request GET:/ipos/market-data/symbols
5111
+ * @secure
5112
+ */
5113
+ monarkAllAvailableSymbols(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5065
5114
  /**
5066
5115
  * @description get pre ipo companies Avaliable categories: on-demand business-video reverse-etl modern-data-stack video-api global-payroll banking-as-a-service ultrafast-delivery online-grocery website-builder fintech b2b venture-capital ecommerce creator-economy productivity real-estate private-markets-exchanges fpa vertical-saas card-issuing connected-fitness gig-marketplaces cms soc-2 analytics cap-table-management contractor-payroll social-media design online-whiteboard conversational-marketing expense-management stock-option-financing customer-onboarding crypto help-desk payroll documents databases mortgage-lending crypto-exchange marketing-automation payments operations checkout cybersecurity messaging investing marketplaces climate-tech robotics data-security online-education gaming universal-api automation biotechnology contact-center defense machine-learning logistics prefab-tech materials telehealth b2c alternative-proteins b2b-marketplaces wealth-management web3 neobank managed-marketplaces plg-crm jamstack public-safety background-checks identity-verification construction home-services sales blockchain-developer-platform space financial-data-aggregation ai writing-assistant autonomous-driving 401k-provider vector-databases ai-models devtools payroll-api internal-tools mlops bookkeeping cloud-infrastructure data-backups personal-finance ai-frameworks generative-ai cloud-gpus micromobility ai-avatars ai-chips life-sciences partnerships wearables fitness-tracking ai-search ai-medical-scribes networking quantum-computing code-editors
5067
5116
  * @tags PreIPOCompanies
@@ -5255,18 +5304,46 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
5255
5304
  */
5256
5305
  getPreIpoCompanySpvsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
5257
5306
  }
5258
- export class Intraday<HandleError extends boolean = boolean> {
5307
+ export class Ipos<HandleError extends boolean = boolean> {
5259
5308
  protected readonly apiClient: JwtClient<HandleError>;
5260
5309
  constructor(apiClient: JwtClient<HandleError>);
5261
5310
  /**
5262
- * @description Returns an array of intraday chart data values for the given ticker.
5263
- * @tags Intraday
5264
- * @name IntradayQuotes
5265
- * @summary Get an array of intraday chart data values for the given ticker
5266
- * @request POST:/intraday/quotes
5311
+ * @description get recent ipos info
5312
+ * @tags Ipos
5313
+ * @name PostRecent
5314
+ * @summary get recent ipos info
5315
+ * @request POST:/ipos/recent
5267
5316
  * @secure
5268
5317
  */
5269
- intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
5318
+ postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5319
+ /**
5320
+ * @description get upcoming ipos info
5321
+ * @tags Ipos
5322
+ * @name GetUpcoming
5323
+ * @summary get upcoming ipos info
5324
+ * @request GET:/ipos/upcoming
5325
+ * @secure
5326
+ */
5327
+ getUpcoming(query: {
5328
+ /** how many records to return. Max value is 50 */
5329
+ limit: number;
5330
+ /** how many records to skip */
5331
+ offset: number;
5332
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5333
+ /**
5334
+ * @description get ipo info by symbol
5335
+ * @tags Ipos
5336
+ * @name GetIpos
5337
+ * @summary get ipo info by symbol
5338
+ * @request GET:/ipos/{symbol}
5339
+ * @secure
5340
+ */
5341
+ getIpos(symbol: string, query?: {
5342
+ /** load quotes */
5343
+ load_quotes?: boolean;
5344
+ /** statuses */
5345
+ statuses?: string[];
5346
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
5270
5347
  }
5271
5348
  export class Logos<HandleError extends boolean = boolean> {
5272
5349
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5368,47 +5445,6 @@ export class Logos<HandleError extends boolean = boolean> {
5368
5445
  symbol: string;
5369
5446
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
5370
5447
  }
5371
- export class Ipos<HandleError extends boolean = boolean> {
5372
- protected readonly apiClient: JwtClient<HandleError>;
5373
- constructor(apiClient: JwtClient<HandleError>);
5374
- /**
5375
- * @description get recent ipos info
5376
- * @tags Ipos
5377
- * @name PostRecent
5378
- * @summary get recent ipos info
5379
- * @request POST:/ipos/recent
5380
- * @secure
5381
- */
5382
- postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5383
- /**
5384
- * @description get upcoming ipos info
5385
- * @tags Ipos
5386
- * @name GetUpcoming
5387
- * @summary get upcoming ipos info
5388
- * @request GET:/ipos/upcoming
5389
- * @secure
5390
- */
5391
- getUpcoming(query: {
5392
- /** how many records to return. Max value is 50 */
5393
- limit: number;
5394
- /** how many records to skip */
5395
- offset: number;
5396
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5397
- /**
5398
- * @description get ipo info by symbol
5399
- * @tags Ipos
5400
- * @name GetIpos
5401
- * @summary get ipo info by symbol
5402
- * @request GET:/ipos/{symbol}
5403
- * @secure
5404
- */
5405
- getIpos(symbol: string, query?: {
5406
- /** load quotes */
5407
- load_quotes?: boolean;
5408
- /** statuses */
5409
- statuses?: string[];
5410
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
5411
- }
5412
5448
  export class MarketDates<HandleError extends boolean = boolean> {
5413
5449
  protected readonly apiClient: JwtClient<HandleError>;
5414
5450
  constructor(apiClient: JwtClient<HandleError>);
@@ -5602,131 +5638,27 @@ export class OptionGreeks<HandleError extends boolean = boolean> {
5602
5638
  */
5603
5639
  ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
5604
5640
  }
5605
- export class Public<HandleError extends boolean = boolean> {
5641
+ export class AlphaTools<HandleError extends boolean = boolean> {
5606
5642
  protected readonly apiClient: JwtClient<HandleError>;
5607
5643
  constructor(apiClient: JwtClient<HandleError>);
5608
5644
  /**
5609
- * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
5610
- * @tags Public
5611
- * @name CalculateEstimatedReturns
5612
- * @summary Calculate Estimated Returns
5613
- * @request GET:/public/estimated-returns
5614
- * @secure
5615
- */
5616
- calculateEstimatedReturns(query: {
5617
- /** Single symbol */
5618
- symbol: string;
5619
- /** Non-zero amount */
5620
- amount: number;
5621
- /** Start date for calculations */
5622
- start_date: string;
5623
- /** End date for calculations */
5624
- end_date: string;
5625
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
5626
- /**
5627
- * @description Returns an expert forecast
5628
- * @tags Public
5629
- * @name ExpertForecast
5630
- * @summary Expert forecast
5631
- * @request GET:/public/expert-forecast
5632
- * @secure
5633
- */
5634
- expertForecast(query: {
5635
- /** Comma separated symbols */
5636
- symbols: string;
5637
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
5638
- /**
5639
- * @description get fundamentals by symbol data
5640
- * @tags Public
5641
- * @name GetPublicFundamentalsBySymbolData
5642
- * @summary get fundamentals by symbol data
5643
- * @request GET:/public/fundamentals/{symbol}
5644
- * @secure
5645
- */
5646
- getPublicFundamentalsBySymbolData(symbol: string, query: {
5647
- /** Annual or quarterly */
5648
- mode: string;
5649
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
5650
- /**
5651
- * @description Daily price history
5652
- * @tags Public
5653
- * @name DailyPriceHistory
5654
- * @summary Daily price history
5655
- * @request GET:/public/price-history/daily
5656
- * @secure
5657
- */
5658
- dailyPriceHistory(query: {
5659
- /** Single symbol */
5660
- symbol: string;
5661
- /** Target date */
5662
- date: string;
5663
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
5664
- /**
5665
- * @description Public quote profile
5666
- * @tags Public
5667
- * @name PublicQuoteProfile
5668
- * @summary Public quote profile
5669
- * @request GET:/public/quote-profile/{symbol}
5670
- * @secure
5671
- */
5672
- publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
5673
- /**
5674
- * @description get ratios by symbol data
5675
- * @tags Public
5676
- * @name GetPublicRatiosBySymbolData
5677
- * @summary get ratios by symbol data
5678
- * @request GET:/public/ratios/{symbol}
5679
- * @secure
5680
- */
5681
- getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
5682
- /**
5683
- * @description find a symbol by name or description
5684
- * @tags Public
5685
- * @name QuoteFundamentalsSearch
5686
- * @summary find a symbol by name or description
5687
- * @request GET:/public/symbol-search
5688
- * @secure
5689
- */
5690
- quoteFundamentalsSearch(query: {
5691
- /** Search query */
5692
- search_query: string;
5693
- /** how many records to return. Max value is 50 */
5694
- limit: number;
5695
- /** how many records to skip */
5696
- offset: number;
5697
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
5698
- /**
5699
- * @description Get top gainers
5700
- * @tags Public
5701
- * @name TopGainers
5702
- * @summary Top Gainers
5703
- * @request GET:/public/top-gainers
5645
+ * @description get seasonlity data with comparison to benchmark
5646
+ * @tags AlphaTools
5647
+ * @name GetMomentumRatioGraph
5648
+ * @summary get seasonlity data
5649
+ * @request POST:/rst
5704
5650
  * @secure
5705
5651
  */
5706
- topGainers(query: {
5707
- /** sort direction - asc or desc */
5708
- order_direction?: string;
5709
- /** how many records to return. Max value is 50 */
5710
- limit: number;
5711
- /** how many records to skip */
5712
- offset: number;
5713
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
5652
+ getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
5714
5653
  /**
5715
- * @description Get top stocks
5716
- * @tags Public
5717
- * @name TopStocks
5718
- * @summary Top Stocks
5719
- * @request GET:/public/top-stocks
5654
+ * @description get seasonlity data with comparison to benchmark
5655
+ * @tags AlphaTools
5656
+ * @name GetSeasonality
5657
+ * @summary get seasonlity data
5658
+ * @request POST:/seasonality
5720
5659
  * @secure
5721
5660
  */
5722
- topStocks(query: {
5723
- /** EQUITY|ETF|CRYPTO */
5724
- stock_type: InsightTopStocksParamsStockTypeEnum;
5725
- /** how many records to return. Max value is 50 */
5726
- limit: number;
5727
- /** how many records to skip */
5728
- offset: number;
5729
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
5661
+ getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
5730
5662
  }
5731
5663
  export class TipRank<HandleError extends boolean = boolean> {
5732
5664
  protected readonly apiClient: JwtClient<HandleError>;
@@ -6107,6 +6039,132 @@ export class UsageTracking<HandleError extends boolean = boolean> {
6107
6039
  */
6108
6040
  getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
6109
6041
  }
6042
+ export class Public<HandleError extends boolean = boolean> {
6043
+ protected readonly apiClient: JwtClient<HandleError>;
6044
+ constructor(apiClient: JwtClient<HandleError>);
6045
+ /**
6046
+ * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
6047
+ * @tags Public
6048
+ * @name CalculateEstimatedReturns
6049
+ * @summary Calculate Estimated Returns
6050
+ * @request GET:/public/estimated-returns
6051
+ * @secure
6052
+ */
6053
+ calculateEstimatedReturns(query: {
6054
+ /** Single symbol */
6055
+ symbol: string;
6056
+ /** Non-zero amount */
6057
+ amount: number;
6058
+ /** Start date for calculations */
6059
+ start_date: string;
6060
+ /** End date for calculations */
6061
+ end_date: string;
6062
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
6063
+ /**
6064
+ * @description Returns an expert forecast
6065
+ * @tags Public
6066
+ * @name ExpertForecast
6067
+ * @summary Expert forecast
6068
+ * @request GET:/public/expert-forecast
6069
+ * @secure
6070
+ */
6071
+ expertForecast(query: {
6072
+ /** Comma separated symbols */
6073
+ symbols: string;
6074
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
6075
+ /**
6076
+ * @description get fundamentals by symbol data
6077
+ * @tags Public
6078
+ * @name GetPublicFundamentalsBySymbolData
6079
+ * @summary get fundamentals by symbol data
6080
+ * @request GET:/public/fundamentals/{symbol}
6081
+ * @secure
6082
+ */
6083
+ getPublicFundamentalsBySymbolData(symbol: string, query: {
6084
+ /** Annual or quarterly */
6085
+ mode: string;
6086
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
6087
+ /**
6088
+ * @description Daily price history
6089
+ * @tags Public
6090
+ * @name DailyPriceHistory
6091
+ * @summary Daily price history
6092
+ * @request GET:/public/price-history/daily
6093
+ * @secure
6094
+ */
6095
+ dailyPriceHistory(query: {
6096
+ /** Single symbol */
6097
+ symbol: string;
6098
+ /** Target date */
6099
+ date: string;
6100
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
6101
+ /**
6102
+ * @description Public quote profile
6103
+ * @tags Public
6104
+ * @name PublicQuoteProfile
6105
+ * @summary Public quote profile
6106
+ * @request GET:/public/quote-profile/{symbol}
6107
+ * @secure
6108
+ */
6109
+ publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
6110
+ /**
6111
+ * @description get ratios by symbol data
6112
+ * @tags Public
6113
+ * @name GetPublicRatiosBySymbolData
6114
+ * @summary get ratios by symbol data
6115
+ * @request GET:/public/ratios/{symbol}
6116
+ * @secure
6117
+ */
6118
+ getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
6119
+ /**
6120
+ * @description find a symbol by name or description
6121
+ * @tags Public
6122
+ * @name QuoteFundamentalsSearch
6123
+ * @summary find a symbol by name or description
6124
+ * @request GET:/public/symbol-search
6125
+ * @secure
6126
+ */
6127
+ quoteFundamentalsSearch(query: {
6128
+ /** Search query */
6129
+ search_query: string;
6130
+ /** how many records to return. Max value is 50 */
6131
+ limit: number;
6132
+ /** how many records to skip */
6133
+ offset: number;
6134
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
6135
+ /**
6136
+ * @description Get top gainers
6137
+ * @tags Public
6138
+ * @name TopGainers
6139
+ * @summary Top Gainers
6140
+ * @request GET:/public/top-gainers
6141
+ * @secure
6142
+ */
6143
+ topGainers(query: {
6144
+ /** sort direction - asc or desc */
6145
+ order_direction?: string;
6146
+ /** how many records to return. Max value is 50 */
6147
+ limit: number;
6148
+ /** how many records to skip */
6149
+ offset: number;
6150
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6151
+ /**
6152
+ * @description Get top stocks
6153
+ * @tags Public
6154
+ * @name TopStocks
6155
+ * @summary Top Stocks
6156
+ * @request GET:/public/top-stocks
6157
+ * @secure
6158
+ */
6159
+ topStocks(query: {
6160
+ /** EQUITY|ETF|CRYPTO */
6161
+ stock_type: InsightTopStocksParamsStockTypeEnum;
6162
+ /** how many records to return. Max value is 50 */
6163
+ limit: number;
6164
+ /** how many records to skip */
6165
+ offset: number;
6166
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6167
+ }
6110
6168
  export class Ownerships<HandleError extends boolean = boolean> {
6111
6169
  protected readonly apiClient: JwtClient<HandleError>;
6112
6170
  constructor(apiClient: JwtClient<HandleError>);
@@ -6129,28 +6187,6 @@ export class Ownerships<HandleError extends boolean = boolean> {
6129
6187
  */
6130
6188
  getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6131
6189
  }
6132
- export class AlphaTools<HandleError extends boolean = boolean> {
6133
- protected readonly apiClient: JwtClient<HandleError>;
6134
- constructor(apiClient: JwtClient<HandleError>);
6135
- /**
6136
- * @description get seasonlity data with comparison to benchmark
6137
- * @tags AlphaTools
6138
- * @name GetMomentumRatioGraph
6139
- * @summary get seasonlity data
6140
- * @request POST:/rst
6141
- * @secure
6142
- */
6143
- getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
6144
- /**
6145
- * @description get seasonlity data with comparison to benchmark
6146
- * @tags AlphaTools
6147
- * @name GetSeasonality
6148
- * @summary get seasonlity data
6149
- * @request POST:/seasonality
6150
- * @secure
6151
- */
6152
- getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
6153
- }
6154
6190
  export class Passport<HandleError extends boolean = boolean> {
6155
6191
  protected readonly apiClient: JwtClient<HandleError>;
6156
6192
  constructor(apiClient: JwtClient<HandleError>);