跳到主要内容

获取挂单数据

API说明​

此接口允许用户获取指定交易品种的所有当前未成交订单，提供订单ID、交易时间、数量和状态等详细信息。

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

注意事项​

  1. 此接口仅支持查询指定交易品种的当前未成交订单。不支持查询所有交易品种的未成交订单。

认证​

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

请求方法​

POST

接口地址​

/api/v1/private?command=returnOpenOrders

频率限制​

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

请求参数​

参数必填类型描述
currencyPairTrueString交易品种，例如BTC_USDT
startAtFalseLong开始时间（时间戳）
endAtFalseLong结束时间（时间戳）

响应参数​

参数类型描述
orderNumberString订单ID
dateString交易时间（时间戳）
startingAmountString以报价货币计的订单大小
totalString以基础货币计的订单大小
typeString交易方向：buy/sell
prizeString用户设置的订单价格
success_countString以基础货币计的已执行订单大小
success_amountString以报价货币计的已执行订单大小
statusString状态：1：未完成，2：部分完成，3：完全完成，4：用户取消

请求示例​

以下Python代码展示了如何获取BTC-USDT的当前未成交订单。

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

api_url = "/api/v1/private?command=returnOpenOrders"
method = "post"
params = {
    "currencyPair": "BTC_USDT",
    "startAt": "1741671490745",
    "endAt": "1741844290745"
}
SpotRestuflPrivate(host, api_url, method, api_key, params, secret_key)  # 函数SpotRestuflPrivate()在章节(简介 > 认证和代码示例 > 现货 > RESTful私有接口)中定义

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

响应示例​

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

{'code': '200',
 'data': [{'orderNumber': 4624541508540145096,
   'date': 1743669325942,
   'startingAmount': '8.20',
   'total': '0.0001',
   'type': 'buy',
   'prize': '82000.00',
   'success_count': '0.0000',
   'success_amount': '0.00',
   'status': 1},
  {'orderNumber': 4624586588413897537,
   'date': 1743669298855,
   'startingAmount': '8.20',
   'total': '0.0001',
   'type': 'buy',
   'prize': '82000.00',
   'success_count': '0.0000',
   'success_amount': '0.00',
   'status': 1}],
 'msg': 'SUCCESS',
 'success': True,
 'failed': False}