Stoqey IB

https://stoqey.github.io/ib-doc
Admin
Stoqey IB is an Interactive Brokers TWS (or IB Gateway) TypeScript API client library for Node.js.
Tokens:28,187
Snippets:296
Trust Score:8.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install @stoqey/ib via npm

Source: https://stoqey.github.io/ib-doc/index.html

Use this command to install the package using npm.

```bash
$ npm install @stoqey/ib
```

--------------------------------

### Install @stoqey/ib via yarn

Source: https://stoqey.github.io/ib-doc/index.html

Use this command to install the package using yarn.

```bash
$ yarn add @stoqey/ib
```

--------------------------------

### connectionState

Source: https://stoqey.github.io/ib-doc/classes/IBApiNext.html

Get an Observable for observing the connection-state.

```APIDOC
## get connectionState()

### Description
Get an Observable for observing the connection-state.

### Returns
- **Observable<ConnectionState>**
```

--------------------------------

### reqScannerSubscription(reqId, subscription, scannerSubscriptionOptions, scannerSubscriptionFilterOptions)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Starts a subscription to market scan results.

```APIDOC
## reqScannerSubscription(reqId, subscription, scannerSubscriptionOptions, scannerSubscriptionFilterOptions)

### Description
Starts a subscription to market scan results based on the provided parameters.

### Parameters
- **reqId** (number) - The request's identifier.
- **subscription** (ScannerSubscription) - Summary of the scanner subscription including its filters.
- **scannerSubscriptionOptions** (TagValue[]) - Optional configuration.
- **scannerSubscriptionFilterOptions** (TagValue[]) - Optional filter configuration.

### Returns
- **IBApi** - The API instance.
```

--------------------------------

### Handle pnlSingle events (Current)

Source: https://stoqey.github.io/ib-doc/index.html

Example of handling pnlSingle events in versions 1.2.1 and later, where unavailable values return undefined.

```typescript
ib.on(EventName.pnlSingle, (  
      reqId: number,  
      pos: number,  
      dailyPnL: number,  
      unrealizedPnL: number | undefined,  
      realizedPnL: number | undefined,  
      value: number  
    ) => {  
      ...  
    }  
  );
```

--------------------------------

### logLevel

Source: https://stoqey.github.io/ib-doc/classes/IBApiNext.html

Get or set the current log level.

```APIDOC
## get logLevel()

### Description
Get the current log level.

### Returns
- **LogLevel**

## set logLevel(level)

### Description
Set the current log level.

### Parameters
- **level** (LogLevel) - Required - The log level to set.
```

--------------------------------

### Handle pnlSingle events (Legacy)

Source: https://stoqey.github.io/ib-doc/index.html

Example of handling pnlSingle events in versions up to 1.1.x where unavailable values return Number.MAX_VALUE.

```typescript
ib.on(EventName.pnlSingle, (  
      reqId: number,  
      pos: number,  
      dailyPnL: number,  
      unrealizedPnL: number,  
      realizedPnL: number,  
      value: number  
    ) => {  
      ...  
    }  
  );
```

--------------------------------

### Local development and testing commands

Source: https://stoqey.github.io/ib-doc/index.html

Commands for setting up the environment, building the project, and managing the IB Gateway container.

```bash
yarn
```

```bash
cp sample.env .env
```

```bash
yarn build
```

```bash
docker-compose up
```

```bash
docker-compose down
```

--------------------------------

### getManagedAccounts

Source: https://stoqey.github.io/ib-doc/classes/IBApiNext.html

Get the accounts to which the logged user has access to.

```APIDOC
## getManagedAccounts()

### Description
Get the accounts to which the logged user has access to.

### Returns
- Promise<string[]>
```

--------------------------------

### Run account summary tool

Source: https://stoqey.github.io/ib-doc/index.html

Executes the account summary command-line tool with specified parameters.

```bash
node ./dist/tools/account-summary.js -group=All -tags="NetLiquidation,MaintMarginReq" -watch -inc -port=4002
```

--------------------------------

### constructor

Source: https://stoqey.github.io/ib-doc/classes/Option.html

Creates a new instance of an Option contract.

```APIDOC
## constructor

### Description
Creates a new instance of an Option contract.

### Signature
`new Option(symbol: string, expiry: string, strike: number, right: OptionType, exchange?: string, currency?: string): Option`

### Parameters
- **symbol** (string) - The asset symbol.
- **expiry** (string) - The option expiry date.
- **strike** (number) - The option's strike price.
- **right** (OptionType) - Either Put or Call (P, PUT, C, CALL).
- **exchange** (string) - Optional. The destination exchange.
- **currency** (string) - Optional. The trading currency.
```

--------------------------------

### getHistogramData

Source: https://stoqey.github.io/ib-doc/classes/IBApiNext.html

Get data histogram of specified contract.

```APIDOC
## getHistogramData(contract: Contract, useRTH: boolean, duration: number, durationUnit: DurationUnit)

### Description
Get data histogram of specified contract.

### Parameters
- **contract** (Contract) - Required - Contract object for which histogram is being requested.
- **useRTH** (boolean) - Required - Use regular trading hours only.
- **duration** (number) - Required - Period duration of which data is being requested.
- **durationUnit** (DurationUnit) - Required - Duration unit of which data is being requested.

### Returns
- **Promise<HistogramEntry[]>** - A promise that resolves to an array of histogram entries.
```

--------------------------------

