跳到主要内容

市价平仓

API说明​

此接口允许用户以市价平仓指定交易品种所有持仓。

注意：市价平仓仅通过RESTful API可用。

注意事项​

  1. 指定交易品种下的所有持仓将以市价平仓.
  2. 该接口与"获取当前持仓信息"和"获取当前持仓"的接口在URL结构上较为相似，用户应仔细区分以确保采用正确的请求方法，避免因混淆导致非预期操作或数据异常。
  3. 平台支持三种交易来源：用户自主下单、跟单系统下单、策略广场量化机器人下单，三类交易在持仓层面统一展示，不过 OpenAPI 仅支持对用户自主下单产生的仓位进行操作（如平仓、撤单等）。对于跟单及策略广场产生的仓位，API 无操作权限，相关操作建议使用平台内对应功能完成处理。

认证​

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

请求方法​

DELETE

接口地址​

/v1/perpum/allpositions

频率限制​

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

请求参数​

参数必填类型描述
instrumenttrueString交易品种基础货币（例如，BTC或btc）。此参数不区分大小写。注意：对于以数字开头的合约（例如1000PEPE），大写和小写格式都有效。

响应参数​

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

请求示例​

以下Python代码展示了如何以市价平仓所有持仓。

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

params = {"instrument": "btc",}
 
api_url = "/v1/perpum/allpositions"
 
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, 'msg': ''}