We provide an ‘application programming interface’ (API) for accessing the anonymised data – both live and historic – that Studybugs collects.

This page details how to access this API and the open data licensing terms that apply.

Privacy

All data collection is carried out with the consent of our users and in accordance with our privacy notice. All sick report data is fully anonymised and users can opt out of the whole process if they wish.

How to Access

Anonymised sick reports can be retrieved in JSON format by making an HTTPS request to the following API endpoint: GET https://studybugs.com/public-apis/sickdata?since=SINCE&before=BEFORE&offset=OFFSET Accept: application/vnd.studybugs.data+json;v=1 Content-Encoding: gzip

Anonymised well reports (reports of lack of symptoms) can be retrieved in JSON format by making an HTTPS request to the following API endpoint: GET https://studybugs.com/public-apis/welldata?since=SINCE&before=BEFORE&offset=OFFSET Accept: application/vnd.studybugs.data+json;v=1 Content-Encoding: gzip

This will return up to 10,000 reports posted between SINCE and BEFORE, where SINCE and BEFORE are in Unix time milliseconds. To fetch the next 10,000 reports increment the OFFSET parameter to skip the first OFFSET number of results.

Data is returned in JSON format, compressed. You can also specify the following Accept header to return data in a comma separated values (CSV) format. Accept: application/vnd.studybugs.data+csv;v=1

We plan to add here more detailed documentation on the format of the data returned. Meanwhile if you’d like more detail on this please feel free to email support@studybugs.com.

Licensing

Anonymised sick report data is made available under the Open Database License: http://opendatacommons.org/licenses/odbl/. Any rights in individual contents of the database are licensed under the Database Contents License: http://opendatacommons.org/licenses/dbcl/.

Keep Us Posted!

If you’re putting the open data we collect to use, please drop us a quick email – we’d love to hear about the project you’re working on.