ExerciseOptionsRequest

View as MarkdownOpen in Claude

ExerciseOptionsRequest

FieldTypeDescription
orderIdint32The API client’s order id.
contractContractContract object containing defining characteristics for ticker.
exerciseActionint32Set to 1 to exercise the option, set to 2 to let the option lapse
exerciseQuantityint32Number of contracts to be exercised
accountstringThe IBKR account identifier to affiliate the request with
overrideboolIndicate if the default options exercise behavior should be overwritten.
manualOrderTimestringUsed by brokers and advisors when manually entering an order request. Format should be “YYYYMMDD-HH:mm:ss” using UTC as the timezone value.
customerAccountstringRequired for Nondisclosed Omnibus Accounts. A unique identifier for each account within the Omnibus structure to signify the account holder being traded. Best practice (Not Required): clients should look to hash this value, using something along the lines of 5 digits of SHA1 of the account number. This should not be implemented for non-omnibus accounts.
professionalCustomerbooltrue indicates account represents an institutional or professional trader.