获取交易品种信息
API说明
此接口允许查询交易所上所有交易品种基本信息,包括杠杆率、保证金、止损率、止盈率、maker/taker费用、资金费率、最大持仓量等。用户还可以通过指定名称查询特定交易品种基本信息。
注意:交易品种信息数据只能通过 RESTful API 获取。
注意事项
- 此接口支持查询特定合约或所有可用交易品种信息。"name"参数是可选的;如果未指定,响应将包含所有交易品种信息。
认证
这是一个公共接口,不需要认证。有关使用RESTful API的详细信息,请参考简介 > 认证和代码示例 > 合约 > RESTful公共接口。
请求方法
GET
接口地址
频率限制
该接口的调用频率限制为:每个 IP 和用户 ID 每秒最多请求5次。
此外,该接口还受到全局频率限制的约束。
有关"全局速率限制"和"API限频策略"的详细信息,请参阅“频率限制”部分,跳转
请求参数
| 参数 | 必填 | 类型 | 描述 |
|---|---|---|---|
| name | false | String | 交易品种的基础货币。(例如,BTC或btc)。此参数不区分大小写。 注意:对于以数字开头的交易品种(例如,1000PEPE),大写和小写格式均有效。 如果未指定此参数,响应将包含所有交易品种的数据。 |
响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| base | String | 交易品种的基础货币,例如BTC、ETH |
| defaultLeverage | Integer | 默认杠杆率 |
| defaultStopLossRate | BigDecimal | 默认止损率 |
| defaultStopProfitRate | BigDecimal | 默认止盈率 |
| indexId | Integer | 索引ID |
| leverage | String | 可用杠杆选项 |
| makerFee | BigDecimal | maker费用 |
| maxLeverage | Integer | 允许的最大杠杆率 |
| minLeverage | Integer | 允许的最小杠杆率 |
| maxPosition | BigDecimal | 允许的最大持仓量 |
| minSize | BigDecimal | 最小下单张数 |
| name | String | 基础货币名称(例如,BTC,ETH) |
| oneLotMargin | BigDecimal | 每手所需保证金 |
| oneMaxPosition | BigDecimal | 每手最大持仓量 |
| pricePrecision | Integer | 价格精度的小数位数(例如,2表示0.01) |
| quote | String | 交易品种报价货币(例如,USDT) |
| settledAt | Long | 结算时间戳 |
| settlementRate | BigDecimal | 资金费率 |
| status | String | 合约当前状态:offline:不可交易。online:活跃可交易。pretest:预测试阶段。settlement:结算过程中。preOffline:预下线阶段 。 |
| takerFee | BigDecimal | taker费用 |
| stopCrossPositionRate | Integer | 全仓保证金风险率 |
| stopSurplusRate | Integer | 最小剩余保证金率 |
| updatedDate | BigDecimal | 最后更新的时间戳 |
| sort | Integer | 排序编号 |
| selected | Integer | 默认选择状态(0:否,1:是) |
| openSpread | BigDecimal | 开仓点差 |
| oneLotSize | BigDecimal | 最小合约大小(等同于网页端的Base-size"合约面值") |
| -margins | BigDecimal | 保证金层级列表及相应所需存款 |
| -simulatedMargins | BigDecimal | 模拟保证金(可以忽略) |
| closeSpread | BigDecimal | 平仓点差 |
| partitionIds | String | 创新区IDs(可以忽略) |
| commissionRate | BigDecimal | 佣金率 |
| depthPrecision | String | 深度聚合精度(可以忽略) |
| id | Integer | 合约ID |
| iconUrl | String | 图标URL |
| createdDate | Long | 上线时间。 |
| settledPeriod | Integer | 结算周期。 |
请求示例
以下Python代码展示了如何获取BTC的合约信息。
注意:完整代码示例请参考简介 > 认证和代码示例 > 合约 > RESTful公共接口。
api_url = "/v1/perpum/instruments"
params = {
"name": "BTC"
}
FuturesRestfulPublic(api_url, params) #function FuturesRestfulPublic() is defined in section (Introduction > Authentication & Code Snippet > Futures > RESTful Public Interface)
注意:完整Java代码示例请参考简介 > 认证和代码示例 > 合约 > RESTful公共接口。
响应示例
以下是上述Python请求返回的示例响应:
{'code': 0,
'data': [{'base': 'btc',
'closeSpread': 0.0002,
'commissionRate': 0.0006,
'configBo': {'margins': {'100': 0.075,
'5': 0.00375,
'50': 0.0375,
'20': 0.015,
'10': 0.0075},
'simulatedMargins': {'5': 0.00375, '20': 0.015, '10': 0.0075}},
'createdDate': 1548950400000,
'defaultLeverage': 20,
'defaultStopLossRate': 0.99,
'defaultStopProfitRate': 100,
'depthPrecision': '0.1,1,10,50,100',
'iconUrl': 'https://hkto-prod.oss-accelerate.aliyuncs.com/201810020046047_T9g8i.png',
'id': 1,
'indexId': 1,
'leverage': [5, 10, 20, 50, 100, 125, 200],
'makerFee': '0.0001',
'maxLeverage': 200,
'maxPosition': 20000,
'minLeverage': 1,
'minSize': 1,
'name': 'BTC',
'oneLotMargin': 1,
'oneLotSize': 0.001,
'oneMaxPosition': 15000,
'openSpread': 0.0003,
'partitionIds': '2013,2011',
'pricePrecision': 1,
'quote': 'usdt',
'selected': 0,
'settledAt': 1740124800000,
'settledPeriod': 8,
'settlementRate': 0.0004,
'sort': 1,
'status': 'online',
'stopCrossPositionRate': 0.1,
'stopSurplusRate': 0.01,
'takerFee': '0.0006',
'updatedDate': 1731394149000}],
'msg': ''}