Private Channels

Endpoint

Download Schema

Account Channel

Streams collateral balance changes for the authenticated account.

WSS

account

wss://ws-contract.weex.com/v3/ws/private

Account Channel › Request Parameters

method

string · required

SUBSCRIBE or UNSUBSCRIBE.

Example: SUBSCRIBE

params

string[] · required

Channel list. Use account.

Example: ["account"]

id

number

Client-defined identifier echoed in the acknowledgement.

Example: 11

Account Channel › Responses

Account Channel

e

string

Event type, always account.

E

number

Event time in milliseconds.

v

number

Account version associated with the update.

msgEvent

string

Upstream event label (for example PositionFundingSettle).

object[]

Collateral entries.

WSSaccountwss://ws-contract.weex.com/v3/ws/private

wscat -c wss://ws-contract.weex.com/v3/ws/private -x '{
  "method": "SUBSCRIBE",
  "params": [
    "account"
  ],
  "id": 11
}' -w 30

Example Request Body

{
  "method": "SUBSCRIBE",
  "params": [
    "account"
  ],
  "id": 11
}

json

application/json

{
  "e": "account",
  "E": 1773298961302,
  "v": 46571,
  "msgEvent": "PositionFundingSettle",
  "d": [
    {
      "coin": "USDT",
      "marginMode": "CROSSED",
      "crossSymbol": "",
      "isolatedPositionId": "0",
      "amount": "6625267.708162",
      "pendingDepositAmount": "0.000000",
      "pendingWithdrawAmount": "0.000000",
      "pendingTransferInAmount": "0",
      "pendingTransferOutAmount": "0",
      "liquidating": false,
      "legacyAmount": "6628108.535375",
      "cumDepositAmount": "6850179.708361",
      "cumWithdrawAmount": "118.284985",
      "cumTransferInAmount": "151.912400",
      "cumTransferOutAmount": "0",
      "cumMarginMoveInAmount": "0",
      "cumMarginMoveOutAmount": "114.587618",
      "cumPositionOpenLongAmount": "3551408.796139",
      "cumPositionOpenShortAmount": "287685.101200",
      "cumPositionCloseLongAmount": "3406364.752975",
      "cumPositionCloseShortAmount": "287789.808420",
      "cumPositionFillFeeAmount": "32.199683",
      "cumPositionLiquidateFeeAmount": "76.930498",
      "cumPositionFundingAmount": "-5778.744009",
      "cumOrderFillFeeIncomeAmount": "0",
      "cumOrderLiquidateFeeIncomeAmount": "0",
      "createdTime": "1728493664997",
      "updatedTime": "1747188961302"
    }
  ]
}

json

application/json

Position Channel

Streams position changes (quantity, funding, margin mode) for the authenticated account.

WSS

positions

wss://ws-contract.weex.com/v3/ws/private

Position Channel › Request Parameters

method

string · required

SUBSCRIBE or UNSUBSCRIBE.

Example: SUBSCRIBE

params

string[] · required

Channel list. Use positions.

Example: ["positions"]

id

number

Client-specified identifier echoed in the acknowledgement.

Example: 7

Position Channel › Responses

Position Channel

e

string

Event type, always positions.

E

number

Event time in milliseconds.

v

number

Account data version associated with the update.

msgEvent

string

Upstream event label (e.g. PositionFundingSettle).

object[]

Updated position entries.

WSSpositionswss://ws-contract.weex.com/v3/ws/private

wscat -c wss://ws-contract.weex.com/v3/ws/private -x '{
  "method": "SUBSCRIBE",
  "params": [
    "positions"
  ],
  "id": 7
}' -w 30

Example Request Body

{
  "method": "SUBSCRIBE",
  "params": [
    "positions"
  ],
  "id": 7
}

json

application/json

{
  "e": "positions",
  "E": 1773298805123,
  "v": 55218,
  "msgEvent": "PositionFundingSettle",
  "d": [
    {
      "id": "615193369903104410",
      "coin": "USDT",
      "symbol": "BTCUSDT",
      "side": "LONG",
      "marginMode": "CROSSED",
      "separatedMode": "COMBINED",
      "separatedOpenOrderId": "0",
      "leverage": "20",
      "size": "0.01000",
      "openValue": "992.405443",
      "openFee": "0.595443",
      "fundingFee": "157.475456",
      "isolatedMargin": "0",
      "autoAppendIsolatedMargin": false,
      "cumOpenSize": "0.55061",
      "cumOpenValue": "54642.836110",
      "cumOpenFee": "32.785700",
      "cumCloseSize": "0.54061",
      "cumCloseValue": "53666.138456",
      "cumCloseFee": "32.199683",
      "cumFundingFee": "163.232384",
      "cumLiquidateFee": "0",
      "createdMatchSequenceId": "3647905144",
      "updatedMatchSequenceId": "3656434385",
      "createdTime": "1746673529125",
      "updatedTime": "1747188961302"
    }
  ]
}

json

application/json

Fill Channel

Streams real-time fill details for orders owned by the authenticated account.

WSS

fill

wss://ws-contract.weex.com/v3/ws/private

Fill Channel › Request Parameters

method

string · required

SUBSCRIBE or UNSUBSCRIBE.

Example: SUBSCRIBE

params

string[] · required

Channel list. Use fill.

Example: ["fill"]

id

number

Client-defined identifier echoed in the acknowledgement.

Example: 9

Fill Channel › Responses

Fill Channel

e

string

Event type, always fill.

E

number

Event time in milliseconds.

v

number

Account data version related to the update.

msgEvent

string

Upstream event label (e.g. OrderUpdate).

object[]

Fill entries.

WSSfillwss://ws-contract.weex.com/v3/ws/private

wscat -c wss://ws-contract.weex.com/v3/ws/private -x '{
  "method": "SUBSCRIBE",
  "params": [
    "fill"
  ],
  "id": 9
}' -w 30

Example Request Body

{
  "method": "SUBSCRIBE",
  "params": [
    "fill"
  ],
  "id": 9
}

json

application/json

{
  "e": "fill",
  "E": 1773295739154,
  "v": 46655,
  "msgEvent": "OrderUpdate",
  "d": [
    {
      "id": "617414920887075482",
      "coin": "USDT",
      "symbol": "BTCUSDT",
      "orderId": "617414920861909658",
      "marginMode": "CROSSED",
      "separatedMode": "COMBINED",
      "separatedOpenOrderId": "0",
      "positionSide": "LONG",
      "orderSide": "BUY",
      "fillSize": "0.10000",
      "fillValue": "10381.270000",
      "fillFee": "6.228762",
      "liquidateFee": "0",
      "realizePnl": "0",
      "direction": "TAKER",
      "createdTime": "1747203188154",
      "updatedTime": "1747203188154"
    }
  ]
}

json

application/json

Order Channel

Streams real-time order lifecycle updates for the authenticated account.

WSS

orders

wss://ws-contract.weex.com/v3/ws/private

Order Channel › Request Parameters

method

string · required

SUBSCRIBE or UNSUBSCRIBE.

Example: SUBSCRIBE

params

string[] · required

Channel list. Use orders.

Example: ["orders"]

id

number

Client-provided identifier echoed in the acknowledgement.

Example: 1

Order Channel › Responses

Order Channel

e

string

Event type, always orders.

E

number

Event time in milliseconds.

v

number

Account version associated with the update.

msgEvent

string

Upstream event name (for example OrderUpdate).

object[]

Updated order entries.

WSSorderswss://ws-contract.weex.com/v3/ws/private

wscat -c wss://ws-contract.weex.com/v3/ws/private -x '{
  "method": "SUBSCRIBE",
  "params": [
    "orders"
  ],
  "id": 1
}' -w 30

Example Request Body

{
  "method": "SUBSCRIBE",
  "params": [
    "orders"
  ],
  "id": 1
}

json

application/json

{
  "e": "orders",
  "E": 1773295738939,
  "v": 46654,
  "msgEvent": "OrderUpdate",
  "d": [
    {
      "id": "617414920861909658",
      "coin": "USDT",
      "symbol": "BTCUSDT",
      "marginMode": "CROSSED",
      "separatedMode": "COMBINED",
      "separatedOpenOrderId": "0",
      "positionSide": "LONG",
      "orderSide": "BUY",
      "price": "0.0",
      "size": "0.10000",
      "clientOrderId": "1747203186927FPIZRP",
      "type": "MARKET",
      "timeInForce": "IOC",
      "reduceOnly": false,
      "triggerPrice": "0",
      "triggerPriceType": "CONTRACT_PRICE",
      "orderSource": "WEB",
      "openTpslParentOrderId": "0",
      "positionTpsl": false,
      "setOpenTp": false,
      "setOpenSl": false,
      "leverage": "20",
      "takerFeeRate": "0.0006",
      "makerFeeRate": "0.0002",
      "feeDiscount": "1",
      "liquidateFeeRate": "0.01",
      "status": "PENDING",
      "triggerTime": "0",
      "triggerPriceTime": "0",
      "triggerPriceValue": "0",
      "cancelReason": "UNKNOWN_ORDER_CANCEL_REASON",
      "latestFillPrice": "0",
      "maxFillPrice": "0",
      "minFillPrice": "0",
      "cumFillSize": "0",
      "cumFillValue": "0",
      "cumFillFee": "0",
      "cumLiquidateFee": "0",
      "cumRealizePnl": "0",
      "createdTime": "1747203188148",
      "updatedTime": "1747203188148"
    }
  ]
}

json

application/json

Public Channels