Repository navigation
docs(api-quickstart): document the API rate limit and 429 handling - #725
Merged
Merged
Conversation
The Quickstart said the API enforced no rate limits. The WAF now blocks clients above 1,500 requests per IP per 5 minutes with a 429 and a Retry-After header. Document the limit and add Python, R, and curl examples that wait and retry on 429.
3 tasks done
|
coverage: 10.496%. remained the same — docs/bencap/api-rate-limits into release-2026.3.0 |
3 tasks done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The API Quickstart's Rate Limits section said the API enforced no rate limits. The WAF now enforces one (VariantEffect/mavedb-api#669), so this documents it.
Changes
429 Too Many Requestswith aRetry-Afterheader. A shared address, such as a campus network, counts as one client.Retry-Afterand retry. The curl example uses--failso a 429 body doesn't end up in the downloaded output.The Python and curl snippets were checked against a mock server returning 429 with
Retry-After.