欢迎使用全新的 WEEX API 文档。需要查看旧版本?切换到旧版文档
WEEX

下止盈止损条件单 (TRADE)

  • POST /capi/v3/placeTpSlOrder

请求权重

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

请求参数

参数名类型是否必填说明
symbolString是交易对。
clientAlgoIdString是客户自定义条件单 ID(1-36 位,匹配 ^[\\.A-Z\:/a-z0-9_-]{1,36}$)。
planTypeString是条件单类型:TAKE_PROFIT、STOP_LOSS。
triggerPriceString是触发价格,必须大于 0。
executePriceString条件必填执行价格,为 0 或省略表示以市价执行。带单类型 API key 只支持市价平仓,必须传 0 或省略。
quantityString否委托数量。为 0 或省略表示设置全部仓位止盈止损。带单类型 API key 必须设置全部仓位平仓,必须传 0 或省略。
positionSideString是持仓方向:LONG、SHORT。
triggerPriceTypeString否触发价类型:CONTRACT_PRICE、MARK_PRICE,默认 CONTRACT_PRICE。
reduceOnlyBoolean否是否只减仓。
请求示例
PowerShellCode
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 }'
返回参数

返回数组,字段如下:

参数名类型说明
successBoolean是否提交成功。
orderIdLong成功时返回的条件单 ID。
errorCodeString当 success = false 时的错误码。
errorMessageString当 success = false 时的错误信息。
返回示例
JSONCode
[ { "success": true, "orderId": 812345678901234900, "errorCode": "", "errorMessage": "" } ]