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

Positions

View positions and manage position instructions.

Get Positions
$ clst v1:positions get-positions
GET/v1/accounts/{account_id}/positions
Close Positions
$ clst v1:positions close-positions
DELETE/v1/accounts/{account_id}/positions
Close Position
$ clst v1:positions close-position
DELETE/v1/accounts/{account_id}/positions/{instrument_id}
Get Position Instructions
$ clst v1:positions get-position-instructions
GET/v1/accounts/{account_id}/positions/instructions
Submit Position Instructions
$ clst v1:positions submit-position-instructions
POST/v1/accounts/{account_id}/positions/instructions
Cancel Position Instruction
$ clst v1:positions cancel-position-instruction
DELETE/v1/accounts/{account_id}/positions/instructions/{instruction_id}
ModelsExpand Collapse
position: object { account_id, available_quantity, instrument_id, 16 more }

Represents a holding of a particular instrument in an account

account_id: number

The account this position belongs to

available_quantity: string

The quantity of a position that is free to be operated on.

instrument_id: string

Unique instrument identifier

instrument_type: "COMMON_STOCK" or "OPTION" or "CASH"

Type of security

"COMMON_STOCK"
"OPTION"
"CASH"
market_value: string

The current market value of the position

position_type: "LONG" or "SHORT" or "LONG_CALL" or 3 more

The type of position

"LONG"
"SHORT"
"LONG_CALL"
"SHORT_CALL"
"LONG_PUT"
"SHORT_PUT"
quantity: string

The number of shares or contracts. Can be positive (long) or negative (short)

symbol: string

The trading symbol for the instrument

avg_price: optional string

The average price paid per share or contract for this position When a null/undefined value is observed, it indicates that there is no available data.

closing_price: optional string

The closing price used to value the position for the last trading day When a null/undefined value is observed, it indicates that there is no available data.

closing_price_date: optional string

The market date associated with closing_price When a null/undefined value is observed, it indicates that there is no available data.

cost_basis: optional string

The total cost basis for this position When a null/undefined value is observed, it indicates that there is no available data.

daily_realized_pnl: optional string

The realized profit or loss for this position for the current day When a null/undefined value is observed, it indicates that there is no available data.

daily_unrealized_pnl: optional string

The unrealized profit or loss for this position relative to the previous close When a null/undefined value is observed, it indicates that there is no available data.

daily_unrealized_pnl_pct: optional string

The unrealized profit/loss for the position for the current day, expressed as a percentage of the baseline value (range: 0-100). When a null/undefined value is observed, it indicates that there is no available data.

instrument_price: optional string

The current market price of the instrument When a null/undefined value is observed, it indicates that there is no available data.

underlying_instrument_id: optional string

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

unrealized_pnl: optional string

The total unrealized profit or loss for this position based on current market value When a null/undefined value is observed, it indicates that there is no available data.

unrealized_pnl_pct: optional string

The unrealized profit/loss for the position, expressed as a percentage of the position’s cost basis (range: 0-100). When a null/undefined value is observed, it indicates that there is no available data.

position_instruction: object { id, account_id, instruction_id, 9 more }

A position instruction and its current lifecycle state.

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 4 more

Current lifecycle status.

"SENT"
"ACCEPTED"
"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. When a null/undefined value is observed, it indicates that there is no available data.

created_at: optional string

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

rejection_reason: optional string

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.

updated_at: optional string

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

position_instruction_list: 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 4 more

Current lifecycle status.

"SENT"
"ACCEPTED"
"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. When a null/undefined value is observed, it indicates that there is no available data.

created_at: optional string

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

rejection_reason: optional string

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.

updated_at: optional string

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

position_instruction_status: "SENT" or "ACCEPTED" or "REJECTED" or 4 more

Lifecycle status of a position instruction.

  • SENT: accepted and submitted to the clearing venue.
  • ACCEPTED: terminal — accepted by the clearing venue.
  • REJECTED: terminal rejection; rejection_reason carries the detail. Covers both venue-reported rejections and rejections raised before the instruction reached the clearing venue (e.g. duplicate instruction_id, DO_NOT_EXERCISE / CONTRARY_EXERCISE submitted on a non-expiry day, insufficient position, or an instrument that does not resolve).
  • CANCEL_REQUESTED: cancel accepted; final cancel state pending.
  • CANCELLED: terminal — cancel completed.
  • CANCEL_FAILED: cancel could not be completed; operator attention required. rejection_reason carries the detail.
  • UNKNOWN: status could not be determined.
"SENT"
"ACCEPTED"
"REJECTED"
"CANCEL_REQUESTED"
"CANCELLED"
"CANCEL_FAILED"
"UNKNOWN"
position_instruction_type: "EXERCISE" or "DO_NOT_EXERCISE" or "CONTRARY_EXERCISE"

The action to take against an options position.

"EXERCISE"
"DO_NOT_EXERCISE"
"CONTRARY_EXERCISE"
position_list: array of Position { account_id, available_quantity, instrument_id, 16 more }
account_id: number

The account this position belongs to

available_quantity: string

The quantity of a position that is free to be operated on.

instrument_id: string

Unique instrument identifier

instrument_type: "COMMON_STOCK" or "OPTION" or "CASH"

Type of security

"COMMON_STOCK"
"OPTION"
"CASH"
market_value: string

The current market value of the position

position_type: "LONG" or "SHORT" or "LONG_CALL" or 3 more

The type of position

"LONG"
"SHORT"
"LONG_CALL"
"SHORT_CALL"
"LONG_PUT"
"SHORT_PUT"
quantity: string

The number of shares or contracts. Can be positive (long) or negative (short)

symbol: string

The trading symbol for the instrument

avg_price: optional string

The average price paid per share or contract for this position When a null/undefined value is observed, it indicates that there is no available data.

closing_price: optional string

The closing price used to value the position for the last trading day When a null/undefined value is observed, it indicates that there is no available data.

closing_price_date: optional string

The market date associated with closing_price When a null/undefined value is observed, it indicates that there is no available data.

cost_basis: optional string

The total cost basis for this position When a null/undefined value is observed, it indicates that there is no available data.

daily_realized_pnl: optional string

The realized profit or loss for this position for the current day When a null/undefined value is observed, it indicates that there is no available data.

daily_unrealized_pnl: optional string

The unrealized profit or loss for this position relative to the previous close When a null/undefined value is observed, it indicates that there is no available data.

daily_unrealized_pnl_pct: optional string

The unrealized profit/loss for the position for the current day, expressed as a percentage of the baseline value (range: 0-100). When a null/undefined value is observed, it indicates that there is no available data.

instrument_price: optional string

The current market price of the instrument When a null/undefined value is observed, it indicates that there is no available data.

underlying_instrument_id: optional string

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

unrealized_pnl: optional string

The total unrealized profit or loss for this position based on current market value When a null/undefined value is observed, it indicates that there is no available data.

unrealized_pnl_pct: optional string

The unrealized profit/loss for the position, expressed as a percentage of the position’s cost basis (range: 0-100). When a null/undefined value is observed, it indicates that there is no available data.

position_type: "LONG" or "SHORT" or "LONG_CALL" or 3 more

Position type classification

"LONG"
"SHORT"
"LONG_CALL"
"SHORT_CALL"
"LONG_PUT"
"SHORT_PUT"