### getExecutionDetails

Source: https://stoqey.github.io/ib-doc/classes/IBApiNext.html

Get execution details of all executed trades.

```APIDOC
## getExecutionDetails(filter: ExecutionFilter)

### Description
Get execution details of all executed trades.

### Parameters
- **filter** (ExecutionFilter) - Required - Filter trade data on ExecutionFilter.

### Returns
- **Promise<ExecutionDetail[]>** - A promise that resolves to an array of execution details.
```

--------------------------------

### on(event: 'symbolSamples', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for symbol sample contract descriptions.

```APIDOC
## on(event: 'symbolSamples', listener)

### Description
Registers a callback function to receive an array of sample contract descriptions.

### Parameters
- **reqId** (number) - The id of the request.
- **contractDescriptions** (ContractDescription[]) - An array of ContractDescription objects.

### Returns
- **IBApi** - The IBApi instance.
```

--------------------------------

### new IBApi(options?)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Creates a new instance of the IBApi client.

```APIDOC
## new IBApi(options?)

### Description
Creates a new IB API object instance.

### Parameters
- **options** (IBApiCreationOptions) - Optional - Creation options.
```

--------------------------------

### getCurrentTime

Source: https://stoqey.github.io/ib-doc/classes/IBApiNext.html

Get TWS's current time.

```APIDOC
## getCurrentTime()

### Description
Get TWS's current time.

### Returns
- **Promise<number>** - A promise that resolves to the current system time.
```

--------------------------------

### on(event: 'realtimeBar', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for real-time 5-second bar updates.

```APIDOC
## on(event: 'realtimeBar', listener)

### Description
Registers a callback function to receive updates for real-time 5-second bars.

### Parameters
- **reqId** (number) - The request ID.
- **date** (number) - The bar's date and time (Epoch/Unix time).
- **open** (number) - The bar's open point.
- **high** (number) - The bar's high point.
- **low** (number) - The bar's low point.
- **close** (number) - The bar's closing point.
- **volume** (number) - The bar's traded volume.
- **WAP** (number) - The bar's Weighted Average Price.
- **count** (number) - The number of trades during the bar's timespan.
```

--------------------------------

### on(event: 'receiveFA', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for Financial Advisor configuration data.

```APIDOC
## on(event: 'receiveFA', listener)

### Description
Registers a callback function to receive Financial Advisor configuration data from TWS.

### Parameters
- **faDataType** (number) - The type of FA data (1: Groups, 2: Profiles, 3: Account Aliases).
- **faXmlData** (string) - The XML-formatted configuration data.
```

--------------------------------

### getCommissionReport

Source: https://stoqey.github.io/ib-doc/classes/IBApiNext.html

Get commission report details of all executed trades.

```APIDOC
## getCommissionReport(filter: ExecutionFilter)

### Description
Get commission report details of all executed trades.

### Parameters
- **filter** (ExecutionFilter) - Required - Filter trade data on ExecutionFilter.

### Returns
- **Promise<CommissionReport[]>** - A promise that resolves to an array of commission reports.
```

--------------------------------

### error

Source: https://stoqey.github.io/ib-doc/classes/IBApiNext.html

Get an Observable to receive errors on IB API.

```APIDOC
## get error()

### Description
Get an Observable to receive errors on IB API. Errors that have a valid request id, will additionally be sent to the observers of the request.

### Returns
- **Observable<IBApiNextError>**
```

--------------------------------

### new IBApiNext(options?)

Source: https://stoqey.github.io/ib-doc/classes/IBApiNext.html

Creates a new instance of the IBApiNext class.

```APIDOC
## Constructor

### Description
Creates an IBApiNext object.

### Parameters
- **options** (IBApiNextCreationOptions) - Optional - Creation options.
```

--------------------------------

### on(event: 'pnlSingle', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for real-time PnL updates for a single position.

```APIDOC
## on(event: 'pnlSingle', listener)

### Description
Registers a callback function to receive real-time updates for daily PnL values of a single position.

### Parameters
- **event** (string) - Required - Must be 'pnlSingle'.
- **listener** (function) - Required - Callback function with signature: (reqId: number, pos: number, dailyPnL: number, unrealizedPnL: number, realizedPnL: number, value: number) => void.

### Returns
- **IBApi** - Returns the IBApi instance for chaining.
```

--------------------------------

### getHeadTimestamp

Source: https://stoqey.github.io/ib-doc/classes/IBApiNext.html

Get the timestamp of earliest available historical data for a contract and data type.

```APIDOC
## getHeadTimestamp(contract: Contract, whatToShow: WhatToShow, useRTH: boolean, formatDate: number)

### Description
Get the timestamp of earliest available historical data for a contract and data type.

### Parameters
- **contract** (Contract) - Required - Contract object for which head timestamp is being requested.
- **whatToShow** (WhatToShow) - Required - Type of data for head timestamp.
- **useRTH** (boolean) - Required - Use regular trading hours only.
- **formatDate** (number) - Required - Set to 1 for yyyyMMdd HH:mm:ss, set to 2 for system time format in seconds.

### Returns
- **Promise<string>** - A promise that resolves to the head timestamp string.
```

--------------------------------

### on(event: 'tickByTickBidAsk', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for 'BidAsk' tick-by-tick real-time data.

