Skip to content
zagorsky edited this page Aug 13, 2021 · 2 revisions

The data download API is for raw/chunked data. It's an alternative to downloading data through the web page, and it lets you specify all the same things that the web page downloader lets you specify: participant IDs, data streams, and date ranges.

One advantage of using the Data Download API (instead of the webpage for downloads) is that the API creates a registry file that tracks which files have already been downloaded, and then each time you request more data from the API, it only downloads new data.

There's an example download script, written in Python, in the beiwe-backend repo at data_access_api_reference/download_data.py. To run this script, you need to provide ACCESS_KEY and SECRET_KEY, which you get from the "Manage Credentials" page of your Beiwe deployment. You also need to define API_URL_BASE, which is the URL of your Beiwe deployment.

Clone this wiki locally