Position Updates

Stream real-time position updates including size, margin, liquidation price, and PnL via WebSocket.

Overview

Receive position updates including size, average entry and exit prices, margin, liquidation price, profit and loss (PnL), and more via the positions channel.

Channel information

Property	Value
Channel Name	positions
Authentication	Required
Update Frequency	On position changes
Data Type	Array of position objects

Subscribe

Subscribe

{
  "op": "subscribe",
  "args": [ { "channel": "positions" } ]
}

Message format

Position Update

{
  "type": "position",
  "data": [
    {
      "id": "pos-uuid",
      "symbol": "US500-BTC",
      "accountId": "acct-uuid",
      "side": "long",
      "entryAmount": "1.000",
      "exitAmount": "0.500",
      "size": "0.500",
      "tradeMode": "isolated",
      "openDate": 1640995200000,
      "closeDate": null,
      "avgEntry": "50000.00",
      "avgExit": null,
      "entryFees": "0.00100000",
      "exitFees": null,
      "positionBalance": "0.05000000",
      "initialMargin": "0.05000000",
      "maintenanceMargin": "0.00500000",
      "liquidationPrice": "45000.00",
      "leverage": "10.0",
      "unrealizedPnl": "0.00100000",
      "realizedPnl": "0.00200000",
      "markPrice": "52500.00",
      "status": "normal",
      "updatedAt": 1640995200000000000,
      "createdAt": 1640995200000000000
    }
  ]
}

data[] · object

Position fields

Show Position properties

id · string

Position identifier

symbol · string

Instrument symbol

accountId · string

Account identifier (UUID)

side · string

long or short

entryAmount · string

Total entry amount (BTC)

exitAmount · string

Total exit amount (BTC)

size · string

Current position size (BTC)

tradeMode · string

e.g. isolated

openDate · integer

Open time in ms

closeDate · integer?

Close time in ms, if closed

avgEntry · string

Average entry price

avgExit · string?

Average exit price (if any)

entryFees · string

Entry fees (BTC)

exitFees · string?

Exit fees (BTC)

positionBalance · string

Position margin balance (BTC)

initialMargin · string

Initial margin (BTC)

maintenanceMargin · string

Maintenance margin (BTC)

liquidationPrice · string

Liquidation price

leverage · string

Leverage

unrealizedPnl · string

Unrealized PnL (BTC)

realizedPnl · string

Realized PnL (BTC)

markPrice · string

Mark price

status · string

normal, liquidation, or adl

updatedAt · integer

Update time in ns

createdAt · integer

Creation time in ns