Versions Compared

Key

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

Allow user to get TickerId Energy Fuel Types with filter criterias. This TickerId Energy Fuel Type will be used afterward. Query params

Table of Contents

Table of Contents
stylenone

Changelogs

Version

Date

Changes by

Description of change

V 1.0.1

05 Jul

Que NguyenAllen Li

  • Added document

Ticket Information Resource

TickerId text

绿证行情唯一标识符

Ticker unique id

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

CountryCode text

国家代码

Country Alpha Two Code

两位国家代码

Vintage number

生效日期

Vintage year

生效年份

FuelType text

能源类型

Fuel’s Energy types

能源类型

Registry text - enum (IREC - TIGR)

注册处

Registry enum values

注册处枚举值

Code Block
languagejson
{
  "TickerId": "MY.24.SLR.i",
  "CountryCode": "MY",
  "Vintage": 2024,
  "FuelType": "Solar",
  "Registry": "IREC"
}

Fuel Energy types

Value

Short Code

Biogas/沼气

BGS

Biomass/生物

BMS

Co-fired with fossil/化石共生能

CFF

Geothermal/地热能

GTM

Hydro/氢能

HYD

Marine Current/海洋洋流能

MRC

Marine Tidal/海洋潮汐能

MRT

Marine Vertical Pressure/海洋垂直压力能

MRP

Marine Wave/海洋浪能

MRW

Nuclear/核能

NUC

Solar/太阳能

SLR

Wind/风能

WND

API Definitions

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

Request

Headers

Authorization text

Authorization Bearer access token

Ex: Bearer {{access_token}}

Query Parameters

CountryCode (required) text

国家代码(必须)

Country Alpha Two Code

国家两位代码

Vintage (required) number

生效时间

Vintage year

生效年

FuelType (required) text

能源类型

Fuel’s Energy types

能源类型

Registry (required) text - enum (IREC - TIGR)

注册处(必须)文本类型 - 枚举(IRECT - TIGR)

Registry enum values

注册处枚举值

Code Block
curl -X 'GET' \
  'https://uat-api.redex.eco/public/v2/exchange/spot/ticker?CountryCode=VN&Vintage=2023&FuelType=Solar&Registry=IREC' \
  -H 'accept: application/json'

Response

Response Body

Data object - Ticker information resource

绿证行情信息资源

An object of Ticker information 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": {
    "TickerId": "MY.24.SLR.i",
    "CountryCode": "MY",
    "Vintage": 2024,
    "FuelType": "Solar",
    "Registry": "IREC"
  },
  "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
}