Skip to main content

Notifications

WSProductionwss://ws.btse.com/ws/futuresTestnetwss://testws.btse.io/ws/futures

Real-time order status updates. Requires WebSocket authentication. Topic: notificationApiV4

Carries the full v2.3 size set (originalOrderSize, currentOrderSize, filledSize, totalFilledSize, remainingSize) plus positionId and postOnly, so partial fills and post-only orders are represented faithfully.

Response Content

NameTypeRequiredDescription
topicStringYes
dataObject[]YesArray of data objects

Data Object:

NameTypeRequiredDescription
symbolStringYesMarket symbol
orderIDStringYesInternal order ID
sideStringYesBUY or SELL
typeIntegerYes76: Limit · 77: Market · 80: Algo
priceDoubleYesOrder price or transacted price
originalOrderSizeIntegerYesOriginal order quantity
currentOrderSizeIntegerYesLatest order quantity
filledSizeIntegerYesQuantity filled in this update
totalFilledSizeIntegerYesCumulative filled quantity
remainingSizeIntegerYesRemaining quantity
avgFilledPriceDoubleYesAverage filled price
statusIntegerYesOrder status code: 2 (ORDER_INSERTED) · 4 (FULLY_MATCHED) · 5 (PARTIAL_FILL) · 6 (CANCELLED) · 9 (TRIGGER_INSERTED) · 10 (TRIGGER_ACTIVATED) · 15 (REJECTED)
clOrderIDStringYesCustom order ID
makerBooleanYesWhether this was a maker trade
time_in_forceStringYesTime in force: GTC · IOC · FOK · HALFMIN · FIVEMIN · HOUR · TWELVEHOUR · DAY · WEEK · MONTH
timestampLongYesOrder/trade timestamp
txTypeStringYesSTOP · TAKEPROFIT · LIMIT
triggerPriceDoubleYesTrigger price
stealthDoubleYesAlgo orders only
pegPriceDeviationDoubleYesAlgo orders only
positionIdStringYesPosition ID
postOnlyBooleanYesWhether post-only order
example

Response

{
"topic": "notificationApiV4",
"data": [
{
"symbol": "BTC-PERP",
"orderID": "45e8bb8d-d708-4a90-a428-c61583f90efe",
"side": "BUY",
"orderType": 77,
"type": 0,
"price": 111085.1,
"triggerPrice": 0,
"status": 4,
"timestamp": 1752147101805,
"avgFilledPrice": 111085.1,
"clOrderID": "",
"postOnly": false,
"maker": false,
"positionId": "BTC-PERP-USDT",
"originalOrderSize": 900,
"currentOrderSize": 900,
"filledSize": 900,
"totalFilledSize": 900,
"remainingSize": 0,
"time_in_force": "GTC"
}
]
}