REST API Rate Limiting

To prevent API abuse, we enable API rate limiting in our API server.

# API Quota

The API quota represents how many requests are allowed for the cutomers.

# Default Quota

By default, each customer is allowing 7500 API requests per hour.

The quota is shared by all users within the same customer.

# Time Window Algorithm

Internally, we leverage the sliding window to limit the API request.

# Increasing Quota

If the default API quota cannot meet your specific business requirement, please send a request to our support team to increase the API quota.

# API Rate Limit Protocol

We are following this RFC (opens new window) to return corresponding HTTP headers in each API response.

# HTTP Headers

# RateLimit-Limit

The RateLimit-Limit response header field indicates the request-quota associated with the client in the current time window.

The header format is

RateLimit-Limit = expiring-limit [, 1#quota-policy ]
expiring-limit = request-quota

1
2

For example, the default rate limit quota is:

RateLimit-Limit: 7500;w=3600

# RateLimit-Remaining

The RateLimit-Remaining response header field indicates the remaining quota-units associated with the client.

The header format is

RateLimit-Remaining = quota-units

This header MUST NOT occur multiple times.

For example:

RateLimit-Remaining: 7499

# RateLimit-Reset

The RateLimit-Reset response header field indicates the number of seconds until the quota resets. The client should wait that specific time before sending API retry request.