gistfile1.txt

=====================
Readernaut Public API
=====================

1.0 (pre-release)
=================

Reader Books
------------

A reader book is a the relationship a reader has with a book (i.e. user -> reader book -> book).

URL: http://readernaut.com/services/api/<username>/readerbooks/
Formats: JSON
Methods: GET
Parameters: 
  ``page`` Optional. 
    http://readernaut.com/services/api/nathan/readerbooks/?page=2
  ``limit`` Optional. 
    Specifies the number of books to retrieve. May not be greater than 100. Default is 20. http://readernaut.com/services/api/nathan/readerbooks/?limit=20

Notes
-----

Returns a users notes.

User URL:http://readernaut.com/services/api/<username>/notes/
Public URL: http://readernaut.com/services/api/notes/
Formats: JSON
Methods: GET
Parameters:
  ``page`` Optional. 
    http://readernaut.com/services/api/nathan/notes/?page=2
  ``limit`` Optional.
    Specifies the number of notes to retrieve. May not be greater than 100. Default is 20. http://readernaut.com/services/api/nathan/notes/?limit=20

Progress
--------

Returns recent progress updates.

URL:http://readernaut.com/services/api/<username>/progress/
Formats: JSON
Methods: GET
Parameters:
  ``page`` Optional. 
    http://readernaut.com/services/api/nathan/progress/?page=2
  ``limit`` Optional.
    Specifies the number of progress updates to retrieve. May not be greater than 100. Default is 20. http://readernaut.com/services/api/nathan/progress/?limit=20

Friends
-------

Returns a users friends.

URL: http://readernaut.com/services/api/nathan/friends/
Formats: JSON
Methods: GET
Parameters:
  ``page`` Optional. 
    http://readernaut.com/services/api/nathan/friends/?page=2
  ``limit`` Optional. 
    Specifies the number of friends to retrieve. May not be greater than 100. Default is 20. http://readernaut.com/services/api/nathan/friends/?limit=20