
# 一键市价平仓 (TRADE)

- **POST** ```/capi/v3/closePositions```

权重(IP): 40

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


<strong>请求参数</strong>


| 参数名        | 类型      | 是否必填    | 说明      |
|------------|---------|---------|---------|
| symbol     | String  | 否       | 指定交易对平仓 |
| positionId | Long    | 否       | 仓位 ID   |


- 当 `symbol` 与 `positionId` 同时传递时，系统以 `positionId` 为准进行平仓操作，但会校验该仓位是否属于 `symbol` 指定的交易对，若校验不通过则拒绝执行。
- 当 `symbol` 与 `positionId` 同时为空时，系统将平掉账户的所有仓位。
- 仅传递 `symbol`，系统平仓指定交易对（`symbol`）下的全部持仓（含多空双向仓位）。
- 仅传递 `positionId`，系统平仓指定仓位 ID（`positionId`）所对应的仓位。


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

```powershell
curl -X POST "https://api-contract.weex.com/capi/v3/closePositions" \
   -H "ACCESS-KEY:*******" \
   -H "ACCESS-SIGN:*******" \
   -H "ACCESS-PASSPHRASE:*****" \
   -H "ACCESS-TIMESTAMP:1659076670000" \
   -H "Content-Type: application/json" \
   -d '{
     "symbol": "BTCUSDT"
   }'
```
  </div>
  </div>

</div>

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


返回一个数组，字段如下：

| 参数名            | 类型      | 说明                             |
|----------------|---------|--------------------------------|
| positionId     | Long    | 仓位 ID。                         |
| success        | Boolean | 是否平仓成功。                        |
| successOrderId | Long    | 创建的平仓订单 ID（成功时返回）。             |
| errorMessage   | String  | 失败原因（当 `success = false` 时返回）。 |

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

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

```json
[
  {
    "positionId": 689987235755328154,
    "success": true,
    "successOrderId": 702345678901234580,
    "errorMessage": ""
  }
]
```
  </div>
    </div>
</div>
