取消订单

API说明

此接口允许用户通过指定订单ID取消未成交订单。

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

注意事项

1. 此接口不支持批量取消订单。要取消批量订单，请参考合约 > 下单 > 取消批量订单。

2. 此接口不支持取消已成交订单。要平仓已成交订单，请参考合约 > 下单 > 平仓。

3. 如果指定的订单ID不存在，将返回以下响应：

{'code': 9012, 'msg': 'Position not found.'}

认证

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

请求方法

DELETE

接口地址

/v1/perpum/order

频率限制

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

请求参数

参数	必填	类型	描述
id	true	Long	订单ID

响应参数

参数	类型	描述
msg	string	Success

请求示例

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

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

params = {
        "id": "33308749002645666",
        }
 
api_url = "/v1/perpum/order"
method = "DELETE"
response_code, response_data = FuturesRestfulPrivate(params, api_url, method, sec_key, api_key)   # function rFuturesRestfulPrivate() is defined in section (Introduction > Authentication & Code Snippet > Futures > RESTful Private Interface)

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

响应示例

以下是上述Python请求返回的示例响应：

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