[GET] GET Spot exchange transactions

Owned by Tam Tran
Last updated: Oct 25, 2024 by Que Nguyen
5 min read

Allow user to get their transaction with Query params

Table of Contents

Changelogs

Version

Date

Changes by

Description of change

V1.0

Jul 24, 2024

Tam Tran

  • Added Table of Contents.

  • Added Changelogs.

Order Resource

OrderId number

订单唯一标识符

Order unique Identifier

订单唯一标识符

TransactionId text

Transaction Unique Id

Status object

  • Value: Value of Enum

  • Description: Description of Enum

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:

有效时间 - 在进行交易时使用的一种特殊指标，用于指示订单在执行或到期前将保持多长时间有效

  • GTC: Good till Cancel - 取消前有效

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

{ "OrderId": "4256", "TransactionId": "42256", "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": "TEST_OMS-INV-20240913113710", "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

Request

Headers

Content-Type

application/json

Authorization

Bearer {{access_token}}

Query Parameters

Statuses (optional) array - string

Sides (optional) array - enum (Buy - Sell)

订单方（可选）文本 - 枚举（买方 - 卖方）

Order Side

订单方

Types (optional) array - enum (Limit)

Order Type

TIFs (optional) array - enum (GoodTilCancel)

Time In Force

OrderBy (optional) text (OrderId, TickerId, Price, Quantity, CreatedTime)

Order By (Default will be OrderId)

IsDescending (optional) boolean (true/false)

Search (optional) text (TickerId)

Search on Ticker info

CurrentPage (optional) integer

The page number to retrieve the next set of inverters. The number has to be greater than 1, and will default to 1.

ItemsPerPage (optional) integer

The maximum number of inverter brands to return per page. This number can range from 10 to 100 and defaults to 100.

curl --location 'https://uat-api.redex.eco/public/v2/exchange/spot/limit-orders/transactions?CurrentPage=1&ItemsPerPage=1' \ --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 200, 201, 400, 422.

http状态码，如200，201，400, 422

Message text

Response message: Success or error message.

返回成功或错误的信息。

200 Success

{ "Data": [ { "OrderId": "4256", "TransactionId": "42256", "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": "userredex", "DeviceUniqueId": null, "InvoiceId": "OMS-INV-2024091311376510", "CreatedTime": "2024-09-13T11:10:25.7433333Z", "MatchedTime": "2024-09-13T11:10:25.8733333Z", "FinishedTime": "2024-09-13T16:30:07.0585318Z" }, { "OrderId": "4234", "TransactionId": "43524", "Status": { "Value": "Cancelled", "Description": "Cancelled" }, "TickerId": "VN.23.SLR.i", "Side": "Buy", "Type": "Limit", "TimeInForce": "GTC", "Price": 40.00, "CurrencyCode": "USD", "MatchedPrice": 40.00, "Quantity": 1.000000, "UserName": "userredex", "DeviceUniqueId": null, "InvoiceId": "TOMS-INV-2024430913074253", "CreatedTime": "2024-09-13T07:49:43.4800000Z", "MatchedTime": "2024-09-13T07:49:43.5633333Z", "FinishedTime": "2024-09-13T07:54:27.4763174Z" } } ], "Meta": { "CurrentPage": 1, "TotalPage": 1, "TotalItems": 2, "ItemsPerPage": 100 }, "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: 10 requests per 10 seconds(s)

  • Renewal Period: 10 second(s)

  • Key: accound-id business account Id.

  • Increment Condition: Any Request.

Rate Limit Details

  1. Rate Limit by Key:

    1. Key: This ensures that rate limits are applied uniquely for each business account id.

    2. Request Limit: Each key is allowed to make up to 10 requests per 10 seconds.

    3. Reset Interval: The limit resets every 10 seconds.

  2. Response Headers:

    1. 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.

Example Response When Rate Limit is Exceeded