Position

Description

After an order is successfully placed, cancelled, or executed, a push notification will be sent to update the corresponding trading pair's position (including scenarios such as ADL that cause changes in position size).

Push frequency: Real-time

Account & Trade Type Support

Classic accounts: Supports Futures trade type.
UTA accounts: Supports Futures trade types, Margin (Isolated & Cross) is expected to be supported in Q1–Q2 next year.

Note:
The Pro API is currently in beta testing and should not be used in production trading environments.

//All position updates for all symbols.
{
  "id": "1545910660739",
  "action": "SUBSCRIBE",      // or UNSUBSCRIBE
  "channel":"positionAll",
  "tradeType": "FUTURES"   //  FUTURES / UNIFIED
}

//All position updates for your symbol.
{
  "id": "1545910660739",
  "action": "SUBSCRIBE",      // or UNSUBSCRIBE
  "channel":"position",
  "tradeType": "FUTURES",   //  FUTURES / UNIFIED
  "symbol":"XBTUSDTM"
}

Note:
If you are trading in UTA mode, set tradeType to UNIFIED.
This WebSocket subscription will deliver position updates for all supported trade types under the UTA account.

Response

Data Schema

positionAll

Example

{
    "T": "positionAll.UNIFIED",
    "P": 1768826664278643102,
    "d": {
        "pi": "70000000000000006",
        "s": "TRUMPUSDTM",
        "mM": "CROSS",
        "q": "-5",
        "eP": "5.1990844155844155844",
        "pV": "2.485",
        "mP": "4.97",
        "lP": "60.811504654",
        "bP": "61.5777296128",
        "l": "2",
        "uPL": "0.1145422077922077922",
        "rPL": "0.1026057122077922078",
        "iM": "1.2425",
        "mmr": "0.012",
        "mtM": "0.02982",
        "U": 1768826664272000000,
        "O": 1767153641927000000
    }
}

Subscribe Message#

Response#

Request

Subscribe Message

Response