Orders

Topic: /contractMarket/tradeOrders

OR

Topic: /contractMarket/tradeOrders:{symbol}

Description

Push order changes for the specified symbol. When symbol is empty, push order changes of all symbols

Push frequency: real-time

Order Status

“open”: the order is in the order book（maker order）;

“match”: when taker order executes with orders in the order book, the taker order status is “match”;

“done”: the order is fully executed successfully;

Order Type

"open": the order is in the order book（maker order）;

"match": the message sent when the order is match,

When the status is open and the type is match, it is a maker match.

When the status is match and the type is match, it is a taker match.

"update": The message sent when Zero freeze cancel order

"filled": The message sent when the status of the order changes to DONE after the transaction

"canceled": The message sent when the status of the order changes to DONE due to being canceled

//Get all symbols order change
{
  "id": 1545910660739,
  "type": "subscribe",
  "topic": "/contractMarket/tradeOrders",
  "response": true,
  "privateChannel": "true"
}  
 
//Get specific symbol order change
{
  "id": 1545910660739,
  "type": "subscribe",
  "topic": "/contractMarket/tradeOrders:XBTUSDTM",
  "response": true,
  "privateChannel": "true"
}

Response

Data Schema

orders

topic

string

required

type

string

required

subject

enum<string>

required

Allowed values:

orderChangesymbolOrderChange

userId

string

required

channelType

string

required

data

object

required

marginMode

enum<string>

required

Margin Mode

Allowed values:

ISOLATEDCROSS

status

enum<string>

required

Order Status

Allowed values:

openmatchdone

type

enum<string>

required

Order Type

Allowed values:

openmatchupdatefilledcanceled

symbol

string

required

Symbol of the contract. Please refer to Get Symbol endpoint: symbol

side

enum<string>

required

buy or sell

Allowed values:

buysell

tradeType

enum<string>

required

normal order or liquid order

Allowed values:

tradeliquid

orderType

enum<string>

optional

User-specified order type

Allowed values:

limitmarket

feeType

enum<string>

optional

Actual Fee Type

Allowed values:

takerFeemakerFee

liquidity

enum<string>

optional

Actual transaction order type, If the counterparty order is an Hidden/Iceberg Order, even if it is a maker order, this param will be displayed as taker. For actual trading fee, please refer to the feeType

Allowed values:

takermaker

orderId

string

required

The unique order id generated by the trading system

clientOid

string

optional

Client Order ID: The ClientOid field is a unique ID created by the user

tradeId

string

optional

Trade ID: Generated by Matching engine.

price

string

required

Price

size

string

required

User-specified order size

filledSize

string

required

Cumulative number filled

canceledSize

string

required

Cumulative number of cancellations

remainSize

string

required

Remain size

matchSize

string

optional

Match Size (when the type is "match")

matchPrice

string

optional

Match Price (when the type is "match")

oldSize

string

optional

The size before order update

orderTime

integer <int64>

required

Gateway received the message time (milliseconds)

integer <int64>

required

Match engine received the message time
(nanoseconds)

Example

//Open
{
    "topic": "/contractMarket/tradeOrders:XBTUSDTM",
    "type": "message",
    "subject": "symbolOrderChange",
    "userId": "633559791e1cbc0001f319bc",
    "channelType": "private",
    "data": {
        "symbol": "XBTUSDTM",
        "tradeType": "trade",
        "side": "buy",
        "canceledSize": "0",
        "orderId": "247899236673269761",
        "liquidity": "maker",
        "marginMode": "ISOLATED",
        "type": "open",
        "orderTime": 1731916985768138917,
        "size": "1",
        "filledSize": "0",
        "price": "91670",
        "remainSize": "1",
        "status": "open",
        "ts": 1731916985789000000
    }
}
      
      
//Update
{
    "topic": "/contractMarket/tradeOrders",
    "type": "message",
    "subject": "orderChange",
    "userId": "669a61642857ca000186f626",
    "channelType": "private",
    "data": {
        "symbol": "RUNEUSDTM",
        "orderType": "limit",
        "tradeType": "trade",
        "side": "buy",
        "canceledSize": "1037",
        "orderId": "228685469427204099",
        "liquidity": "maker",
        "marginMode": "ISOLATED",
        "type": "update",
        "userId": "669a61642857ca000186f626",
        "oldSize": "19982",
        "orderTime": 1727336066682194084,
        "size": "19982",
        "filledSize": "0",
        "price": "5.029",
        "remainSize": "11618",
        "clientOid": "10496pp066R679264",
        "status": "open",
        "ts": 1727336066766000000
    }
}
      
