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.

​
Get All Current Plan Orders (KEYED)

Applicable for querying contract all plan orders

​
Request URL

GET https://cloud-api.wooxpro.com/contract/private/current-plan-order

​
Request Limit

See Detailed Rate Limit

​
Request Parameter

Request 
curl -H 'X-BM-KEY:{{AccessKey}}'
https://cloud-api.wooxpro.com/contract/private/current-plan-order?symbol=BTCUSDT&type=market&limit=10
FieldTypeRequired?Description
symbolStringNoSymbol of the contract(like BTCUSDT)
typeStringNoOrder type
-limit
- market
limitintNoThe number of returned results, with a maximum of 100 and a default of 100
plan_typeStringNoPlan order type
-plan
- profit_loss
default all

​
Response Data

Response 
{
  "code": 1000,
  "message": "Ok",
  "data": [
    {
      "order_id": "220908185908509",
      "client_order_id": "BM123",
      "executive_price": "14277",
      "trigger_price": "14277",
      "size": "7216",
      "symbol": "BTCUSDT",
      "state": 4,
      "side": 3,
      "mode": 1,
      "position_mode": "hedge_mode",
      "price_way": 2,
      "price_type": 1,
      "plan_category": 2,
      "type": "stop_loss",
      "leverage": "0",
      "open_type": "isolated",
      "create_time": 1662368173000,
      "update_time": 1662368173000
    }
  ],
  "trace": "80ba1f07-1b6f-46ad-81dd-78ac7e9bbccd"
}
FieldTypeDescription
symbolStringSymbol of the contract
order_idStringOrder ID
client_order_idStringClient-defined OrderId (If the field is not defined, a empty string is returned)
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
modeIntOrder mode
-1=GTC
-2=FOK
-3=IOC
-4=Maker Only
position_modeStringPosition mode
-hedge_mode
-one_way_mode
price_wayIntPrice way
-1=price_way_long
-2=price_way_short
price_typeIntTrigger price type
-1=last_price
-2=fair_price
typeStringOrder type
- plan
- take_profit
- stop_loss
plan_categoryIntTP/SL type
- 1=TP/SL
- 2=Position TP/SL
sizeStringOrder amount
leverageStringLeverage order multipliers
open_typeStringOpen type
-cross
-isolated
executive_priceStringExecutive price
trigger_priceStringTrigger price
stateIntOrder status
-1=status_approval
-2=status_check
preset_take_profit_price_typeIntPre-set TP price type
-1=last_price
-2=fair_price
preset_stop_loss_price_typeIntPre-set SL price type
-1=last_price
-2=fair_price
preset_take_profit_priceStringPre-set TP price
preset_stop_loss_priceStringPre-set SL price
create_timeLongOrder created timestamp (ms)
update_timeLongOrder updated timestamp (ms)