reqContractDetails: Request Contract Details From TWS

Description Usage Arguments Details Value Author(s) References See Also Examples

View source: R/reqContractDetails.R

Description

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

Usage

1
2
3
4
5
6
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 http://www.interactivebrokers.com

See Also

twsContract

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
## 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)

hadar2703/ibrokers documentation built on May 17, 2019, 9:42 a.m.