Skip to main content

Get Pending Trigger Order

Rate limit: 10 req/sec/UID

Description

Can be used to query one or all current trigger orders.

HTTP Request

  • GET /api/v2/mix/order/orders-plan-pending
Request Example
curl -X GET "https://api.bitget.com/api/v2/mix/order/orders-plan-pending?orderId=123&clientOid=1234&planType=profit_loss&productType=USDT-FUTURES" \
-H "ACCESS-KEY:*******" \
-H "ACCESS-SIGN:*" \
-H "ACCESS-PASSPHRASE:*" \
-H "ACCESS-TIMESTAMP:1659076670000" \
-H "locale:en-US" \
-H "Content-Type: application/json" \

Request Parameters

ParameterTypeRequiredDescription
orderIdStringNoTrigger order ID
Either orderId or clientOid is required. If both are entered, orderId prevails.
clientOidStringNoCustomized trigger order ID
Either orderId or clientOid is required. If both are entered, orderId prevails.
symbolStringNoTrading pair, e.g. ETHUSDT
planTypeStringYesTrigger order type
normal_plan: average trigger order
track_plan: trailing stop order
profit_loss: take profit and stop loss orders(including the profit_plan, loss_plan, moving_plan, pos_profit and pos_loss)
symbolStringNoTrading pair, e.g. ETHUSDT
productTypeStringYesProduct type
USDT-FUTURES USDT professional futures
COIN-FUTURES Mixed futures
USDC-FUTURES USDC professional futures
SUSDT-FUTURES USDT professional futures demo
SCOIN-FUTURES Mixed futures demo
SUSDC-FUTURES USDC professional futures demo
idLessThanStringNoRequests the content on the page before this ID (older data), the value input should be the endId of the corresponding interface.
startTimeStringNoStart timestamp
Unix timestamp in milliseconds format, e.g. 1597026383085
(The maximum time span supported is three months. The default end time is three months if no value is set for the end time. )
endTimeStringNoEnd timestamp
Unix timestamp in milliseconds format, e.g. 1597026383085
(The maximum time span supported is three months. The default start time is three months ago if no value is set for the start time. )
limitStringNoNumber of queries: Default: 100, maximum: 100
Response Example
{
"code": "00000",
"data": {
"entrustedList": [
{
"planType": "normal_plan",
"symbol": "ethusdt",
"size": "1",
"orderId": "123",
"clientOid": "121212",
"price": "1900",
"executePrice": "1900",
"callbackRatio": "",
"triggerPrice": "1901",
"triggerType": "mark_price",
"planStatus": "not_trigger",
"side": "buy",
"posSide": "long",
"marginCoin": "usdt",
"marginMode": "crossed",
"enterPointSource": "api",
"tradeSide": "open",
"posMode": "hedge_mode",
"orderType": "limit",
"orderSource": "normal",
"cTime": "1627293504612",
"uTime": "",
"stopSurplusExecutePrice": "2001",
"stopSurplusTriggerPrice": "2002",
"stopSurplusTriggerType": "fill_price",
"stopLossExecutePrice": "1800",
"stopLossTriggerPrice": "1820",
"stopLossTriggerType": "fill_price"
}
],
"endId": "123"
},
"msg": "success",
"requestTime": 1627293504612
}

Response Parameters

ParameterTypeDescription
entrustedListList<String>Order list
>planTypeStringTrigger order type
normal_plan: average trigger order
track_plan: trailing stop order
>symbolStringTrading pair
>sizeStringAmount
>orderIdStringTrigger order ID
>clientOidStringCustomized trigger order ID
>priceStringOrder execute price
For a common trigger order, it represents the order execute price.
For a trailing stop order, the value doesn't exist.
>executePriceStringExecute Price
>callbackRatioStringImplementation of the callback rate. (Range 1-10)
Only exists when the order is a trailing stop order.
>triggerPriceStringTrigger price
It appears for both common trigger orders and trailing stop orders.
>triggerTypeStringTrigger type
It appears for both common trigger orders and trailing stop orders.
fill_price: filled price
mark_price: mark price
index_price: index price
>planStatusStringOrder status
For a current trigger order, the status will only be live
>sideStringDirection
Buy; Sell
>posSideStringPosition direction
long: hedge mode long position
short: hedge mode short position
net: one-way position
>marginCoinStringMargin coin
>marginModeStringMargin mode
isolated: isolated margin mode
crossed: crossed margin
>enterPointSourceStringOrder source
WEB: Orders created on the website
API: Orders created on API
SYS: System managed orders, usually generated by forced liquidation logic
ANDROID: Orders created on the Android app
IOS: Orders created on the iOS app
>tradeSideStringDirection
open: Open (hedge-mode)
close: Close (hedge-mode)
>posModeStringPosition mode
one_way_mode: one-way mode
hedge_mode: hedge mode
>orderTypeStringOrder type
limit: limit order
market: market order
>orderSourceStringOrder sources
normal: Normal order
market: Market order
profit_market: Market TP order
loss_market: Market SL order
Trader_delegate: Elite trade order
trader_profit: Trader takes profit
trader_loss: Trader stops loss
trader_reverse: Reversed elite trades
profit_limit: Take-profit limit order
loss_limit: Stop-loss limit order
delivery_close_short: close short positions
pos_profit_limit: Position take-profit limit order
pos_profit_market: Position take-profit market order
pos_loss_limit: Position stop-loss limit order
pos_loss_market: Position stop-loss market order
>cTimeStringCreation time
>uTimeStringLast updated
>stopSurplusExecutePriceStringSetting take profit execution price
>stopSurplusTriggerPriceStringSetting take-profit trigger price
>stopSurplusTriggerTypeStringSetting take-profit trigger type
fill_price: filled price
mark_price: mark price
index_price: index price
>stopLossExecutePriceStringSetting stop loss execution price
>stopLossTriggerPriceStringSetting stop-loss trigger price
>stopLossTriggerTypeStringSetting stop-loss trigger type
fill_price: filled price
mark_price: mark price
index_price: index price
endIdStringThis is used when idLessThan/idGreaterThan is set as a range.

How was your Reading Experience with us?