Skip to main content

Query UM Position Information(USER_DATA)

API Description#

Get current UM position information.

HTTP Request#

GET /papi/v1/um/positionRisk

Request Weight#

5

Parameters:

NameTypeMandatoryDescription
symbolSTRINGNO
recvWindowLONGNO
timestampLONGYES

Note

  • Please use with user data stream ACCOUNT_UPDATE to meet your timeliness and accuracy needs.  
  • for One-way Mode user, the response will only show the "BOTH" positions
  • for Hedge Mode user, the response will show "LONG", and "SHORT" positions.

Response Example#

  • For One-way position mode:
 [    {        "entryPrice": "0.00000", // 开仓均价        "leverage": "10", // 当前杠杆倍数        "markPrice": "6679.50671178",   // 当前标记价格        "maxNotionalValue": "20000000", // 当前杠杆倍数允许的名义价值上限        "positionAmt": "0.000", // 头寸数量,符号代表多空方向, 正数为多,负数为空        "notional": "0",        "symbol": "BTCUSDT", // 交易对        "unRealizedProfit": "0.00000000", // 持仓未实现盈亏        "liquidationPrice": "6170.20509059",        "positionSide": "BOTH", // 持仓方向        "updateTime": 1625474304765   // 更新时间    }]

Or For Hedge position mode(only return with position):

[    {        "symbol": "BTCUSDT",        "positionAmt": "0.001",        "entryPrice": "22185.2",        "markPrice": "21123.05052574",        "unRealizedProfit": "-1.06214947",        "liquidationPrice": "6170.20509059",        "leverage": "4",        "maxNotionalValue": "100000000",        "positionSide": "LONG",        "notional": "21.12305052",        "updateTime": 1655217461579    },    {        "symbol": "BTCUSDT",        "positionAmt": "0.000",        "entryPrice": "0.0",        "markPrice": "21123.05052574",        "unRealizedProfit": "0.00000000",        "liquidationPrice": "6170.20509059",        "leverage": "4",        "maxNotionalValue": "100000000",        "positionSide": "SHORT",        "notional": "0",        "updateTime": 0    }]