Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/simperfy/covid-19-api-philippines-doh

💊 Unofficial Covid-19 Web API for Philippines from data collected by DOH using Node.js that updates itself as soon as DOH released new Data.
https://github.com/simperfy/covid-19-api-philippines-doh

covid covid-19 covid-19-api covid-api covid19-philippines doh-data-drop mongodb nodejs philippines

Last synced: 19 days ago
JSON representation

💊 Unofficial Covid-19 Web API for Philippines from data collected by DOH using Node.js that updates itself as soon as DOH released new Data.

Host: GitHub
URL: https://github.com/simperfy/covid-19-api-philippines-doh
Owner: Simperfy
License: mit
Created: 2020-07-16T11:27:01.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2021-04-08T14:47:12.000Z (over 3 years ago)
Last Synced: 2024-10-11T15:15:55.261Z (about 1 month ago)
Topics: covid, covid-19, covid-19-api, covid-api, covid19-philippines, doh-data-drop, mongodb, nodejs, philippines
Language: TypeScript
Homepage: https://covid19-api-philippines.herokuapp.com
Size: 1.74 MB
Stars: 31
Watchers: 3
Forks: 4
Open Issues: 3
Metadata Files:
- Readme: readme.md
- License: LICENSE

Awesome Lists containing this project

README

# Covid-19-API-Philippines-DOH (Beta)

