[GET] Get Spot exchange ticker depth
- Que Nguyen
- allen li
Allow user to get market available orders with particular ticker, and side Query params
Table of Contents
- 1 Table of Contents
- 2 Changelogs
- 3 Ticker Order Resource
- 4 API Definitions
- 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 |
V 1.0.1 | Jul 5, 2024 | Que Nguyen |
|
Ticker Order Resource
Type text - enum (Limit) 订单类型 Order type 订单类型 |
Side text - enum (Buy - Sell) 订单方 文本类型 - 枚举（买方 - 卖方） Order side enum 订单方枚举 |
HasYourOrder boolean 是否包括业主订单 Has included the owner order. 是否包括业主订单 |
Price number 价格 Order price 订单价格 |
Quantity number 数量 Order quantity 订单数量 |
Currency text 货币 Currency code 货币代码 |
{
"Type": "Limit",
"Side": "Buy",
"HasYourOrder": false,
"Price": 3.5,
"Quantity": 1000,
"Currency": "USD"
}
API Definitions
GET /public/v2/exchange/spot/depth
Request
Headers
Authorization text Authorization Bearer access token Ex: |
Query Parameters
TickerId (required) text 绿证行情唯一标识符 Ticker unique id 绿证行情唯一标识符，可类比“股票代码”，组成格式： “国家代码.生效年.能源类型.注册处” |
Side (optional) text - enum (Buy - Sell) 订单方（可选） 文本类型 - 枚举（买方 - 卖方） Order Side 订单方枚举 |
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 -X 'GET' \
'https://uat-api.redex.eco/public/v2/exchange/spot/depth?TickerId=MY.24.SLR.i&Side=Buy' \
-H 'accept: application/json'
Response
Response Body |
Data object collection - Ticker Order Resource An object collection of Ticker 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，404 |
Message text Response message: Success or error message. 返回成功或错误的信息。 |
200 OK
{
"Data": [
{
"Type": "Limit",
"Side": "Buy",
"HasYourOrder": false,
"Price": 3.5,
"Quantity": 1000,
"Currency": "USD"
},
{
"Type": "Limit",
"Side": "Sell",
"HasYourOrder": false,
"Price": 4.5,
"Quantity": 100,
"Currency": "USD"
}
],
"Meta": {
"CurrentPage": 1,
"TotalPage": 1,
"TotalItems": 2,
"ItemsPerPage": 10
},
"Errors": null,
"StatusCode": 200,
"Message": "Success"
}
400 Bad Request
401 Unauthorized
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: 60 requests 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.