Message: ExchangePositionStatus

File: WebAPI/trade_routing_2.proto

Description

Exchange position status. It contains positions received from the exchange for an account on a per-contract basis, both open positions and realized P&L for closed positions (if available from the exchange). There could be multiple position records for a given account. It is also possible for an account to have zero position records.

Request: TradeSubscription.

Used in

ServerMsg

Fields

subscription_ids

Type: uint32

Description: List of trade subscription IDs this status is related to.

is_snapshot

Type: bool

Description: True means a snapshot of all positions for the account has been sent (possibly in multiple ExchangePositionStatus messages, see is_complete field), so client should replace any local cache with this data. False or empty means this status contains only positions with changes.

Note: Snapshots (is_snapshot=true) are possible even when ExchangePositionStatus is sent as an update. This will occur when the server cannot update individual positions due to exchange limitations.

is_complete

Type: bool

Default: true

Description: True means that requested data is complete at the moment for the account, false means more report messages are expected for completeness.

account_id

Type: sint32

Description: Account ID for which positions are supplied.

Required: yes.

positions

Type: ExchangePosition

Description: Positions for this account.