reqContractDetails: Request Contract Details From TWS

In joshuaulrich/IBrokers: R API to Interactive Brokers Trader Workstation

Request Contract Details From TWS

Description

Returns an object (a list of class twsContractDetails objects) of IB contract details relating to a particular IB tradeable product.

Usage

reqContractDetails(conn,
                   Contract,
                   reqId = "1",
                   verbose = FALSE,
                   eventWrapper = eWrapper(),
                   CALLBACK = twsCALLBACK, ...)

Arguments

conn	a valid twsConnection
Contract	a valid twsContract
reqId	a unique ID
verbose	be verbose?
eventWrapper	event callback closure
CALLBACK	main callback loop
...	be verbose?

Details

Returns a list of details for the product specified. See the TWS API for specifics at this point.

Value

A twsContractDetails object, or list of the same.

Author(s)

Jeffrey A. Ryan

References

Interactive Brokers https://www.interactivebrokers.com/

See Also

twsContract

Examples

## Not run: 
tws <- twsConnect()
reqContractDetails(tws, twsEquity("QQQQ"))

# retrieve all QQQQ contracts as a list
reqContractDetails(tws, twsOption(local="", right="", symbol="QQQQ"))
# retrieve only calls
reqContractDetails(tws, twsOption(local="", right="C", symbol="QQQQ"))
# retrieve only puts
reqContractDetails(tws, twsOption(local="", right="P", symbol="QQQQ"))

opt.details <- lapply(c("MSFT","AAPL"),
                      function(x) {
                                    reqContractDetails(tws,
                                      twsOption(local="", right="",
                                                symbol=x))
                                  } )

length(opt.details) #number of symbols passed e.g. 2
sapply(opt.details, length) # contracts per symbol

## End(Not run)

joshuaulrich/IBrokers documentation built on Feb. 4, 2024, 2:16 a.m.