Subscriptions

Cross Position

Inverse futures cross-margin position state updates (new, limit, cancel, leverage, deposit, withdraw, liquidation, funding)

Private · futures:cross:read · 3 fields

Topic futures/inverse/btc_usd/cross/position

Inverse futures cross-margin position state updates (new, limit, cancel, leverage, deposit, withdraw, liquidation, funding)

Authentication required. Your API key must have permission futures:cross:read. Subscribe after sending authenticate; private events delivered before auth are dropped.

Subscribe

Subscribe by calling the subscribe method with this topic.

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "subscribe",
  "params": {
    "topics": [
      "futures/inverse/btc_usd/cross/position"
    ]
  }
}

Payload

Each notification carries the fields below in params.data.

pair*string
btc_usd
event*string
newlimitcancelleveragedepositwithdrawliquidationfunding
position*object

Example notification

The server pushes the JSON-RPC notification below for every event on this topic.

Notification

{
  "jsonrpc": "2.0",
  "method": "subscription",
  "params": {
    "topic": "futures/inverse/btc_usd/cross/position",
    "data": {
      "pair": "btc_usd",
      "event": "new",
      "position": {
        "quantity": -9007199254740991,
        "leverage": 0,
        "margin": -9007199254740991,
        "entryPrice": -9007199254740991,
        "liquidation": -9007199254740991,
        "totalPl": -9007199254740991,
        "fundingFees": -9007199254740991,
        "tradingFees": -9007199254740991,
        "initialMargin": -9007199254740991,
        "maintenanceMargin": -9007199254740991,
        "runningMargin": -9007199254740991,
        "deltaPl": -9007199254740991,
        "updatedAt": 0
      }
    }
  }
}