We design our website to be nice for humans to read - and you can think of our API as the same website, but designed to be nice for machines to read (and not so nice for humans).
Our API makes the essential public data that you can view on the website - stories, responses, tags, services - available to be read by a program running on your computer. This means that, rather than reading one page at a time, a computer program can very quickly read hundreds or thousands of stories, and store them for future analysis or reporting.
Your subscription scope will determine the data you can access using the API. If you are a healthcare provider organisation, then you will most likely be able to use the API to access the stories linked to your organisation.
The API only shares data which is already public, and never includes confidential data.
Who can make use of the API?
To make use of the API, you'll need two things:
- someone with the ability to write a computer program that can make HTTP requests and process a response in XML or JSON format
- an API key, available if you are an admin in a qualifying subscription
For further technical documentation, please use the link on this page.