已完成订单的历史记录
get
https://api.cryptomus.com/v2/user-api/exchange/orders/history
要求
查询参数
| 姓名 | 参数类型 | 定义 |
|---|---|---|
| market | string | 按交易对过滤（例如“TRX_USDT”） |
| direction | string | 按方向过滤可用选项：• buy• sell |
| order_id | string | 按订单簿中的订单 ID 过滤 |
| client_order_id | string | 按客户订单 ID 过滤 |
| limit | string | 一个特殊参数，用于设置请求将返回的最大记录数 |
| offset | string | 一个特殊参数，指示要跳过的记录数 |
参数类型
string定义
按交易对过滤（例如“TRX_USDT”）参数类型
string定义
按方向过滤可用选项：- buy- sell参数类型
string定义
按订单簿中的订单 ID 过滤参数类型
string定义
按客户订单 ID 过滤参数类型
string定义
一个特殊参数，用于设置请求将返回的最大记录数参数类型
string定义
一个特殊参数，指示要跳过的记录数
回复
订单响应参数
| 姓名 | 定义 |
|---|---|
| id | 订单簿中的订单ID |
| type | 订单类型可用选项：• buy• sell |
| direction | 订单方向可用选项：• buy• sell |
| symbol | 按交易对过滤（例如“TRX_USDT”） |
| quantity | 请求的基础资产数量 |
| filledQuantity | 基础资产填充数量 |
| filledValue | 报价资产已填写数量 |
| state | 订单的当前状态（例如“已完成”） |
| internalState | 订单的内部状态（例如“已成交”） |
| createdAt | 订单创建时间 |
| finishedAt | 订单完成时间 |
| stopLossPrice | 资产的市场价格阈值，达到该阈值订单将自动取消 |
定义
订单簿中的订单ID定义
订单类型可用选项：- buy- sell定义
订单方向可用选项：- buy- sell定义
按交易对过滤（例如“TRX_USDT”）定义
请求的基础资产数量定义
基础资产填充数量定义
报价资产已填写数量定义
订单的当前状态（例如“已完成”）定义
订单的内部状态（例如“已成交”）定义
订单创建时间定义
订单完成时间定义
资产的市场价格阈值，达到该阈值订单将自动取消
交易响应参数
| 姓名 | 定义 |
|---|---|
| id | 交易ID |
| state | 交易状态（例如“已完成”） |
| createdAt | 交易创建时间 |
| completedAt | 交易完成时间 |
| averageFilledPrice | 交易的平均成交价格 |
定义
交易ID定义
交易状态（例如“已完成”）定义
交易创建时间定义
交易完成时间定义
交易的平均成交价格
Deal交易响应参数
| 姓名 | 定义 |
|---|---|
| id | 交易编号 |
| tradeRole | 在贸易中的角色可用选项：• taker• maker |
| filledPrice | 交易的成交价格 |
| filledQuantity | 以基础货币计的执行金额 |
| filledValue | 以报价货币计的执行金额 |
| fee | 交易费 |
| feeCurrency | 收取费用的货币 |
| committedAt | 交易执行时间 |
定义
交易编号定义
在贸易中的角色可用选项：- taker- maker定义
交易的成交价格定义
以基础货币计的执行金额定义
以报价货币计的执行金额定义
交易费定义
收取费用的货币定义
交易执行时间
响应示例
1{
2 "result": [
3 {
4 "id": "01JEXAPY04JDFBVFC2D23BCKMK",
5 "type": "market",
6 "direction": "sell",
7 "symbol": "TRX_USDT",
8 "quantity": "67.5400000000000000",
9 "filledQuantity": "67.5400000000000000",
10 "filledValue": "20.0053480000000000",
11 "state": "completed",
12 "internalState": "filled",
13 "createdAt": "2024-12-12 11:40:19",
14 "finishedAt": "2024-12-12 11:40:21",
15 "deal": {
16 "id": "01JEXAPZ9C9TWENPFZJASZ1YD2",
17 "state": "completed",
18 "createdAt": "2024-12-12 11:40:21",
19 "completedAt": "2024-12-12 11:40:21",
20 "averageFilledPrice": "0.2962000000000000",
21 "transactions": [
22 {
23 "id": "01JEXAPZ9C9TWENPFZJASZ1YD3",
24 "tradeRole": "taker",
25 "filledPrice": "0.2962000000000000",
26 "filledQuantity": "67.5400000000000000",
27 "filledValue": "20.0053480000000000",
28 "fee": "0.0000000000000000",
29 "feeCurrency": "USDT",
30 "committedAt": "2024-12-12 11:40:21"
31 }
32 ]
33 }
34 },
35 {
36 "id": "01JEXAJDK51C453Z3395RTAY8Y",
37 "type": "market",
38 "direction": "buy",
39 "symbol": "TRX_USDT",
40 "value": "20.0000000000000000",
41 "filledQuantity": "67.5400000000000000",
42 "filledValue": "19.9985940000000000",
43 "state": "completed",
44 "internalState": "filled",
45 "createdAt": "2024-12-12 11:37:51",
46 "finishedAt": "2024-12-12 11:37:53",
47 "deal": {
48 "id": "01JEXAJF41RJ05Z220F2H01S9Z",
49 "state": "completed",
50 "createdAt": "2024-12-12 11:37:53",
51 "completedAt": "2024-12-12 11:37:53",
52 "averageFilledPrice": "0.2961000000000000",
53 "transactions": [
54 {
55 "id": "01JEXAJF4ADPPPVH3NVP2SFX0F",
56 "tradeRole": "taker",
57 "filledPrice": "0.2961000000000000",
58 "filledQuantity": "67.5400000000000000",
59 "filledValue": "19.9985940000000000",
60 "fee": "0.0000000000000000",
61 "feeCurrency": "TRX",
62 "committedAt": "2024-12-12 11:37:53"
63 }
64 ]
65 }
66 },
67 {
68 "id": "01JEXAFCCC5ZVJPZAAHHDKQBNG",
69 "type": "limit",
70 "direction": "sell",
71 "symbol": "TRX_USDT",
72 "price": "0.2964000000000000",
73 "quantity": "20.0000000000000000",
74 "value": "5.9280000000000000",
75 "filledQuantity": "20.0000000000000000",
76 "filledValue": "5.9280000000000000",
77 "state": "completed",
78 "internalState": "filled",
79 "createdAt": "2024-12-12 11:36:12",
80 "finishedAt": "2024-12-12 11:36:22",
81 "deal": {
82 "id": "01JEXAFP50QGFS8CGY2YRR5EDV",
83 "state": "completed",
84 "createdAt": "2024-12-12 11:36:22",
85 "completedAt": "2024-12-12 11:36:22",
86 "averageFilledPrice": "0.2964000000000000",
87 "transactions": [
88 {
89 "id": "01JEXAFP55H5XHF3SHRVCEQ1G9",
90 "tradeRole": "taker",
91 "filledPrice": "0.2964000000000000",
92 "filledQuantity": "20.0000000000000000",
93 "filledValue": "5.9280000000000000",
94 "fee": "0.0000000000000000",
95 "feeCurrency": "USDT",
96 "committedAt": "2024-12-12 11:36:22"
97 }
98 ]
99 }
100 }
101 ]
102}
103 可能的代码
404：未找到用户或资源
422: 输入数据无效
500：服务器内部错误
可能的组合
| 姓名 | 定义 | 内部状态 |
|---|---|---|
| completed | 订单已完成并已全部填写 | 充满 |
| canceled | 订单未填写并被用户取消 | 空的 |
| canceled_by_stop_loss | 由于市场达到 stop_loss 价格，订单未成交并被自动取消 | 空的 |
| canceled | 订单已部分履行，然后被用户取消 | 部分填充 |
| canceled_by_stop_loss | 订单已部分成交，然后由于市场达到 stop_loss 价格而自动取消 | 部分填充 |
定义
订单已完成并已全部填写定义
订单未填写并被用户取消定义
由于市场达到 stop_loss 价格，订单未成交并被自动取消定义
订单已部分履行，然后被用户取消定义
订单已部分成交，然后由于市场达到 stop_loss 价格而自动取消
可能的错误
示例响应：
1{
2 "state": 0,
3 "message": "Standard validation error"
4}响应示例与错误
1{
2 "code": 0,
3 "message": "Validation failed.",
4 "errors": [
5 {
6 "property": "direction",
7 "value": "sells",
8 "message": "The value you selected is not a valid choice."
9 }
10 ]
11}