Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.wooxpro.com/llms.txt

Use this file to discover all available pages before exploring further.

​
【Private】Order Channel

Order Channel, which pushes immediately when the order status, transaction amount, etc. changes.

​
Pushing Rules

  1. User login required
  2. After subscribing, then the changes will be pushed

​
Request

Request 
{
  "action": "subscribe",
  "args": ["futures/order"]
}
Message Format: {"action":"subscribe","args":["<channel>"]}
  • actions: subscribe
  • channel: Channel name futures/order, fixed value

​
Response

Response 
{
  "group": "futures/order",
  "data": [
    {
      "action": 3,
      "order": {
        "order_id": "220906179895578",
        "client_order_id": "BM1234",
        "price": "1",
        "size": "1000",
        "symbol": "BTCUSDT",
        "state": 2,
        "side": 1,
        "type": "limit",
        "leverage": "5",
        "open_type": "isolated",
        "deal_avg_price": "0",
        "deal_size": "0",
        "create_time": 1662368173000,
        "update_time": 1662368173000,
        "plan_order_id": "220901412155341",
        "last_trade": {
          "lastTradeID": 1247592391,
          "fillQty": "1",
          "fillPrice": "25667.2",
          "fee": "-0.00027",
          "feeCcy": "USDT"
        },
        "trigger_price": "-",
        "trigger_price_type": "-",
        "execution_price": "-",
        "activation_price_type": "-",
        "activation_price": "-",
        "callback_rate": "-",
        "position_mode": "hedge_mode"
      }
    }
  ]
}
Return data description:
FieldTypeDescription
actionIntAction
-1=match deal
-2=submit order
-3=cancel order
-4=liquidate cancel order
-5=adl cancel order
-6=part liquidate
-7=bankruptcy order
-8=passive adl match deal
-9=active adl match deal
symbolStringSymbol of the contract
order_idStringOrder ID
client_order_idStringClient-defined OrderId
sideIntOrder side
hedge mode
-1=buy_open_long
-2=buy_close_short
-3=sell_close_long
-4=sell_open_short
oneway mode
-1=buy
-2=buy(reduce only)
-3=sell(reduce only)
-4=sell
typeStringOrder type
-limit
-market
-plan_order
-trailing_order
-take_profit
-stop_loss
leverageStringLeverage order multipliers
open_typeStringOpen type
-cross
-isolated
deal_avg_priceStringAverage deal price
deal_sizeStringDeal amount
priceStringConsignment price
stateIntOrder status
-1=status_approval
-2=status_check
-4=status_finish
create_timeLongOrder created timestamp (ms)
update_timeLongOrder updated timestamp (ms)
plan_order_idStringTrigger plan order id
last_tradeobjectrecently trade info for this order，return null if not exist
trigger_priceStringTrigger price of TP/SL / plan order
trigger_price_typeStringTrigger price type of TP/SL / plan order
-last_price
-fair_price
execution_priceStringExecution price of TP/SL / plan order
activation_priceStringActivation price
activation_price_typeStringActivation price type
-last_price
-fair_price
callback_rateStringCall back rate of trailing stop order
position_modeStringPosition mode
-hedge_mode
-one_way_mode
last_trade fields describe：
ParameterTypeDescription
lastTradeIDLongrecently trade id
fillQtyStringlast trade deal vol
fillPriceStringlast trade deal price
feeStringlast trade fee
feeCcyStringlast trade fee coin name