Skip to content

position_risk#

WS wss://api.pro.anboto.xyz/api/v2/ws

Channel for subscribing to position risk telemetry; subscribe with {"topic":"position_risk","exchange":...,"method":"subscribe"}

Authenticate the connection with a listenKey — see WebSocket.

Subscribe message#

topic string required
position_risk
exchange string required
Trading exchange, case-insensitive
Example: BINANCE
method enum required
subscribe / unsubscribe

Update message fields#

exchangeId integer
subaccount string
error string
positionRisk object
positionRisk.symbol string
positionRisk.contracts number
positionRisk.contractSize number
positionRisk.unrealizedPnl number
positionRisk.leverage number
positionRisk.liquidationPrice number
positionRisk.collateral number
positionRisk.notional number
positionRisk.markPrice number
positionRisk.entryPrice number
positionRisk.timestamp integer
positionRisk.initialMargin number
positionRisk.initialMarginPercentage number
positionRisk.maintenanceMargin number
positionRisk.maintenanceMarginPercentage number
positionRisk.marginRatio number
positionRisk.marginMode string
positionRisk.side string
positionRisk.hedged boolean
positionRisk.percentage number
positionRisk.stopLossPrice number
positionRisk.takeProfitPrice number

Responses#
code 0 Acknowledgment of successful subscription
code ≠ 0 Error response for failed subscription — see Errors

Update position_risk

{
  "exchangeId": 0,
  "subaccount": "string",
  "error": "string",
  "positionRisk": {
    "symbol": "string",
    "contracts": 0.0,
    "contractSize": 0.0,
    "unrealizedPnl": 0.0,
    "leverage": 0.0,
    "liquidationPrice": 0.0,
    "collateral": 0.0,
    "notional": 0.0,
    "markPrice": 0.0,
    "entryPrice": 0.0,
    "timestamp": 0,
    "initialMargin": 0.0,
    "initialMarginPercentage": 0.0,
    "maintenanceMargin": 0.0,
    "maintenanceMarginPercentage": 0.0,
    "marginRatio": 0.0,
    "marginMode": "string",
    "side": "string",
    "hedged": true,
    "percentage": 0.0,
    "stopLossPrice": 0.0,
    "takeProfitPrice": 0.0
  }
}

Ack code 0

{
  "code": 0,
  "message": "string"
}