Skip to content

order#

WS wss://api.pro.anboto.xyz/api/v2/ws

Channel for subscribing to order updates for a specific exchange

Authenticate the connection with a listenKey — see WebSocket.

Subscribe message#

topic string required
order
exchange string required
Trading exchange, case-insensitive
Example: BINANCE
method enum required
subscribe / unsubscribe

Update message fields#

orderStatus OrderStatusObj
Order Status
orderStatus.source string
Component sending the status
orderStatus.orderId int64
Anboto's order Id
orderStatus.clientOrderId string
Client referenced order Id
orderStatus.extId string
Order Id from exchange
orderStatus.exchangeId integer
Exchange Id
orderStatus.status enum
Order Status — PENDING_NEW, ACCEPTED, REJECTED, PARTIALLY_FILLED, FILLED, PENDING_CANCEL, CANCELLED, PENDING_PAUSE, … (12 values)
orderStatus.createdAt integer
Unix timestamp of this status change in milliseconds
orderStatus.filledQuantity integer
filled quantity of the order
orderStatus.leavesQuantity integer
leave quantity of the order
orderStatus.side enum
order side — BUY, SELL
orderStatus.averagePrice decimal
average price of the fills
orderStatus.message string
Status message
orderStatus.errorCode string
Error code
order object
The order context: orderId, clientOrderId, exchangeId, exchangeName, subaccount, symbol, assetClass, side, quantity, limitPrice, strategy, orderType, tif, createdAt, startTime, endTime, clipSizeType, clipSizeVal, targetValue, feeUrgency, params, source, linkId. Multi-leg orders carry algo and legs[] instead of the single-symbol fields.
orderProgress number
Execution progress of the parent order, 0..1
mishedge number
Multi-leg only — current mishedge between the legs

Responses#
code 0 Acknowledgment of successful subscription
code ≠ 0 Error response for failed subscription — see Errors 
{
  "topic": "order",
  "exchange": "BINANCE",
  "method": "subscribe"
}

{
  "topic": "order",
  "exchange": "BINANCE",
  "method": "unsubscribe"
}

Update order

{
  "orderStatus": {
    "clientOrderId": "554500941080543232",
    "createdAt": 1773198526482,
    "filledQuantity": 0,
    "leavesQuantity": 0,
    "orderId": "554500941080543233",
    "side": "BUY",
    "source": "ods-764fc58e30",
    "status": "PENDING_NEW"
  },
  "order": {
    "orderId": "554500941080543233",
    "clientOrderId": "554500941080543232",
    "exchangeId": 1,
    "exchangeName": "BINANCE",
    "symbol": "BTC/USDT",
    "assetClass": "SPOT",
    "side": "BUY",
    "quantity": 1.0,
    "strategy": "TWAP",
    "orderType": "LIMIT",
    "createdAt": 1773198526000,
    "startTime": 1773198526000,
    "endTime": 1773202126000
  },
  "orderProgress": 0
}

Ack code 0

{
  "code": 0,
  "message": "string"
}