How to get API access
If you’re an OverDrive library or school partner
Fill out this form to request access to our APIs:
- For Discovery and/or Circulation APIs (for example, to allow users to search your catalog or borrow titles), select the name of the approved vendor you want to integrate with and fill in the contact information.
- For the Reporting API (to see details about the checkouts at your library), fill in the contact information and describe how you plan to use the API. This API is available to public libraries only.
Once your request is approved, OverDrive will send you a client key and secret. If you're working with a vendor, you'll need to give them the key and secret.
If you get approved to access the Reporting API, you'll get additional information about using this API, such as assigned time windows and pulling historical data.
Tip: If you'd like access to both suites of APIs (Discovery/Circulation and Reporting), you'll need to submit separate forms for each.
If you're a developer or vendor building an integration
Step 1: Review the API docs
Before requesting access to the OverDrive APIs, be sure to:
- Review the documentation on the Developer Portal.
- Review the terms and conditions.
Step 2: Submit a request form and get API access
Fill out this form and describe your planned usage of the APIs.
Then, OverDrive will review your request. If approved, OverDrive will:
- Send you information about which APIs you've been approved for (Discovery, Circulation, or Title Link).
- Send you a client key and secret.
- Grant you access to our integration environment.
Step 3: Build your implementation
Build your implementation and test with our integration environment and site.
Using the integration environment is required for Circulation APIs and recommended for Discovery APIs.
Tip: If you're only using the Discovery APIs, you don't need to get your integration approved for production access, so you don't need to proceed to step 4.
Step 4 (Circulation APIs only): Get your implementation approved for production access
Once you've built your implementation using our integration environment, you'll need to submit it to OverDrive for review to get production access.
Contact us via the support form to let us know you're ready for review. Be sure to include the production library or libraries for which you are developing. Then, we'll contact you to get access to your demo environment.
Here are some criteria we look for when reviewing your implementation:
- Accurately and securely authenticate users.
- Add support for OverDrive Advantage accounts.
- Provide search, sort, and filtering options to easily find titles.
- Display cover art and accurate metadata for all titles.
- Provide access to samples of titles, when available.
- Allow users to borrow and place holds on titles.
- Allow users to open or download titles after borrowing.
- Display Libby (for libraries) or Sora (for schools) branding when OverDrive titles are shown.
When your implementation has been reviewed and you've met the criteria, you'll get access to the production environment. This means:
- If you are the authentication vendor for your customers, your existing client key and secret will be promoted to production. If you don't know a library or school's OverDrive credentials (like their website ID), you'll need to ask them for it or reach out to our support team to get it.
- If you aren't the authentication vendor for your customers, you’ll need a new client key and secret for each library or school you work with. Your customers will need to request a key and secret for your API integration by filling out the request form, selecting your company in the vendor drop-down, and sending you their client key/secret.