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

About API call speed improvement #5315

Closed
1 of 7 tasks
Eddie-0721 opened this issue Jan 3, 2025 · 1 comment
Closed
1 of 7 tasks

About API call speed improvement #5315

Eddie-0721 opened this issue Jan 3, 2025 · 1 comment
Labels
🕹 aspect: interface Concerns end-users' experience with the software 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: api Related to the Django API ❓ talk: question Can be resolved with an answer

Comments

@Eddie-0721
Copy link

Eddie-0721 commented Jan 3, 2025

Source API Endpoint / Documentation

https://api.openverse.org/v1/#tag/auth/operation/register

Provider description

Dear Openverse Team,

I hope this message finds you well.

I would like to inquire about the rate limits for the Openverse API:

Does your API have a rate limit for usage?
If so, what steps can we take to increase the rate limit?
We are an AI-focused company working on tourism projects and are very interested in leveraging your API for our platform. Please let us know the process or requirements for enhancing the rate limit to better suit our needs.

Looking forward to your guidance. Thank you for your assistance!

Licenses Provided

none

Provider API Technical info

none

Checklist to complete before beginning development

  • Verify there is a way to retrieve the entire relevant portion of the provider's collection in a systematic way via their API.
  • Verify the API provides license info (license type and version; license URL provides both, and is preferred)
  • Verify the API provides stable direct links to individual works.
  • Verify the API provides a stable landing page URL to individual works.
  • Note other info the API provides, such as thumbnails, dimensions, attribution info (required if non-CC0 licenses will be kept), title, description, other meta data, tags, etc.
  • Attach example responses to API queries that have the relevant info.

Implementation

  • 🙋 I would be interested in implementing this feature.
@Eddie-0721 Eddie-0721 added ☁️ provider: any Replace with the actual provider type 🌟 goal: addition Addition of new feature 💻 aspect: code Concerns the software code in the repository 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: catalog Related to the catalog and Airflow DAGs 🧹 status: ticket work required Needs more details before it can be worked on labels Jan 3, 2025
@openverse-bot openverse-bot moved this to 📋 Backlog in Openverse Backlog Jan 3, 2025
@dhruvkb dhruvkb added 🟨 priority: medium Not blocking but should be addressed soon 🕹 aspect: interface Concerns end-users' experience with the software ❓ talk: question Can be resolved with an answer 🧱 stack: api Related to the Django API and removed 🟩 priority: low Low priority and doesn't need to be rushed 🧹 status: ticket work required Needs more details before it can be worked on 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 🌟 goal: addition Addition of new feature 💻 aspect: code Concerns the software code in the repository 🧱 stack: catalog Related to the catalog and Airflow DAGs ☁️ provider: any Replace with the actual provider type labels Jan 6, 2025
@dhruvkb
Copy link
Member

dhruvkb commented Jan 6, 2025

You're welcome to use the API to build your app. If you would be open to it, we would also love to feature the app on our Made with Openverse page.

To answer your questions, yes, the API has rate limits. You can see the total and available limits in the API response headers.

X-RateLimit-Available-anon_burst: <available limit>
X-RateLimit-Available-anon_sustained: <available limit>
X-RateLimit-Limit-anon_burst: <total limit>/min
X-RateLimit-Limit-anon_sustained: <total limit>/day

The limit without authentication (anonymous) is set to 20 requests/min and 200 requests/day.

You can increase the rate limit by registering an application and making authenticated requests. Authenticated requests get much higher limits such as 100 requests/min and 10,000 requests/day.

Upon request, subject to our availability and discretion, after reviewing the application, we may also provide "enhanced" limits to some authenticated clients that raises the limits to 200 requests/min and 20,000 requests/day.

Note

The exact values of these limits can change based on the availability of our resources. However, enhanced limits will always be more than authenticated limits, which will be more than anonymous limits.

For more information, please reach out to us via email openverse [at] wordpress [dot] org.

@dhruvkb dhruvkb closed this as completed Jan 6, 2025
@openverse-bot openverse-bot moved this from 📋 Backlog to ✅ Done in Openverse Backlog Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🕹 aspect: interface Concerns end-users' experience with the software 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: api Related to the Django API ❓ talk: question Can be resolved with an answer
Projects
Status: ✅ Done
Development

No branches or pull requests

2 participants