//Match
{
    "topic": "/contractMarket/tradeOrders:XBTUSDTM",
    "type": "message",
    "subject": "symbolOrderChange",
    "userId": "633559791e1cbc0001f319bc",
    "channelType": "private",
    "data": {
        "symbol": "XBTUSDTM",
        "orderType": "limit",
        "tradeType": "trade",
        "side": "buy",
        "canceledSize": "0",
        "orderId": "247899236673269761",
        "liquidity": "maker",
        "marginMode": "ISOLATED",
        "type": "match",
        "feeType": "makerFee",
        "orderTime": 1731916985768138917,
        "size": "1",
        "filledSize": "1",
        "price": "91670",
        "matchPrice": "91670",
        "matchSize": "1",
        "remainSize": "0",
        "tradeId": "1794175373644",
        "status": "done",
        "ts": 1731916996762000000
    }
}
   
//Match - "tradeType": "liquid"
{
  "topic": "/contractMarket/tradeOrders:XBTUSDTM",
  "type": "message",
  "subject": "symbolOrderChange",
  "userId": "6356450****001cef524",
  "channelType": "private",
  "data": {
    "symbol": "XBTUSDTM",
    "orderType": "limit",
    "side": "sell",
    "canceledSize": "0",
    "orderId": "440761625608192",
    "liquidity": "taker",
    "marginMode": "ISOLATED",
    "type": "match",
    "feeType": "takerFee",
    "orderTime": 1743146786640000000,
    "size": "3840",
    "filledSize": "1116",
    "price": "84603.44",
    "matchPrice": "85739.69",
    "matchSize": "1000",
    "remainSize": "2724",
    "tradeId": "1740800012709",
    "tradeType": "liquid",
    "status": "match",
    "ts": 1743146786746000000
  }
}
      
//Filled
{
    "topic": "/contractMarket/tradeOrders:XBTUSDTM",
    "type": "message",
    "subject": "symbolOrderChange",
    "userId": "633559791e1cbc0001f319bc",
    "channelType": "private",
    "data": {
        "symbol": "XBTUSDTM",
        "orderType": "limit",
        "tradeType": "trade",
        "side": "buy",
        "canceledSize": "0",
        "orderId": "247899236673269761",
        "marginMode": "ISOLATED",
        "type": "filled",
        "orderTime": 1731916985768138917,
        "size": "1",
        "filledSize": "1",
        "price": "91670",
        "remainSize": "0",
        "status": "done",
        "ts": 1731916996762000000
    }
}

//Canceled
{
    "topic": "/contractMarket/tradeOrders:XBTUSDTM",
    "type": "message",
    "subject": "symbolOrderChange",
    "userId": "633559791e1cbc0001f319bc",
    "channelType": "private",
    "data": {
        "symbol": "XBTUSDTM",
        "orderType": "limit",
        "tradeType": "trade",
        "side": "buy",
        "canceledSize": "1",
        "orderId": "247901211536203776",
        "marginMode": "ISOLATED",
        "type": "canceled",
        "orderTime": 1731917456611809239,
        "size": "1",
        "filledSize": "0",
        "price": "90000",
        "remainSize": "0",
        "status": "done",
        "ts": 1731917460806000000
    }
}

Request

Query Params

token

string

required

The token required to establish a websocket connection

Example:

2neAiuYvAU737TOajb2U3uT8AEZqSWYe0fBD4LoHuXJDSC7gIzJiH4kNTWhCPISWo6nDpAe7aUaaHJ4fG8oRjFgMfUI2sM4IySWHrBceFocY8pKy2REU1HwZIngtMdMrjqPnP-biofFWbNaP1cl0X1pZc2SQ-33hDH1LgNP-yg-JEBbZCQFEaQOj-9FSyw7M.4BR9r0Y7AbFgQZTBjaefmA==

connectId

string

optional

Connection Id, a unique value taken from the client side. Both the id of the welcome message and the id of the error message are connectId.

Example:

121345

Topic: /contractMarket/tradeOrders#

OR#

Topic: /contractMarket/tradeOrders:{symbol}#

Order Status#

Order Type#

Subscribe Message#

Response#

Request

Topic: /contractMarket/tradeOrders

OR

Topic: /contractMarket/tradeOrders:{symbol}

Order Status

Order Type

Subscribe Message

Response