API Documentation

Overview

The BiblioCommons API is implemented using common REST principles.  Currently the API supports GET requests over HTTPS, and returns responses as JSON objects.  The following sections describe the URL Structure and Authentication methods for all API requests, and list the Resources that are currently supported.

Developers should also review the shared Request Parameters and Response Fields that are common to all requests.

URL Structure

All BiblioCommons API requests have the following structure:

https://api.bibliocommons.com/{version}/{resource}

Currently {version} must be v1.  Follow our blog for information about new versions of the API, and deprecation notifications for older versions.

Authentication

Currently the API supports public data only, and requires the following authentication method for all requests:

  • API Key: A valid BiblioCommons API Key must be passed via the api_key parameter.  Get an API key.  For example:
https://api.bibliocommons.com/v1/{resource}?api_key={key}

Resources

Resource Description
libraries/{id} Returns basic information about a given library, specified by library ID.
libraries/{id}/locations

Returns the list of locations for a given library, specified by library ID, with basic information about each location.

lists

Returns a list of user lists, for a given set of criteria, with basic information about each user list.

lists/{id} Returns detailed information about a given user list, specified by user list ID. 
titles Returns a list of titles from a given library catalog and matching a given set of search criteria, with basic information about each title.
titles/{id} Returns detailed information about a given title from a library catalog, specified by title ID.
titles/{id}/copies Returns the list of copies for a given title, specified by title ID, with basic information about each copy.
users Returns a list of users matching a given set of search criteria, with basic public information about each user.
users/{id} Returns basic public information about a given user, specified by user ID.
users/{id}/lists Returns the list of user lists for a given user, specified by user ID, with basic information about each user list. 
users/{id}/user_content Returns the list of user contributed content for a given user, specified by user ID.
user_content Returns a list of user contributed content for a given set of search criteria.