Table of Contents

Changelogs

API Definition

Release status

API Definition

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: 50 requests per 1 minute(s)

• Renewal Period: 60 second(s)

• Key: accound-id business account Id.

• Increment Condition: Success 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 50 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

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
}