Place Plan Order
Place a new trigger order (plan order) that executes when the trigger price is reached.
HTTP Request
POST /api/v1/future/order/place-plan-order
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| symbol | string | Yes | Trading pair symbol (e.g., BTCUSDT) |
| marginMode | string | Yes | Margin mode: "CROSSED" or "ISOLATED" |
| size | string | Yes | Order size |
| side | string | Yes | Position side: "LONG" or "SHORT" |
| triggerPrice | string | Yes | Trigger price |
| triggerPriceType | string | Yes | Trigger price type: "LAST" or "MARK" |
| price | string | No | Order price (required for LIMIT orders) |
| clientOid | string | No | Client order ID |
| presetTakeProfitPrice | string | No | Take profit trigger price |
| presetStopLossPrice | string | No | Stop loss trigger price |
| presetTakeProfitExecutePrice | string | No | Take profit execution price |
| presetStopLossExecutePrice | string | No | Stop loss execution price |
Request Example
curl -X POST "https://open-api.bydoxe.com/api/v1/future/order/place-plan-order" \
-H "ACCESS-KEY: your-api-key" \
-H "ACCESS-SIGN: your-signature" \
-H "ACCESS-PASSPHRASE: your-passphrase" \
-H "ACCESS-TIMESTAMP: 1659076670000" \
-H "Content-Type: application/json" \
-d '{
"symbol": "BTCUSDT",
"marginMode": "CROSSED",
"size": "0.5",
"side": "LONG",
"triggerPrice": "39000.00",
"triggerPriceType": "MARK",
"price": "38900.00",
"clientOid": "my-plan-order-001",
"presetTakeProfitPrice": "42000.00",
"presetStopLossPrice": "37000.00",
"presetTakeProfitExecutePrice": "42000.00",
"presetStopLossExecutePrice": "37000.00"
}'
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| code | string | Response code |
| msg | string | Response message |
| requestTime | number | Request timestamp in milliseconds |
| data | object | Order response data |
| > orderId | string | Created order ID |
| > clientOid | string | Client order ID |
Response Example
Success Response
{
"code": "00000",
"msg": "success",
"requestTime": 1763459280000,
"data": {
"orderId": "fu-plan-123456789",
"clientOid": "my-plan-order-001"
}
}
Error Codes
| Code | Message |
|---|---|
| 40034 | symbol does not exist |
| 40001 | Custom ID already exists |
| 40001 | Already ordering |
| 40001 | A different margin mode is not available than the position currently opened. |
| 40001 | Open Size is too large |
| 40001 | Open Size is too small |
| 40001 | Open Size decimal precision is too high |
| 40001 | Order price is required |
| 40001 | Order price decimal precision is too high |
| 40001 | Trigger price is required |
| 40001 | Trigger price decimal precision is too high |
| 40001 | Insufficient balance |
| 40020 | Take Profit price decimal precision is too high |
| 40021 | Take Profit execute price decimal precision is too high |
| 40022 | Stop Loss price decimal precision is too high |
| 40023 | Stop Loss execute price decimal precision is too high |