Stop Orders

Topic: /contractMarket/advancedOrders

Description

Subscribe this topic to get the realtime push of stop order events indicated by the 'type' in the message body, including:

“open”: when the order enters into the order book;

“triggered”: when the stop order has been triggered;

“cancel”: when the order has been canceled;

This topic will only be pushed when you set the 'stop' type in the place order endpoint.

After triggering, please refer to Topic:/contractMarket/tradeOrders for other processes of the order.

Push frequency: real-time

{
  "id": 1545910660739,
  "type": "subscribe",
  "topic": "/contractMarket/advancedOrders",
  "response": true
}

Response

Data Schema

stopOrders

topic

string

required

type

string

required

subject

string

required

string

required

userId

string

required

channelType

string

required

data

object

required

marginMode

enum<string>

required

Margin Mode

Allowed values:

ISOLATEDCROSS

orderId

string

required

The unique order id generated by the trading system

orderPrice

string

required

Order Price

orderType

enum<string>

required

User-specified order type

Allowed value:

stop

side

enum<string>

required

buy or sell

Allowed values:

buysell

size

integer

required

User-specified order size

stop

enum<string>

required

Either 'down' or 'up'

Allowed values:

downup

stopPrice

string

required

Stop Price

stopPriceType

string

required

symbol

string

required

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

type

enum<string>

required

Order Type

Allowed values:

opentriggeredcancel

createdAt

integer <int64>

required

integer <int64>

required

Example

{
  topic: '/contractMarket/advancedOrders',
  type: 'message',
  subject: 'stopOrder',
  id: '6720ab1ea52a9b0001734392',
  userId: '66f12e8befb04d0001882b49',
  channelType: 'private',
  data: {    
    marginMode: 'ISOLATED',
    orderId: '240673378116083712',
    orderPrice: '0.1',
    orderType: 'stop',
    side: 'buy',
    size: 1,
    stop: 'down',
    stopPrice: '1000',
    stopPriceType: 'TP',
    symbol: 'XBTUSDTM',
    type: 'open',
    createdAt: 1730194206837,
    ts: 1730194206843133000 
  }
}

Request

Query Params

token

string

required

The token required to establish a websocket connection

Example:

2neAiuYvAU737TOajb2U3uT8AEZqSWYe0fBD4LoHuXJDSC7gIzJiH4kNTWhCPISWo6nDpAe7aUaaHJ4fG8oRjFgMfUI2sM4IySWHrBceFocY8pKy2REU1HwZIngtMdMrjqPnP-biofFWbNaP1cl0X1pZc2SQ-33hDH1LgNP-yg8qMQ44JW5_1P0XhDwiNR1f.Hi0an--epNOYhmV3PZh2uQ==

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/advancedOrders#

Subscribe Message#

Response#

Request

Topic: /contractMarket/advancedOrders

Subscribe Message

Response