Interface IBApiCreationOptions

Input arguments on the [[IBApi]] class constructor.

Hierarchy

  • IBApiCreationOptions

Properties

clientId? host? maxReqPerSec? port?

Properties

Optional clientId

clientId?: number

A unique client id (per TWS or IB Gateway instance).

Default is 0.

Deprecated

The attributes should not be used anymore. Use clientId argument [[IBApi.connect]] instead.

Optional host

host?: string

Hostname of the TWS (or IB Gateway).

Default is 'localhost'.

Optional maxReqPerSec

maxReqPerSec?: number

Max. number of requests per second, sent to TWS/IB Gateway. Default is 40. IB specifies 50 requests/s as maximum.

Note that sending large amount of requests within a small amount of time, significantly increases resource consumption of the TWS/IB Gateway (especially memory consumption). If you experience any lags, hangs or crashes on TWS/IB Gateway while sending request bursts, try to reduce this value.

Optional port

port?: number

Hostname of the TWS (or IB Gateway).

Default is 7496, which is the TWS default (4001 is default for IB Gateway Live-Accounts and 4002 for Demo-Accounts).

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc