Skip to content
This repository has been archived by the owner on Sep 18, 2023. It is now read-only.

Latest commit

 

History

History
107 lines (76 loc) · 2.28 KB

README.md

File metadata and controls

107 lines (76 loc) · 2.28 KB

COVID-19 API

This is a fast (< 200ms) and basic API for tracking development of the new coronavirus (2019-nCoV). It's written in Python using 🍼 Flask and also contains historical data 📈. I've also programmed a scheduler on the app to refresh the data every 10 minutes.

Endpoints

All requests must be made to the base url: https://covid19api.herokuapp.com/. You can try it out in your browser to further inspect responses.

Getting confirmed cases, deaths, and recoveries:

GET /
{ "latest": { ... }, "confirmed": { ... }, "deaths": { ... }, "recovered": { ... }, "updatedAt": "2020-03-27 12:00:12.067975" }

Getting just confirmed:

GET /confirmed
{ "latest": 418678, "locations": [ ... ] }

Getting just deaths:

GET /deaths
{ "latest": 18625, "locations": [ ... ] }

Getting just recovered:

GET /recovered
{ "latest": 35000, "locations": [ ... ] }

Getting just latest data:

GET /latest
{ "confirmed": 418678, "deaths": 18625, "recovered": 35000}

Getting update UTC datetime:

GET /updatedAt
"2020-03-27 12:00:12.067975"

Data

The data comes from the 2019 Novel Coronavirus (nCoV) Data Repository, provided by JHU CCSE. It is programmatically retrieved, re-formatted and stored in the server for every 10 minutes.

Prerequisites

You will need the following things properly installed on your computer.

Installation

  • git clone https://github.com/Omaroid/Covid-19-API
  • cd Covid-19-API
  • pip install -r requirements.txt

Running / Development

Deploying

  • Create a Heroku account
  • Create a Heroku application
  • heroku login
  • git init
  • heroku git:remote -a <AppName>
  • git add .
  • git commit -am "first commit"
  • git push heroku master

Testing

  • Visit your application webpage
  • https://<AppName>.herokuapp.com/

License

The data is available to the public strictly for educational and academic research purposes.