跳到主要内容

获取指定交易品种的订单簿

API说明​

此接口允许查询指定交易品种的深度数据，包括买单和卖单。

注意：交易品种订单簿数据可通过RESTful和Websocket接口获取。本页是RESTful接口的描述。如需了解Websocket接口，请参见 跳转

注意事项​

  1. 此接口不允许用户指定买单/卖单级别。默认情况下，它在响应中返回20个级别的买单和卖单。
  2. 该接口不提供时间戳信息。

认证​

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

请求方法​

GET

接口地址​

/v1/perpumPublic/depth

频率限制​

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

请求参数​

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

响应参数​

参数类型描述
asksList卖方深度，包含20个卖单
bidsList买方深度，包含20个买单
mBigDecimal基础货币数量
pBigDecimal基础货币价格
nString交易品种基础货币，例如BTC
tsLong时间戳（毫秒）

请求示例​

以下Python代码展示了如何获取BTC的订单簿。

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

api_url = "/v1/perpumPublic/depth"
params = {"base" : "BTC"}
FuturesRestfulPublic(api_url, params) # function FuturesRestfulPublic() is defined in section (Introduction > Authentication & Code Snippet > Futures > RESTful Public Interface)

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

响应示例​

以下是上述Python请求返回的示例响应。上述请求的实际响应返回20个级别的买单和卖单。为简洁起见，以下仅显示5个级别：

{'code': 0,
 'data': {'asks': [{'m': 0.516, 'p': 89942.2},
   {'m': 0.807, 'p': 89942.3},
   {'m': 0.15, 'p': 89942.4},
   {'m': 0.542, 'p': 89942.5},
    ...............................,
   {'m': 0.475, 'p': 89944.7}],
  'bids': [{'m': 0.044, 'p': 89942.1},
   {'m': 0.3, 'p': 89941.8},
   {'m': 0.517, 'p': 89941.5},
   {'m': 0.553, 'p': 89941.3},
    ...............................,
   {'m': 0.046, 'p': 89938.7}],
  'n': 'btc',
  't': None,
  'ts': 1775443378356},
 'msg': ''}