![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/Simperfy/Covid-19-API-Philippines-DOH?style=plastic)
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/Simperfy/Covid-19-API-Philippines-DOH/Node.js%20CI?style=plastic)
![License](https://img.shields.io/github/license/simperfy/Covid-19-API-Philippines-DOH?style=plastic&logo=github)
![Last Commit](https://img.shields.io/github/last-commit/simperfy/Covid-19-API-Philippines-DOH?style=plastic&logo=github)
![Stars](https://img.shields.io/github/stars/simperfy/Covid-19-API-Philippines-DOH?style=plastic&logo=github)
![Forks](https://img.shields.io/github/forks/Simperfy/Covid-19-API-Philippines-DOH?style=plastic&logo=github)
![Tweet](https://img.shields.io/twitter/url?url=https%3A%2F%2Fgithub.com%2FSimperfy%2FCovid-19-API-Philippines-DOH)

#### Covid-19 Web API for Philippines from data collected by DOH using Node.js that automatically updates itself.
> A Web API doesn't use web scraping to fetch data from DOH website instead it collects the data from the csv file from DOH Google Drive.
> This means that even if DOH website changes this API will be able to maintain itself.

---

## 📌 Endpoints
Base URL

(MAIN): https://covid19-api-philippines.herokuapp.com/

(Optional) https://covid19-ph-api.herokuapp.com/ 🆕

[Documentation in POSTMAN are available here](https://documenter.getpostman.com/view/12463261/T1LV9jLU?version=latest)

**Get list of all possible values for the specified field 🆕**

*datasets: `case_information`, `facilities_information`*

*(DEFAULT: `case_information`)*
```http
GET api/list-of/:field
GET api/list-of/:field?dataset=case_information

eg:
GET api/list-of/regions
GET api/list-of/age_groups
```

## Case Information

View Endpoints

**Fetching summary**
```http
GET api/summary
GET api/summary?region={region}
```

Example Response

```JSON
{
"data": {
"total": 89374,
"recoveries": 65064,
"deaths": 1983,
"active_cases": 22327,
"fatality_rate": "2.22",
"recovery_rate": "72.80"
}
}
```

**Fetching Top Regions**
```http
GET api/top-regions
```

Example Response

```JSON
{
"data": [
{
"region": "ncr",
"cases": 115906,
"recovered": 75658,
"deaths": 1553
},
{
"region": "region iv-a: calabarzon",
"cases": 30489,
"recovered": 17281,
"deaths": 282
},
{...},
{
"region": "caraga",
"cases": 490,
"recovered": 298,
"deaths": 4
}
]
}
```

**Fetching No. of Cases Timeline**
```http
GET api/timeline
GET api/timeline?region={region_name}
```

Example Response

```JSON
{
"data": [
{
"cases": 43,
"recovered": 38,
"died": 4,
"date": "2020-03-01"
},
{
"cases": 18,
"recovered": 14,
"died": 4,
"date": "2020-03-02"
},
{...},
{
"cases": 2109,
"recovered": 1992,
"died": 12,
"date": "2020-07-17"
},
]
}
```

---

**Fetching raw data** (Ordered by case_code)
*`limit` cannot exceed `10000`*
```http
GET api/get?page=1&limit=10000
```

**Fetching raw data by month**
```http
GET api/get?month=03
```

**Fetching raw data by specific date**
```http
GET api/get?month=03&date=01
```

**Fetching raw data with filters**

```http
GET api/get?region_res=ncr&age_group=20-24
```

Example Response

```JSON
{
"data": [
{
"case_code": "C100018",
"age": 53,
"age_group": "50-54",
"sex": "female",
"date_specimen": "2020-04-30",
"date_result_release": "2020-05-09",
"date_rep_conf": "2020-05-11",
"date_died": "",
"date_recover": "",
"removal_type": "recovered",
"admitted": "no",
"region_res": "Region IV-A: CALABARZON",
"prov_res": "laguna",
"city_mun_res": "city of san pedro",
"city_muni_psgc": "PH043425000",
"health_status": "recovered",
"quarantined": "no",
"date_onset": "",
"pregnant_tab": "no"
},
{...}
],
"pagination": {
"next_page": 2,
"limit": 10000,
"max_page": 10
},
"result_count": 10000
}
```

## Facilities Information ^🆕

View Endpoints

**Fetching facilities summary**
```http
GET api/facilities/summary
```

Example Response

```JSON
{
"data": {
"total_facilities": 1912,
"occupancy_rate": 0.49,
"beds": {
"total_vacant": 9945,
"total_occupied": 9730,
"covid": {
"icu_v": 774,
"icu_o": 831,
"isolbed_v": 6638,
"isolbed_o": 6240,
"beds_ward_v": 2533,
"beds_ward_o": 2659
},
"non_covid": {
"icu_v_nc": 3345,
"icu_o_nc": 2938,
"nonicu_v_nc": 41335,
"nonicu_o_nc": 42019
}
},
"equipments": {
"mechvent_v": 1537,
"mechvent_o": 607,
"mechvent_v_nc": 2399,
"mechvent_o_nc": 2399
}
}
}
```

**Fetching list of facilities**
```http
GET api/list-of/hospitals?dataset=facilities_information
```

Example Response

```JSON
{
"data": [
{
"name": "a. de la cruz maternity hospital"
},
{
"name": "a. zarate general hospital"
},
{...},
{
"name": "zone medical and intervention hospital, inc."
}
]
}
```

**Fetching raw facility/hospital records**

```http
GET api/facilities
GET api/facilities?region={region name}
GET api/facilities?hospital_name={hospital name}
```

Example Response

```JSON
{
"data": [
{
"hfhudcode": "DOH000000000000410",
"cf_name": "asian hospital inc.",
"updated_date": "2020-08-13T16:05:30.000Z",
"added_date": "2020-08-13T16:05:30.000Z",
"report_date": "2020-08-13T00:00:00.000Z",
"icu_v": 0,
"icu_o": 16,
"isolbed_v": 0,
"isolbed_o": 69,
"beds_ward_v": 0,
"beds_ward_o": 0,
"mechvent_v": 18,
"mechvent_o": 28,
"icu_v_nc": 10,
"icu_o_nc": 14,
"nonicu_v_nc": 72,
"nonicu_o_nc": 55,
"mechvent_v_nc": 18,
"mechvent_o_nc": 28,
"q_nurse": 37,
"q_doctor": 7,
"q_other": 68,
"nurse_adm": 0,
"doctor_adm": 1,
"other_adm": 2,
"susp_asym": 0,
"susp_mild": 18,
"susp_severe": 1,
"susp_crit": 1,
"susp_died": 0,
"prob_asym": 0,
"prob_mild": 1,
"prob_severe": 0,
"prob_crit": 0,
"prob_died": 0,
"conf_asym": 0,
"conf_mild": 50,
"conf_severe": 0,
"conf_crit": 15,
"conf_died": 1,
"t_patient_adm": 2,
"t_patient_er": 2,
"t_patient_icu": 2,
"trans_ttmf": 2,
"discharged": 2,
"region": "national capital region (ncr)",
"region_psgc": "PH130000000",
"province": "ncr, fourth district (not a province)",
"province_psgc": "PH137600000",
"city_mun": "city of muntinlupa",
"city_mun_psgc": "PH137603000",
"north_coord": "0.0",
"east_coord": "0.0"
},
{...}
]
}
```

---

## Field and Values Reference

| Field
|--------------
| case_code
| age
| age_group
| sex
| date_specimen
| date_result_release
| date_rep_conf
| date_died
| date_recover
| removal_type
| admitted
| region_res/region
| prov_res
| city_mun_res
| city_muni_psgc
| health_status
| quarantined
| date_onset
| pregnant_tab

| Type | Values | Can be empty? | -------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| | String(7) | UNIQUE ID String with length of 7 | NO | | Integer(3) | 1 - 3 digits | NO | | String | 0-4, 5-9, 10-14, 15-19, 20-24, 25-29, 30-34, 35-39, 40-44, 45-49, 50-54, 55-59, 60-64, 65-69, 70-74, 75-79, 80+ | YES | | String | male, female | NO | | Date(YYYY-MM-DD) | Date(YYYY-MM-DD) | YES | | Date(YYYY-MM-DD) | Date(YYYY-MM-DD) | YES | | Date(YYYY-MM-DD) | Date(YYYY-MM-DD) | NO | | Date(YYYY-MM-DD) | Date(YYYY-MM-DD) | YES | | Date(YYYY-MM-DD) | Date(YYYY-MM-DD) | YES | | String | recovered, died | YES | | String | yes, no | YES | | String | BARMM, CAR, CARAGA, NCR, Region I: Ilocos Region, Region II: Cagayan Valley, Region III: Central Luzon, Region IV-A: CALABARZON, Region IV-B: MIMAROPA, Region IX: Zamboanga Peninsula, Region V: Bicol Region, Region VI: Western Visayas, Region VII: Central Visayas, Region VIII: Eastern Visayas, Region X: Northern Mindanao, Region XI: Davao Region, Region XII: SOCCSKSARGEN, REPATRIATE | YES | | String | abra, agusan del norte, agusan del sur, aklan, albay, antique, apayao, aurora, basilan, bataan, batangas, benguet, biliran, bohol, bukidnon, bulacan, cagayan, camarines norte, camarines sur, camiguin, capiz, catanduanes, cavite, cebu, city of isabela (not a province), cotabato (north cotabato) cotabato city (not a province), davao de oro, davao del norte, davao del sur, davao occidental, davao oriental, eastern samar, guimaras, ifugao, ilocos norte, ilocos sur, iloilo, isabela, kalinga, la union, laguna, lanao del norte, lanao del sur, leyte, maguindanao, marinduque, masbate, misamis occidental, misamis oriental, mountain province, ncr, negros occidental, negros oriental, northern samar, nueva ecija, nueva vizcaya, occidental mindoro, oriental mindoro, palawan, pampanga, pangasinan, quezon, rizal, romblon, samar (western samar), sarangani, siquijor, sorsogon, south cotabato, southern leyte, sultan kudarat, sulu, surigao del norte, surigao del sur, tarlac, tawi-tawi, zambales, zamboanga del norte, zamboanga del sur, zamboanga sibugay, | YES | | String | https://pastebin.com/EmP2MQDH | YES | | String | Unique ID (eg: PH012802000) | YES | | String | asymptomatic, critical, died, mild, recovered, severe | NO | | String | yes, no | YES | | Date(YYYY-MM-DD) | Date(YYYY-MM-DD) | YES | | String | yes, no | YES |

---

## 🔨 Installation

### Prerequisites
* [configured service account](https://developers.google.com/identity/protocols/oauth2/service-account)
* [Node.js](https://nodejs.org/en/)
* [MongoDB](https://www.mongodb.com/)

### Steps

1. run the command:

```
$ npm install
```

2. Create a [Service Account](https://developers.google.com/identity/protocols/oauth2/service-account) and download the key.

3. copy .env.example to .env and paste the service key and database credentials respectively

4. Run the project in development:

```
$ npm run dev
```

5. Done

NOTE: You use `/api/updatedatabase` to manually update database (in development mode)

API documentation:

[Documentation in POSTMAN are available here](https://documenter.getpostman.com/view/12463261/T1LV9jLU?version=latest)

---

## 📄 About the Data
### Where does the data come from?

* The data comes from [DOH DATA DROP](http://bit.ly/DataDropPH) and [DOH DATA DROP Archives](https://drive.google.com/drive/folders/1UelgRGmUGNMKH1Q3nzqTj57V41bjmnxg)
* The data wasn't tampered and was directly converted to json from csv without heavy modification.

## 🔧 Built With
* [Node.js](https://nodejs.org) - open source server environment.
* [ExpressJS](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
* [Google Drive API v3](https://developers.google.com/drive/api/v3/about-sdk) - Used to download files from DOH
* [Amazon Web Services](https://aws.amazon.com/) - Provides MySQL in Deployment

## Authors

* 🐶 **Simperfy** - [Github](https://github.com/Simperfy)

## Acknowledgments

* 💗 [DOH - Philippines](https://www.doh.gov.ph/) - Data Source

## Donate

- ETH: 0x38f0278bB385ce5cce627C8E8085AbA774761169