```APIDOC
## on(event: 'tickByTickBidAsk', listener)

### Description
Registers a callback function to receive 'BidAsk' tick-by-tick real-time data.

### Parameters
- **reqId** (number) - The id of the request.
- **time** (number) - The tick-by-tick real-time tick timestamp.
- **bidPrice** (number) - The tick-by-tick real-time tick bid price.
- **askPrice** (number) - The tick-by-tick real-time tick ask price.
- **bidSize** (number) - The tick-by-tick real-time tick bid size.
- **askSize** (number) - The tick-by-tick real-time tick ask size.
- **tickAttribBidAsk** (unknown) - The tick-by-tick real-time bid/ask tick attributes.

### Returns
- **IBApi** - The IBApi instance.
```

--------------------------------

### on(event: 'accountSummary', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for account summary updates. The listener receives the request ID, account ID, attribute tag, attribute value, and currency.

```APIDOC
## on(event: 'accountSummary', listener)

### Description
Registers a callback function to handle account summary data updates. This event is triggered when account attributes are received.

### Parameters
- **event** (string) - Required - Must be 'accountSummary'.
- **listener** (function) - Required - Callback function with signature: (reqId: number, account: string, tag: string, value: string, currency: string) => void.
```

--------------------------------

### on(event: 'pnl', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for real-time account PnL updates, including daily and unrealized PnL.

```APIDOC
## on(event: 'pnl', listener)

### Description
Registers a callback function to receive real-time updates for daily PnL and total unrealized PnL for an account.

### Parameters
- **event** (string) - Required - Must be 'pnl'.
- **listener** (function) - Required - Callback function with signature: (reqId: number, dailyPnL: number, unrealizedPnL?: number, realizedPnL?: number) => void.

### Returns
- **IBApi** - Returns the IBApi instance for chaining.
```

--------------------------------

### on(event: 'openOrder', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for open order updates.

```APIDOC
## on(event: 'openOrder', listener)

### Description
Registers a callback to receive information about currently open orders.

### Parameters
- **event** (string) - 'openOrder'
- **listener** (function) - Callback receiving `orderId` (number), `contract` (Contract), `order` (Order), and `orderState` (OrderState).
```

--------------------------------

### on(event: 'softDollarTiers', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for soft dollar tiers information.

```APIDOC
## on(event: 'softDollarTiers', listener)

### Description
Registers a callback function to receive soft dollar tiers information.

### Parameters
- **reqId** (number) - The id of the request.
- **tiers** (SoftDollarTier[]) - An array of SoftDollarTier objects.

### Returns
- **IBApi** - The IBApi instance.
```

--------------------------------

### new MarketCloseOrder(action, totalQuantity, transmit?)

Source: https://stoqey.github.io/ib-doc/classes/MarketCloseOrder.html

Constructs a new MarketCloseOrder instance.

```APIDOC
## Constructor

### Signature
`new MarketCloseOrder(action: OrderAction, totalQuantity: number, transmit: boolean = true): MarketCloseOrder`

### Parameters
- **action** (OrderAction) - Required - The action to perform (e.g., BUY or SELL).
- **totalQuantity** (number) - Required - The total quantity for the order.
- **transmit** (boolean) - Optional - Whether to transmit the order immediately (default: true).
```

--------------------------------

### new MarketOrder(action, totalQuantity, transmit?, goodAfterTime?, goodTillDate?)

Source: https://stoqey.github.io/ib-doc/classes/MarketOrder.html

Creates a new instance of a MarketOrder.

```APIDOC
## Constructor

### Signature
`new MarketOrder(action: OrderAction, totalQuantity: number, transmit?: boolean, goodAfterTime?: string, goodTillDate?: string): MarketOrder`

### Parameters
- **action** (OrderAction) - Required - The action for the order.
- **totalQuantity** (number) - Required - The total quantity for the order.
- **transmit** (boolean) - Optional - Whether to transmit the order immediately.
- **goodAfterTime** (string) - Optional - The time after which the order becomes active.
- **goodTillDate** (string) - Optional - The date until which the order is valid.
```

--------------------------------

### IBApiNextCreationOptions

Source: https://stoqey.github.io/ib-doc/interfaces/IBApiNextCreationOptions.html

Interface defining the configuration options for the IBApiNext constructor.

```APIDOC
## Interface: IBApiNextCreationOptions

### Description
Configuration options for the IBApiNext constructor.

### Properties
- **connectionWatchdogInterval** (number) - Optional - The connection-watchdog timeout interval in seconds. Monitors socket activity; triggers reconnect if no response within this time. 0 or undefined disables it.
- **host** (string) - Optional - Hostname of the TWS or IB Gateway. Defaults to 'localhost'.
- **logger** (Logger) - Optional - Custom logger implementation. Defaults to console logging.
- **maxReqPerSec** (number) - Optional - Maximum number of requests per second sent to TWS/IB Gateway. Default is 40.
- **port** (number) - Optional - Port of the TWS or IB Gateway. Default is 7496.
- **reconnectInterval** (number) - Optional - The auto-reconnect interval in milliseconds. 0 or undefined disables auto-reconnect.
```

--------------------------------

### on(event: 'tickOptionComputation', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for option-specific market data computations.

```APIDOC
## on(event: 'tickOptionComputation', listener)

### Description
Provides a callback for option-specific market data, including implied volatility, delta, and other Greeks.

### Parameters
- **event** (string) - Required - Must be 'tickOptionComputation'
- **listener** (function) - Required - Callback function receiving (reqId, field, impliedVolatility, delta, optPrice, pvDividend, gamma, vega, theta, undPrice)
```

