跳到主要内容

Websocket账户信息推送

  • 本篇所列出API接口的base url : https://api.mexc.com
  • 用于订阅账户数据的 listenKey 从创建时刻起有效期为60分钟
  • 可以通过 PUT 一个 listenKey 延长60分钟有效期
  • 可以通过DELETE一个 listenKey 立即关闭当前数据流，并使该listenKey 无效
  • websocket接口的baseurl: ws://wbs-api.mexc.com/ws
  • 订阅账户数据流的stream名称为 /ws?listenKey=listenKey
    如：ws://wbs-api.mexc.com/ws?listenKey=pqia91ma19a5s61cv6a81va65sd099v8a65a1a5s61cv6a81va65sdf19v8a65a1
  • 每个链接有效期不超过24小时，请妥善处理断线重连
  • 每个UID，最多申请60个listen key（不包含已失效listen key）
  • ws链接数的数量限制：每个listen key最多5个ws链接（即：每个uid最多申请的60个listen key，300个ws链接）

Listen Key​

生成 Listen Key​

响应

{
  "listenKey": "pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
}

接口权限要求: 账户读 / SPOT_ACCOUNT_R

HTTP请求

  • POST /api/v3/userDataStream

开始一个新的数据流。除非发送 keepalive，否则数据流于60分钟后关闭。

参数:

NONE

获取有效 Listen Key​

响应

{
    "listenKey": [
        "c285bc363cfeac6646576b801a2ed1f9523310fcda9e927e509aaaaaaaaaaaaaa",
        "87cb8da0fb150e36c232c2c060bc3848693312008caf3acae73bbbbbbbbbbbb",
        "dc027517ebee2328b75268461a9df4d21addfac6ebebab8f5a6cccccccccccccc"
    ]
}

接口权限要求: 账户读 / SPOT_ACCOUNT_R

HTTP请求

  • GET /api/v3/userDataStream

获取当前所有有效的listenKey

参数:

NONE

延长 Listen Key 有效期​

响应

{
    "listenKey": "pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
}

HTTP请求

  • PUT /api/v3/userDataStream

有效期延长至本次调用后60分钟,建议每30分钟发送一次请求。

请求参数:

参数名数据类型是否必需说明
listenKeystring是

关闭 Listen Key​

响应

{
    "listenKey": "pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
}

HTTP请求

  • DELETE /api/v3/userDataStream

关闭用户数据流。

请求参数:

参数名数据类型是否必需说明
listenKeystring是

现货账户信息​

在订阅成功后，每当账户余额发生变动或可用余额发生变动时，服务器将推送账户资产的更新。

request:

{
    "method": "SUBSCRIPTION",
    "params": [
    "spot@private.account.v3.api.pb"
    ]
}

response:

{
	channel: "spot@private.account.v3.api.pb"
	createTime: 1736417034305
	sendTime: 1736417034307
	privateAccount {
  	vcoinName: "USDT"
  	coinId: "128f589271cb4951b03e71e6323eb7be"
  	balanceAmount: "21.94210356004384"
  	balanceAmountChange: "10"
  	frozenAmount: "0"
  	frozenAmountChange: "0"
  	type: "CONTRACT_TRANSFER"
  	time: 1736416910000
	}
}

请求参数： spot@private.account.v3.api.pb

返回参数:

参数名数据类型说明
privateAccountjson账户信息
vcoinNamestring资产名称
balanceAmountstring可用余额
balanceAmountChangestring可用变动金额
frozenAmountstring冻结余额
frozenAmountChangestring冻结变动金额
typestring变动类型
timelong结算时间

现货账户成交​

request:

{
    "method": "SUBSCRIPTION",
    "params": [
        "spot@private.deals.v3.api.pb"
    ]
}

response:

{
	channel: "spot@private.deals.v3.api.pb"
	symbol: "MXUSDT"
	sendTime: 1736417034332
	privateDeals {
  	price: "3.6962"
		quantity: "1"
 		amount: "3.6962"
	  tradeType: 2
	  isMaker: false
	  tradeId: "505979017439002624X1"
	  orderId: "C02__505979017439002624115"
	  feeAmount: "0.0003998377369698171"
 		feeCurrency: "MX"
	  time: 1736417034280
	}
}

请求参数： spot@private.deals.v3.api.pb

返回参数:

参数名数据类型说明
symbolstring交易对
sendTimelong事件时间
privateDealsjson账户成交信息
pricestring交易价格
quantitystring交易数量
amountstring交易金额
tradeTypeint交易类型 1:买 2:卖
tradeIdstring成交id: tradeId
isMakerBoolean是否是maker
orderIdstring订单id: orderId
clientOrderIdstring用户自定义订单id: clientOrderId
feeAmountstring手续费数量
feeCurrencystring手续费币种
timelong成交时间

现货账户订单​

request:

{
  "method": "SUBSCRIPTION",
  "params": [
      "spot@private.orders.v3.api.pb"
  ]
}

请求参数： spot@private.orders.v3.api.pb

response:

{
	channel: "spot@private.orders.v3.api.pb"
	symbol: "MXUSDT"
	sendTime: 1736417034281
	privateOrders {
	  clientId: "C02__505979017439002624115"
	  price: "3.5121"
	  quantity: "1"
	  amount: "0"
	  avgPrice: "3.6962"
	  orderType: 5
	  tradeType: 2
	  remainAmount: "0"
	  remainQuantity: "0"
	  lastDealQuantity: "1"
	  cumulativeQuantity: "1"
	  cumulativeAmount: "3.6962"
	  status: 2
	  createTime: 1736417034259
	}
}

返回参数:

参数名数据类型说明
symbolstring交易对
sendTimelong事件时间
privateOrdersjson账户订单信息
idstring订单id
pricebigDecimal下单价格
quantitybigDecimal下单数量
amountbigDecimal下单总金额
avgPricebigDecimal平均成交价
orderTypeint订单类型LIMIT_ORDER(1),POST_ONLY(2),IMMEDIATE_OR_CANCEL(3),
FILL_OR_KILL(4),MARKET_ORDER(5); 止盈止损（100）
tradeTypeint交易类型 1:买 2:卖
remainAmountbigDecimal实际剩余金额: remainAmount
remainQuantitybigDecimal实际剩余数量: remainQuantity
cumulativeQuantitybigDecimal累计成交数量
cumulativeAmountbigDecimal累计成交金额
statusint订单状态 1:未成交 2:已成交 3:部分成交 4:已撤单 5:部分撤单
createTimelong订单创建时间