[GET] Get Spot exchange tickers

Owned by Que Nguyen
Last updated: Aug 15, 2024 by Xiaowei Chen
3 min read

Allow user to get current available tickers with highest bid and lowest offer Query params

Table of Contents

Changelogs

Version

Date

Changes by

Description of change

V 1.0.1

Jul 5, 2024

Que Nguyen

  • Added document

Ticker highest bid and lowest offer Resource

TickerId text

绿证行情唯一标识符

Ticker unique id

绿证行情唯一标识符，可类比“股票代码”，组成格式： “国家代码.生效年.能源类型.注册处”

Registry text - enum (IREC - TIGR)

注册处

Registry enum values

注册处枚举值

Bids number

竞标价格

Highest bid

最高竞标价

Offers number

报价

Lowest offer

最低报价

{ "TickerId": "MY.24.SLR.i", "Registry": "IREC", "Bids": 5.23, "Offers": 5.3 }

 

API Definitions

GET /public/v2/exchange/spot/tickers

Request

Headers

Authorization text

Authorization Bearer access token

Ex: Bearer {{access_token}}

Query Parameters

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/tickers?CurrentPage=1&ItemsPerPage=10' \ -H 'accept: application/json'

 

Response

Response Body

Data object collection - Ticker highest bid and lowest offer Resource

An object collection of Ticker highest bid and lowest offer 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, 404.

http状态码，如200，201，404

Message text

Response message: Success or error message.

返回成功或错误的信息。

200 OK

{ "Data": [ { "TickerId": "MY.24.SLR.i", "Registry": "IREC", "Bids": 5.23, "Offers": 5.3 }, { "TickerId": "MY.24.HYD.i", "Registry": "TIGR", "Bids": 4.2, "Offers": 4.4 } ], "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-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 60 requests per minute.

    3. Reset Interval: The limit resets every 60 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