跳到主要内容

获取用户最大合约规模

API说明​

此接口允许用户检索其合约账户中已成交订单的最大可用合约规模。用户必须指定合约，响应将包括做多和做空持仓的最大合约规模。

注意：用户最大合约规模数据只能通过 RESTful API 获取。

注意事项​

  1. 此接口不支持指定合约列表。

  2. 如果指定合约没有已成交订单，将返回以下响应：

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

认证​

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

请求方法​

GET

接口地址​

/v1/perpum/orders/availSize

频率限制​

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

请求参数​

参数必填类型描述
instrumenttrueString交易品种的基础货币。注意：USDT 合约只需传入基础货币名称，如 BTCUSDT 传 BTC 即可；USDC 合约请传完整交易对，如 BTC_USDC。此参数不区分大小写。注意：对于以数字开头的交易品种（例如1000PEPE），大写和小写格式都有效。

响应参数​

参数类型描述
availBuyBigDecimal用户可以平仓的做多方向的最大合约数量
availSellBigDecimal用户可以平仓的做空方向的最大合约数量

请求示例​

以下Python代码展示了如何检索用户合约账户中"BTC"的最大可用合约规模。

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

params = {
        "instrument" : "BTC",
    }
api_url = "/v1/perpum/orders/availSize"
method = "GET"
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, 'data': {'availBuy': 0, 'availSell': 1}, 'msg': ''}