Skip to main content

​
Overview

Receive position updates including size, average entry/exit, margin, liquidation price, PnL and more via the positions channel.

​
Channel Information

PropertyValue
Channel Namepositions
AuthenticationRequired
Update FrequencyOn position changes
Data TypeArray of position objects

​
Subscribe

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

​
Message Format

{
  "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
⌘I