v57

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-07-2161198428.4 KB
Positions

Get Position 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.

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

Path parameters

account_idinteger required

Account identifier

Query parameters

string uuid

Instrument identifier

OR
string

Symbol (symbol for equities, OSI for options)

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

Response

Position instructions

Example response

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