Home

This is the documentation for v1 of the Readmill API which is deprecated and will be discontinued on 2012-12-16. Please upgrade to v2, the new developer documentations are at developers.readmill.com.

Readmill API

Introduction

Before you jump into to the docs, please read our introduction to Readmill

The Readmill API is RESTful which means that we're using the HTTP verbs GET, PUT, DELETE and POST. We also strive to be as standardized as possible so if you find anything strange or unconventional please let us know. For authenticated requests we are using OAuth2 with access tokens and refresh tokens. The API is open but we require you to register an application to use it. This means that you have to pass a client_id to all requests. You can register an app by going to Your apps on Readmill.

The functionality of the API reflects the most part of the Readmill code base and we develop it continuously to make it better, faster and easier to use.

A basic request using curl can look like this:

$ curl api.readmill.com/users/2?client_id=CLIENTID

{
  "id": 2,
  "username": "henrik",
  "firstname": "Henrik",
  "lastname": "Berggren",
  "fullname": "Henrik Berggren",
  "country": "Sweden",
  "city": "Stockholm",
  "website": "http://henrikberggren.com",
  "description": "Passionate reader of internet lit and crime novels",
  "uri": "http://api.readmill.com/users/2",
  "permalink_url":"http://readmill.com/henrik",
  "books_interesting":23,
  "books_open":2,
  "books_finished":3,
  "books_abandoned":0,
  "readings":"http://api.readmill.com/users/2/readings",
  "avatar_url":"http://static.readmill.com/avatars/c4f503989a8115d83d198c8dd2635ef4-medium.png?1311690158",
  "followers":125,
  "followings":115
}