Skip to main content

LivePosition

Summary view of a live position (legs and detailed market data are returned by GetPosition).

FieldTypeRequiredNullableDefaultDescription
IdintYesNoLive position id.
StateLivePositionStateYesNoCurrent position state.
CreatedAtdatetimeYesNoUTC timestamp when the position was created.
ClosedAtdatetimeYesYesUTC timestamp when the position was closed, or null if still open.
NamestrYesNoUser-facing position name.
BrokerAccountIdstrYesNoBroker account id that owns this position.
LiveStrategyIdintYesNoLive strategy id associated with this position.
StrategyNamestrYesNoStrategy name at the time the position snapshot was generated.
UnderlyingstrNoYesUnderlying symbol for this position, when available.
UnderlyingContractIdintNoYesLive contract id for the position underlying, when available.
IsDefaultPositionboolNoNoTrue when this summary represents the account's default broker-position container.
QtyMultiplierDecimalNoYesOptional quantity multiplier used by some execution flows to scale leg quantities.