@stoqey/ib 1.3.6 → 1.3.8

package/dist/api-next/api-next.d.ts

@@ -1,10 +1,11 @@
 import { Observable, Subject } from "rxjs";
-import { Bar, CommissionReport, Contract, ContractDetails, DepthMktDataDescription, DurationUnit, ExecutionFilter, HistogramEntry, HistoricalTick, HistoricalTickBidAsk, HistoricalTickLast, TagValue, OrderBookUpdate, Order, OpenOrder, BarSizeSetting, ExecutionDetail, ContractDescription, SecType } from "../";
+import { Bar, BarSizeSetting, CommissionReport, Contract, ContractDescription, ContractDetails, DepthMktDataDescription, DurationUnit, ExecutionDetail, ExecutionFilter, HistogramEntry, HistoricalTick, HistoricalTickBidAsk, HistoricalTickLast, OpenOrder, Order, OrderBookUpdate, ScannerSubscription, SecType, TagValue } from "../";
 import LogLevel from "../api/data/enum/log-level";
 import { MutableMarketData } from "../core/api-next/api/market/mutable-market-data";
 import { IBApiNextLogger } from "../core/api-next/logger";
-import { AccountPositionsUpdate, AccountSummariesUpdate, ConnectionState, SecurityDefinitionOptionParameterType, IBApiNextError, MarketDataType, MarketDataUpdate, OpenOrdersUpdate, PnL, PnLSingle, AccountUpdatesUpdate } from "./";
+import { AccountPositionsUpdate, AccountSummariesUpdate, AccountUpdatesUpdate, ConnectionState, IBApiNextError, MarketDataType, MarketDataUpdate, OpenOrdersUpdate, PnL, PnLSingle, SecurityDefinitionOptionParameterType } from "./";
 import { Logger } from "./common/logger";
+import { MarketScannerUpdate } from "./market-scanner/market-scanner";
 /**
  * Input arguments on the [[IBApiNext]] constructor.
  */
@@ -136,7 +137,7 @@ export declare class IBApiNext {
      */
     disconnect(): IBApiNext;
     /** currentTime event handler.  */
-    private onCurrentTime;
+    private readonly onCurrentTime;
     /**
      * Get TWS's current time.
      */
@@ -533,7 +534,7 @@ export declare class IBApiNext {
     getMarketDepthExchanges(): Promise<DepthMktDataDescription[]>;
     /** updateMktDepth event handler */
     private readonly onUpdateMktDepth;
-    private readonly insertAtIndex;
+    private insertAtMapIndex;
     /** marketDepthL2 event handler */
     private readonly onUpdateMktDepthL2;
     /**
@@ -550,6 +551,39 @@ export declare class IBApiNext {
      * @param mktDepthOptions TODO document
      */
     getMarketDepth(contract: Contract, numRows: number, isSmartDepth: boolean, mktDepthOptions?: TagValue[]): Observable<OrderBookUpdate>;
+    private readonly onScannerParameters;
+    /**
+     * Requests an XML string that describes all possible scanner queries.
+     */
+    getScannerParameters(): Promise<string>;
+    /**
+     * Provides the data resulting from the market scanner request.
+     * @param subscriptions
+     * @param reqId the request's identifier
+     * @param rank the ranking within the response of this bar.
+     * @param contract the data's ContractDetails
+     * @param distance according to query
+     * @param benchmark according to query
+     * @param projection according to query
+     * @param legStr describes the combo legs when the scanner is returning EFP
+     * @returns void
+     */
+    private readonly onScannerData;
+    /**
+     * Indicates the scanner data reception has terminated.
+     * @param subscriptions
+     * @param reqId the request's identifier
+     * @returns
+     */
+    private readonly onScannerDataEnd;
+    /**
+     * It returns an observable that will emit a list of scanner subscriptions.
+     * @param {ScannerSubscription} scannerSubscription - ScannerSubscription
+     * @param {TagValue[]} [scannerSubscriptionOptions] - An array of TagValue objects.
+     * @param {TagValue[]} [scannerSubscriptionFilterOptions] - An optional array of TagValue objects.
+     * @returns An observable that will emit a list of items.
+     */
+    getMarketScanner(scannerSubscription: ScannerSubscription, scannerSubscriptionOptions?: TagValue[], scannerSubscriptionFilterOptions?: TagValue[]): Observable<MarketScannerUpdate>;
     /** histogramData event handler */
     private readonly onHistogramData;
     /**
@@ -706,4 +740,10 @@ export declare class IBApiNext {
      * @param pattern Either start of ticker symbol or (for larger strings) company name.
      */
     searchContracts(pattern: string): Promise<ContractDescription[]>;
+    /** userInfo event handler. */
+    private readonly onUserInfo;
+    /**
+     * Get the user info of the logged user.
+     */
+    getUserInfo(): Promise<string>;
 }