C3 AI COVID-19 Data Lake Public API Tips and Tricks
For many researchers, accessing the public API for the COVID-19 Federated Data Image will be enough for their research goals. The public API provides fetch access to many Data Lake objects, and metrics access to some time series data such as case data.
Pros:
- Easy to integrate into existing scientific workflows and run on existing scientific computational hardware
- Publicly available API means no credentials or special software are needed.
- Assuming you have access to your own computational resources, you don't have to worry about allocations on C3's platform.
Cons:
- All data used from the Data Lake must be streamed to wherever you're processing data
- Performance benefits from working with the Data Lake using C3 will not be available.
- Not all data within the Data Lake is available through the public API.
Training Curriculum
Following this guide is enough to get started.
You’ll need to have asked for access to see the API doc pages:
- Go to the API docs link, choose “Get Access” from the left sidebar, and fill out the simple form.
- Follow the “Confirm Email” link in email you should get sent automatically as soon you submit the form (subject: "C3 AI COVID-19 Data Lake - Confirm Email").
Note: save that email! There is no account creation to access the API, but you will need to follow the "Confirm Email" link again if you access from another browser in the future, if your cookies get cleared, etc.
Official C3 Public COVID-19 API Documentation:
- This excellent set of documentation from C3 describes the publicly available API.
- This documentation comes with plenty of examples showing how to use the API.
- This documentation comes with a python notebook and R notebook showing exactly how to use this API.
- Researchers may find they do not need to read all of this document. We however, recommend reading at least to the section 'Using C3.ai APIs'. The rest of the document gives examples on how to fetch the various available data types.
Example Workflows
Follow these examples to more fully understand the C3 system and compose more complex data analysis.
- Official C3 Public COVID-19 API Documentation
- Worked examples in both Python and R are available from the link above.
- Cases example (Public API)
- Vaccine Listing example (Public API)
- Epidemiology example (Public API)
- Phylogenetic Tree building example (Public API)
Optional References/Training
While not necessary, some researchers may find this optional reference useful.
- Differences between the public API and the full C3 AI COVID-19 Data Lake
- The DTI team tries to keep a list of differences between the public face of the Data Lake, and the full Data Lake.
- This will help researchers decide whether they need full access, or can just use the public API.
- C3 AI COVID-19 Data Lake Public API Tips and Tricks
- DTI Guide to utilizing C3 Documentation
- While not necessary, some portions of the C3 Documentation is useful even for Public API users.