获取订单状态
API说明
此接口允许用户通过提供相应的 订单 ID 来查询订单的状态。它返回的信息包括交易品种、方向、数量、执行状态以及时间戳。
注意:订单状态只能通过 RESTful API 获取。
注意事项
- 此接口每个请求仅支持一个订单ID。不支持指定多个订单ID。
- 此接口每个请求仅支持查询订单ID不超过7天的订单。
认证
这是一个私有接口,需要认证。有关使用RESTful API的详细信息,请参考简介 > 认证和代码示例 > 现货 > RESTful私有接口。
请求方法
POST
接口地址
/api/v1/private?command=returnOrderStatus
频率限制
该接口的调用频率限制为:每个用户 ID 每2秒最多请求30次。
此外,该接口还受到全局频率限制的约束。
有关"全局速率限制"和"API限频策略"的详细信息,请参阅“频率限制”部分,跳转
请求参数
| 参数 | 必填 | 类型 | 描述 |
|---|---|---|---|
| orderNumber | True | String | 订单ID |
响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| currencyPair | String | 交易品种,例如BTC_USDT |
| type | String | 交易方向:buy/sell |
| total | String | 以基础货币计的当前订单大小 |
| startingAmount | String | 以报价货币计的当前订单金额 |
| status | Integer | 状态:1:未完成,2:部分完成,3:完全完成,4:用户取消 |
| date | String | 交易时间 |
请求示例
以下Python代码展示了如何获取订单状态。
注意:完整代码示例请参考简介 > 认证和代码示例 > 现货 > RESTful私有接口。
api_url = "/api/v1/private?command=returnOrderStatus"
method = "post"
params = {
"orderNumber": "4624544807079846405"
}
SpotRestuflPrivate(host, api_url, method, api_key, params, secret_key) # 函数SpotRestuflPrivate()在章节(简介 > 认证和代码示例 > 现货 > RESTful私有接口)中定义
注意:完整Java代码示例请参考简介 > 认证和代码示例 > 现货 > RESTful私有接口。
响应示例
以下是上述Python请求返回的示例响应:
{'code': '200',
'data': {'status': 4,
'currencyPair': 'BTC_USDT',
'date': '2025-04-03 18:39:58',
'total': '0.0001',
'type': 'buy',
'startingAmount': '8.20'},
'msg': 'SUCCESS',
'success': True,
'failed': False}