Skip to main content

ListPositionsArgs

Arguments for ListPositions.

FieldTypeRequiredNullableDefaultDescription
KindLivePositionKindFilterNoNoLivePositionKindFilter.StrategyOrExecutionPlanWhich position namespace to query.
LiveStrategyIdintNoYesOptional filter by live strategy id.
LiveExecPlanIdintNoYesOptional filter by live execution plan id.
BrokerAccountIdstrNoYesOptional filter by broker account id.
UnderlyingContractIdintNoYesOptional filter by underlying live contract id.
StateLivePositionStateNoYesOptional filter by live position state.
LimitintNoYesMaximum number of items to return. The server may cap this value.
ContinuationTokenstrNoYesPagination token returned by a previous ListPositions call.