私有频道

端点

下载Schema

账户频道

推送账户抵押品（资金）变动。

WSS

account

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

账户频道 › 请求参数

method

string · required

SUBSCRIBE 或 UNSUBSCRIBE。

Example: SUBSCRIBE

params

string[] · required

渠道列表，账户频道填写 account。

Example: ["account"]

id

number

客户端自定义 ID，回执中原样返回。

Example: 11

账户频道 › 响应

账户频道

e

string

事件类型，固定为 account。

E

number

事件时间（毫秒）。

v

number

推送对应的账户版本号。

msgEvent

string

上游事件标签，例如 PositionFundingSettle。

object[]

抵押品明细数组。

coin

string

抵押品币种（大写）。

marginMode

string

保证金模式（CROSSED, ISOLATED）。

crossSymbol

string

全仓模式关联的交易对（非全仓时为空）。

isolatedPositionId

string

逐仓模式关联的仓位 ID。

amount

string

现有抵押品数量。

pendingDepositAmount

string

待入账充值。

pendingWithdrawAmount

string

待出账提现。

pendingTransferInAmount

string

待入账内部转入。

pendingTransferOutAmount

string

待出账内部转出。

liquidating

boolean

是否处于强平中。

legacyAmount

string

历史余额字段（仅展示）。

cumDepositAmount

string

累计充值。

cumWithdrawAmount

string

累计提现。

cumTransferInAmount

string

累计转入。

cumTransferOutAmount

string

累计转出。

cumMarginMoveInAmount

string

累计保证金转入。

cumMarginMoveOutAmount

string

累计保证金转出。

cumPositionOpenLongAmount

string

累计开多使用的抵押品数量。

cumPositionOpenShortAmount

string

累计开空使用的抵押品数量。

cumPositionCloseLongAmount

string

累计平多返还的抵押品数量。

cumPositionCloseShortAmount

string

累计平空返还的抵押品数量。

cumPositionFillFeeAmount

string

累计成交手续费。

cumPositionLiquidateFeeAmount

string

累计清算手续费。

cumPositionFundingAmount

string

累计资金费用（可能为负值）。

cumOrderFillFeeIncomeAmount

string

累计手续费收入。

cumOrderLiquidateFeeIncomeAmount

string

累计清算费收入。

createdTime

string

记录创建时间。

updatedTime

string

持仓频道

推送当前账户的持仓变动（数量、资金费用、保证金模式等）。

WSS

positions

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

持仓频道 › 请求参数

method

string · required

SUBSCRIBE 或 UNSUBSCRIBE。

Example: SUBSCRIBE

params

string[] · required

渠道列表，持仓频道填写 positions。

Example: ["positions"]

id

number

客户端自定义 ID，回执中原样返回。

Example: 7

持仓频道 › 响应

持仓频道

e

string

事件类型，固定为 positions。

E

number

事件时间（毫秒）。

v

number

推送对应的账户版本号。

msgEvent

string

上游事件标签，例如 PositionFundingSettle。

object[]

持仓明细数组。

id

string

仓位 ID。

coin

string

抵押品币种（大写）。

symbol

string

交易对（大写，如 BTCUSDT）。

side

string

持仓方向（LONG, SHORT, UNKNOWN）。

marginMode

string

保证金模式（CROSSED, ISOLATED）。

separatedMode

string

持仓模式（COMBINED, SEPARATED）。

separatedOpenOrderId

string

分仓开仓委托单 ID。

leverage

string

当前仓位杠杆。

size

string

当前持仓数量。

openValue

string

累计开仓价值。

openFee

string

累计开仓手续费。

fundingFee

string

当前资金费用累计。

isolatedMargin

string

逐仓保证金（全仓模式为 0）。

autoAppendIsolatedMargin

boolean

是否自动补充逐仓保证金。

cumOpenSize

string

累计开仓数量。

cumOpenValue

string

累计开仓价值。

cumOpenFee

string

累计开仓费用。

cumCloseSize

string

累计平仓数量。

cumCloseValue

string

累计平仓价值。

cumCloseFee

string

累计平仓费用。

cumFundingFee

string

累计资金费用。

cumLiquidateFee

string

累计清算费用。

createdMatchSequenceId

string

创建时的撮合引擎序号。

updatedMatchSequenceId

string

