Versions Compared

Version Old Version 2 New Version Current
Changes made by

allen li

allen li

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Allow user to get markets base it’s account setting

Table of Contents

Table of Contents
stylenone

Changelogs

Version

Date

Changes by

Description of change

V 1.0.1

allen li

  • Added document

Market Resource

MarketId text Int

市场唯一标识符

Market unique id

市场唯一标识符

Name text - (Global- Latam - China)

市场名称

Market Name

市场名称

CurrrencyCode text

货币代码

Currency Code

货币代码

Code Block
languagejson
{
    "MarketId": 1,
    "Name": "Global",
    "CurrencyCode": "USD"
}

Market List

Market Id

Market Name

Currency Code

1

Global

USD

2

China

CNY

3

Latam

BRL

API Definitions

Status
colourGreen
titleGET
/public/v2/exchange/spot/markets

Request

Headers

Authorization text

Authorization Bearer access token

Ex: Bearer {{access_token}}

Code Block
curl -X 'GET' \
  'https://uat-api.redex.eco/public/v2/exchange/spot/markets' \
  -H 'accept: application/json'

Response

Response Body

Data object collection - Spot Exchange Market Resource

An object collection of Spot Exchange Market 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.

返回成功或错误的信息。

Info

200 OK

Code Block
languagejson
{
    "Data": [
        {
            "MarketId": 1,
            "Name": "Global",
            "CurrencyCode": "USD"
        }
    ],
    "Meta": null,
    "Errors": null,
    "StatusCode": 200,
    "Message": "Success"
}

Warning

400 Bad Request

Code Block
languagejson
{
  "Data": null,
  "StatusCode": 400,
  "Errors": [],
  "Meta": null,
  "Message": "Bad Request"
}

Warning

401 Unauthorized

Code Block
languagejson
{
  "Data": null,
  "StatusCode": 400,
  "Errors": [],
  "Meta": null,
  "Message": "Unauthorized"
}

Warning

403 Forbidden

Code Block
languagejson
{
  "Data": null,
  "StatusCode": 403,
  "Errors": [],
  "Meta": null,
  "Message": "Forbidden"
}

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

Code Block
languagejson
HTTP/1.1 429 Too Many Requests
Retry-After: 60
Content-Type: application/json

{
    "Data": null,
    "Errors": null,
    "StatusCode": 429,
    "Message": "Rate limit exceeded",
    "Meta": null
}