--------------------------------

### on(event: 'positionMulti', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for portfolio position updates.

```APIDOC
## on(event: 'positionMulti', listener)

### Description
Registers a callback function to receive updates for portfolio open positions.

### Parameters
- **reqId** (number) - The request ID.
- **account** (string) - The account holding the position.
- **modelCode** (string) - The model code holding the position.
- **contract** (Contract) - The position's contract details.
- **pos** (number) - The number of positions held.
- **avgCost** (number) - The average cost of the position.
```

--------------------------------

### on(event: 'tickEFP', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for EFP (Exchange for Physical) market data ticks.

```APIDOC
## on(event: 'tickEFP', listener)

### Description
Provides a callback for EFP market data ticks, including basis points and implied future prices.

### Parameters
- **event** (string) - Required - Must be 'tickEFP'
- **listener** (function) - Required - Callback function receiving (reqId, tickType, basisPoints, formattedBasisPoints, impliedFuture, holdDays, futureLastTradeDate, dividendImpact, dividendsToLastTradeDate)
```

--------------------------------

### new Combo(symbol, comboLegs, currency?, exchange?)

Source: https://stoqey.github.io/ib-doc/classes/Combo.html

Creates a new instance of a Combo contract.

```APIDOC
## Constructor

### Signature
`new Combo(symbol: string, comboLegs: ComboLeg[], currency?: string, exchange?: string): Combo`

### Parameters
- **symbol** (string) - The asset symbol.
- **comboLegs** (ComboLeg[]) - The legs of a combined contract definition.
- **currency** (string, optional) - The trading currency.
- **exchange** (string, optional) - The destination exchange.
```

--------------------------------

### on(event: 'accountUpdateMulti', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for multi-account updates, providing details on specific account parameters.

```APIDOC
## on(event: 'accountUpdateMulti', listener)

### Description
Registers a callback to receive updates for multiple accounts, including model codes and specific parameter keys.

### Parameters
- **event** (string) - Required - Must be 'accountUpdateMulti'.
- **listener** (function) - Required - Callback function with signature: (reqId: number, account: string, modelCode: string, key: string, value: string, currency: string) => void.
```

--------------------------------

### new Bond(symbol, maturity?, exchange?, currency?)

Source: https://stoqey.github.io/ib-doc/classes/Bond.html

Constructor to initialize a new Bond contract instance.

```APIDOC
## Constructor

### Signature
`new Bond(symbol: string, maturity?: string, exchange?: string, currency?: string): Bond`

### Description
Creates a new instance of a Bond contract.

### Parameters
- **symbol** (string) - Required - The asset symbol.
- **maturity** (string) - Optional - The maturity date of the bond.
- **exchange** (string) - Optional - The destination exchange.
- **currency** (string) - Optional - The trading currency.
```

--------------------------------

### getMarketData

Source: https://stoqey.github.io/ib-doc/classes/IBApiNext.html

Create a subscription to receive real time market data.

```APIDOC
## getMarketData(contract, genericTickList, snapshot, regulatorySnapshot)

### Description
Create a subscription to receive real time market data for an instrument.

### Parameters
- **contract** (Contract) - Required - The Contract for which the data is being requested.
- **genericTickList** (string) - Required - Comma separated ids of available generic ticks.
- **snapshot** (boolean) - Required - If true, returns a one-time snapshot; if false, provides endless streaming data.
- **regulatorySnapshot** (boolean) - Required - Snapshot for US stocks requesting NBBO snapshots.

### Returns
- Observable<MarketDataUpdate>
```

--------------------------------

### getAccountUpdates(acctCode?)

Source: https://stoqey.github.io/ib-doc/classes/IBApiNext.html

Creates a subscription to receive account and portfolio information, mirroring the TWS Account Window.

```APIDOC
## getAccountUpdates(acctCode?)

### Description
Creates a subscription to the TWS through which account and portfolio information is delivered. This information is the exact same as the one displayed within the TWS' Account Window.

### Parameters
- **acctCode** (string) - Optional - The specific account to retrieve. In a single account structure, this is not necessary.

### Returns
- **Observable<AccountUpdatesUpdate>** - An observable stream of account and portfolio updates.
```

--------------------------------

### WhatToShow

Source: https://stoqey.github.io/ib-doc/variables/WhatToShow-1.html

A constant object defining the available data types for historical bar requests.

```APIDOC
## WhatToShow

### Description
An enumeration of string constants used to specify the type of data to retrieve when requesting historical bars from Interactive Brokers.

### Members
- **ADJUSTED_LAST**: "ADJUSTED_LAST"
- **ASK**: "ASK"
- **BID**: "BID"
- **BID_ASK**: "BID_ASK"
- **HISTORICAL_VOLATILITY**: "HISTORICAL_VOLATILITY"
- **MIDPOINT**: "MIDPOINT"
- **None**: ""
- **OPTION_IMPLIED_VOLATILITY**: "OPTION_IMPLIED_VOLATILITY"
- **SCHEDULE**: "SCHEDULE"
- **TRADES**: "TRADES"
- **YIELD_ASK**: "YIELD_ASK"
- **YIELD_BID**: "YIELD_BID"
- **YIELD_BID_ASK**: "YIELD_BID_ASK"
- **YIELD_LAST**: "YIELD_LAST"
```

--------------------------------

