OverDrive Developers

Retailer Account API

The Retailer Account API delivers general information about an account including available formats and a products hypermedia link that returns all available titles in a retailer collection.

Retailers will be provided with a retailer account ID to access the Retailer Account API.

Accessing the Retailer Account API

The Retailer Account API serves as the starting point for most API clients to discover the full list of products available in a retailer's digital media collection.

Resource URL

https://api.overdrive.com/v1/retailers/{Retailer ID}

This URL returns a JSON response that includes:

  • The retailer's name
  • The account type
  • A link for all products available in the digital media collection
  • The formats supported by the retailer

Example request

GET https://api.overdrive.com/v1/retailers/9999999
User-Agent: {Your application}
Authorization: Bearer {OAuth access token}
Host: api.overdrive.com

Example response

200 OK
Pragma: no-cache
X-Frame-Options: deny
Content-Length: 1134
Cache-Control: no-cache
Content-Type: application/json; charset=utf-8
Date: Wed, 24 Feb 2016 14:00:55 GMT
Expires: -1

{
    "id": 9999999,
    "name": "My Digital Retailer (OverDrive Made Up Retailer) (OH)",
    "type": "Retailer",
    "links": {
        "self": {
            "href": "https://api.overdrive.com.oddev/v1/retailers/9999999",
            "type": "application/vnd.overdrive.api+json"
        },
        "products": {
            "href": "https://api.overdrive.com.oddev/v1/collections/v1L1Bf5aYAA2Z/products",
            "type": "application/vnd.overdrive.api+json"
        },
    },
    "formats": [
        {
            "id": "ebook-pdf-adobe",
            "name": "Adobe PDF eBook"
        },
        {
            "id": "ebook-epub-adobe",
            "name": "Adobe EPUB eBook"
        },
        {
            "id": "audiobook-mp3",
            "name": "OverDrive MP3 Audiobook"
        }
    ]
}

Now that you have the retailer account products URL, you can access the Search API. From there, follow the hypermedia links to access the Metadata API to get the information you need to make your app work.