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

Latest commit

History

History
153 lines (116 loc) 路 2.87 KB

README-US.md

File metadata and controls

153 lines (116 loc) 路 2.87 KB

COVID-19 Brazil API

Notification of cases of disease by the coronavirus 2019 (COVID-19) in Brazil and worldwide.


Screenshot1

Reason 馃

Provide a json API with updated data on advancement of coronavirus Brazil. Just like in other countries.

Datasets 馃捊

Showcase 馃幆

Development server 馃殌

Clone the project:

git clone https://github.com/devarthurribeiro/covid19-brazil-api.git

Go into the project root folder:

cd covid19-brazil-api/api

Install the projects dependencies:

yarn

Run project

yarn dev

Open http://localhost:3000 in your browser.

Docs 馃搫

Endpoints 馃攲

Base URL:

https://covid19-brazil-api.now.sh

Cases by Brazilian states

// GET /api/report/v1

{
"data": [
    {
      "uid": 35,
      "datetime": "2020-03-18T20:00:00.000Z",
      "uf": "SP",
      "state": "S茫o Paulo",
      "cases": 164,
      "deaths": 1,
      "suspects": 5047,
      "refuses": 709,
    }
    //...
   ]
}

Cases from all countries

// GET /api/report/v1/countries

{
"data": [
    {
      "country": "Brazil",
      "cases": 523,
      "confirmed": 529,
      "deaths": 4,
      "recovered": 2,
      "updated_at": "2020-03-19T02:53:32.000Z"
    }
    //...
   ]
}

Cases by country

// GET /api/report/v1/:country

// resultado para /api/report/v1/brazil
{
  "data": {
    "country": "Brazil",
    "cases": 523,
    "confirmed": 529,
    "deaths": 4,
    "recovered": 2,
    "updated_at": "2020-03-19T02:53:32.000Z"
  }
}

API status

// GET /api/status/v1

{
  "status": "ok",
  "date": "2020-03-18T12:37:59.227Z",
  "environment": "production",
  "aws": {
    "region": "us-west-1",
    "function_version": "$LATEST"
  }
}

License 馃搫

This project is licensed under the MIT License - see the LICENSE file for details.

Author


Arthur Ribeiro

馃捇 馃帹