Positions
View positions and manage position instructions.
Get Positions
Close Positions
Close Position
Get Position Instructions
Submit Position Instructions
Cancel Position Instruction
ModelsExpand Collapse
Position object { account_id, available_quantity, instrument_id, 16 more }
Represents a holding of a particular instrument in an account
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.
PositionInstruction object { id, account_id, instruction_id, 9 more }
A position instruction and its current lifecycle state.
instruction_id: string
Caller-supplied idempotency key echoed from the submit request; the server-assigned fallback when none was supplied.
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.
instruction_id: string
Caller-supplied idempotency key echoed from the submit request; the server-assigned fallback when none was supplied.
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.
PositionInstructionStatus = "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_reasoncarries the detail. Covers both venue-reported rejections and rejections raised before the instruction reached the clearing venue (e.g. duplicateinstruction_id,DO_NOT_EXERCISE/CONTRARY_EXERCISEsubmitted 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_reasoncarries the detail.UNKNOWN: status could not be determined.
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.
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.
average_fill_price: optional string
Average fill price across all executions When a null/undefined value is observed, it indicates that there is no available data.
expires_at: optional string
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. When a null/undefined value is observed, it indicates it does not apply.
limit_offset: optional string
Limit offset for trailing stop-limit orders (signed) When a null/undefined value is observed, it indicates it does not apply.
limit_price: optional string
Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
releases_at: optional string
Scheduled release time for orders awaiting release. When a null/undefined value is observed, it indicates it does not apply.
stop_price: optional string
Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
trailing_limit_px: optional string
Current trailing limit price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_offset: optional string
Trailing offset amount for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_stop_px: optional string
Current trailing stop price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_px: optional string
Trailing watermark price for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: optional string
Trailing watermark timestamp for trailing orders When a null/undefined value is observed, it indicates it does not apply.
underlying_instrument_id: optional string
Instrument ID of the option’s underlying instrument. Populated only for
options orders. A null means one of two things: the order is not an
option, so the field does not apply; or the order is an option whose
underlier has not yet been resolved.
When a null/undefined value is observed, it indicates it does not apply.
average_fill_price: optional string
Average fill price across all executions When a null/undefined value is observed, it indicates that there is no available data.
expires_at: optional string
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. When a null/undefined value is observed, it indicates it does not apply.
limit_offset: optional string
Limit offset for trailing stop-limit orders (signed) When a null/undefined value is observed, it indicates it does not apply.
limit_price: optional string
Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
releases_at: optional string
Scheduled release time for orders awaiting release. When a null/undefined value is observed, it indicates it does not apply.
stop_price: optional string
Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.
trailing_limit_px: optional string
Current trailing limit price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_offset: optional string
Trailing offset amount for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_stop_px: optional string
Current trailing stop price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_px: optional string
Trailing watermark price for trailing orders When a null/undefined value is observed, it indicates it does not apply.
trailing_watermark_ts: optional string
Trailing watermark timestamp for trailing orders When a null/undefined value is observed, it indicates it does not apply.
underlying_instrument_id: optional string
Instrument ID of the option’s underlying instrument. Populated only for
options orders. A null means one of two things: the order is not an
option, so the field does not apply; or the order is an option whose
underlier has not yet been resolved.
When a null/undefined value is observed, it indicates it does not apply.
instruction_id: string
Caller-supplied idempotency key echoed from the submit request; the server-assigned fallback when none was supplied.
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.
instruction_id: string
Caller-supplied idempotency key echoed from the submit request; the server-assigned fallback when none was supplied.
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.
A position instruction and its current lifecycle state.
instruction_id: string
Caller-supplied idempotency key echoed from the submit request; the server-assigned fallback when none was supplied.
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.