exerciseOptions: Exercise Options Contracts

View source: R/exerciseOptions.R

exerciseOptionsR Documentation

Exercise Options Contracts

Description

Send message to exercise option contracts.

Usage

exerciseOptions(twsconn, 
                contract, 
                exerciseAction = 1, 
                exerciseQuantity = 1, 
                account = "", 
                override = 0, 
                tickerId = 1)

Arguments

twsconn

A twsConnection object

contract

A twsContract object

exerciseAction

exercise=1 or lapse=2

exerciseQuantity

number of contracts to exercise

account

IB account [institutional orders]

override

override system's natural action. 0 for do not override, 1 for override

tickerId

id for request

Details

Exercise option contract.

Value

Called for its side-effect.

Note

exch=‘SMART’ is not valid in exerciseOptions calls. See the official API for further details.

Author(s)

Jeffrey A. Ryan

References

https://interactivebrokers.github.io/tws-api/classIBApi_1_1EClient.html#aad70a7b82ad3b5e7ae3e9f0b98dc2a5b


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