### Print portfolio positions using IBApi

Source: https://stoqey.github.io/ib-doc/index.html

Retrieves and logs all portfolio positions to the console using the IBApi client.

```typescript
/* Example: Print all portfolio positions to console. */  
  
import { IBApi, EventName, ErrorCode, Contract } from "@stoqey/ib";  
  
// create IBApi object  
  
const ib = new IBApi({  
  // clientId: 0,  
  // host: '127.0.0.1',  
  port: 7497,  
});  
  
// register event handler  
  
let positionsCount = 0;  
  
ib.on(EventName.error, (err: Error, code: ErrorCode, reqId: number) => {  
  console.error(`${err.message} - code: ${code} - reqId: ${reqId}`);  
})  
  .on(  
    EventName.position,  
    (account: string, contract: Contract, pos: number, avgCost?: number) => {  
      console.log(`${account}: ${pos} x ${contract.symbol} @ ${avgCost}`);  
      positionsCount++;  
    },  
  )  
  .once(EventName.positionEnd, () => {  
    console.log(`Total: ${positionsCount} positions.`);  
    ib.disconnect();  
  });  
  
// call API functions  
  
ib.connect();  
ib.reqPositions();
```

--------------------------------

### on(event: 'orderBound', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for order binding events.

```APIDOC
## on(event: 'orderBound', listener)

### Description
Registers a callback for API bind order control messages.

### Parameters
- **event** (string) - 'orderBound'
- **listener** (function) - Callback receiving `orderId` (number), `apiClientId` (number), and `apiOrderId` (number).
```

--------------------------------

### constructor

Source: https://stoqey.github.io/ib-doc/classes/WshEventData.html

Creates a new instance of the WshEventData class with specified filtering parameters.

```APIDOC
## constructor

### Description
Initializes a new WshEventData object to define the parameters for a Wall Street Horizon event request.

### Signature
`new WshEventData(conId: number, fillWatchlist?: boolean, fillPortfolio?: boolean, fillCompetitors?: boolean, startDate?: string, endDate?: string, totalLimit?: number): WshEventData`

### Parameters
- **conId** (number) - Required - The contract ID.
- **fillWatchlist** (boolean) - Optional - Whether to include watchlist data. Default: false.
- **fillPortfolio** (boolean) - Optional - Whether to include portfolio data. Default: false.
- **fillCompetitors** (boolean) - Optional - Whether to include competitor data. Default: false.
- **startDate** (string) - Optional - The start date for the event range. Default: "".
- **endDate** (string) - Optional - The end date for the event range. Default: "".
- **totalLimit** (number) - Optional - The maximum number of events to return. Default: 0.
```

--------------------------------

### new TrailingStopOrder(action, totalQuantity, auxPrice?, trailingPercent?, transmit?, parentId?, tif?)

Source: https://stoqey.github.io/ib-doc/classes/TrailingStopOrder.html

Creates a new instance of a trailing-stop order.

```APIDOC
## Constructor: new TrailingStopOrder

### Description
Creates a new trailing-stop order instance.

### Parameters
- **action** (OrderAction) - Required - The order action (buy or sell).
- **totalQuantity** (number) - Required - The number of positions being bought/sold.
- **auxPrice** (number) - Optional - Generic field to contain the stop price for STP LMT orders, trailing amount, etc.
- **trailingPercent** (number) - Optional - Specifies the trailing amount of a trailing stop order as a percentage.
- **transmit** (boolean) - Optional - Specifies whether the order will be transmitted by TWS.
- **parentId** (number) - Optional - The order ID of the parent order, used for bracket and auto trailing stop orders.
- **tif** (TimeInForce) - Optional - The time in force (DAY or GTC).
```

--------------------------------

### new StopLimitOrder(action, lmtPrice, auxPrice, totalQuantity?, transmit?, parentId?, tif?)

Source: https://stoqey.github.io/ib-doc/classes/StopLimitOrder.html

Constructs a new instance of a StopLimitOrder.

```APIDOC
## Constructor: new StopLimitOrder

### Description
Creates a new instance of a stop-limit order.

### Signature
`new StopLimitOrder(action: OrderAction, lmtPrice: number, auxPrice: number, totalQuantity?: boolean, transmit?: boolean, parentId?: number, tif?: TimeInForce): StopLimitOrder`

### Parameters
- **action** (OrderAction) - Required - The action for the order.
- **lmtPrice** (number) - Required - The limit price for the order.
- **auxPrice** (number) - Required - The auxiliary price for the order.
- **totalQuantity** (boolean) - Optional - The total quantity of the order.
- **transmit** (boolean) - Optional - Whether to transmit the order immediately.
- **parentId** (number) - Optional - The ID of the parent order.
- **tif** (TimeInForce) - Optional - The time in force for the order.
```

--------------------------------

### on(event: 'displayGroupList', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for the displayGroupList event, providing a one-time response to querying display groups.

```APIDOC
## on('displayGroupList', listener)

### Description
Registers a listener for the displayGroupList event, which returns a list of visible Group IDs.

### Parameters
- **reqId** (number) - The ID of the request.
- **groups** (string) - A list of integers representing visible Group IDs separated by '|'.
```

--------------------------------

### Send a limit order using IBApi

Source: https://stoqey.github.io/ib-doc/index.html

Demonstrates how to request a valid order ID and place a limit buy order for a specific contract.

