Get Plan Order List

HTTP Request

GET /api/v1/private/planorder/list/orders

Required Permission: View Order Details

Request Parameters

Parameter	Type	Required	Description
symbol	string	false	Contract
states	string	false	Status,1: untriggered,2: canceled,3: executed,4: invalidated,5: execution failed; multiple separated by ','
side	int	false	Order side,1: open long,2: close short,3: open short,4: close long
start_time	long	true	Start time, Unix millisecond timestamp
end_time	long	true	End time, Unix millisecond timestamp
page_num	int	true	Current page, default 1
page_size	int	true	Page size, default 20, max 100

Response Parameters

Parameter	Type	Description
id	int	Order id
symbol	string	Contract
leverage	decimal	Leverage
side	string	Order side, 1 open long,3 open short
triggerPrice	decimal	Trigger price
price	decimal	Execution price
vol	decimal	Order quantity
openType	int	Open type,1: isolated,2: cross
triggerType	int	Trigger type,1: greater than or equal,2: less than or equal
state	int	Status,1: untriggered,2: canceled,3: executed,4: invalidated,5: execution failed
executeCycle	int	Execution cycle, unit: hours
trend	int	Trigger price type,1: latest price,2: fair price,3: index price
errorCode	int	Error code when execution fails, 0: normal
orderId	long	Order id, returned when execution succeeds
orderType	int	Order type,1: Limit,2: Post Only (maker only),3: Immediate-Or-Cancel,4: Fill-Or-Kill,5: Market
createTime	long	Created time
updateTime	long	Updated time
priceProtect	int	Price difference protection 1 on 0 off
positionMode	int	User-set position mode. Default 0: no record (historical orders); 1: Hedge Mode; 2: One-way Mode
lossTrend	int	Stop-loss reference price type 1 latest price 2 fair price 3 index price
profitTrend	int	Take-profit reference price type 1 latest price 2 fair price 3 index price
stopLossPrice	decimal	Stop-loss price
takeProfitPrice	decimal	Take-profit price
reduceOnly	boolean	Reduce-only

Response Parameters

Common parameters, success: true success, false failure

Response

{
  "success": true,
  "code": 0,
  "data": [
    {
      "id": "739114860879304259",
      "symbol": "DOGE_USD",
      "leverage": 2,
      "side": 1,
      "triggerPrice": 0.00001,
      "price": 0.00001,
      "vol": 1,
      "openType": 1,
      "triggerType": 2,
      "state": 1,
      "executeCycle": 87600,
      "trend": 1,
      "orderType": 1,
      "errorCode": 0,
      "priceProtect": 0,
      "createTime": 1761889115000,
      "updateTime": 1761889115000,
      "positionMode": 1,
      "lossTrend": 1,
      "profitTrend": 1,
      "reduceOnly": false
    }
  ]
}