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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/dist/aesmidas/index.d.ts +43 -41
  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 +232 -213
  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 +243 -200
  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 +117 -117
  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 +772 -768
  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 +363 -351
  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 +13 -13
  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
@@ -949,6 +949,7 @@ export interface InsightFundScreenerQuote {
949
949
  export interface InsightFundScreenerRequest {
950
950
  assets?: string[];
951
951
  categories?: string[];
952
+ expense_ratio?: InsightLessAndMore;
952
953
  /** @example "ETF" */
953
954
  fund_type?: InsightFundScreenerRequestFundTypeEnum;
954
955
  /** @example "ANY" */
@@ -3341,6 +3342,7 @@ export interface InsightPreIPOCompanyResearchDocument {
3341
3342
  export interface InsightPreIPOCompanySPV {
3342
3343
  all_in_price_per_share: number;
3343
3344
  close_date: string;
3345
+ co_manager_partner_ids: string[];
3344
3346
  cusip: string;
3345
3347
  demand_side_commission_split: number;
3346
3348
  description: string;
@@ -3352,9 +3354,11 @@ export interface InsightPreIPOCompanySPV {
3352
3354
  investor_price_per_share: number;
3353
3355
  management_fee: number;
3354
3356
  management_fee_years_payable: number;
3357
+ manager_partner_id: string;
3355
3358
  master_llc_name: string;
3356
3359
  min_commitment_amount: number;
3357
3360
  monark_commission_split: number;
3361
+ monark_stage: string;
3358
3362
  name: string;
3359
3363
  notable_investors: string[];
3360
3364
  number_of_seats_remaining: number;
@@ -3387,6 +3391,7 @@ export interface InsightPreIPOCompanySPVDocument {
3387
3391
  tax_year: number;
3388
3392
  template_document: boolean;
3389
3393
  type: string;
3394
+ url: string;
3390
3395
  }
3391
3396
  export interface InsightPublicQuoteProfile {
3392
3397
  average_volume_30d: number;
@@ -4242,6 +4247,18 @@ export enum InsightSymbolLogoConvertedRequestConversionEnum {
4242
4247
  SquareStrictOrNormal = "square_strict_or_normal",
4243
4248
  BestMatch = "best_match"
4244
4249
  }
4250
+ /** sort field */
4251
+ export enum InsightGetPreIpoCompaniesParamsOrderFieldEnum {
4252
+ Id = "id",
4253
+ Name = "name",
4254
+ LastValuation = "last_valuation",
4255
+ TotalFunding = "total_funding"
4256
+ }
4257
+ /** sort direction */
4258
+ export enum InsightGetPreIpoCompaniesParamsOrderDirectionEnum {
4259
+ Asc = "asc",
4260
+ Desc = "desc"
4261
+ }
4245
4262
  /** search by research type */
4246
4263
  export enum InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum {
4247
4264
  INTERVIEW = "INTERVIEW",
@@ -4253,6 +4270,26 @@ export enum InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum {
4253
4270
  SUBJECT = "SUBJECT",
4254
4271
  CONNECTED = "CONNECTED"
4255
4272
  }
4273
+ /** search by monark stage */
4274
+ export enum InsightGetPreIpoCompanySpvsParamsMonarkStageEnum {
4275
+ DRAFT = "DRAFT",
4276
+ WAITING_MONARK_REVIEW = "WAITING_MONARK_REVIEW",
4277
+ FUND_ADMIN_REVIEW = "FUND_ADMIN_REVIEW",
4278
+ FUND_ADMIN_APPROVED = "FUND_ADMIN_APPROVED",
4279
+ PRIMARY_FUNDRAISE = "PRIMARY_FUNDRAISE",
4280
+ MONARK_DILIGENCE = "MONARK_DILIGENCE",
4281
+ PRE_CLOSE_REVIEW = "PRE_CLOSE_REVIEW",
4282
+ CLOSE_REQUESTED = "CLOSE_REQUESTED",
4283
+ CLOSE_IN_PROCESS = "CLOSE_IN_PROCESS",
4284
+ FUNDS_SENT_TO_TARGET = "FUNDS_SENT_TO_TARGET",
4285
+ CLOSED = "CLOSED",
4286
+ REGULATORY_HOLD_PERIOD = "REGULATORY_HOLD_PERIOD",
4287
+ ACTIVELY_TRADING = "ACTIVELY_TRADING",
4288
+ CLOSE_FAILED = "CLOSE_FAILED",
4289
+ HALTED = "HALTED",
4290
+ LIQUIDATION = "LIQUIDATION",
4291
+ DISSOLVED = "DISSOLVED"
4292
+ }
4256
4293
  /** sort direction */
4257
4294
  export enum InsightGetPreIpoCompanySpvsParamsDirectionEnum {
4258
4295
  ASC = "ASC",
@@ -4983,60 +5020,6 @@ export class StockScreener<HandleError extends boolean = boolean> {
4983
5020
  */
4984
5021
  getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
4985
5022
  }
4986
- export class Intraday<HandleError extends boolean = boolean> {
4987
- protected readonly apiClient: JwtClient<HandleError>;
4988
- constructor(apiClient: JwtClient<HandleError>);
4989
- /**
4990
- * @description Returns an array of intraday chart data values for the given ticker.
4991
- * @tags Intraday
4992
- * @name IntradayQuotes
4993
- * @summary Get an array of intraday chart data values for the given ticker
4994
- * @request POST:/intraday/quotes
4995
- * @secure
4996
- */
4997
- intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
4998
- }
4999
- export class Ipos<HandleError extends boolean = boolean> {
5000
- protected readonly apiClient: JwtClient<HandleError>;
5001
- constructor(apiClient: JwtClient<HandleError>);
5002
- /**
5003
- * @description get recent ipos info
5004
- * @tags Ipos
5005
- * @name PostRecent
5006
- * @summary get recent ipos info
5007
- * @request POST:/ipos/recent
5008
- * @secure
5009
- */
5010
- postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5011
- /**
5012
- * @description get upcoming ipos info
5013
- * @tags Ipos
5014
- * @name GetUpcoming
5015
- * @summary get upcoming ipos info
5016
- * @request GET:/ipos/upcoming
5017
- * @secure
5018
- */
5019
- getUpcoming(query: {
5020
- /** how many records to return. Max value is 50 */
5021
- limit: number;
5022
- /** how many records to skip */
5023
- offset: number;
5024
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5025
- /**
5026
- * @description get ipo info by symbol
5027
- * @tags Ipos
5028
- * @name GetIpos
5029
- * @summary get ipo info by symbol
5030
- * @request GET:/ipos/{symbol}
5031
- * @secure
5032
- */
5033
- getIpos(symbol: string, query?: {
5034
- /** load quotes */
5035
- load_quotes?: boolean;
5036
- /** statuses */
5037
- statuses?: string[];
5038
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
5039
- }
5040
5023
  export class Quotes<HandleError extends boolean = boolean> {
5041
5024
  protected readonly apiClient: JwtClient<HandleError>;
5042
5025
  constructor(apiClient: JwtClient<HandleError>);
@@ -5096,6 +5079,10 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
5096
5079
  limit: number;
5097
5080
  /** how many records to skip */
5098
5081
  offset: number;
5082
+ /** sort field */
5083
+ order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
5084
+ /** sort direction */
5085
+ order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
5099
5086
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
5100
5087
  /**
5101
5088
  * @description get pre ipo company by id
@@ -5249,6 +5236,8 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
5249
5236
  limit: number;
5250
5237
  /** how many records to skip */
5251
5238
  offset: number;
5239
+ /** search by monark stage */
5240
+ monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
5252
5241
  /** sort direction */
5253
5242
  direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
5254
5243
  /** sort field */
@@ -5266,6 +5255,19 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
5266
5255
  */
5267
5256
  getPreIpoCompanySpvsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
5268
5257
  }
5258
+ export class Intraday<HandleError extends boolean = boolean> {
5259
+ protected readonly apiClient: JwtClient<HandleError>;
5260
+ constructor(apiClient: JwtClient<HandleError>);
5261
+ /**
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
5267
+ * @secure
5268
+ */
5269
+ intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
5270
+ }
5269
5271
  export class Logos<HandleError extends boolean = boolean> {
5270
5272
  protected readonly apiClient: JwtClient<HandleError>;
5271
5273
  constructor(apiClient: JwtClient<HandleError>);
@@ -5366,6 +5368,47 @@ export class Logos<HandleError extends boolean = boolean> {
5366
5368
  symbol: string;
5367
5369
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
5368
5370
  }
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
+ }
5369
5412
  export class MarketDates<HandleError extends boolean = boolean> {
5370
5413
  protected readonly apiClient: JwtClient<HandleError>;
5371
5414
  constructor(apiClient: JwtClient<HandleError>);
@@ -5559,27 +5602,131 @@ export class OptionGreeks<HandleError extends boolean = boolean> {
5559
5602
  */
5560
5603
  ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
5561
5604
  }
5562
- export class Ownerships<HandleError extends boolean = boolean> {
5605
+ export class Public<HandleError extends boolean = boolean> {
5563
5606
  protected readonly apiClient: JwtClient<HandleError>;
5564
5607
  constructor(apiClient: JwtClient<HandleError>);
5565
5608
  /**
5566
- * @description get ownerships by id datadata
5567
- * @tags Ownerships
5568
- * @name GetOwnershipsByIdData
5569
- * @summary get ownerships by id data
5570
- * @request POST:/ownerships
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
5571
5614
  * @secure
5572
5615
  */
5573
- getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
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>>;
5574
5626
  /**
5575
- * @description get ownerships by symbol data
5576
- * @tags Ownerships
5577
- * @name GetOwnershipsBySymbolData
5578
- * @summary get ownerships by symbol data
5579
- * @request POST:/symbol-ownerships
5627
+ * @description Returns an expert forecast
5628
+ * @tags Public
5629
+ * @name ExpertForecast
5630
+ * @summary Expert forecast
5631
+ * @request GET:/public/expert-forecast
5580
5632
  * @secure
5581
5633
  */
5582
- getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
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
5704
+ * @secure
5705
+ */
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>>;
5714
+ /**
5715
+ * @description Get top stocks
5716
+ * @tags Public
5717
+ * @name TopStocks
5718
+ * @summary Top Stocks
5719
+ * @request GET:/public/top-stocks
5720
+ * @secure
5721
+ */
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>>;
5583
5730
  }
5584
5731
  export class TipRank<HandleError extends boolean = boolean> {
5585
5732
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5947,28 +6094,6 @@ export class TipRank<HandleError extends boolean = boolean> {
5947
6094
  Authorization?: string;
5948
6095
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
5949
6096
  }
5950
- export class AlphaTools<HandleError extends boolean = boolean> {
5951
- protected readonly apiClient: JwtClient<HandleError>;
5952
- constructor(apiClient: JwtClient<HandleError>);
5953
- /**
5954
- * @description get seasonlity data with comparison to benchmark
5955
- * @tags AlphaTools
5956
- * @name GetMomentumRatioGraph
5957
- * @summary get seasonlity data
5958
- * @request POST:/rst
5959
- * @secure
5960
- */
5961
- getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
5962
- /**
5963
- * @description get seasonlity data with comparison to benchmark
5964
- * @tags AlphaTools
5965
- * @name GetSeasonality
5966
- * @summary get seasonlity data
5967
- * @request POST:/seasonality
5968
- * @secure
5969
- */
5970
- getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
5971
- }
5972
6097
  export class UsageTracking<HandleError extends boolean = boolean> {
5973
6098
  protected readonly apiClient: JwtClient<HandleError>;
5974
6099
  constructor(apiClient: JwtClient<HandleError>);
@@ -5982,131 +6107,49 @@ export class UsageTracking<HandleError extends boolean = boolean> {
5982
6107
  */
5983
6108
  getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
5984
6109
  }
5985
- export class Public<HandleError extends boolean = boolean> {
6110
+ export class Ownerships<HandleError extends boolean = boolean> {
5986
6111
  protected readonly apiClient: JwtClient<HandleError>;
5987
6112
  constructor(apiClient: JwtClient<HandleError>);
5988
6113
  /**
5989
- * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
5990
- * @tags Public
5991
- * @name CalculateEstimatedReturns
5992
- * @summary Calculate Estimated Returns
5993
- * @request GET:/public/estimated-returns
5994
- * @secure
5995
- */
5996
- calculateEstimatedReturns(query: {
5997
- /** Single symbol */
5998
- symbol: string;
5999
- /** Non-zero amount */
6000
- amount: number;
6001
- /** Start date for calculations */
6002
- start_date: string;
6003
- /** End date for calculations */
6004
- end_date: string;
6005
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
6006
- /**
6007
- * @description Returns an expert forecast
6008
- * @tags Public
6009
- * @name ExpertForecast
6010
- * @summary Expert forecast
6011
- * @request GET:/public/expert-forecast
6012
- * @secure
6013
- */
6014
- expertForecast(query: {
6015
- /** Comma separated symbols */
6016
- symbols: string;
6017
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
6018
- /**
6019
- * @description get fundamentals by symbol data
6020
- * @tags Public
6021
- * @name GetPublicFundamentalsBySymbolData
6022
- * @summary get fundamentals by symbol data
6023
- * @request GET:/public/fundamentals/{symbol}
6024
- * @secure
6025
- */
6026
- getPublicFundamentalsBySymbolData(symbol: string, query: {
6027
- /** Annual or quarterly */
6028
- mode: string;
6029
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
6030
- /**
6031
- * @description Daily price history
6032
- * @tags Public
6033
- * @name DailyPriceHistory
6034
- * @summary Daily price history
6035
- * @request GET:/public/price-history/daily
6036
- * @secure
6037
- */
6038
- dailyPriceHistory(query: {
6039
- /** Single symbol */
6040
- symbol: string;
6041
- /** Target date */
6042
- date: string;
6043
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
6044
- /**
6045
- * @description Public quote profile
6046
- * @tags Public
6047
- * @name PublicQuoteProfile
6048
- * @summary Public quote profile
6049
- * @request GET:/public/quote-profile/{symbol}
6050
- * @secure
6051
- */
6052
- publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
6053
- /**
6054
- * @description get ratios by symbol data
6055
- * @tags Public
6056
- * @name GetPublicRatiosBySymbolData
6057
- * @summary get ratios by symbol data
6058
- * @request GET:/public/ratios/{symbol}
6114
+ * @description get ownerships by id datadata
6115
+ * @tags Ownerships
6116
+ * @name GetOwnershipsByIdData
6117
+ * @summary get ownerships by id data
6118
+ * @request POST:/ownerships
6059
6119
  * @secure
6060
6120
  */
6061
- getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
6121
+ getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6062
6122
  /**
6063
- * @description find a symbol by name or description
6064
- * @tags Public
6065
- * @name QuoteFundamentalsSearch
6066
- * @summary find a symbol by name or description
6067
- * @request GET:/public/symbol-search
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
6068
6128
  * @secure
6069
6129
  */
6070
- quoteFundamentalsSearch(query: {
6071
- /** Search query */
6072
- search_query: string;
6073
- /** how many records to return. Max value is 50 */
6074
- limit: number;
6075
- /** how many records to skip */
6076
- offset: number;
6077
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
6130
+ getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6131
+ }
6132
+ export class AlphaTools<HandleError extends boolean = boolean> {
6133
+ protected readonly apiClient: JwtClient<HandleError>;
6134
+ constructor(apiClient: JwtClient<HandleError>);
6078
6135
  /**
6079
- * @description Get top gainers
6080
- * @tags Public
6081
- * @name TopGainers
6082
- * @summary Top Gainers
6083
- * @request GET:/public/top-gainers
6136
+ * @description get seasonlity data with comparison to benchmark
6137
+ * @tags AlphaTools
6138
+ * @name GetMomentumRatioGraph
6139
+ * @summary get seasonlity data
6140
+ * @request POST:/rst
6084
6141
  * @secure
6085
6142
  */
6086
- topGainers(query: {
6087
- /** sort direction - asc or desc */
6088
- order_direction?: string;
6089
- /** how many records to return. Max value is 50 */
6090
- limit: number;
6091
- /** how many records to skip */
6092
- offset: number;
6093
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6143
+ getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
6094
6144
  /**
6095
- * @description Get top stocks
6096
- * @tags Public
6097
- * @name TopStocks
6098
- * @summary Top Stocks
6099
- * @request GET:/public/top-stocks
6145
+ * @description get seasonlity data with comparison to benchmark
6146
+ * @tags AlphaTools
6147
+ * @name GetSeasonality
6148
+ * @summary get seasonlity data
6149
+ * @request POST:/seasonality
6100
6150
  * @secure
6101
6151
  */
6102
- topStocks(query: {
6103
- /** EQUITY|ETF|CRYPTO */
6104
- stock_type: InsightTopStocksParamsStockTypeEnum;
6105
- /** how many records to return. Max value is 50 */
6106
- limit: number;
6107
- /** how many records to skip */
6108
- offset: number;
6109
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6152
+ getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
6110
6153
  }
6111
6154
  export class Passport<HandleError extends boolean = boolean> {
6112
6155
  protected readonly apiClient: JwtClient<HandleError>;