```typescript
ib.once(EventName.nextValidId, (orderId: number) => {  
  const contract: Contract = {  
    symbol: "AMZN",  
    exchange: "SMART",  
    currency: "USD",  
    secType: SecType.STK,  
  };  
  
  const order: Order = {  
    orderType: OrderType.LMT,  
    action: OrderAction.BUY,  
    lmtPrice: 1,  
    orderId,  
    totalQuantity: 1,  
    account: "YOUR_ACCOUNT_ID",  
  };  
  
  ib.placeOrder(orderId, contract, order);  
});  
  
ib.connect();  
ib.reqIds();
```

--------------------------------

### on(event: 'mktDepthExchanges', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for market depth exchange updates.

```APIDOC
## on(event: 'mktDepthExchanges', listener)

### Description
Registers a callback to receive market depth exchange descriptions.

### Parameters
- **event** (string) - 'mktDepthExchanges'
- **listener** (function) - Callback receiving `depthMktDataDescriptions` (Array of DepthMktDataDescription objects).
```

--------------------------------

### on(event: 'marketDataType', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for the marketDataType event, which signals changes in the market data type (e.g., real-time, frozen, delayed).

```APIDOC
## on('marketDataType', listener)

### Description
Registers a listener for the marketDataType event. This event notifies when the API switches between market data types.

### Parameters
- **reqId** (number) - The request's identifier.
- **marketDataType** (number) - The market data type: 1 (real-time), 2 (frozen), 3 (delayed), 4 (delayed-frozen).
```

--------------------------------

### on(event: 'newsArticle', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for incoming news articles.

```APIDOC
## on(event: 'newsArticle', listener)

### Description
Registers a callback to receive news articles.

### Parameters
- **event** (string) - 'newsArticle'
- **listener** (function) - Callback receiving `reqId` (number), `articleType` (number), and `articleText` (string).
```

--------------------------------

### on(event: 'marketRule', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for market rule updates.

```APIDOC
## on('marketRule', listener)

### Description
Registers a callback to receive minimum price increment structure for a market rule ID.

### Parameters
- **marketRuleId** (number) - The Market rule ID.
- **priceIncrements** (unknown[]) - Array of price increments.
```

--------------------------------

### on(event: 'nextValidId', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for the next valid order ID.

```APIDOC
## on(event: 'nextValidId', listener)

### Description
Registers a callback to receive the next valid order ID, invoked upon connection or after calling reqIds.

### Parameters
- **event** (string) - 'nextValidId'
- **listener** (function) - Callback receiving `orderId` (number).
```

--------------------------------

### new Index(symbol, currency?, exchange?)

Source: https://stoqey.github.io/ib-doc/classes/Index.html

Constructs a new Index instance to represent a financial index contract.

```APIDOC
## Constructor

### Description
Creates a new instance of the Index class.

### Signature
`new Index(symbol: string, currency?: string, exchange?: string): Index`

### Parameters
- **symbol** (string) - Required - The asset symbol.
- **currency** (string) - Optional - The trading currency.
- **exchange** (string) - Optional - The destination exchange.
```

--------------------------------

### reqRealTimeBars(reqId, contract, barSize, whatToShow, useRTH, realTimeBarsOptions)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Requests real time bars for a specific contract.

```APIDOC
## reqRealTimeBars(reqId, contract, barSize, whatToShow, useRTH, realTimeBarsOptions)

### Description
Requests real time bars. Currently, only 5 seconds bars are provided.

### Parameters
- **reqId** (number) - The request's unique identifier.
- **contract** (Contract) - The Contract for which the depth is being requested.
- **barSize** (number) - Currently being ignored.
- **whatToShow** (WhatToShow) - The nature of the data being retrieved (TRADES, MIDPOINT, BID, ASK).
- **useRTH** (boolean) - Set to false to obtain data outside Regular Trading Hours, true for RTH data only.
- **realTimeBarsOptions** (TagValue[]) - Optional configuration.

### Returns
- **IBApi** - The API instance.
```

--------------------------------

### on(event: 'tickGeneric', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for generic market data ticks.

```APIDOC
## on(event: 'tickGeneric', listener)

### Description
Provides a callback for generic market data ticks.

### Parameters
- **event** (string) - Required - Must be 'tickGeneric'
- **listener** (function) - Required - Callback function receiving (reqId, field, value)
```

--------------------------------

### on(event: 'position', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for position updates.

```APIDOC
## on(event: 'position', listener)

### Description
Registers a callback function to be executed when a position update is received.

### Parameters
- **account** (string) - The account holding the position.
- **contract** (Contract) - The position's contract details.
- **pos** (number) - The number of positions held.
- **avgCost** (number) - Optional. The average cost of the position.
```

--------------------------------

### connect

Source: https://stoqey.github.io/ib-doc/classes/IBApiNext.html

Connect to the TWS or IB Gateway.

```APIDOC
## connect(clientId?)

### Description
Connect to the TWS or IB Gateway.

### Parameters
- **clientId** (number) - Optional - A fixed client id to be used on all connection attempts.

### Returns
- **IBApiNext**
```

--------------------------------

### on(event, listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Subscribes to account portfolio updates. This method receives the portfolio of the subscribed account, with subsequent callbacks occurring only for positions that have changed.

```APIDOC
## on(event, listener)

### Description
Receives the subscribed account's portfolio. After the initial callback, updates are only triggered for positions that have changed.

### Parameters
- **event** (string) - The event name to listen for.
- **listener** (function) - The callback function to execute when the event occurs.

### Returns
- **IBApi** - Returns the IBApi instance for chaining.
```

