Revish API

Welcome

Welcome to the Revish API. You can use the API to access information in our databases in a variety of formats. There are some restrictions on the uses you may put the API to, so please take a look at our terms and conditions if you are not familiar with them.

Commercial use of the API is prohibited without express written permission. Please contact us to discuss a commercial API license.

Overview

All API functions are accessed using this syntax:

http://api.revish.com/methodName?apikey=apikey&argument=argument…

Where methodName is the case-sensitive name of the method as detailed below. Only one argument is compulsory for all methods, apikey:

API Key

All Revish users are allocated an API Key on registration. It can be found on your profile page.

Format

Results can be returned in one of several formats by specifying the format argument:

  1. xml - results will be returned as XML.
  2. php - results will be returned as a base-64 encoded, serialised PHP array
  3. js - results will be returned as a JavaScript object

Methods

getReviews

Retrieve up to 20 reviews at a time from Revish. You can search by various criteria including user, book title, author, ISBN, rating, publisher, reviewer and tag, or any combination of these.

getReadingList

Retrieve a user's reading list.

getReadingHistory

Retrieve a user's reading history.

getToBeReadList

Retrieve a user's to-be-read list.

Restrictions on use

Personal use is limited to 1,000 queries per day across the Revish API. Any usage beyond this will be blocked, and repeated breaking of this limit will result in account suspension. Please contact us to discuss heavy usage licences.

Commercial use of the API is forbidden without our written permission. Please contact us to discuss a commercial API license.