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.

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

Clarify the rate-limiting language with additional details #593

Closed
sabbyanandan opened this issue Jan 17, 2024 · 2 comments
Closed

Clarify the rate-limiting language with additional details #593

sabbyanandan opened this issue Jan 17, 2024 · 2 comments
Assignees

Comments

@sabbyanandan
Copy link
Contributor

Ask 1:
The language written as-is is entirely correct. However, we can further expand on what "all Hiro APIs" means. In this case, a single rate-limiting quota is applied to all 3 public-facing APIs: Stacks Blockchain API, Metadata API, and Ordinals API.

For instance, if a developer uses either one or all 3 APIs simultaneously. In that case, the entirety of all API traffic will be attributed to a single default quota, which would be 50 RPM for unauthenticated and 500 RPM for authenticated traffic, respectively.

Let's explicitly state this in the docs so it provides further guidance to developers.


Ask 2:
In addition to RPM (requests per minute; the primary rate-limiting criteria), we recently introduced secondary rate-limiting criteria in our API infrastructure. Having both kinds is a best practice for any publicly offered API service for added security, better utilization & resource protection, and protecting the API service from abuse.

We want to include a blurb about the secondary rate limit, and in our case, that is 20 RPS (requests per second) for both authenticated and unauthenticated traffic.

@sabbyanandan
Copy link
Contributor Author

@ryanwaits: I would like to request us to clarify the language soon, so I marked it as "urgent" priority.

cc:/ @CharlieC3 @andresgalante

@ryanwaits
Copy link
Collaborator

sorry i let this one slip through the cracks, @sabbyanandan

heres the pr addressing this issue: #594

ryanwaits added a commit that referenced this issue Jan 22, 2024
update rate limiting copy in reference to issue #593
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Archived in project
Development

No branches or pull requests

2 participants