DRdrivewealth
Position Management
Options

Request Exercise for options position

beta Request Exercise for options positions by accountID.

post/accounts/{accountID}/positions/options/exercise

Request

  • Base URL
    https://bo-api.drivewealth.io/back-office
  • URL
    https://bo-api.drivewealth.io/back-office/accounts/{accountID}/positions/options/exercise
  • Auth
    HTTP bearer

Path parameters

accountIDstring required

sensitive The user's unique account identifier.

Example:123e4567-e89b-12d3-a456-000000000004.1234567890125

sensitive

Request body

tradingType'CASH' | 'MARGIN'

Trading type for the exercise request. Optional — defaults to CASH if not provided. Should match the trading type on the account. Only CASH is currently supported; MARGIN will be rejected with a 400 error.

instrumentIDstring uuid required

A unique ID created by DriveWealth to identify a specific instrument.

quantityinteger required

Number of contracts to exercise or do not exercise. Must be a positive whole number.

Example request

{
  "tradingType": "CASH",
  "instrumentID": "123e4567-e89b-12d3-a456-000000000006"
}

Response

Exercise request submitted successfully.

instructionIDstring

Unique identifier for the exercise request.

Changes

No recorded changes to this operation across all 1 revision of this API.