Positions
View positions and manage position instructions.
Get Positions
Close Positions
Close Position
List Position Instructions
Submit Position Instructions
Cancel Position Instruction
ModelsExpand Collapse
class Position: …
Represents a holding of a particular instrument in an account
daily_unrealized_pnl: Optional[str]
The unrealized profit or loss for this position relative to the previous close
daily_unrealized_pnl_pct: Optional[str]
The unrealized profit/loss for the position for the current day, expressed as a percentage of the baseline value (range: 0-100).
underlying_instrument_id: Optional[str]
OEMS instrument identifier of the underlying instrument, if resolvable
class PositionInstruction: …
A position instruction and its current lifecycle state.
instruction_id: str
Caller-supplied idempotency key echoed from the submit request; the server-assigned fallback when none was supplied.
accepted_quantity: Optional[str]
Number of contracts accepted by the clearing venue. Populated once
the instruction reaches ACCEPTED.
created_at: Optional[datetime]
When the instruction was first accepted by the service.
List[PositionInstruction]
instruction_id: str
Caller-supplied idempotency key echoed from the submit request; the server-assigned fallback when none was supplied.
accepted_quantity: Optional[str]
Number of contracts accepted by the clearing venue. Populated once
the instruction reaches ACCEPTED.
created_at: Optional[datetime]
When the instruction was first accepted by the service.
List[Position]
daily_unrealized_pnl: Optional[str]
The unrealized profit or loss for this position relative to the previous close
daily_unrealized_pnl_pct: Optional[str]
The unrealized profit/loss for the position for the current day, expressed as a percentage of the baseline value (range: 0-100).
underlying_instrument_id: Optional[str]
OEMS instrument identifier of the underlying instrument, if resolvable
class PositionGetPositionsResponse: …
daily_unrealized_pnl: Optional[str]
The unrealized profit or loss for this position relative to the previous close
daily_unrealized_pnl_pct: Optional[str]
The unrealized profit/loss for the position for the current day, expressed as a percentage of the baseline value (range: 0-100).
underlying_instrument_id: Optional[str]
OEMS instrument identifier of the underlying instrument, if resolvable
class PositionClosePositionsResponse: …
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.
class PositionClosePositionResponse: …
expires_at: Optional[datetime]
Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.
class PositionGetPositionInstructionsResponse: …
instruction_id: str
Caller-supplied idempotency key echoed from the submit request; the server-assigned fallback when none was supplied.
accepted_quantity: Optional[str]
Number of contracts accepted by the clearing venue. Populated once
the instruction reaches ACCEPTED.
created_at: Optional[datetime]
When the instruction was first accepted by the service.
class PositionSubmitPositionInstructionsResponse: …
instruction_id: str
Caller-supplied idempotency key echoed from the submit request; the server-assigned fallback when none was supplied.
accepted_quantity: Optional[str]
Number of contracts accepted by the clearing venue. Populated once
the instruction reaches ACCEPTED.
created_at: Optional[datetime]
When the instruction was first accepted by the service.
class PositionCancelPositionInstructionResponse: …
A position instruction and its current lifecycle state.
instruction_id: str
Caller-supplied idempotency key echoed from the submit request; the server-assigned fallback when none was supplied.
accepted_quantity: Optional[str]
Number of contracts accepted by the clearing venue. Populated once
the instruction reaches ACCEPTED.
created_at: Optional[datetime]
When the instruction was first accepted by the service.