twsEquity {IBrokers}

Create a twsEquity

Description

Create a twsEquity for use in API calls.

Usage

twsEquity(symbol,
          exch="SMART",
          primary,
          strike='0.0',
          currency='USD',
          right='',
          local='',
          multiplier='',
          include_expired='0',
          conId=0)

Arguments

symbol

the IB symbol requested

exch

the requested exchange (defaults to ‘SMART’)

primary

the primary exchange of the security

strike

the strike price

currency

the requested currency

right

the requested right

local

the local security name

multiplier

the contract multiplier

include_expired

should expired contracts be included

conId

contract ID

Details

A wrapper to twsContract to make ‘equity’ contracts easier to specify.

twsSTK is an alias.

Value

A twsContract object.

Author(s)

Jeffrey A. Ryan

References

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

See Also

reqHistoricalData, twsContract

Examples

equity <- twsEquity("AAPL","SMART","ISLAND")