twsConnect: Establish, Check or Terminate a Connection to TWS or IBG

In hgodinez/ibrokers: R API to Interactive Brokers Trader Workstation

Description

Functions to initiate, check, or disconnect from the Trader Workstation (TWS) or IB Gateway (IBG).

Usage

twsConnect(clientId = 1, host = 'localhost', 
           port = 7496, verbose = TRUE, timeout = 5,
           filename = NULL, blocking=.Platform$OS.type=="windows")
ibgConnect(clientId = 1, host = 'localhost', 
           port = 4001, verbose = TRUE, timeout = 5,
           filename = NULL, blocking=.Platform$OS.type=="windows")

twsDisconnect(twsconn)

isConnected(twsconn)
is.twsConnection(x)
is.twsPlayback(x)

Arguments

clientId	the unique client id to associate with
host	the host server
port	the port that the TWS is listening on
verbose	should the connection attempt be verbose
timeout	length in seconds before aborting attempt
filename	file containing recorded TWS data
blocking	should a blocking connection be established. See details.
twsconn	a valid twsConnection object
x	a connection to be checked

Details

Returns a twsConnection object for use in subsequent TWS API calls. Attempting to create another connection to the server with the same clientId will result in an error.

If filename is set to a file containing data recorded in the standard TWS format - calls using this connection will playback the recorded data.

While the IBrokers package is fully cross-platform, the behavior of sockets varies by operating system implementation. In general, setting blocking=TRUE on Windows (the default on Windows) results in more consistent and reliable connections. This option is only exposed to enable debugging of platform differences and optimization - and is not intended to be altered except in those cases.

Value

A twsconn object.

Note

While it is not strictly required to disconnect via twsDisconnect it is probably advisable.

If not set options(digits.secs=6) will be called internally to properly represent on screen the R based timestamps.

Author(s)

Jeffrey A. Ryan

References

Interactive Brokers: www.interactivebrokers.com

Examples

## Not run: 
tws <- twsConnect()
twsDisconnect(tws)

## End(Not run)

hgodinez/ibrokers documentation built on May 17, 2019, 3:57 p.m.