跳到主要内容

获取最大合约规模

API说明

此接口允许根据指定的合约、杠杆率和持仓模式查询最大可用合约规模(对于做多和做空持仓)。用户可以选择指定开仓价格。

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

注意事项

  1. 此接口提供公共市场信息,与用户账户无关。

认证

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

请求方法

GET

接口地址

/v1/perpum/orders/maxSize

频率限制

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

请求参数

参数必填类型描述
leveragetrueInteger持仓杠杆率
instrumenttrueString交易品种的基础货币(例如,BTC或btc)。此参数不区分大小写。注意:对于以数字开头的交易品种(例如1000PEPE),大写和小写格式都有效。
orderPricefalseBigDecimal用户指定的订单价格
positionModeltrueInteger持仓持仓模式:0:逐仓,1:全仓

响应参数

参数类型描述
maxBuyBigDecimal最大可用合约规模(买入)
maxSellBigDecimal最大可用合约规模(卖出)

请求示例

以下Python代码展示了如何获取BTC的最大可用合约规模。

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

params = {
"leverage" : 10,
"instrument" : "BTC",
"positionModel" : 0,
"orderPrice" : 87900
}

api_url = "/v1/perpum/orders/maxSize"
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': {'maxBuy': 36, 'maxSell': 36}, 'msg': ''}