最近一次更新时的撮合引擎序号。

createdTime

string

创建时间戳。

updatedTime

string

更新时间戳。

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

请求体示例

{
  "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

成交明细频道

推送当前账户的成交明细（撮合成交记录）。

WSS

fill

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

成交明细频道 › 请求参数

method

string · required

SUBSCRIBE 或 UNSUBSCRIBE。

Example: SUBSCRIBE

params

string[] · required

渠道列表，成交频道填写 fill。

Example: ["fill"]

id

number

客户端自定义 ID，服务端在回执中原样返回。

Example: 9

成交明细频道 › 响应

成交明细频道

e

string

事件类型，固定为 fill。

E

number

事件时间（毫秒）。

v

number

账户版本号。

msgEvent

string

上游事件标签（例如 OrderUpdate）。

object[]

成交明细数组。

id

string

成交记录 ID。

coin

string

抵押品币种（大写）。

symbol

string

交易对（大写）。

orderId

string

对应的委托单 ID。

marginMode

string

保证金模式（CROSSED, ISOLATED）。

separatedMode

string

持仓模式（COMBINED, SEPARATED）。

separatedOpenOrderId

string

分仓开仓委托单 ID。

positionSide

string

仓位方向（LONG, SHORT, UNKNOWN）。

orderSide

string

买卖方向（BUY, SELL）。

fillSize

string

成交数量。

fillValue

string

成交金额。

fillFee

string

成交手续费。

liquidateFee

string

清算手续费（如有）。

realizePnl

string

本次成交实现盈亏。

direction

string

流动性方向（MAKER, TAKER）。

createdTime

string

创建时间戳。

updatedTime

string

更新时间戳。

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

请求体示例

{
  "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

订单频道

推送当前账户的委托生命周期变更。

WSS

orders

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

订单频道 › 请求参数

method

string · required

SUBSCRIBE 或 UNSUBSCRIBE。

Example: SUBSCRIBE

params

string[] · required

渠道列表，订单频道填写 orders。

Example: ["orders"]

id

number

客户端自定义标识，服务端会在回执中原样返回。

Example: 1

订单频道 › 响应

订单频道

e

string

事件类型，固定为 orders。

E

number

事件时间（毫秒）。

v

number

当前推送对应的账户版本号。

msgEvent

string

上游事件标签，如 OrderUpdate。

object[]

订单明细数组。

id

string

委托单 ID。

coin

string

抵押品币种（大写）。

symbol

string

交易对（大写，如 BTCUSDT）。

marginMode

string

保证金模式（CROSSED, ISOLATED）。

separatedMode

string

持仓模式（COMBINED, SEPARATED）。

separatedOpenOrderId

string

分仓开仓委托单 ID。

positionSide

string

仓位方向（LONG, SHORT, UNKNOWN）。

orderSide

string

下单方向（BUY, SELL）。

price

string

委托价格。

size

string

委托数量。

clientOrderId

string

客户端自定义 ID。

type

string

委托类型（LIMIT, MARKET, STOP, TAKE_PROFIT, STOP_MARKET, TAKE_PROFIT_MARKET）。

timeInForce

string

有效方式（GTC, IOC, FOK, POST_ONLY）。

reduceOnly

boolean

是否仅减仓。

triggerPrice

string

触发价格。

triggerPriceType

string

触发价格类型（CONTRACT_PRICE, MARK_PRICE）。

orderSource

string

委托来源（如 WEB, API）。

openTpslParentOrderId

string

关联的开仓订单 ID（针对止盈止损委托）。

positionTpsl

boolean

是否为仓位止盈/止损委托。

setOpenTp

boolean

是否设置开仓止盈。

setOpenSl

boolean

是否设置开仓止损。

leverage

string

下单时的杠杆倍数。

takerFeeRate

string

Taker 手续费率。

makerFeeRate

string

Maker 手续费率。

feeDiscount

string

手续费折扣系数。

liquidateFeeRate

string

清算手续费率。

status

string

订单状态（NEW, PENDING, UNTRIGGERED, FILLED, CANCELED, CANCELING 等）。

triggerTime

string

条件单触发时间。

triggerPriceTime

string

条件价更新时间。

triggerPriceValue

string

触发时记录的价格。

cancelReason

string

撤单原因（枚举）。

latestFillPrice

string