Readernaut provides a RESTful API for integration with third party applications. This API is under development and backwards incompatible changes can (and will) happen. This document assumes you have a basic understanding of REST and HTTP.

Public API

The following are hooks into the public version of the Readernaut API.

Reader Books

You can get a list of "reader books" which are relationships between a user and a book edition.

/api/v1/xml/<username>/books/

Example: http://readernaut.com/api/v1/xml/nathan/books/ 

Notes

You can get a list of notes generated by users.

/api/v1/xml/<username>/notes/

Example: http://readernaut.com/api/v1/xml/nathan/notes/ 

Contacts

You can get a list of user contacts which is a relationship between two users.

/api/v1/xml/<username>/contacts/

Example: http://readernaut.com/api/v1/xml/nathan/contacts/ 

Pagination

By default lists return the first 20 results. You can advance through pages by adding page=2 to the URL string.

Example: http://readernaut.com/api/v1/xml/nathan/books/?page=2 

Ordering

By default lists are ordered by creation date. You can change this by adding order_by=modified to the url string. Possible values to order_by include -created, created, modified, -modified.

Example: http://readernaut.com/api/v1/xml/nathan/books/?order_by=modified 

JSON support

If you'd like to return JSON instead just replace the /xml/ part of the url with /json/ like so:

Example: http://readernaut.com/api/v1/json/nathan/books/ 

If you'd like to add a callback just append ?callback=foo to the URL.

Example: http://readernaut.com/api/v1/json/nathan/books/?callback=makeWidget

Private API

Under development