Skip to content
Clear Street Clear Street Clear Street
Start Trading
API Reference
V1
Positions

Cancel Position Instruction

v1.positions.cancel_position_instruction(strinstruction_id, PositionCancelPositionInstructionParams**kwargs) -> PositionCancelPositionInstructionResponse
DELETE/v1/accounts/{account_id}/positions/instructions/{instruction_id}

Cancel an outstanding position instruction by its server-assigned id. Returns the updated instruction with status CANCEL_REQUESTED. The terminal CANCELLED or CANCEL_FAILED state arrives asynchronously and is observable via subsequent GETs.

ParametersExpand Collapse
account_id: int
instruction_id: str
ReturnsExpand Collapse
class PositionCancelPositionInstructionResponse: …

A position instruction and its current lifecycle state.

id: str

Server-assigned id. Used as the path parameter on cancel.

formatuuid
account_id: int

Account the instruction belongs to.

formatint64
client_instruction_id: str

Caller-supplied idempotency key echoed from the submit request; the server-assigned fallback when none was supplied.

instruction_type: PositionInstructionType

The action this instruction requests.

One of the following:
"EXERCISE"
"DO_NOT_EXERCISE"
"CONTRARY_EXERCISE"
instrument_id: str

Identifier of the options contract this instruction acts on.

formatuuid
quantity: str

Number of contracts included in the instruction.

Current lifecycle status.

One of the following:
"SENT"
"ACCEPTED"
"REJECTED"
"CANCEL_REQUESTED"
"CANCELLED"
"CANCEL_FAILED"
"UNKNOWN"
symbol: str

Options symbol (OSI) for display.

accepted_quantity: Optional[str]

Number of contracts accepted by the clearing venue. Populated once the instruction reaches ACCEPTED. When a null/undefined value is observed, it indicates that there is no available data.

created_at: Optional[datetime]

When the instruction was first accepted by the service. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time
rejection: Optional[PositionInstructionRejection]

Machine-readable counterpart to rejection_reason: a stable reason code, human-readable description, and params, present on every rejected row — on submit, cancel, get, and list alike. Branch on rejection.reason and read rejection.description instead of the top-level rejection_reason. When a null/undefined value is observed, it indicates it does not apply.

description: str

Human-readable explanation of the rejection. Duplicates the top-level rejection_reason; prefer this field.

domain: str

Namespacing domain of the reason code — com.clearstreet.oems.exercise for reasons OEMS validates, com.clearstreet.oems.clearing for clearing-owned reasons.

metadata: Dict[str, str]

Reason-specific parameters as a string→string map. Which keys are present depends on reason:

  • INSUFFICIENT_POSITION → available, requested
  • DNE_NOT_ON_EXPIRY / CEA_NOT_ON_EXPIRY → expiry, business_date
  • EXERCISE_PAST_CUTOFF → cutoff_time
  • DUPLICATE_INSTRUCTION → existing_id

Empty for reasons that carry no parameters. New keys may be added over time, so treat unknown keys leniently.

reason: str

Stable, machine-readable reason code, e.g. DNE_NOT_ON_EXPIRY, INSUFFICIENT_POSITION, OPTIONS_LEVEL_EXCEEDED, EXERCISE_PAST_CUTOFF.

rejection_reason: Optional[str]

Human-readable explanation populated on any non-success terminal status — REJECTED or CANCEL_FAILED. On a 207 Multi-Status batch submit the top-level error field summarizes the batch; per-row detail continues to live here. When a null/undefined value is observed, it indicates it does not apply.

underlying_instrument_id: Optional[str]

Identifier of the underlying instrument, when available. When a null/undefined value is observed, it indicates it does not apply.

formatuuid
updated_at: Optional[datetime]

When the instruction’s lifecycle state last changed. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time

Cancel Position Instruction

from clearstreet import ClearStreet

client = ClearStreet(
    api_key="My API Key",
)
response = client.v1.positions.cancel_position_instruction(
    instruction_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    account_id=0,
)
print(response)
{
  "data": {
    "accepted_quantity": null,
    "account_id": 122503,
    "client_instruction_id": "ui-20260424-001",
    "created_at": "2026-04-24T14:30:00Z",
    "id": "0195f6d0-a1b2-7c3d-8e4f-5a6b7c8d9e09",
    "instruction_type": "EXERCISE",
    "instrument_id": "0195f6d0-a1b2-7c3d-8e4f-5a6b7c8d9e01",
    "quantity": "1",
    "rejection_reason": null,
    "status": "CANCEL_REQUESTED",
    "symbol": "AAPL  280121C00195000",
    "updated_at": "2026-04-24T14:35:00Z"
  },
  "error": null,
  "metadata": {
    "request_id": "0a5c9ebf-a9a7-4f2d-9c7e-f2b5f0b1bd08"
  }
}
Returns Examples
{
  "data": {
    "accepted_quantity": null,
    "account_id": 122503,
    "client_instruction_id": "ui-20260424-001",
    "created_at": "2026-04-24T14:30:00Z",
    "id": "0195f6d0-a1b2-7c3d-8e4f-5a6b7c8d9e09",
    "instruction_type": "EXERCISE",
    "instrument_id": "0195f6d0-a1b2-7c3d-8e4f-5a6b7c8d9e01",
    "quantity": "1",
    "rejection_reason": null,
    "status": "CANCEL_REQUESTED",
    "symbol": "AAPL  280121C00195000",
    "updated_at": "2026-04-24T14:35:00Z"
  },
  "error": null,
  "metadata": {
    "request_id": "0a5c9ebf-a9a7-4f2d-9c7e-f2b5f0b1bd08"
  }
}