Skip to main content

See Trigger Orders

Type: GET

Description: /future/trade/v1/entrust/plan-list

Limit Flow Rules

200/s/apikey

Parameters

NameTypeMandatoryDefaultDescriptionRanges
symbolstringtrueN/ATrading pairs (queries all trading pairs if not passed)
pageintegerfalse1Page
sizeintegerfalse10Quantity of a single page
startTimeintegerfalseN/AStart time
endTimeintegerfalseN/AEnd time
statestringtrueN/AOrder status: NOT_TRIGGERED (new order); TRIGGERING; TRIGGERED; USER_REVOCATION; PLATFORM_REVOCATION; EXPIRED; UNFINISHED; HISTORYNOT_TRIGGERED;TRIGGERING;TRIGGERED;USER_REVOCATION;PLATFORM_REVOCATION;EXPIRED;UNFINISHED;HISTORY

Request Example

curl -G "https://fapi.xt.com/future/trade/v1/entrust/plan-list" \
-H "validate-appkey: $APPKEY" # Required
-H "validate-timestamp: $TIMESTAMP" # Required
-H "validate-signature: $SIGNATURE" # Required
-H "Content-Type: application/x-www-form-urlencoded" # Required
-d "symbol=btc_usdt" # Required
-d "state=TRIGGERING" # Required
-d "page=1" \
-d "size=10"

Response Example

Response
{
"error": {
"code": "",
"msg": ""
},
"msgInfo": "",
"result": {
"items": [
{
"clientOrderId": "", // Client order ID
"closePosition": false, // Whether triggered to close all
"createdTime": 0, // Create time
"entrustId": 0, // Order ID
"entrustType": "", // Order type
"marketOrderLevel": 0, // Best market price
"orderSide": "", // Order side
"ordinary": true,
"origQty": 0, // Quantity (Cont)
"positionSide": "", // Position side
"price": 0, // Order price
"state": "", // Order state: NOT_TRIGGERED; TRIGGERING; TRIGGERED; USER_REVOCATION; PLATFORM_REVOCATION; EXPIRED; UNFINISHED; HISTORY
"stopPrice": 0, // Trigger price
"symbol": "", // Trading pair
"timeInForce": "", // Valid way
"triggerPriceType": "" // Trigger price type
}
],
"page": 0,
"ps": 0,
"total": 0
},
"returnCode": 0
}

Error Codes

Error codeDescription
invalid_stateInvalid state parameter
invalid_symbolTrading pair does not exist