Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
{
"id": "clientID3",
"event": "subscribe",
"success": true,
"ts": 1682244308139
}
{
"topic": "position",
"ts": 1684926050966,
"data": {
"positions": [
{
"symbol": "PERP_ETH_USDC",
"positionQty": 3.1408,
"costPosition": 5706.51952,
"lastSumUnitaryFunding": 0.804,
"sumUnitaryFundingVersion": 0,
"pendingLongQty": 0.0,
"pendingShortQty": -1.0,
"settlePrice": 1816.9,
"averageOpenPrice": 1804.51490427,
"unsettledPnl": -2.79856,
"pnl24H": -338.90179488,
"fee24H": 4.242423,
"markPrice": 1816.2,
"estLiqPrice": 0.0,
"version": 179967,
"imrwithOrders": 0.1,
"mmrwithOrders": 0.05,
"mmr": 0.05,
"imr": 0.1,
"seq": 1730181536341943600,
"timestamp": 1685429350571,
"updated_time": 1685429350571,
"leverage": 10,
"marginMode": "CROSS",
"margin": 0,
"accruedFundingFee": 0.005202
}
]
}
}
Subscribe to real-time position updates via private WebSocket stream.
{
"id": "clientID3",
"event": "subscribe",
"success": true,
"ts": 1682244308139
}
{
"topic": "position",
"ts": 1684926050966,
"data": {
"positions": [
{
"symbol": "PERP_ETH_USDC",
"positionQty": 3.1408,
"costPosition": 5706.51952,
"lastSumUnitaryFunding": 0.804,
"sumUnitaryFundingVersion": 0,
"pendingLongQty": 0.0,
"pendingShortQty": -1.0,
"settlePrice": 1816.9,
"averageOpenPrice": 1804.51490427,
"unsettledPnl": -2.79856,
"pnl24H": -338.90179488,
"fee24H": 4.242423,
"markPrice": 1816.2,
"estLiqPrice": 0.0,
"version": 179967,
"imrwithOrders": 0.1,
"mmrwithOrders": 0.05,
"mmr": 0.05,
"imr": 0.1,
"seq": 1730181536341943600,
"timestamp": 1685429350571,
"updated_time": 1685429350571,
"leverage": 10,
"marginMode": "CROSS",
"margin": 0,
"accruedFundingFee": 0.005202
}
]
}
}
{
"id": "clientID3",
"topic": "position",
"event": "subscribe"
}
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Y | id generate by client |
| event | string | Y | subscribe/unsubscribe |
| topic | string | Y | position |
{
"id": "clientID3",
"event": "subscribe",
"success": true,
"ts": 1682244308139
}
{
"topic": "position",
"ts": 1684926050966,
"data": {
"positions": [
{
"symbol": "PERP_ETH_USDC",
"positionQty": 3.1408,
"costPosition": 5706.51952,
"lastSumUnitaryFunding": 0.804,
"sumUnitaryFundingVersion": 0,
"pendingLongQty": 0.0,
"pendingShortQty": -1.0,
"settlePrice": 1816.9,
"averageOpenPrice": 1804.51490427,
"unsettledPnl": -2.79856,
"pnl24H": -338.90179488,
"fee24H": 4.242423,
"markPrice": 1816.2,
"estLiqPrice": 0.0,
"version": 179967,
"imrwithOrders": 0.1,
"mmrwithOrders": 0.05,
"mmr": 0.05,
"imr": 0.1,
"seq": 1730181536341943600,
"timestamp": 1685429350571,
"updated_time": 1685429350571,
"leverage": 10,
"marginMode": "CROSS",
"margin": 0,
"accruedFundingFee": 0.005202
}
]
}
}
positionQty is signed: positive means an UP position, negative means a DOWN position. marginMode is always ISOLATED for Predict positions. See Positions and Settlement for how this position is reported over REST.