[GET] GET Spot exchange transaction detail
- Tam Tran
- Siyuan Shu
- Que Nguyen
Allow user to get their transaction with Query params
Table of Contents
- 1 Table of Contents
- 2 Changelogs
- 3 Order Resource
- 4 API Definition
- 4.1 Request
- 4.1.1 Headers
- 4.1.2 Query Parameters
- 4.2 Response
- 4.1 Request
- 5 Rate limit
Changelogs
Version | Date | Changes by | Description of change |
V1.0 | Jul 24, 2024 | Tam Tran |
|
Order Resource
OrderId number 订单唯一标识符 Order unique Identifier 订单唯一标识符 |
TransactionId numeric - bigint Transaction Unique Id |
Status object
Transaction status (Pending, Settled, Voided, Cancelled, Refunded, Requested) |
TickerId text Ticker Unique Id |
Side text - enum (Buy - Sell) 订单方 文本类型 - 枚举（买方 - 卖方） Order side enum 订单方枚举 |
Type text 订单类型 Order type: Limit 订单类型：限制 |
TimeInForce text 有效时间 Time in force: 有效时间 - 在进行交易时使用的一种特殊指标，用于指示订单在执行或到期前将保持多长时间有效
|
Price number 价格 Order Price 订单价格 |
Quantity number 数量 Transaction’s quantity 订单数量 |
MatchedPrice number Matched Price |
UserName text User Name |
CurrencyCode text 货币 Currency code 货币代码 |
DeviceUniqueId text Device Unique Identifier |
BuyerInvoiceId text Buyer Invoice Id |
SellerInvoiceId text Buyer Invoice Id |
CreatedTime datetime 创建时间 Order’s created time 订单创建时间 |
MatchedTime datetime Transaction’s created time |
FinishedTime datetime Transaction’s updated time |
RecTransactionHistoryId text Rec Transaction History Id |
RecItemTransactionHistories array - object
|
{
"OrderId": "4256",
"TransactionId": "3223",
"Status": {
"Value": "Pending",
"Description": "Pending Settlement"
},
"TickerId": "VN.23.SLR.i",
"Side": "Buy",
"Type": "Limit",
"TimeInForce": "GTC",
"Price": 89.000000,
"CurrencyCode": "USD",
"MatchedPrice": 89.000000,
"Quantity": 20.000000,
"UserName": "vinhlongsolar",
"DeviceUniqueId": null,]
"InvoiceId": "OMS-INV-20240913160430",
"RecTransactionHistoryId": "TRANS-IREC-TRAD-20240913-GT6J-00040",
"RecItemTransactionHistories": [
{
"RecItemId": "c91f8643-c3e3-49ce-8372-08dbff94c16d",
"SerialNumber": "IREC-DXNDES10001-VN-2023-0707-0707-258 to 277",
"DeviceUniqueId": null,
"DeviceName": "DXN Device 1"
}
],
"CreatedTime": "2024-09-13T11:10:25.7433333Z",
"MatchedTime": "2024-09-13T11:10:25.8733333Z",
"FinishedTime": "2024-09-13T16:30:07.0585318Z"
}API Definition
GET /public/v2/exchange/spot/limit-orders/transactions/{transactionId}
Request
Headers
Content-Type |
|
Authorization |
|
Query Parameters
TransactionId - text The ID of Transaction |
curl --location 'https://uat-api.redex.eco/public/v2/exchanges/spots/transactions/EX2024091311102597630230' \
--header 'accept: application/json' \
--header 'Authorization: Bearer {{access_token}}'
Response
Response Body |
Data object collection - Order Resource A collection of objects - Order Resource |
Errors list of error objects Please see "Getting Started - #Error Object" for more details 请查看Getting Started - #Error Object以获得更多信息。 |
Meta pagination resource Return Pagination Resource 返回分页信息 |
StatusCode integer Http Status codes standard. Example http状态码，如200，201，400, 422 |
Message text Response message: Success or error message. 返回成功或错误的信息。 |
200 Success
{
"Data": {
"OrderId": "4256",
"TransactionId": "43225",
"Status": {
"Value": "Pending",
"Description": "Pending Settlement"
},
"TickerId": "VN.23.SLR.i",
"Side": "Buy",
"Type": "Limit",
"TimeInForce": "GTC",
"Price": 89.00,
"CurrencyCode": "USD",
"MatchedPrice": 89.00,
"Quantity": 20.000000,
"UserName": "vinhlongsolar",
"DeviceUniqueId": null,
"InvoiceId": "OMS-INV-20240913160430",
"RecTransactionHistoryId": "TRANS-IREC-TRAD-20240913-GT6J-00040",
"RecItemTransactionHistories": [
{
"RecItemId": "c91f8643-c3e3-49ce-8372-08dbff94c16d",
"SerialNumber": "IREC-DXNDES10001-VN-2023-0707-0707-258 to 277",
"DeviceUniqueId": null,
"DeviceName": "DXN Device 1"
}
],
"CreatedTime": "2024-09-13T11:10:25.7433333Z",
"MatchedTime": "2024-09-13T11:10:25.8733333Z",
"FinishedTime": "2024-09-13T16:30:07.0585318Z"
},
"Meta": null,
"Errors": null,
"StatusCode": 200,
"Message": "Success"
}
400 Bad Request
422 Unprocessable Entity
Rate limit
Rate Limit Algorithm: Fixed Window
In fixed window rate limiting, a fixed time window (e.g., one minute, one hour) is used to track the number of requests or actions allowed within that window. Requests exceeding the limit are either rejected or throttled until the window resets.
Rate Limiting Overview
Our API employs rate limiting to ensure fair usage and protect the performance and availability of the service. Combination of Global Policy and Operation Policy
Global Policy
Rate Limit: 3000 requests per 5 minute(s)
Renewal Period: 300 second(s)
Key: IP Address
Increment Condition: Any Request
Operation Policy
Rate Limit: 60requests per 1 minute(s)
Renewal Period: 60 second(s)
Key:
accound-idbusiness account Id.Increment Condition: Any Request.
Rate Limit Details
Rate Limit by Key:
Key: This ensures that rate limits are applied uniquely for each business account id.
Request Limit: Each key is allowed to make up to 60 requests per minute.
Reset Interval: The limit resets every 60 seconds.
Response Headers:
Retry-After: Sent when the rate limit is exceeded, indicating how long to wait before making another request.
Exceeding the Rate Limit
When the rate limit is exceeded, the API will return a 429 Too Many Requests status code. The response will include a Retry-After header specifying the number of seconds to wait before making a new request.