If you're wanting to find out more about the API, you've come to the right place. Here you will find information on:
- how to make calls to the service
- request and response formats
- the resources available to you
- how to authenticate
We also have some FAQs as well as some sample code to help you get started. There may also be a 3rd party library for your favourite programming language - check the downloads page.
A request is made by accessing a URL, containing some additional parameters that identify your application and the type of data you want to receive.
The API contains a variety of resources, each performing a different task. For example, one resource can return search results, while another allows you to add a comment to a journal entry.
Each resource has a unique URL, adhering to a simple format. In addition, each resource has a set of parameters which can modify the data that is returned.
After making a request, the API will return its response to you. This contains the data you requested, as well as details of any errors that occurred.
The default response format is XML, but JSON, JSON-P and serialised PHP are also available.