跳到主要内容

获取订单簿

API说明​

此接口允许用户查询指定交易品种的现货订单簿数据。用户可以选择查询5级或20级的买单和卖单。

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

注意事项​

  1. 此接口不提供时间戳信息。
  2. 用户可以一次查询单个或多个交易品种的订单簿数据。

认证​

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

请求方法​

GET

接口地址​

/api/v1/public?command=returnOrderBook

频率限制​

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

请求参数​

参数必填类型描述
sizeIntegerFalse订单簿深度数据级别(5, 20)
注意：默认为5
symbolStringTrue交易对。允许输入多个交易对，以逗号分隔。
示例："BTC_USDT,ETH_USDT"
注意：每次请求最多可输入 20 个交易对

响应参数​

参数类型描述
asksArray卖方深度注意：默认返回5级卖单。
-quantityString以基础货币计的交易量
-priceString以基础货币计的价格
bidsArray买方深度注意：默认返回5级买单。
-quantityString以基础货币计的交易量
-priceString以基础货币计的价格
pairString交易品种

请求示例​

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

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

api_url= "/api/v1/public?command=returnOrderBook"

params= {"size" : 5,
        "symbol" : "BTC_USDT,ETH_USDT",}

SpotRestfulPublic(api_url, params)   # 函数SpotRestfulPublicc()在章节(简介 > 认证和代码示例 > 现货 > RESTful公共接口)中定义

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

响应示例​

以下是上述Python请求返回的示例响应。

{
  'code': '200',
  'data': [
    {
      'asks': [
        ['87668.0600', '0.5452'],
        ['87668.1800', '0.7087'],
        ['87668.2900', '0.0165'],
        ['87668.4100', '0.0305'],
        ['87668.5200', '1.2592']
      ],
      'bids': [
        ['87667.4400', '0.3312'],
        ['87666.8500', '0.0459'],
        ['87666.2700', '0.0492'],
        ['87665.6800', '0.0734'],
        ['87665.1000', '0.0616']
      ],
      'pair': 'BTC_USDT'
    },
    {
      'asks': [
        ['2926.3200', '21.7389'],
        ['2926.4800', '25.2155'],
        ['2926.5700', '25.6872'],
        ['2926.6700', '23.6043'],
        ['2926.7900', '12.4068']
      ],
      'bids': [
        ['2926.1300', '12.8027'],
        ['2926.0300', '18.8028'],
        ['2925.9400', '21.5573'],
        ['2925.7800', '23.1259'],
        ['2925.6900', '23.7506']
      ],
      'pair': 'ETH_USDT'
    }
  ],
  'msg': 'SUCCESS',
  'success': True,
  'failed': False
}