Get Untriggered Stop Order List
Get the un-triggered stop orders list. Stop orders that have been triggered can be queried through the general order interface.
HTTP REQUEST
GET /api/v1/stopOrders
Example
GET /api/v1/stopOrders?symbol=XBTUSDM
Query this endpoint to get the untriggered stop orders of the position in XBTUSDM.
{
"code": "200000",
"data": {
"currentPage": 1,
"pageSize": 100,
"totalNum": 1000,
"totalPage": 10,
"items": [
{
"id": "622076e79f12700001f84138",
"symbol": "XBTUSDTM",
"type": "limit",
"side": "sell",
"price": "32000",
"size": 2,
"value": "0",
"dealValue": "0",
"dealSize": 0,
"stp": "",
"stop": "down",
"stopPriceType": "TP",
"stopTriggered": null,
"stopPrice": "3000",
"timeInForce": "GTC",
"postOnly": false,
"hidden": false,
"iceberg": false,
"leverage": "20",
"forceHold": false,
"closeOrder": false,
"visibleSize": null,
"clientOid": null,
"remark": null,
"tags": null,
"isActive": true,
"cancelExist": false,
"createdAt": 1646294759000,
"updatedAt": 1646294759000,
"endAt": null,
"orderTime": null,
"settleCurrency": "USDT",
"status": "open",
"filledValue": "0",
"filledSize": 0,
"reduceOnly": false,
"marginMode": "ISOLATED" // Added field for margin mode: ISOLATED (isolated), CROSS (cross margin).
}
]
}
}
API KEY PERMISSIONS
This endpoint requires the General permission.
REQUEST URL
This endpoint support Futures URL
REQUEST RATE LIMIT
Futures weight
:6
PARAMETERS
Param | Type | Mandatory | Description |
---|---|---|---|
symbol | String | No | Symbol of the contract |
side | String | No | buy or sell |
type | String | No | limit or market |
startAt | long | No | Start time (milisecond) |
endAt | long | No | End time (milisecond) |
currentPage | long | No | Current request page, The default currentPage is 1 |
pageSize | long | No | pageSize, The default pageSize is 50, The maximum cannot exceed 1000 |
This request is paginated.
RESPONSES
Param | Description |
---|---|
id | Order ID |
symbol | Symbol of the contract |
type | Order type, market order or limit order |
side | Transaction side |
price | Order price |
size | Order quantity |
value | Order value |
dealValue | Executed size of funds |
dealSize | Executed quantity |
stp | self trade prevention |
stop | Stop order type (stop limit or stop market) |
stopPriceType | Trigger price type of stop orders |
stopTriggered | Mark to show whether the stop order is triggered |
stopPrice | Trigger price of stop orders |
timeInForce | Time in force policy type |
postOnly | Mark of post only |
hidden | Mark of the hidden order |
iceberg | Mark of the iceberg order |
leverage | Leverage of the order |
forceHold | A mark to forcely hold the funds for an order |
closeOrder | A mark to close the position |
visibleSize | Visible size of the iceberg order |
clientOid | Unique order id created by users to identify their orders |
remark | Remark of the order |
tags | tag order source |
isActive | Mark of the active orders |
cancelExist | Mark of the canceled orders |
createdAt | Time the order created |
updatedAt | last update time |
endAt | End time |
orderTime | Order create time in nanosecond |
settleCurrency | settlement currency |
status | order status: “open” or “done” |
filledSize | Value of the executed orders |
filledValue | Executed order quantity |
reduceOnly | A mark to reduce the position size only |
marginMode | Margin mode: ISOLATED (isolated), CROSS (cross margin). |