Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documented rate limit to 60 RPS #49

Merged
merged 1 commit into from
Oct 24, 2023
+4 −4
Merged

Update documented rate limit to 60 RPS #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,14 @@ If you are approaching any of these limits in your implementation and require su

### Do you have any rate limits in place in your public API?

Our public API currently limits users to a maximum of 20 requests per second. Specific headers are returned to indicate current quota:
* `ratelimit-limit`: indicates the total quota (20)
Our public API currently limits users to a maximum of 60 RPS (Requests Per Second). Specific headers are returned to indicate current quota:
* `ratelimit-limit`: indicates the total quota (60)
* `ratelimit-remaining`: indicates the current quota
* `x-rate-limit-request-forwarded-for` and `x-rate-limit-request-remote-addr`: echo back your remote IP and forwarded-for IP for debugging purposes

When rate limits are exceeded, an error with HTTP 429 is returned with the following message: `Too many requests. Please wait and try again in a few seconds`.

This limit is on a **per IP address** basis: if you have multiple servers making requests to the turnkey API under a different IP address, each server is subject to the 20 RPS limit individually.
This limit is on a **per IP address** basis: if you have multiple servers making requests to the turnkey API under a different IP address, each server is subject to the 60 RPS limit individually.

Please get in touch with us (<[email protected]>) if you need this limit adjusted for your use-case.

Expand Down Expand Up @@ -115,4 +115,4 @@ If you get stuck or have a one-off question, post it to our [developer forum](ht

### Is my country supported?

Turnkey is not currently available to users in any countries currently subject to US OFAC sanctions.
Turnkey is not currently available to users in any countries currently subject to US OFAC sanctions.