Submit an exercise instruction

Submit an exercise, or a contrary instruction, against a long option
position.

Processing is asynchronous. The response reflects pending; poll
getExercise or listExercises to observe validation, release, and
the OCC's terminal response.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 256

The account ID or account number.

Body Params

Name the option by exactly one of option_symbol and instrument_id. Giving both, or neither, is a validation-error, as is an instrument_id that names no option.

string
required
length between 1 and 64

Your identifier for the exercise, echoed back.

string
enum
required

The action requested.

  • early-exercise: exercise a long option before its maturity date.
  • exercise-at-expiry: a contrary instruction at expiration, to exercise
    an option even if that option is out of the money.
  • do-not-exercise: a contrary instruction at expiration, to suppress
    automatic exercise of an option that is in the money.
Allowed:
string
length between 1 and 32

The option contract, in OSI format. This is the same string other Studio endpoints accept as symbol with symbol_format: osi.

string
length between 1 and 64

Clear Street's identifier for the option contract.

string
required
length between 1 and 16
^[0-9]{1,16}$

A whole number of contracts, given as a string.

int32
required
20150101 to 29999999

The date the instruction is effective.

string
enum
required

The clearing venue to exercise at. Only occ is accepted; cme is rejected with validation-error.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json