批量设 置止损/止盈
API说明
此接口允许用户批量设置合约交易的止损(SL)和止盈(TP)。
注意:批量设置止损/止盈通过RESTful API可用。
注意事项
- 对于未成交的订单,一次最多可设置一个止损/获利 (SL/TP)。
{'code': 9610, 'msg': 'Each limit order can only add one take profit and stop loss.'}
- 对于部分仓位,最多可配置五个止损/止盈订单。为此,请设置参数 stopType = 1。
- 对于全仓,最多可配置一个止损/止盈订单。在这种情况下,请设置 stopType = 2。
认证
这是一个私有接口,需要认证。有关使用RESTful API的详细信息,请参考简介 > 认证和代码示例 > 合约 > RESTful私有接口。
请求方法
POST
接口地址
频率限制
该接口的调用频率限制为:每个 IP 和用户 ID 每2秒最多请求10次。
此外,该接口还受到全局频率限制的约束。
有关"全局速率限制"和"API限频策略"的详细信息,请参阅“频率限制”部分,跳转
请求参数
| 参数 | 必填 | 类型 | 描述 |
|---|---|---|---|
| id | true | Long | 订单ID/持仓ID/计划ID |
| instrument | false | String | 交易品种基础货币(例如,BTC或btc)。此参数不区分大小写。注意:对于以数字开头的合约(例如1000PEPE),大写和小写格式都有效。 |
| stopLossOrderPrice | false | BigDecimal | 止损限价 |
| stopProfitOrderPrice | false | BigDecimal | 止盈限价 |
| stopLossPrice | false | BigDecimal | 止损价格 |
| stopProfitPrice | false | BigDecimal | 止盈价格 |
| stopLossRate | false | BigDecimal | 止损率 |
| stopProfitRate | false | BigDecimal | 止盈率 |
| priceType | false | Integer | 止盈和止损触发价格类型:1:指数价格,2:最新价格,3:标记价格 |
| stopFrom | true | Integer | 止盈/止损触发后的订单类型:1:限价单(在"id"参数中提供订单ID),2:市价单(在"id"参数中提供持仓ID),3:条件单(在"id"参数中提供计划ID) |
| stopType | false | Integer | 止损/止盈类型:1:批量止盈/止损(部分),2:整个持仓止盈/止损(仅适用于已成交订单) |
| closePiece | false | BigDecimal | 止盈和止损合约数量(批量止盈/止损必填) 注意:如果未指定,SL/TP将应用于所有合约。 |
响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| msg | String | 成功执行时返回"Success" |
请求示例
以下Python代码展示了如何批量设置止损/止盈。
注意:完整代码示例请参考简介 > 认证和代码示例 > 合约 > RESTful私有接口。
params = {
"id": 2435521222632243158,
"instrument": "btc",
"stopLossPrice": 86000 ,
"stopProfitPrice": 90000,
"priceType" : 3,
"stopFrom" : 2,
"stopType" : 1,
"closePiece" : 1,
}
api_url = "/v1/perpum/addTpsl"
method = "POST"
response_code, response_data = FuturesRestfulPrivate(params, api_url, method, sec_key, api_key) # function FuturesRestfulPrivate() is defined in section (Introduction > Authentication & Code Snippet > Futures > RESTful Private Interface)
注意:完整Java代码示例请参考简介 > 认证和代码示例 > 合约 > RESTful私有接口。
响应示例
以下是上述Python请求返回的示例响应:
{'code': 0, 'msg': 'Success'}