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

Get Position Instructions

client.V1.Positions.GetPositionInstructions(ctx, accountID, query) (*V1PositionGetPositionInstructionsResponse, error)
GET/v1/accounts/{account_id}/positions/instructions

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

Note: instructions that fail pre-acceptance validation on POST — duplicates, DO_NOT_EXERCISE / CONTRARY_EXERCISE on a non-expiry day, insufficient position, or an unresolvable instrument — are rejected (with status = REJECTED and a rejection_reason) without being persisted, so they surface only in the POST response and never appear in this list.

ParametersExpand Collapse
accountID int64
query V1PositionGetPositionInstructionsParams
InstrumentID param.Field[InstrumentIDOrSymbol]Optional

Limit results to a single contract. Instrument ID (UUID) or symbol (equity ticker or OSI option symbol).

formatuuid
ReturnsExpand Collapse
type V1PositionGetPositionInstructionsResponse struct{…}
ID string

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

formatuuid
AccountID int64

Account the instruction belongs to.

formatint64
InstructionID string

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

InstructionType PositionInstructionType

The action this instruction requests.

One of the following:
const PositionInstructionTypeExercise PositionInstructionType = "EXERCISE"
const PositionInstructionTypeDoNotExercise PositionInstructionType = "DO_NOT_EXERCISE"
const PositionInstructionTypeContraryExercise PositionInstructionType = "CONTRARY_EXERCISE"
InstrumentID string

Identifier of the options contract this instruction acts on.

formatuuid
Quantity string

Number of contracts included in the instruction.

Current lifecycle status.

One of the following:
const PositionInstructionStatusSent PositionInstructionStatus = "SENT"
const PositionInstructionStatusAccepted PositionInstructionStatus = "ACCEPTED"
const PositionInstructionStatusRejected PositionInstructionStatus = "REJECTED"
const PositionInstructionStatusCancelRequested PositionInstructionStatus = "CANCEL_REQUESTED"
const PositionInstructionStatusCancelled PositionInstructionStatus = "CANCELLED"
const PositionInstructionStatusCancelFailed PositionInstructionStatus = "CANCEL_FAILED"
const PositionInstructionStatusUnknown PositionInstructionStatus = "UNKNOWN"
Symbol string

Options symbol (OSI) for display.

AcceptedQuantity stringOptional

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.

CreatedAt TimeOptional

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
RejectionReason stringOptional

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.

UpdatedAt TimeOptional

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

Get Position Instructions

package main

import (
  "context"
  "fmt"

  "github.com/clear-street/clear-street-go"
  "github.com/clear-street/clear-street-go/option"
)

func main() {
  client := clearstreet.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.V1.Positions.GetPositionInstructions(
    context.TODO(),
    0,
    clearstreet.V1PositionGetPositionInstructionsParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response)
}

{
  "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"
    }
  ]
}