Documentation

Get started

To get started, you'll need to request an API key. An API key will be generated for you and emailed to you within a week, provided I'm not on holiday!

This documentation mirrors the API calls exactly. For example, clicking on 'details' will take you to: http://api.ashton.codes/docs/details/ To actually get 'details', simply replace 'docs' with 'get', and append your API key: http://api.ashton.codes/get/details/?key=YOUR_API_KEY

Data formats

Return values can be encoded as json (default), xml, or csv - simply append the required datatype to the end of the URL, e.g. http://api.ashton.codes/get/miscellaneous/codingDays/?key=YOUR_API_KEY&type=xml

Up-to-dateness

Ok, that's a horrible heading, but can you think of a better alternative?

The API return values are precalculated, and are updated once every 10 minutes. Therefore the return values can be up to 10 minutes out of date. Just give it a few minutes to catch up then try again.

Why the precalculated values? The API has several external dependencies, such as Twitter and LinkedIn. These services have been known to go down, so rather than risk bringing down the API I decided to cache values regularly instead. This also makes for a much faster API call.

Usage limits

At the moment, there is no usage limit - your API key grants you unlimited access to the API.