跳到主要内容

取消批量订单

API说明​

此接口允许用户批量取消多个未成交订单。

注意：取消批量订单通过RESTful API可用。

注意事项​

  1. 此接口不返回任何响应参数。收到"code:0"表示成功。
{'code': 0, 'msg': ''}

认证​

这是一个私有接口，需要认证。有关使用RESTful API的详细信息，请参考简介 > 认证和代码示例 > 合约 > RESTful私有接口。

请求方法​

DELETE

接口地址​

/v1/perpum/batchOrders

频率限制​

该接口的调用频率限制为：每个 IP 和用户 ID 每秒最多请求10次。
此外，该接口还受到全局频率限制的约束。
有关"全局速率限制"和"API限频策略"的详细信息，请参阅“频率限制”部分，跳转

请求参数​

参数必填类型描述
posTypefalseString指定要取消的订单类型：execute/plan/moveStop/stopProfitLossexecute：市价单plan：限价单moveStop：移动止损和止盈订单stopProfitLoss：止损和止盈订单
sourceIdstrueList订单ID列表（字符串格式）。例如：[orderId1, orderId2]或["orderId1","orderId2"]（两种格式均有效）。注意：列表不能包含超过20个订单ID。

响应参数​

此接口不返回任何响应参数。收到"code:0"表示成功。

请求示例​

以下Python代码展示了如何批量取消未成交订单。

注意：完整代码示例请参考简介 > 认证和代码示例 > 合约 > RESTful私有接口。

params = {
        # "posType": "plan",              
        "sourceIds" : ["33308750270880236","33308750270538609"]  
        }
 
api_url = "/v1/perpum/batchOrders"
method = "DELETE"
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"表示成功。

{'code': 0, 'msg': ''}