--------------------------------

### reqPnL

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Creates subscription for real time daily PnL and unrealized PnL updates.

```APIDOC
## reqPnL(reqId, account, modelCode?)

### Description
Creates subscription for real time daily PnL and unrealized PnL updates.

### Parameters
- **reqId** (number) - Required - ID of the request.
- **account** (string) - Required - Account for which to receive PnL updates.
- **modelCode** (string) - Optional - Specify to request PnL updates for a specific model.
```

--------------------------------

### new FOP()

Source: https://stoqey.github.io/ib-doc/classes/FOP.html

Constructs a new Future Option Contract instance.

```APIDOC
## Constructor

### new FOP(symbol, expiry, strike, right, multiplier?, exchange?, currency?)

Creates a new instance of a Future Option Contract.

### Parameters
- **symbol** (string) - Required - The asset symbol.
- **expiry** (string) - Required - The contract expiry date.
- **strike** (number) - Required - The option's strike price.
- **right** (OptionType) - Required - Either Put or Call (P, PUT, C, CALL).
- **multiplier** (number) - Optional - The instrument's multiplier.
- **exchange** (string) - Optional - The destination exchange.
- **currency** (string) - Optional - The trading currency.
```

--------------------------------

### on(event: 'accountSummaryEnd', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener that notifies when all account information has been received for a specific request ID.

```APIDOC
## on(event: 'accountSummaryEnd', listener)

### Description
Registers a callback to be invoked when all account summary data for a request has been transmitted. Requires TWS 967+.

### Parameters
- **event** (string) - Required - Must be 'accountSummaryEnd'.
- **listener** (function) - Required - Callback function with signature: (reqId: number) => void.
```

--------------------------------

### on(event: 'positionEnd', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for the completion of position transmissions.

```APIDOC
## on(event: 'positionEnd', listener)

### Description
Registers a callback function that is triggered when all positions have been transmitted.
```

--------------------------------

### on(event: 'tickByTickMidPoint', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for 'MidPoint' tick-by-tick real-time data.

```APIDOC
## on(event: 'tickByTickMidPoint', listener)

### Description
Registers a callback function to receive 'MidPoint' tick-by-tick real-time data.

### Parameters
- **reqId** (number) - The id of the request.
- **time** (number) - The tick-by-tick real-time tick timestamp.
- **midPoint** (number) - The tick-by-tick real-time tick mid point.

### Returns
- **IBApi** - The IBApi instance.
```

--------------------------------

### on(event, listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for a specific event on the IBApi instance.

```APIDOC
## on(event, listener)

### Description
Registers a callback function to handle specific events emitted by the IBApi client.

### Parameters
- **event** (string) - The name of the event to listen for (e.g., 'execDetails', 'contractDescriptions', 'historicalData').
- **listener** (function) - The callback function to execute when the event is triggered.

### Returns
- **IBApi** - Returns the IBApi instance for chaining.
```

--------------------------------

### new StopOrder(action, auxPrice, totalQuantity, transmit?, parentId?, tif?)

Source: https://stoqey.github.io/ib-doc/classes/StopOrder.html

Constructs a new instance of a StopOrder.

```APIDOC
## Constructor

### Description
Creates a new StopOrder instance.

### Signature
`new StopOrder(action: OrderAction, auxPrice: number, totalQuantity: number, transmit?: boolean, parentId?: number, tif?: TimeInForce): StopOrder`

### Parameters
- **action** (OrderAction) - Required - The action for the order.
- **auxPrice** (number) - Required - The auxiliary price for the stop order.
- **totalQuantity** (number) - Required - The total quantity of the order.
- **transmit** (boolean) - Optional - Whether to transmit the order immediately.
- **parentId** (number) - Optional - The ID of the parent order.
- **tif** (TimeInForce) - Optional - The time in force for the order.
```

--------------------------------

### on(event: 'tickSnapshotEnd', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for the tickSnapshotEnd event, indicating that market data snapshot reception is finished.

```APIDOC
## on('tickSnapshotEnd', listener)

### Description
Registers a listener for the tickSnapshotEnd event, which signals that the market data snapshot reception is complete.

### Parameters
- **reqId** (number) - The request's identifier.
```

--------------------------------

### Execute Jest tests

Source: https://stoqey.github.io/ib-doc/index.html

Commands to run unit tests using the Jest framework.

```bash
jest src/test/unit/api/api.test.ts
```

```bash
yarn test
```

--------------------------------

### exerciseOptions

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Exercises an options contract.

```APIDOC
## exerciseOptions(reqId, contract, exerciseAction, exerciseQuantity, account, override)

### Description
Exercises an options contract.

### Parameters
- **reqId** (number) - Required - The exercise request's identifier.
- **contract** (Contract) - Required - The option Contract to be exercised.
- **exerciseAction** (OptionExerciseAction) - Required - 1 to exercise the option, 2 to let the option lapse.
- **exerciseQuantity** (number) - Required - Number of contracts to be exercised.
- **account** (string) - Required - Destination account.
- **override** (number) - Required - Specifies whether your setting will override the system's natural action.

### Returns
- **IBApi** - The API instance.
```

--------------------------------

### once(event, fn, context?)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Adds a one-time listener for a given event.

