API

The API is available at https://api.opencovid.ca. See the guide below for how to construct API queries.

Navigation

Welcome
License
Acknowledgements
Issues, Suggestions and Code Availability
Basic Usage
API Documentation

Welcome

Welcome to the API documentation for the COVID-19 Canada Open Data Working Group dataset. The goal of the API is to provide an alternative method of accessing the dataset available in our GitHub repository. All results are returned as JSON.

License

The COVID-19 Open Data Working Group dataset is available under the Creative Commons Attribution 4.0 International license.

Acknowledgements

API programming by Jean-Paul R. Soucy. Dataset by the COVID-19 Open Data Working Group (see About Us).

Issues, Suggestions and Code Availability

The code for the API is available on GitHub. Please submit issues and suggestions here or by email to: ccodwg [at] gmail [dot] com.

Basic Usage

The API is capable of returning two types of data: time series data and a summary of all data for a particular day or days.

Each data type is capable of taking one or more parameters. Begin your parameter string with ? and join parameters with &. See sample queries for examples.

API Documentation