URL:

arguments array

The connection parameters.

In the first element, provide the accountId as a string.

invocationId string

The invocation identifier.

Must be unique and increase by 1 for each sent message.

target string

The stream name.

Specify "OpenPositions".

type int

The operation type.

Set to 4 to indicate a subscription to the stream.

Example:

type string

The operation type.

2 indicates the streaming is in progress.

invocationId string

The invocation identifier. Same as in the request.

item object

The dataset object.

item.item array of objects

The array of position objects.

item.item.positionId string

The unique identifier of the position assigned by the system.

item.item.marketId string

The market identifier, in the following format: {marketType}.{baseAssetId}_{quoteAssetId}, for example: cfd.eth_eur.

item.item.marketType string

The market type.

Possible values:

item.item.marketDisplayName string

The market ticker.

item.item.marketFullName string

The market full name or description (optional).

item.item.createdAt dateTime

The timestamp when the position was opened, in ISO 8601 format.

item.item.updatedAt dateTime

The timestamp of the most recent update to the position, in ISO 8601 format.

item.item.side string

The position side. Possible values:

item.item.status string

The current position status. Always "Open".

item.item.leverage int

Applicable only to CFD markets.

The leverage ratio used when opening the position.

item.item.positionLotAmount decimal string

The position volume, in lots.

item.item.positionPriceInRAT decimal string

The current position price, in conversion to RAT.

item.item.rateToRAT decimal string

The current exchange rate of a quote asset to RAT.

item.item.usedMarginInRAT decimal string

The amount of trader’s funds used for maintaining a position, in conversion to RAT.

item.item.openPrice decimal string

The volume-weighted average price (VWAP) at which the position was opened.

item.item.currentMarketPrice decimal string

The current market price of the base asset: bid for Long positions and ask for Short positions.

item.item.unrealizedPnlDayInRAT decimal string

The potential profit or loss earned for a current day, in conversion to RAT.

For Long positions, this value is calculated as Position size × (Current bid price – First bid price for today).

For Short positions, this value is calculated as Position size × (First ask price for today – Current ask price).

If a position was opened today, then the Open VWAP is used instead of the First price for today.

item.item.unrealizedPnlDayPercent decimal string

The potential profit or loss earned for a current day, in percents.

item.item.unrealizedPnlTotalInRAT decimal string

The potential profit or loss earned for the entire period from the moment the position was opened, in conversion to RAT.

For Long positions, this value is calculated as Position size × (Current bid price – Open VWAP).

For Short positions, this value is calculated as Position size × (Open VWAP – Current ask price).

item.item.unrealizedPnlTotalPercent decimal string

The potential profit or loss earned for the entire period from the moment the position was opened, in conversion to RAT, in percents.

item.item.takeProfit decimal string

The Take Profit price, if set.

item.item.stopLoss decimal string

The Stop Loss price, if set.

item.item.positionModifier string

The reason for the latest position update.

snapshot boolean

The data snapshot.

If snapshot: true, it indicates the message contains the full dataset. Subsequent messages with snapshot: false only include updates or changes since the initial snapshot.

Example: