Private Channels

Endpoint

Account Channel

Streams balance and asset updates (account) for the authenticated spot account. Events are pushed when deposits, withdrawals, transfers, or order operations change available balances.

WSS

account

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

Account Channel › Request Parameters

method

string · required

SUBSCRIBE or UNSUBSCRIBE.

Example: SUBSCRIBE

params

string[] · required

Use account.

Example: ["account"]

id

number

Client-defined identifier echoed in the acknowledgement.

Example: 1

Account Channel › Responses

Account Channel

e

string

Event type, account.

E

number

Event time in milliseconds.

v

number

Account version.

msgEvent

string

Upstream event name (e.g. DepositUpdate, WithdrawUpdate, OrderUpdate).

object[]

Asset list describing the latest balances.

Fill Channel

Streams execution details (fill) for orders belonging to the authenticated account.

WSS

fill

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

Fill Channel › Request Parameters

method

string · required

SUBSCRIBE or UNSUBSCRIBE.

Example: SUBSCRIBE

params

string[] · required

Use fill.

Example: ["fill"]

id

number

Client-defined identifier echoed in the acknowledgement.

Example: 2

Fill Channel › Responses

Fill Channel

e

string

Event type, fill.

E

number

Event time in milliseconds.

v

number

Account version.

msgEvent

string

Upstream event name (for example OrderUpdate).

object[]

Fill entries.

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

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

Example Request Body

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

json

application/json

{
  "e": "fill",
  "E": 1773295739001,
  "v": 39,
  "msgEvent": "OrderUpdate",
  "d": [
    {
      "id": "7423916138",
      "symbol": "BTCUSDT",
      "baseCoin": "BTC",
      "quoteCoin": "USDT",
      "orderId": "625138763307155610",
      "orderSide": "BUY",
      "fillSize": "0.000952",
      "fillValue": "99.9676160",
      "fillFee": "0.00000095",
      "direction": "TAKER",
      "createdTime": "1749044695718",
      "updatedTime": "1749044695718"
    }
  ]
}

json

application/json

Order Channel

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

WSS

orders

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

Order Channel › Request Parameters

method

string · required

SUBSCRIBE or UNSUBSCRIBE.

Example: SUBSCRIBE

params

string[] · required

Use orders. Only a single private channel may be subscribed per entry.

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-spot.weex.com/v3/ws/private

wscat -c wss://ws-spot.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": 38,
  "msgEvent": "OrderUpdate",
  "d": [
    {
      "id": "625138763307155610",
      "symbol": "BTCUSDT",
      "baseCoin": "BTC",
      "quoteCoin": "USDT",
      "orderSide": "BUY",
      "price": "0",
      "size": "0",
      "value": "100.0000000",
      "clientOrderId": "1749044695347g1xrdKa2xuDzbDHgTTkbu",
      "type": "MARKET",
      "timeInForce": "IOC",
      "reduceOnly": false,
      "triggerPrice": "0",
      "orderSource": "API",
      "openTpslParentOrderId": "0",
      "setOpenTp": false,
      "setOpenSl": false,
      "takerFeeRate": "0.001",
      "makerFeeRate": "0",
      "feeDiscount": "1",
      "takerFeeDiscount": "1",
      "makerFeeDiscount": "1",
      "status": "FILLED",
      "triggerTime": "0",
      "triggerPriceTime": "0",
      "triggerPriceValue": "0",
      "cancelReason": "UNKNOWN_ORDER_CANCEL_REASON",
      "latestFillPrice": "105008.0",
      "maxFillPrice": "105008.0",
      "minFillPrice": "105008.0",
      "cumFillSize": "0.000952",
      "cumFillValue": "99.9676160",
      "cumFillFee": "0.00000095",
      "createdTime": "1749044695689",
      "updatedTime": "1749044695720"
    }
  ]
}

json

application/json

Public Channels