
# 下止盈止损条件单 (TRADE)

- **POST** ```/capi/v3/placeTpSlOrder```

<strong>请求权重</strong>

10s order rate limit(X-ORDER-COUNT-10S)为1; 1min order rate limit(X-ORDER-COUNT-1M)为1; IP rate limit(X-USED-WEIGHT-1M)为0


<div class='api-content-wrap'>
<div>


<strong>请求参数</strong>


| 参数名              | 类型       | 是否必填    | 说明                                                          |
|------------------|----------|---------|-------------------------------------------------------------|
| symbol           | String   | 是       | 交易对。                                                        |
| clientAlgoId     | String   | 是       | 客户自定义条件单 ID（1-36 位，匹配 `^[\\.A-Z\:/a-z0-9_-]{1,36}$`）。       |
| planType         | String   | 是       | 条件单类型：`TAKE_PROFIT`、`STOP_LOSS`。                            |
| triggerPrice     | String   | 是       | 触发价格，必须大于 0。                                                |
| executePrice     | String   | 条件必填    | 执行价格，为 0 或省略表示以市价执行。带单类型 API key 只支持市价平仓，必须传 0 或省略。         |
| quantity         | String   | 否       | 委托数量。为 0 或省略表示设置全部仓位止盈止损。带单类型 API key 必须设置全部仓位平仓，必须传 0 或省略。 |
| positionSide     | String   | 是       | 持仓方向：`LONG`、`SHORT`。                                        |
| triggerPriceType | String   | 否       | 触发价类型：`CONTRACT_PRICE`、`MARK_PRICE`，默认 `CONTRACT_PRICE`。    |
| reduceOnly       | Boolean  | 否       | 是否只减仓。                                                       |

</div>
<div class='api-align'>
  <div class='code-wrap'>
<strong>请求示例</strong>

```powershell
curl -X POST "https://api-contract.weex.com/capi/v3/placeTpSlOrder" \
   -H "ACCESS-KEY:*******" \
   -H "ACCESS-SIGN:*******" \
   -H "ACCESS-PASSPHRASE:*****" \
   -H "ACCESS-TIMESTAMP:1659076670000" \
   -H "Content-Type: application/json" \
   -d '{
     "symbol": "BTCUSDT",
     "clientAlgoId": "tp-20240201-1",
     "planType": "TAKE_PROFIT",
     "triggerPrice": "70500",
     "executePrice": "70500",
     "quantity": "0.01",
     "positionSide": "LONG",
     "triggerPriceType": "MARK_PRICE",
     "reduceOnly": false
   }'
```
  </div>
  </div>

</div>

<div class='api-content-wrap'>
  <div>
<strong>返回参数</strong>


返回数组，字段如下：

| 参数名      | 类型    | 说明 |
|-------------|---------|------|
| success     | Boolean | 是否提交成功。 |
| orderId     | Long    | 成功时返回的条件单 ID。 |
| errorCode   | String  | 当 `success = false` 时的错误码。 |
| errorMessage| String  | 当 `success = false` 时的错误信息。 |

  </div>
  <div class='api-align'>

  <div class='code-wrap'>
<strong>返回示例</strong>

```json
[
  {
    "success": true,
    "orderId": 812345678901234900,
    "errorCode": "",
    "errorMessage": ""
  }
]
```
  </div>
    </div>
</div>
