@orbis-systems/orbis-api-clients 0.8.8 → 0.8.10

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 +501 -468
  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 +681 -254
  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 +164 -164
  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 +83 -83
  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 +1001 -972
  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 +490 -368
  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/package.json +1 -1
@@ -287,6 +287,7 @@ export interface AesMidasBondReformat {
287
287
  isin?: string | null;
288
288
  cusip?: string | null;
289
289
  company_name?: string | null;
290
+ issue_market?: string | null;
290
291
  exchange?: string | null;
291
292
  market_description?: string | null;
292
293
  country?: string | null;
@@ -1399,6 +1400,7 @@ export interface AesMidasLevel1Reformat {
1399
1400
  isin?: string | null;
1400
1401
  cusip?: string | null;
1401
1402
  company_name?: string | null;
1403
+ issue_market?: string | null;
1402
1404
  exchange?: string | null;
1403
1405
  market_description?: string | null;
1404
1406
  country?: string | null;
@@ -2804,34 +2806,6 @@ export interface AesMidasUserMultiConditionResultResponseResponsewithPagination
2804
2806
  page_size?: number;
2805
2807
  data?: AesMidasUserMultiConditionResultResponse[] | null;
2806
2808
  }
2807
- export class BackgroundService<HandleError extends boolean = boolean> {
2808
- protected readonly apiClient: JwtClient<HandleError>;
2809
- constructor(apiClient: JwtClient<HandleError>);
2810
- /**
2811
- * @tags BackgroundService
2812
- * @name PostStart
2813
- * @summary Start the background service to sync UMA firms/users
2814
- * @request POST:/api/background-service/start
2815
- * @secure
2816
- */
2817
- postStart(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2818
- /**
2819
- * @tags BackgroundService
2820
- * @name PostStop
2821
- * @summary Stop the background service to sync UMA firms/users
2822
- * @request POST:/api/background-service/stop
2823
- * @secure
2824
- */
2825
- postStop(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2826
- /**
2827
- * @tags BackgroundService
2828
- * @name GetStatus
2829
- * @summary Check the status of the background service
2830
- * @request GET:/api/background-service/status
2831
- * @secure
2832
- */
2833
- getStatus(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2834
- }
2835
2809
  export class DataSource<HandleError extends boolean = boolean> {
2836
2810
  protected readonly apiClient: JwtClient<HandleError>;
2837
2811
  constructor(apiClient: JwtClient<HandleError>);
@@ -2935,6 +2909,34 @@ export class DataSource<HandleError extends boolean = boolean> {
2935
2909
  firm_id: string;
2936
2910
  }, data: AesMidasQueryPostBody, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDataSourceTallyResponsewithPagination, HandleError>>;
2937
2911
  }
2912
+ export class BackgroundService<HandleError extends boolean = boolean> {
2913
+ protected readonly apiClient: JwtClient<HandleError>;
2914
+ constructor(apiClient: JwtClient<HandleError>);
2915
+ /**
2916
+ * @tags BackgroundService
2917
+ * @name PostStart
2918
+ * @summary Start the background service to sync UMA firms/users
2919
+ * @request POST:/api/background-service/start
2920
+ * @secure
2921
+ */
2922
+ postStart(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2923
+ /**
2924
+ * @tags BackgroundService
2925
+ * @name PostStop
2926
+ * @summary Stop the background service to sync UMA firms/users
2927
+ * @request POST:/api/background-service/stop
2928
+ * @secure
2929
+ */
2930
+ postStop(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2931
+ /**
2932
+ * @tags BackgroundService
2933
+ * @name GetStatus
2934
+ * @summary Check the status of the background service
2935
+ * @request GET:/api/background-service/status
2936
+ * @secure
2937
+ */
2938
+ getStatus(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2939
+ }
2938
2940
  export class Entitlement<HandleError extends boolean = boolean> {
2939
2941
  protected readonly apiClient: JwtClient<HandleError>;
2940
2942
  constructor(apiClient: JwtClient<HandleError>);
@@ -3508,198 +3510,321 @@ export class Permission<HandleError extends boolean = boolean> {
3508
3510
  user_name: string;
3509
3511
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3510
3512
  }
3511
- export class Quote<HandleError extends boolean = boolean> {
3513
+ export class QuotesReformat<HandleError extends boolean = boolean> {
3512
3514
  protected readonly apiClient: JwtClient<HandleError>;
3513
3515
  constructor(apiClient: JwtClient<HandleError>);
3514
3516
  /**
3515
- * @tags Quote
3516
- * @name PostSymbolSearch
3517
- * @summary Symbol screener - All users
3518
- * @request POST:/api/quote/symbol-search
3517
+ * @tags QuotesReformat
3518
+ * @name GetEquity
3519
+ * @summary Query full Level 1 data - All users
3520
+ * @request GET:/api/quotes/equity
3519
3521
  * @secure
3520
3522
  */
3521
- postSymbolSearch(data: AesMidasSymbolSearchBody, query?: {
3522
- /**
3523
- * Optional. Default is false. If true, response will be camel case
3524
- * @default false
3525
- */
3526
- response_camel_case?: boolean;
3527
- /** @default "" */
3528
- user_name?: string;
3523
+ getEquity(query: {
3524
+ /** Allow multiple symbols, separated by ',' */
3525
+ symbols: string;
3529
3526
  /** @default "" */
3530
3527
  platform?: string;
3531
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSymbolSearchRecordResponsewithPagination, HandleError>>;
3528
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3532
3529
  /**
3533
- * @tags Quote
3534
- * @name GetBestQuote
3535
- * @summary Query Best Quote(Level 1 data) - All users
3536
- * @request GET:/api/quote/best-quote
3530
+ * @tags QuotesReformat
3531
+ * @name GetEquityCboe
3532
+ * @summary TEMPORARY ENDPOINT: Query US Realtime data from CBOE1 - All users
3533
+ * @request GET:/api/quotes/equity/cboe
3537
3534
  * @secure
3538
3535
  */
3539
- getBestQuote(query: {
3540
- /** Allow multiple symbols query, seperated by ',' */
3536
+ getEquityCboe(query: {
3537
+ /** Allow multiple symbols, separated by ',' */
3541
3538
  symbols: string;
3542
- /**
3543
- * Optional. Default is false. If true, response will be camel case
3544
- * @default false
3545
- */
3546
- response_camel_case?: boolean;
3547
- /**
3548
- * Optional. Must input if enterprise user query on behave of their clients
3549
- * @default ""
3550
- */
3551
- user_name?: string;
3552
3539
  /** @default "" */
3553
3540
  platform?: string;
3554
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasBestQuote[], HandleError>>;
3541
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3555
3542
  /**
3556
- * @tags Quote
3557
- * @name GetNbboSnapshot
3558
- * @summary Query NBBO Snapshot - All users
3559
- * @request GET:/api/quote/nbbo-snapshot
3543
+ * @tags QuotesReformat
3544
+ * @name GetEquityIntraday
3545
+ * @summary Query intra-day and historical Minute Chart. If no days range provided, it return intraday chart. rsiSpan is no supported. All Volume is raw Volume. - All users
3546
+ * @request GET:/api/quotes/equity/intraday
3560
3547
  * @secure
3561
3548
  */
3562
- getNbboSnapshot(query: {
3563
- /** Allow multiple symbols query, seperated by ',' */
3564
- symbols: string;
3565
- /**
3566
- * Optional. Default is false. If true, response will be camel case
3567
- * @default false
3568
- */
3569
- response_camel_case?: boolean;
3570
- /**
3571
- * Optional. Must input if enterprise user query on behave of their clients
3572
- * @default ""
3573
- */
3574
- user_name?: string;
3549
+ getEquityIntraday(query: {
3550
+ /** Allow one symbol */
3551
+ symbol: string;
3552
+ /** optional timestamp format for multiday charts. Timestamp format: yyyy-MM-dd HH:mm:ss */
3553
+ from?: string;
3554
+ /** optional timestamp format for multiday charts. Timestamp format: yyyy-MM-dd HH:mm:ss */
3555
+ to?: string;
3575
3556
  /** @default "" */
3576
3557
  platform?: string;
3577
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshot[], HandleError>>;
3558
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3578
3559
  /**
3579
- * @tags Quote
3580
- * @name GetOpraSnapshot
3581
- * @summary Query OPRA Snapshot - All users - available in Microservice
3582
- * @request GET:/api/quote/opra-snapshot
3560
+ * @tags QuotesReformat
3561
+ * @name GetEquityHistorical
3562
+ * @summary Query Historical Day Chart. No weekly data point support yet. No rsiSpan support. - All users
3563
+ * @request GET:/api/quotes/equity/historical
3583
3564
  * @secure
3584
3565
  */
3585
- getOpraSnapshot(query: {
3586
- /** Allow multiple symbols query, seperated by ',' */
3587
- symbols: string;
3588
- /**
3589
- * Optional. Default is false. If true, response will be camel case
3590
- * @default false
3591
- */
3592
- response_camel_case?: boolean;
3566
+ getEquityHistorical(query: {
3567
+ /** Allow one symbol */
3568
+ symbol: string;
3569
+ /** start date (MM/dd/yyyy) */
3570
+ start?: string;
3571
+ /** end date (MM/dd/yyyy) */
3572
+ end?: string;
3593
3573
  /**
3594
- * Optional. Must input if enterprise user query on behave of their clients
3574
+ * If start and end are not specified, then range needs to be given. Format: [num][y/m/w] (y – year, m – months, w - weeks). num specifies number of (y/m) back from current date
3595
3575
  * @default ""
3596
3576
  */
3597
- user_name?: string;
3577
+ range?: string;
3598
3578
  /** @default "" */
3599
3579
  platform?: string;
3600
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshot[], HandleError>>;
3580
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3601
3581
  /**
3602
- * @tags Quote
3603
- * @name GetLevel1
3604
- * @summary Query full Level 1 data - All users
3605
- * @request GET:/api/quote/level1
3582
+ * @tags QuotesReformat
3583
+ * @name GetSearch
3584
+ * @summary To search for a company and the exact ticker symbol is not known, use this endpoint for a string search. - All users
3585
+ * @request GET:/api/quotes/search
3606
3586
  * @secure
3607
3587
  */
3608
- getLevel1(query: {
3609
- /** Allow multiple symbols, separated by ',' */
3610
- symbols: string;
3588
+ getSearch(query: {
3589
+ /** String to search for */
3590
+ criteria: string;
3611
3591
  /**
3612
- * Optional. Default is false. If true, response will be camel case
3613
- * @default false
3592
+ * Maximum number of results to return (default is 20)
3593
+ * @format int32
3594
+ * @default 20
3614
3595
  */
3615
- response_camel_case?: boolean;
3596
+ limit?: number;
3616
3597
  /**
3617
- * Optional. Must input if enterprise user query on behave of their clients
3618
- * @default ""
3598
+ * Whether to load quotes for the results or not
3599
+ * @default false
3619
3600
  */
3620
- user_name?: string;
3621
- /** @default "" */
3622
- platform?: string;
3623
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasLevel1[], HandleError>>;
3624
- /**
3625
- * @tags Quote
3626
- * @name GetRegionQuotes
3627
- * @summary Query Region Quotes from Tick data - All users
3628
- * @request GET:/api/quote/region-quotes
3629
- * @secure
3630
- */
3631
- getRegionQuotes(query: {
3632
- /** Allow one symbol */
3633
- symbol: string;
3601
+ loadQuotes?: boolean;
3602
+ /** include countries. For example, if only want to display US symbols, please send 'US' in this parameter */
3603
+ includeCountries?: string;
3634
3604
  /**
3635
- * Optional. Default is false. If true, response will be camel case
3605
+ * include mutual fund in search results
3636
3606
  * @default false
3637
3607
  */
3638
- response_camel_case?: boolean;
3608
+ includeMF?: boolean;
3639
3609
  /**
3640
- * Optional. Must input if enterprise user query on behave of their clients
3641
- * @default ""
3610
+ * filter out quotes not found symbols. This parameter only works if 'loadQuotes' is true.
3611
+ * @default false
3642
3612
  */
3643
- user_name?: string;
3613
+ excludeNotFound?: boolean;
3644
3614
  /** @default "" */
3645
3615
  platform?: string;
3646
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasRegionQuote[], HandleError>>;
3616
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3647
3617
  /**
3648
- * @tags Quote
3649
- * @name GetNightSessionRegionQuotesOnbbo
3650
- * @summary Query ONBBO Region Quotes(Level2) from Tick data - All users - available in Microservice
3651
- * @request GET:/api/quote/night-session/region-quotes/onbbo
3618
+ * @tags QuotesReformat
3619
+ * @name GetSearchRedis
3620
+ * @summary TEST Redis symbol search. - All users - available in Microservice version
3621
+ * @request GET:/api/quotes/search-redis
3652
3622
  * @secure
3653
3623
  */
3654
- getNightSessionRegionQuotesOnbbo(query: {
3655
- /** Allow one symbol */
3656
- symbol: string;
3624
+ getSearchRedis(query: {
3625
+ /** String to search for */
3626
+ criteria: string;
3657
3627
  /**
3658
- * Optional. Default is false. If true, response will be camel case
3628
+ * Maximum number of results to return (default is 20)
3629
+ * @format int32
3630
+ * @default 20
3631
+ */
3632
+ limit?: number;
3633
+ /**
3634
+ * Whether to load quotes for the results or not
3659
3635
  * @default false
3660
3636
  */
3661
- response_camel_case?: boolean;
3637
+ loadQuotes?: boolean;
3662
3638
  /**
3663
- * Optional. Must input if enterprise user query on behave of their clients
3664
- * @default ""
3639
+ * include mutual fund in search results
3640
+ * @default false
3665
3641
  */
3666
- user_name?: string;
3642
+ includeMF?: boolean;
3643
+ /**
3644
+ * filter out quotes not found symbols. This parameter only works if 'loadQuotes' is true.
3645
+ * @default false
3646
+ */
3647
+ excludeNotFound?: boolean;
3667
3648
  /** @default "" */
3668
3649
  platform?: string;
3669
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasRegionQuote[], HandleError>>;
3650
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3670
3651
  /**
3671
- * @tags Quote
3672
- * @name GetTimeSale
3673
- * @summary Query TimeSale from Tick data - All users
3674
- * @request GET:/api/quote/time-sale
3652
+ * @tags QuotesReformat
3653
+ * @name GetEquitySnapshot
3654
+ * @summary Query NBBO Snapshot - All users
3655
+ * @request GET:/api/quotes/equity/snapshot
3675
3656
  * @secure
3676
3657
  */
3677
- getTimeSale(query: {
3658
+ getEquitySnapshot(query: {
3659
+ /** Allow multiple symbols query, seperated by ',' */
3660
+ symbols: string;
3661
+ /** @default "" */
3662
+ platform?: string;
3663
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3664
+ /**
3665
+ * @tags QuotesReformat
3666
+ * @name GetOption
3667
+ * @summary Query Option Level 1 data - All users
3668
+ * @request GET:/api/quotes/option
3669
+ * @secure
3670
+ */
3671
+ getOption(query: {
3672
+ /** Option symbol. Format {Underlying Symbol}yymmdd{C/P}{Strike price*1000, total 8 digits} */
3673
+ symbols: string;
3674
+ /**
3675
+ * if include greek letter value in response
3676
+ * @default false
3677
+ */
3678
+ greeks?: boolean;
3679
+ /** @default "" */
3680
+ platform?: string;
3681
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3682
+ /**
3683
+ * @tags QuotesReformat
3684
+ * @name GetOptionChainDates
3685
+ * @summary Query Option Chain dates - All users
3686
+ * @request GET:/api/quotes/option/chain/dates/{symbol}
3687
+ * @secure
3688
+ */
3689
+ getOptionChainDates(symbol: string, query?: {
3690
+ /** @default "" */
3691
+ platform?: string;
3692
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3693
+ /**
3694
+ * @tags QuotesReformat
3695
+ * @name GetOptionChain
3696
+ * @summary Query Option Chain data - All users
3697
+ * @request GET:/api/quotes/option/chain/{symbol}/{date}
3698
+ * @secure
3699
+ */
3700
+ getOptionChain(symbol: string, date: string, query?: {
3701
+ /** @default "" */
3702
+ platform?: string;
3703
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3704
+ /**
3705
+ * @tags QuotesReformat
3706
+ * @name GetOptionHistorical
3707
+ * @summary Query option Day Chart. No weekly data point support yet. No rsiSpan support. - All users
3708
+ * @request GET:/api/quotes/option/historical
3709
+ * @secure
3710
+ */
3711
+ getOptionHistorical(query: {
3678
3712
  /** Allow one symbol */
3679
3713
  symbol: string;
3714
+ /** start date (MM/dd/yyyy) */
3715
+ start?: string;
3716
+ /** end date (MM/dd/yyyy) */
3717
+ end?: string;
3680
3718
  /**
3681
- * Optional. Default is false. If true, response will be camel case
3719
+ * If start and end are not specified, then range needs to be given. Format: [num][y/m] (y – year, m – months). num specifies number of (y/m) back from current date
3720
+ * @default ""
3721
+ */
3722
+ range?: string;
3723
+ /** @default "" */
3724
+ platform?: string;
3725
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3726
+ /**
3727
+ * @tags QuotesReformat
3728
+ * @name GetBonds
3729
+ * @summary Query Bonds data - All users
3730
+ * @request GET:/api/quotes/bonds
3731
+ * @secure
3732
+ */
3733
+ getBonds(query: {
3734
+ /** ISIN, allow multiple query separated by ',' */
3735
+ identifiers: string;
3736
+ /**
3737
+ * Price type, default is Percentage. ('Percentage'|'Decimal')
3738
+ * @default "Percentage"
3739
+ */
3740
+ bondPriceType?: string;
3741
+ /**
3742
+ * Quantity type, default is Par. ('Par'|'Unit')
3743
+ * @default "Par"
3744
+ */
3745
+ bondQuantityType?: string;
3746
+ /** @default "" */
3747
+ platform?: string;
3748
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3749
+ /**
3750
+ * @tags QuotesReformat
3751
+ * @name GetBondsSearch
3752
+ * @summary Search bonds - All users
3753
+ * @request GET:/api/quotes/bonds/search
3754
+ * @secure
3755
+ */
3756
+ getBondsSearch(query: {
3757
+ /** search string */
3758
+ criteria: string;
3759
+ /**
3760
+ * how many records that need to return, 20 is maximum
3761
+ * @format int32
3762
+ * @default 20
3763
+ */
3764
+ limit?: number;
3765
+ /**
3766
+ * if return bonds quote. If false, will only return ISIN list
3682
3767
  * @default false
3683
3768
  */
3684
- response_camel_case?: boolean;
3769
+ loadQuotes?: boolean;
3685
3770
  /**
3686
- * Optional. Must input if enterprise user query on behave of their clients
3687
- * @default ""
3771
+ * Price type, default is Percentage. ('Percentage'|'Decimal')
3772
+ * @default "Percentage"
3773
+ */
3774
+ bondPriceType?: string;
3775
+ /**
3776
+ * Quantity type, default is Par. ('Par'|'Unit')
3777
+ * @default "Par"
3778
+ */
3779
+ bondQuantityType?: string;
3780
+ /** @default "" */
3781
+ platform?: string;
3782
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3783
+ /**
3784
+ * @tags QuotesReformat
3785
+ * @name GetQuotesReformat
3786
+ * @summary Query Forex rate - All users
3787
+ * @request GET:/api/quotes/fx
3788
+ * @secure
3789
+ */
3790
+ getQuotesReformat(query: {
3791
+ /** base_currency/quote_currecy. Can query multiple, separated with ',' */
3792
+ symbols: string;
3793
+ /** @default "" */
3794
+ platform?: string;
3795
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
3796
+ }
3797
+ export class Quote<HandleError extends boolean = boolean> {
3798
+ protected readonly apiClient: JwtClient<HandleError>;
3799
+ constructor(apiClient: JwtClient<HandleError>);
3800
+ /**
3801
+ * @tags Quote
3802
+ * @name PostSymbolSearch
3803
+ * @summary Symbol screener - All users
3804
+ * @request POST:/api/quote/symbol-search
3805
+ * @secure
3806
+ */
3807
+ postSymbolSearch(data: AesMidasSymbolSearchBody, query?: {
3808
+ /**
3809
+ * Optional. Default is false. If true, response will be camel case
3810
+ * @default false
3688
3811
  */
3812
+ response_camel_case?: boolean;
3813
+ /** @default "" */
3689
3814
  user_name?: string;
3690
3815
  /** @default "" */
3691
3816
  platform?: string;
3692
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTimeSell[], HandleError>>;
3817
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSymbolSearchRecordResponsewithPagination, HandleError>>;
3693
3818
  /**
3694
3819
  * @tags Quote
3695
- * @name GetNightSessionTimeSaleOnbbo
3696
- * @summary Query ONBBO TimeSale from Tick data - All users - available in Microservice
3697
- * @request GET:/api/quote/night-session/time-sale/onbbo
3820
+ * @name GetBestQuote
3821
+ * @summary Query Best Quote(Level 1 data) - All users
3822
+ * @request GET:/api/quote/best-quote
3698
3823
  * @secure
3699
3824
  */
3700
- getNightSessionTimeSaleOnbbo(query: {
3701
- /** Allow one symbol */
3702
- symbol: string;
3825
+ getBestQuote(query: {
3826
+ /** Allow multiple symbols query, seperated by ',' */
3827
+ symbols: string;
3703
3828
  /**
3704
3829
  * Optional. Default is false. If true, response will be camel case
3705
3830
  * @default false
@@ -3712,15 +3837,15 @@ export class Quote<HandleError extends boolean = boolean> {
3712
3837
  user_name?: string;
3713
3838
  /** @default "" */
3714
3839
  platform?: string;
3715
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTimeSell[], HandleError>>;
3840
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasBestQuote[], HandleError>>;
3716
3841
  /**
3717
3842
  * @tags Quote
3718
- * @name GetLastTrade
3719
- * @summary Query Last Trade(Level 2 data) - All users
3720
- * @request GET:/api/quote/last-trade
3843
+ * @name GetNbboSnapshot
3844
+ * @summary Query NBBO Snapshot - All users
3845
+ * @request GET:/api/quote/nbbo-snapshot
3721
3846
  * @secure
3722
3847
  */
3723
- getLastTrade(query: {
3848
+ getNbboSnapshot(query: {
3724
3849
  /** Allow multiple symbols query, seperated by ',' */
3725
3850
  symbols: string;
3726
3851
  /**
@@ -3735,15 +3860,15 @@ export class Quote<HandleError extends boolean = boolean> {
3735
3860
  user_name?: string;
3736
3861
  /** @default "" */
3737
3862
  platform?: string;
3738
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTimeSell[], HandleError>>;
3863
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshot[], HandleError>>;
3739
3864
  /**
3740
3865
  * @tags Quote
3741
- * @name GetNightSessionLastTradeOnbbo
3742
- * @summary Query ONBBO Last Trade(Level 2 data) - All users - available in Microservice
3743
- * @request GET:/api/quote/night-session/last-trade/onbbo
3866
+ * @name GetOpraSnapshot
3867
+ * @summary Query OPRA Snapshot - All users - available in Microservice
3868
+ * @request GET:/api/quote/opra-snapshot
3744
3869
  * @secure
3745
3870
  */
3746
- getNightSessionLastTradeOnbbo(query: {
3871
+ getOpraSnapshot(query: {
3747
3872
  /** Allow multiple symbols query, seperated by ',' */
3748
3873
  symbols: string;
3749
3874
  /**
@@ -3758,22 +3883,17 @@ export class Quote<HandleError extends boolean = boolean> {
3758
3883
  user_name?: string;
3759
3884
  /** @default "" */
3760
3885
  platform?: string;
3761
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTimeSell[], HandleError>>;
3886
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSnapshot[], HandleError>>;
3762
3887
  /**
3763
3888
  * @tags Quote
3764
- * @name GetIntradayChart
3765
- * @summary Query intra-day Day Chart and Minute Chart - All users
3766
- * @request GET:/api/quote/intraday-chart
3889
+ * @name GetLevel1
3890
+ * @summary Query full Level 1 data - All users
3891
+ * @request GET:/api/quote/level1
3767
3892
  * @secure
3768
3893
  */
3769
- getIntradayChart(query: {
3770
- /** Allow one symbol */
3771
- symbol: string;
3772
- /**
3773
- * 'D' for day chart, 'M' for minute chart
3774
- * @default "D"
3775
- */
3776
- day_minute?: string;
3894
+ getLevel1(query: {
3895
+ /** Allow multiple symbols, separated by ',' */
3896
+ symbols: string;
3777
3897
  /**
3778
3898
  * Optional. Default is false. If true, response will be camel case
3779
3899
  * @default false
@@ -3786,28 +3906,17 @@ export class Quote<HandleError extends boolean = boolean> {
3786
3906
  user_name?: string;
3787
3907
  /** @default "" */
3788
3908
  platform?: string;
3789
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasChartBar[], HandleError>>;
3909
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasLevel1[], HandleError>>;
3790
3910
  /**
3791
3911
  * @tags Quote
3792
- * @name GetHistoricalDayChart
3793
- * @summary Query Historical Day Chart - All users
3794
- * @request GET:/api/quote/historical-day-chart
3912
+ * @name GetRegionQuotes
3913
+ * @summary Query Region Quotes from Tick data - All users
3914
+ * @request GET:/api/quote/region-quotes
3795
3915
  * @secure
3796
3916
  */
3797
- getHistoricalDayChart(query: {
3917
+ getRegionQuotes(query: {
3798
3918
  /** Allow one symbol */
3799
3919
  symbol: string;
3800
- /**
3801
- * Year for day cart, format: yyyy. Optional. If both 'year' and 'month' is blank, will use current year.
3802
- * @default ""
3803
- */
3804
- year?: string;
3805
- /**
3806
- * how many months back from today, range from 1~12. Optional. If use this parameter, please leave parameter 'year' blank.
3807
- * @format int32
3808
- * @default 0
3809
- */
3810
- month?: number;
3811
3920
  /**
3812
3921
  * Optional. Default is false. If true, response will be camel case
3813
3922
  * @default false
@@ -3820,19 +3929,17 @@ export class Quote<HandleError extends boolean = boolean> {
3820
3929
  user_name?: string;
3821
3930
  /** @default "" */
3822
3931
  platform?: string;
3823
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDayChart[], HandleError>>;
3932
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasRegionQuote[], HandleError>>;
3824
3933
  /**
3825
3934
  * @tags Quote
3826
- * @name GetHistoricalMinuteChart
3827
- * @summary Query Historical Minute Chart - All users
3828
- * @request GET:/api/quote/historical-minute-chart
3935
+ * @name GetNightSessionRegionQuotesOnbbo
3936
+ * @summary Query ONBBO Region Quotes(Level2) from Tick data - All users - available in Microservice
3937
+ * @request GET:/api/quote/night-session/region-quotes/onbbo
3829
3938
  * @secure
3830
3939
  */
3831
- getHistoricalMinuteChart(query: {
3940
+ getNightSessionRegionQuotesOnbbo(query: {
3832
3941
  /** Allow one symbol */
3833
3942
  symbol: string;
3834
- /** Date for minute chart, format: yyyy-MM-dd, optional, default: yesterday date */
3835
- date?: string;
3836
3943
  /**
3837
3944
  * Optional. Default is false. If true, response will be camel case
3838
3945
  * @default false
@@ -3845,15 +3952,194 @@ export class Quote<HandleError extends boolean = boolean> {
3845
3952
  user_name?: string;
3846
3953
  /** @default "" */
3847
3954
  platform?: string;
3848
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasMinuteChart[], HandleError>>;
3955
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasRegionQuote[], HandleError>>;
3849
3956
  /**
3850
3957
  * @tags Quote
3851
- * @name GetTop20
3852
- * @summary Query Top20 data - All users
3853
- * @request GET:/api/quote/top-20
3958
+ * @name GetTimeSale
3959
+ * @summary Query TimeSale from Tick data - All users
3960
+ * @request GET:/api/quote/time-sale
3854
3961
  * @secure
3855
3962
  */
3856
- getTop20(query?: {
3963
+ getTimeSale(query: {
3964
+ /** Allow one symbol */
3965
+ symbol: string;
3966
+ /**
3967
+ * Optional. Default is false. If true, response will be camel case
3968
+ * @default false
3969
+ */
3970
+ response_camel_case?: boolean;
3971
+ /**
3972
+ * Optional. Must input if enterprise user query on behave of their clients
3973
+ * @default ""
3974
+ */
3975
+ user_name?: string;
3976
+ /** @default "" */
3977
+ platform?: string;
3978
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTimeSell[], HandleError>>;
3979
+ /**
3980
+ * @tags Quote
3981
+ * @name GetNightSessionTimeSaleOnbbo
3982
+ * @summary Query ONBBO TimeSale from Tick data - All users - available in Microservice
3983
+ * @request GET:/api/quote/night-session/time-sale/onbbo
3984
+ * @secure
3985
+ */
3986
+ getNightSessionTimeSaleOnbbo(query: {
3987
+ /** Allow one symbol */
3988
+ symbol: string;
3989
+ /**
3990
+ * Optional. Default is false. If true, response will be camel case
3991
+ * @default false
3992
+ */
3993
+ response_camel_case?: boolean;
3994
+ /**
3995
+ * Optional. Must input if enterprise user query on behave of their clients
3996
+ * @default ""
3997
+ */
3998
+ user_name?: string;
3999
+ /** @default "" */
4000
+ platform?: string;
4001
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTimeSell[], HandleError>>;
4002
+ /**
4003
+ * @tags Quote
4004
+ * @name GetLastTrade
4005
+ * @summary Query Last Trade(Level 2 data) - All users
4006
+ * @request GET:/api/quote/last-trade
4007
+ * @secure
4008
+ */
4009
+ getLastTrade(query: {
4010
+ /** Allow multiple symbols query, seperated by ',' */
4011
+ symbols: string;
4012
+ /**
4013
+ * Optional. Default is false. If true, response will be camel case
4014
+ * @default false
4015
+ */
4016
+ response_camel_case?: boolean;
4017
+ /**
4018
+ * Optional. Must input if enterprise user query on behave of their clients
4019
+ * @default ""
4020
+ */
4021
+ user_name?: string;
4022
+ /** @default "" */
4023
+ platform?: string;
4024
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTimeSell[], HandleError>>;
4025
+ /**
4026
+ * @tags Quote
4027
+ * @name GetNightSessionLastTradeOnbbo
4028
+ * @summary Query ONBBO Last Trade(Level 2 data) - All users - available in Microservice
4029
+ * @request GET:/api/quote/night-session/last-trade/onbbo
4030
+ * @secure
4031
+ */
4032
+ getNightSessionLastTradeOnbbo(query: {
4033
+ /** Allow multiple symbols query, seperated by ',' */
4034
+ symbols: string;
4035
+ /**
4036
+ * Optional. Default is false. If true, response will be camel case
4037
+ * @default false
4038
+ */
4039
+ response_camel_case?: boolean;
4040
+ /**
4041
+ * Optional. Must input if enterprise user query on behave of their clients
4042
+ * @default ""
4043
+ */
4044
+ user_name?: string;
4045
+ /** @default "" */
4046
+ platform?: string;
4047
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTimeSell[], HandleError>>;
4048
+ /**
4049
+ * @tags Quote
4050
+ * @name GetIntradayChart
4051
+ * @summary Query intra-day Day Chart and Minute Chart - All users
4052
+ * @request GET:/api/quote/intraday-chart
4053
+ * @secure
4054
+ */
4055
+ getIntradayChart(query: {
4056
+ /** Allow one symbol */
4057
+ symbol: string;
4058
+ /**
4059
+ * 'D' for day chart, 'M' for minute chart
4060
+ * @default "D"
4061
+ */
4062
+ day_minute?: string;
4063
+ /**
4064
+ * Optional. Default is false. If true, response will be camel case
4065
+ * @default false
4066
+ */
4067
+ response_camel_case?: boolean;
4068
+ /**
4069
+ * Optional. Must input if enterprise user query on behave of their clients
4070
+ * @default ""
4071
+ */
4072
+ user_name?: string;
4073
+ /** @default "" */
4074
+ platform?: string;
4075
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasChartBar[], HandleError>>;
4076
+ /**
4077
+ * @tags Quote
4078
+ * @name GetHistoricalDayChart
4079
+ * @summary Query Historical Day Chart - All users
4080
+ * @request GET:/api/quote/historical-day-chart
4081
+ * @secure
4082
+ */
4083
+ getHistoricalDayChart(query: {
4084
+ /** Allow one symbol */
4085
+ symbol: string;
4086
+ /**
4087
+ * Year for day cart, format: yyyy. Optional. If both 'year' and 'month' is blank, will use current year.
4088
+ * @default ""
4089
+ */
4090
+ year?: string;
4091
+ /**
4092
+ * how many months back from today, range from 1~12. Optional. If use this parameter, please leave parameter 'year' blank.
4093
+ * @format int32
4094
+ * @default 0
4095
+ */
4096
+ month?: number;
4097
+ /**
4098
+ * Optional. Default is false. If true, response will be camel case
4099
+ * @default false
4100
+ */
4101
+ response_camel_case?: boolean;
4102
+ /**
4103
+ * Optional. Must input if enterprise user query on behave of their clients
4104
+ * @default ""
4105
+ */
4106
+ user_name?: string;
4107
+ /** @default "" */
4108
+ platform?: string;
4109
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasDayChart[], HandleError>>;
4110
+ /**
4111
+ * @tags Quote
4112
+ * @name GetHistoricalMinuteChart
4113
+ * @summary Query Historical Minute Chart - All users
4114
+ * @request GET:/api/quote/historical-minute-chart
4115
+ * @secure
4116
+ */
4117
+ getHistoricalMinuteChart(query: {
4118
+ /** Allow one symbol */
4119
+ symbol: string;
4120
+ /** Date for minute chart, format: yyyy-MM-dd, optional, default: yesterday date */
4121
+ date?: string;
4122
+ /**
4123
+ * Optional. Default is false. If true, response will be camel case
4124
+ * @default false
4125
+ */
4126
+ response_camel_case?: boolean;
4127
+ /**
4128
+ * Optional. Must input if enterprise user query on behave of their clients
4129
+ * @default ""
4130
+ */
4131
+ user_name?: string;
4132
+ /** @default "" */
4133
+ platform?: string;
4134
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasMinuteChart[], HandleError>>;
4135
+ /**
4136
+ * @tags Quote
4137
+ * @name GetTop20
4138
+ * @summary Query Top20 data - All users
4139
+ * @request GET:/api/quote/top-20
4140
+ * @secure
4141
+ */
4142
+ getTop20(query?: {
3857
4143
  /**
3858
4144
  * Optional. Default is false. If true, response will be camel case
3859
4145
  * @default false
@@ -4544,277 +4830,24 @@ export class Quote<HandleError extends boolean = boolean> {
4544
4830
  /** @default "" */
4545
4831
  platform?: string;
4546
4832
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasPolygonTop[], HandleError>>;
4547
- }
4548
- export class QuotesReformat<HandleError extends boolean = boolean> {
4549
- protected readonly apiClient: JwtClient<HandleError>;
4550
- constructor(apiClient: JwtClient<HandleError>);
4551
- /**
4552
- * @tags QuotesReformat
4553
- * @name GetEquity
4554
- * @summary Query full Level 1 data - All users
4555
- * @request GET:/api/quotes/equity
4556
- * @secure
4557
- */
4558
- getEquity(query: {
4559
- /** Allow multiple symbols, separated by ',' */
4560
- symbols: string;
4561
- /** @default "" */
4562
- platform?: string;
4563
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4564
- /**
4565
- * @tags QuotesReformat
4566
- * @name GetEquityCboe
4567
- * @summary TEMPORARY ENDPOINT: Query US Realtime data from CBOE1 - All users
4568
- * @request GET:/api/quotes/equity/cboe
4569
- * @secure
4570
- */
4571
- getEquityCboe(query: {
4572
- /** Allow multiple symbols, separated by ',' */
4573
- symbols: string;
4574
- /** @default "" */
4575
- platform?: string;
4576
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4577
- /**
4578
- * @tags QuotesReformat
4579
- * @name GetEquityIntraday
4580
- * @summary Query intra-day and historical Minute Chart. If no days range provided, it return intraday chart. rsiSpan is no supported. All Volume is raw Volume. - All users
4581
- * @request GET:/api/quotes/equity/intraday
4582
- * @secure
4583
- */
4584
- getEquityIntraday(query: {
4585
- /** Allow one symbol */
4586
- symbol: string;
4587
- /** optional timestamp format for multiday charts. Timestamp format: yyyy-MM-dd HH:mm:ss */
4588
- from?: string;
4589
- /** optional timestamp format for multiday charts. Timestamp format: yyyy-MM-dd HH:mm:ss */
4590
- to?: string;
4591
- /** @default "" */
4592
- platform?: string;
4593
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4594
4833
  /**
4595
- * @tags QuotesReformat
4596
- * @name GetEquityHistorical
4597
- * @summary Query Historical Day Chart. No weekly data point support yet. No rsiSpan support. - All users
4598
- * @request GET:/api/quotes/equity/historical
4599
- * @secure
4600
- */
4601
- getEquityHistorical(query: {
4602
- /** Allow one symbol */
4603
- symbol: string;
4604
- /** start date (MM/dd/yyyy) */
4605
- start?: string;
4606
- /** end date (MM/dd/yyyy) */
4607
- end?: string;
4608
- /**
4609
- * If start and end are not specified, then range needs to be given. Format: [num][y/m/w] (y – year, m – months, w - weeks). num specifies number of (y/m) back from current date
4610
- * @default ""
4611
- */
4612
- range?: string;
4613
- /** @default "" */
4614
- platform?: string;
4615
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4616
- /**
4617
- * @tags QuotesReformat
4618
- * @name GetSearch
4619
- * @summary To search for a company and the exact ticker symbol is not known, use this endpoint for a string search. - All users
4620
- * @request GET:/api/quotes/search
4621
- * @secure
4622
- */
4623
- getSearch(query: {
4624
- /** String to search for */
4625
- criteria: string;
4626
- /**
4627
- * Maximum number of results to return (default is 20)
4628
- * @format int32
4629
- * @default 20
4630
- */
4631
- limit?: number;
4632
- /**
4633
- * Whether to load quotes for the results or not
4634
- * @default false
4635
- */
4636
- loadQuotes?: boolean;
4637
- /** include countries. For example, if only want to display US symbols, please send 'US' in this parameter */
4638
- includeCountries?: string;
4639
- /**
4640
- * include mutual fund in search results
4641
- * @default false
4642
- */
4643
- includeMF?: boolean;
4644
- /**
4645
- * filter out quotes not found symbols. This parameter only works if 'loadQuotes' is true.
4646
- * @default false
4647
- */
4648
- excludeNotFound?: boolean;
4649
- /** @default "" */
4650
- platform?: string;
4651
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4652
- /**
4653
- * @tags QuotesReformat
4654
- * @name GetSearchRedis
4655
- * @summary TEST Redis symbol search. - All users - available in Microservice version
4656
- * @request GET:/api/quotes/search-redis
4657
- * @secure
4658
- */
4659
- getSearchRedis(query: {
4660
- /** String to search for */
4661
- criteria: string;
4662
- /**
4663
- * Maximum number of results to return (default is 20)
4664
- * @format int32
4665
- * @default 20
4666
- */
4667
- limit?: number;
4668
- /**
4669
- * Whether to load quotes for the results or not
4670
- * @default false
4671
- */
4672
- loadQuotes?: boolean;
4673
- /**
4674
- * include mutual fund in search results
4675
- * @default false
4676
- */
4677
- includeMF?: boolean;
4678
- /**
4679
- * filter out quotes not found symbols. This parameter only works if 'loadQuotes' is true.
4680
- * @default false
4681
- */
4682
- excludeNotFound?: boolean;
4683
- /** @default "" */
4684
- platform?: string;
4685
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4686
- /**
4687
- * @tags QuotesReformat
4688
- * @name GetOption
4689
- * @summary Query Option Level 1 data - All users
4690
- * @request GET:/api/quotes/option
4691
- * @secure
4692
- */
4693
- getOption(query: {
4694
- /** Option symbol. Format {Underlying Symbol}yymmdd{C/P}{Strike price*1000, total 8 digits} */
4695
- symbols: string;
4696
- /**
4697
- * if include greek letter value in response
4698
- * @default false
4699
- */
4700
- greeks?: boolean;
4701
- /** @default "" */
4702
- platform?: string;
4703
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4704
- /**
4705
- * @tags QuotesReformat
4706
- * @name GetOptionChainDates
4707
- * @summary Query Option Chain dates - All users
4708
- * @request GET:/api/quotes/option/chain/dates/{symbol}
4709
- * @secure
4710
- */
4711
- getOptionChainDates(symbol: string, query?: {
4712
- /** @default "" */
4713
- platform?: string;
4714
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4715
- /**
4716
- * @tags QuotesReformat
4717
- * @name GetOptionChain
4718
- * @summary Query Option Chain data - All users
4719
- * @request GET:/api/quotes/option/chain/{symbol}/{date}
4720
- * @secure
4721
- */
4722
- getOptionChain(symbol: string, date: string, query?: {
4723
- /** @default "" */
4724
- platform?: string;
4725
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4726
- /**
4727
- * @tags QuotesReformat
4728
- * @name GetOptionHistorical
4729
- * @summary Query option Day Chart. No weekly data point support yet. No rsiSpan support. - All users
4730
- * @request GET:/api/quotes/option/historical
4731
- * @secure
4732
- */
4733
- getOptionHistorical(query: {
4734
- /** Allow one symbol */
4735
- symbol: string;
4736
- /** start date (MM/dd/yyyy) */
4737
- start?: string;
4738
- /** end date (MM/dd/yyyy) */
4739
- end?: string;
4740
- /**
4741
- * If start and end are not specified, then range needs to be given. Format: [num][y/m] (y – year, m – months). num specifies number of (y/m) back from current date
4742
- * @default ""
4743
- */
4744
- range?: string;
4745
- /** @default "" */
4746
- platform?: string;
4747
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4748
- /**
4749
- * @tags QuotesReformat
4750
- * @name GetBonds
4751
- * @summary Query Bonds data - All users
4752
- * @request GET:/api/quotes/bonds
4753
- * @secure
4754
- */
4755
- getBonds(query: {
4756
- /** ISIN, allow multiple query separated by ',' */
4757
- identifiers: string;
4758
- /**
4759
- * Price type, default is Percentage. ('Percentage'|'Decimal')
4760
- * @default "Percentage"
4761
- */
4762
- bondPriceType?: string;
4763
- /**
4764
- * Quantity type, default is Par. ('Par'|'Unit')
4765
- * @default "Par"
4766
- */
4767
- bondQuantityType?: string;
4768
- /** @default "" */
4769
- platform?: string;
4770
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4771
- /**
4772
- * @tags QuotesReformat
4773
- * @name GetBondsSearch
4774
- * @summary Search bonds - All users
4775
- * @request GET:/api/quotes/bonds/search
4834
+ * @tags Quote
4835
+ * @name GetOptionCorporateActions
4836
+ * @summary Query OCC corporate actions by symbol and optional publish date range
4837
+ * @request GET:/api/quote/option-corporate-actions
4776
4838
  * @secure
4777
4839
  */
4778
- getBondsSearch(query: {
4779
- /** search string */
4780
- criteria: string;
4781
- /**
4782
- * how many records that need to return, 20 is maximum
4783
- * @format int32
4784
- * @default 20
4785
- */
4786
- limit?: number;
4787
- /**
4788
- * if return bonds quote. If false, will only return ISIN list
4789
- * @default false
4790
- */
4791
- loadQuotes?: boolean;
4792
- /**
4793
- * Price type, default is Percentage. ('Percentage'|'Decimal')
4794
- * @default "Percentage"
4795
- */
4796
- bondPriceType?: string;
4797
- /**
4798
- * Quantity type, default is Par. ('Par'|'Unit')
4799
- * @default "Par"
4800
- */
4801
- bondQuantityType?: string;
4840
+ getOptionCorporateActions(query?: {
4841
+ symbol?: string;
4842
+ date_from?: string;
4843
+ date_to?: string;
4844
+ /** @default false */
4845
+ response_camel_case?: boolean;
4802
4846
  /** @default "" */
4803
- platform?: string;
4804
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4805
- /**
4806
- * @tags QuotesReformat
4807
- * @name GetQuotesReformat
4808
- * @summary Query Forex rate - All users
4809
- * @request GET:/api/quotes/fx
4810
- * @secure
4811
- */
4812
- getQuotesReformat(query: {
4813
- /** base_currency/quote_currecy. Can query multiple, separated with ',' */
4814
- symbols: string;
4847
+ user_name?: string;
4815
4848
  /** @default "" */
4816
4849
  platform?: string;
4817
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4850
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4818
4851
  }
4819
4852
  export class UmaTest<HandleError extends boolean = boolean> {
4820
4853
  protected readonly apiClient: JwtClient<HandleError>;