List Position Instructions

$ clear-street v1:positions get-position-instructions

GET/v1/accounts/{account_id}/positions/instructions

Returns the current lifecycle state of the account’s position instructions. Optionally filter by a specific contract.

ParametersExpand Collapse

--account-id: number

Account identifier

--instrument-id: optional string

Limit results to a single contract. Accepts the instrument id or the OSI symbol.

ReturnsExpand Collapse

V1PositionGetPositionInstructionsResponse: BaseResponse { metadata, error }

data: array of PositionInstruction { id, account_id, instruction_id, 9 more }

id: string

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

account_id: number

Account the instruction belongs to.

instruction_id: string

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

instruction_type: "EXERCISE" or "DO_NOT_EXERCISE" or "CONTRARY_EXERCISE"

The action this instruction requests.

"EXERCISE"

"DO_NOT_EXERCISE"

"CONTRARY_EXERCISE"

instrument_id: string

Identifier of the options contract this instruction acts on.

quantity: string

Number of contracts included in the instruction.

status: "SENT" or "ACCEPTED" or "REJECTED" or 5 more

Current lifecycle status.

"SENT"

"ACCEPTED"

"REJECTED"

"ENGINE_REJECTED"

"CANCEL_REQUESTED"

"CANCELLED"

"CANCEL_FAILED"

"UNKNOWN"

symbol: string

Options symbol (OSI) for display.

accepted_quantity: optional string

Number of contracts accepted by the clearing venue. Populated once the instruction reaches ACCEPTED.

created_at: optional string

When the instruction was first accepted by the service.

rejection_reason: optional string

Human-readable explanation populated on any non-success terminal status — REJECTED, ENGINE_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.

updated_at: optional string

When the instruction’s lifecycle state last changed.

List Position Instructions

clear-street v1:positions get-position-instructions \
  --api-key 'My API Key' \
  --account-id 0

{
  "metadata": {
    "request_id": "request_id",
    "next_page_token": "U3RhaW5sZXNzIHJvY2tz",
    "page_number": 0,
    "previous_page_token": "U3RhaW5sZXNzIHJvY2tz",
    "total_items": 0,
    "total_pages": 0
  },
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero",
    "details": [
      {
        "foo": "bar"
      }
    ]
  },
  "data": [
    {
      "id": "0195f6d0-a1b2-7c3d-8e4f-5a6b7c8d9e02",
      "account_id": 122503,
      "instruction_id": "ui-20260424-001",
      "instruction_type": "EXERCISE",
      "instrument_id": "0195f6d0-a1b2-7c3d-8e4f-5a6b7c8d9e02",
      "quantity": "1",
      "status": "SENT",
      "symbol": "AAPL  280121C00195000",
      "accepted_quantity": null,
      "created_at": "2026-04-24T14:30:00Z",
      "rejection_reason": null,
      "updated_at": "2026-04-24T14:30:00Z"
    }
  ]
}

Returns Examples

{
  "metadata": {
    "request_id": "request_id",
    "next_page_token": "U3RhaW5sZXNzIHJvY2tz",
    "page_number": 0,
    "previous_page_token": "U3RhaW5sZXNzIHJvY2tz",
    "total_items": 0,
    "total_pages": 0
  },
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero",
    "details": [
      {
        "foo": "bar"
      }
    ]
  },
  "data": [
    {
      "id": "0195f6d0-a1b2-7c3d-8e4f-5a6b7c8d9e02",
      "account_id": 122503,
      "instruction_id": "ui-20260424-001",
      "instruction_type": "EXERCISE",
      "instrument_id": "0195f6d0-a1b2-7c3d-8e4f-5a6b7c8d9e02",
      "quantity": "1",
      "status": "SENT",
      "symbol": "AAPL  280121C00195000",
      "accepted_quantity": null,
      "created_at": "2026-04-24T14:30:00Z",
      "rejection_reason": null,
      "updated_at": "2026-04-24T14:30:00Z"
    }
  ]
}