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

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 (40) hide show
  1. package/dist/aesmidas/index.d.ts +65 -48
  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 +1348 -406
  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 +252 -227
  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 +154 -154
  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 +261 -259
  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.map +1 -1
  38. package/dist/zerohash/index.esm.js.map +1 -1
  39. package/dist/zerohash/index.js.map +1 -1
  40. package/package.json +1 -1
@@ -1219,7 +1219,7 @@ export interface InsightGetIndustriesPerformanceResponse {
1219
1219
  export interface InsightGetMarketDatesRequest {
1220
1220
  /** @example "2023-12-31" */
1221
1221
  end_date: string;
1222
- /** @example ["NYSE","NASDAQ"] */
1222
+ /** @example ["U","AU"] */
1223
1223
  markets?: string[];
1224
1224
  paging: InsightPaging;
1225
1225
  /** @example "2023-01-01" */
@@ -4332,45 +4332,6 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
4332
4332
  Date = "date",
4333
4333
  Rank = "rank"
4334
4334
  }
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
4335
  export class WorldMarkets<HandleError extends boolean = boolean> {
4375
4336
  protected readonly apiClient: JwtClient<HandleError>;
4376
4337
  constructor(apiClient: JwtClient<HandleError>);
@@ -4553,6 +4514,45 @@ export class WorldMarkets<HandleError extends boolean = boolean> {
4553
4514
  id: string;
4554
4515
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4555
4516
  }
4517
+ export class CompanyProfile<HandleError extends boolean = boolean> {
4518
+ protected readonly apiClient: JwtClient<HandleError>;
4519
+ constructor(apiClient: JwtClient<HandleError>);
4520
+ /**
4521
+ * @description get company profile, industries classification and closest earning release
4522
+ * @tags CompanyProfile
4523
+ * @name GetCompanyProfile
4524
+ * @summary get company profile
4525
+ * @request GET:/company-profile
4526
+ * @secure
4527
+ */
4528
+ getCompanyProfile(query: {
4529
+ /** Company symbol */
4530
+ symbol: string;
4531
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
4532
+ /**
4533
+ * @description get combined profile, equities and funds
4534
+ * @tags CompanyProfile
4535
+ * @name GetCombinedProfile
4536
+ * @summary get company profile
4537
+ * @request GET:/quote-profile
4538
+ * @secure
4539
+ */
4540
+ getCombinedProfile(query: {
4541
+ /** Company symbol */
4542
+ symbol: string;
4543
+ /** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
4544
+ symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
4545
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
4546
+ /**
4547
+ * @description sort input array of symbols by type
4548
+ * @tags CompanyProfile
4549
+ * @name GetSymbolsPerSymbolType
4550
+ * @summary sort input array of symbols by type
4551
+ * @request POST:/symbols-per-type
4552
+ * @secure
4553
+ */
4554
+ getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
4555
+ }
4556
4556
  export class CustomLists<HandleError extends boolean = boolean> {
4557
4557
  protected readonly apiClient: JwtClient<HandleError>;
4558
4558
  constructor(apiClient: JwtClient<HandleError>);
@@ -5059,9 +5059,47 @@ export class Quotes<HandleError extends boolean = boolean> {
5059
5059
  symbols: string;
5060
5060
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
5061
5061
  }
5062
+ export class Intraday<HandleError extends boolean = boolean> {
5063
+ protected readonly apiClient: JwtClient<HandleError>;
5064
+ constructor(apiClient: JwtClient<HandleError>);
5065
+ /**
5066
+ * @description Returns an array of intraday chart data values for the given ticker.
5067
+ * @tags Intraday
5068
+ * @name IntradayQuotes
5069
+ * @summary Get an array of intraday chart data values for the given ticker
5070
+ * @request POST:/intraday/quotes
5071
+ * @secure
5072
+ */
5073
+ intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
5074
+ }
5062
5075
  export class PreIpoCompanies<HandleError extends boolean = boolean> {
5063
5076
  protected readonly apiClient: JwtClient<HandleError>;
5064
5077
  constructor(apiClient: JwtClient<HandleError>);
5078
+ /**
5079
+ * @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbola
5080
+ * @tags PreIPOCompanies
5081
+ * @name MonarkOghlcDataForSymbol
5082
+ * @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
5083
+ * @request GET:/ipos/market-data/ohlc/{symbol}
5084
+ * @secure
5085
+ */
5086
+ monarkOghlcDataForSymbol(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
5087
+ close?: number;
5088
+ high?: number;
5089
+ low?: number;
5090
+ open?: number;
5091
+ time?: string;
5092
+ volume?: number;
5093
+ }[], HandleError>>;
5094
+ /**
5095
+ * @description Retrieves all symbols available in the market data
5096
+ * @tags PreIPOCompanies
5097
+ * @name MonarkAllAvailableSymbols
5098
+ * @summary Retrieves all symbols available in the market data
5099
+ * @request GET:/ipos/market-data/symbols
5100
+ * @secure
5101
+ */
5102
+ monarkAllAvailableSymbols(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5065
5103
  /**
5066
5104
  * @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
5105
  * @tags PreIPOCompanies
@@ -5255,18 +5293,46 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
5255
5293
  */
5256
5294
  getPreIpoCompanySpvsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
5257
5295
  }
5258
- export class Intraday<HandleError extends boolean = boolean> {
5296
+ export class Ipos<HandleError extends boolean = boolean> {
5259
5297
  protected readonly apiClient: JwtClient<HandleError>;
5260
5298
  constructor(apiClient: JwtClient<HandleError>);
5261
5299
  /**
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
5300
+ * @description get recent ipos info
5301
+ * @tags Ipos
5302
+ * @name PostRecent
5303
+ * @summary get recent ipos info
5304
+ * @request POST:/ipos/recent
5267
5305
  * @secure
5268
5306
  */
5269
- intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
5307
+ postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5308
+ /**
5309
+ * @description get upcoming ipos info
5310
+ * @tags Ipos
5311
+ * @name GetUpcoming
5312
+ * @summary get upcoming ipos info
5313
+ * @request GET:/ipos/upcoming
5314
+ * @secure
5315
+ */
5316
+ getUpcoming(query: {
5317
+ /** how many records to return. Max value is 50 */
5318
+ limit: number;
5319
+ /** how many records to skip */
5320
+ offset: number;
5321
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5322
+ /**
5323
+ * @description get ipo info by symbol
5324
+ * @tags Ipos
5325
+ * @name GetIpos
5326
+ * @summary get ipo info by symbol
5327
+ * @request GET:/ipos/{symbol}
5328
+ * @secure
5329
+ */
5330
+ getIpos(symbol: string, query?: {
5331
+ /** load quotes */
5332
+ load_quotes?: boolean;
5333
+ /** statuses */
5334
+ statuses?: string[];
5335
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
5270
5336
  }
5271
5337
  export class Logos<HandleError extends boolean = boolean> {
5272
5338
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5368,47 +5434,6 @@ export class Logos<HandleError extends boolean = boolean> {
5368
5434
  symbol: string;
5369
5435
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
5370
5436
  }
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
5437
  export class MarketDates<HandleError extends boolean = boolean> {
5413
5438
  protected readonly apiClient: JwtClient<HandleError>;
5414
5439
  constructor(apiClient: JwtClient<HandleError>);
@@ -5602,131 +5627,27 @@ export class OptionGreeks<HandleError extends boolean = boolean> {
5602
5627
  */
5603
5628
  ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
5604
5629
  }
5605
- export class Public<HandleError extends boolean = boolean> {
5630
+ export class Ownerships<HandleError extends boolean = boolean> {
5606
5631
  protected readonly apiClient: JwtClient<HandleError>;
5607
5632
  constructor(apiClient: JwtClient<HandleError>);
5608
5633
  /**
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
5634
+ * @description get ownerships by id datadata
5635
+ * @tags Ownerships
5636
+ * @name GetOwnershipsByIdData
5637
+ * @summary get ownerships by id data
5638
+ * @request POST:/ownerships
5704
5639
  * @secure
5705
5640
  */
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>>;
5641
+ getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5714
5642
  /**
5715
- * @description Get top stocks
5716
- * @tags Public
5717
- * @name TopStocks
5718
- * @summary Top Stocks
5719
- * @request GET:/public/top-stocks
5643
+ * @description get ownerships by symbol data
5644
+ * @tags Ownerships
5645
+ * @name GetOwnershipsBySymbolData
5646
+ * @summary get ownerships by symbol data
5647
+ * @request POST:/symbol-ownerships
5720
5648
  * @secure
5721
5649
  */
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>>;
5650
+ getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5730
5651
  }
5731
5652
  export class TipRank<HandleError extends boolean = boolean> {
5732
5653
  protected readonly apiClient: JwtClient<HandleError>;
@@ -6107,28 +6028,6 @@ export class UsageTracking<HandleError extends boolean = boolean> {
6107
6028
  */
6108
6029
  getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
6109
6030
  }
6110
- export class Ownerships<HandleError extends boolean = boolean> {
6111
- protected readonly apiClient: JwtClient<HandleError>;
6112
- constructor(apiClient: JwtClient<HandleError>);
6113
- /**
6114
- * @description get ownerships by id datadata
6115
- * @tags Ownerships
6116
- * @name GetOwnershipsByIdData
6117
- * @summary get ownerships by id data
6118
- * @request POST:/ownerships
6119
- * @secure
6120
- */
6121
- getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6122
- /**
6123
- * @description get ownerships by symbol data
6124
- * @tags Ownerships
6125
- * @name GetOwnershipsBySymbolData
6126
- * @summary get ownerships by symbol data
6127
- * @request POST:/symbol-ownerships
6128
- * @secure
6129
- */
6130
- getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6131
- }
6132
6031
  export class AlphaTools<HandleError extends boolean = boolean> {
6133
6032
  protected readonly apiClient: JwtClient<HandleError>;
6134
6033
  constructor(apiClient: JwtClient<HandleError>);
@@ -6209,6 +6108,132 @@ export class Passport<HandleError extends boolean = boolean> {
6209
6108
  */
6210
6109
  passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6211
6110
  }
6111
+ export class Public<HandleError extends boolean = boolean> {
6112
+ protected readonly apiClient: JwtClient<HandleError>;
6113
+ constructor(apiClient: JwtClient<HandleError>);
6114
+ /**
6115
+ * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
6116
+ * @tags Public
6117
+ * @name CalculateEstimatedReturns
6118
+ * @summary Calculate Estimated Returns
6119
+ * @request GET:/public/estimated-returns
6120
+ * @secure
6121
+ */
6122
+ calculateEstimatedReturns(query: {
6123
+ /** Single symbol */
6124
+ symbol: string;
6125
+ /** Non-zero amount */
6126
+ amount: number;
6127
+ /** Start date for calculations */
6128
+ start_date: string;
6129
+ /** End date for calculations */
6130
+ end_date: string;
6131
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
6132
+ /**
6133
+ * @description Returns an expert forecast
6134
+ * @tags Public
6135
+ * @name ExpertForecast
6136
+ * @summary Expert forecast
6137
+ * @request GET:/public/expert-forecast
6138
+ * @secure
6139
+ */
6140
+ expertForecast(query: {
6141
+ /** Comma separated symbols */
6142
+ symbols: string;
6143
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
6144
+ /**
6145
+ * @description get fundamentals by symbol data
6146
+ * @tags Public
6147
+ * @name GetPublicFundamentalsBySymbolData
6148
+ * @summary get fundamentals by symbol data
6149
+ * @request GET:/public/fundamentals/{symbol}
6150
+ * @secure
6151
+ */
6152
+ getPublicFundamentalsBySymbolData(symbol: string, query: {
6153
+ /** Annual or quarterly */
6154
+ mode: string;
6155
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
6156
+ /**
6157
+ * @description Daily price history
6158
+ * @tags Public
6159
+ * @name DailyPriceHistory
6160
+ * @summary Daily price history
6161
+ * @request GET:/public/price-history/daily
6162
+ * @secure
6163
+ */
6164
+ dailyPriceHistory(query: {
6165
+ /** Single symbol */
6166
+ symbol: string;
6167
+ /** Target date */
6168
+ date: string;
6169
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
6170
+ /**
6171
+ * @description Public quote profile
6172
+ * @tags Public
6173
+ * @name PublicQuoteProfile
6174
+ * @summary Public quote profile
6175
+ * @request GET:/public/quote-profile/{symbol}
6176
+ * @secure
6177
+ */
6178
+ publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
6179
+ /**
6180
+ * @description get ratios by symbol data
6181
+ * @tags Public
6182
+ * @name GetPublicRatiosBySymbolData
6183
+ * @summary get ratios by symbol data
6184
+ * @request GET:/public/ratios/{symbol}
6185
+ * @secure
6186
+ */
6187
+ getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
6188
+ /**
6189
+ * @description find a symbol by name or description
6190
+ * @tags Public
6191
+ * @name QuoteFundamentalsSearch
6192
+ * @summary find a symbol by name or description
6193
+ * @request GET:/public/symbol-search
6194
+ * @secure
6195
+ */
6196
+ quoteFundamentalsSearch(query: {
6197
+ /** Search query */
6198
+ search_query: string;
6199
+ /** how many records to return. Max value is 50 */
6200
+ limit: number;
6201
+ /** how many records to skip */
6202
+ offset: number;
6203
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
6204
+ /**
6205
+ * @description Get top gainers
6206
+ * @tags Public
6207
+ * @name TopGainers
6208
+ * @summary Top Gainers
6209
+ * @request GET:/public/top-gainers
6210
+ * @secure
6211
+ */
6212
+ topGainers(query: {
6213
+ /** sort direction - asc or desc */
6214
+ order_direction?: string;
6215
+ /** how many records to return. Max value is 50 */
6216
+ limit: number;
6217
+ /** how many records to skip */
6218
+ offset: number;
6219
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6220
+ /**
6221
+ * @description Get top stocks
6222
+ * @tags Public
6223
+ * @name TopStocks
6224
+ * @summary Top Stocks
6225
+ * @request GET:/public/top-stocks
6226
+ * @secure
6227
+ */
6228
+ topStocks(query: {
6229
+ /** EQUITY|ETF|CRYPTO */
6230
+ stock_type: InsightTopStocksParamsStockTypeEnum;
6231
+ /** how many records to return. Max value is 50 */
6232
+ limit: number;
6233
+ /** how many records to skip */
6234
+ offset: number;
6235
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6236
+ }
6212
6237
  export interface InsightBeforeAndAfterV2 {
6213
6238
  after?: string;
6214
6239
  before?: string;