```APIDOC
## once(event, fn, context?)

### Description
Adds a listener that will be invoked only once for the specified event.

### Parameters
- **event** (T) - The event name.
- **fn** (function) - The callback function to execute.
- **context** (any, optional) - The context to execute the function in.

### Returns
- **IBApi** - The instance of the IBApi class.
```

--------------------------------

### on(event: 'managedAccounts', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for managed account updates.

```APIDOC
## on('managedAccounts', listener)

### Description
Registers a callback to receive a comma-separated string of managed account IDs.

### Parameters
- **accountsList** (string) - A comma-separated string with the managed account IDs.
```

--------------------------------

### on(event, listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers an event listener for specific IB API events.

```APIDOC
## on(event, listener)

### Description
Registers a listener function to be called when a specific event occurs. Returns the IBApi instance for chaining.

### Parameters
- **event** (string) - The name of the event to listen for (e.g., 'updatePortfolio', 'updateMktDepth', 'updateMktDepthL2', 'updateNewsBulletin', 'userInfo').
- **listener** (function) - The callback function to execute when the event is triggered.

### Returns
- **IBApi** - The instance of the IBApi class.
```

--------------------------------

### new Forex(symbol, currency)

Source: https://stoqey.github.io/ib-doc/classes/Forex.html

Creates a new instance of a Forex contract.

```APIDOC
## Constructor

### new Forex(symbol, currency)

Creates a new Forex contract instance.

### Parameters
- **symbol** (string) - The asset symbol.
- **currency** (string) - The trading currency.

### Returns
- **Forex** - A new instance of the Forex class.
```

--------------------------------

### on(event, listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for specific events emitted by the IBApi instance.

```APIDOC
## on(event, listener)

### Description
Registers a callback function to handle specific events emitted by the IBApi client.

### Signature
`on(event: string, listener: Function): IBApi`

### Supported Events
- **accountUpdateMultiEnd**: Triggered when multi-account updates end. Listener: `(reqId: number) => void`
- **bondContractDetails**: Triggered when bond contract data is received. Listener: `(reqId: number, contract: Contract) => void`
- **commissionReport**: Triggered when a commission report is received. Listener: `(commissionReport: CommissionReport) => void`
- **completedOrder**: Triggered when an order is completed. Listener: `(contract: Contract, order: Order, orderState: OrderState) => void`
- **completedOrdersEnd**: Triggered when the reception of completed orders ends. Listener: `() => void`
- **wshMetaData**: Triggered when WSH calendar metadata is received. Listener: `(reqId: number, dataJson: string) => void`
- **wshEventData**: Triggered when WSH calendar event data is received. Listener: `(reqId: number, dataJson: string) => void`
- **connectionClosed**: Triggered when the API connection is closed. Listener: `() => void`
- **contractDetails**: Triggered when contract definitions are received. Listener: `(reqId: number, contractDetails: ContractDetails) => void`
- **contractDetailsEnd**: Triggered when contract details reception ends. Listener: `(reqId: number) => void`
- **currentTime**: Triggered when TWS current time is received. Listener: `(time: number) => void`
```

--------------------------------

### on(event: 'orderStatus', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for order status updates. The listener receives details about order execution, status changes, and fill information.

```APIDOC
## on(event: 'orderStatus', listener)

### Description
Registers a callback function to receive real-time updates regarding the status of an order.

### Parameters
- **event** (string) - Required - Must be 'orderStatus'.
- **listener** (function) - Required - Callback function with signature: (orderId: number, status: string, filled: number, remaining: number, avgFillPrice: number, permId?: number, parentId?: number, lastFillPrice?: number, clientId?: number, whyHeld?: string, mktCapPrice?: number) => void.

### Returns
- **IBApi** - Returns the IBApi instance for chaining.
```

--------------------------------

### getAccountSummary(group, tags)

Source: https://stoqey.github.io/ib-doc/classes/IBApiNext.html

Creates a subscription to receive account summaries for all linked accounts, similar to the TWS Account Summary tab.

```APIDOC
## getAccountSummary(group, tags)

### Description
Creates a subscription to receive the account summaries of all linked accounts as presented in the TWS' Account Summary tab. All account summaries are sent on the first event.

### Parameters
- **group** (string) - Required - Set to "All" to return account summary data for all accounts, or set to a specific Advisor Account Group name.
- **tags** (string) - Required - A comma separated list with the desired tags (e.g., NetLiquidation, TotalCashValue, BuyingPower).

### Returns
- **Observable<AccountSummariesUpdate>** - An observable stream of account summary updates.
```

--------------------------------

### on(event: 'tickNews', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for news headline ticks.

```APIDOC
## on(event: 'tickNews', listener)

### Description
Provides a callback for news headline ticks.

### Parameters
- **event** (string) - Required - Must be 'tickNews'
- **listener** (function) - Required - Callback function receiving (reqId, timeStamp, providerCode, articleId, headline, extraData)
```

--------------------------------

### on(event: 'historicalTicks', listener)

Source: https://stoqey.github.io/ib-doc/classes/IBApi.html

Registers a listener for historical price tick data.

```APIDOC
## on('historicalTicks', listener)

### Description
Registers a callback to receive historical price tick data.

### Parameters
- **reqId** (number) - The request's identifier.
- **ticks** (HistoricalTick[]) - Array of historical tick objects.
- **done** (boolean) - Flag to indicate if all historical tick data has been received.
```
Tokens:
Raw