Skip to content

Api docs changes #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ExpDev07 merged 20 commits into from
Mar 23, 2020
Merged

Api docs changes #150

Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
fa34e56
Description on top of documentation added
carmelag Mar 22, 2020
990e1d0
Some changes to the intro part
carmelag Mar 22, 2020
7ed908e
Description for API Endpoints modified
carmelag Mar 22, 2020
fcd4750
Latest and location endpoints work
carmelag Mar 23, 2020
621cca4
path parameter added for location
carmelag Mar 23, 2020
055ad84
Small fix
carmelag Mar 23, 2020
98ae697
Table was fixed
carmelag Mar 23, 2020
7574abe
Minor fixes
carmelag Mar 23, 2020
a2d4a3c
Table for params fixed
carmelag Mar 23, 2020
7797aa8
Samples per parameters added
carmelag Mar 23, 2020
5ab9cdc
Making the URL a real link
carmelag Mar 23, 2020
213ef1f
code inline removed from URL
carmelag Mar 23, 2020
86f3c7c
curl command added
carmelag Mar 23, 2020
9f4ab08
some other small fixes
carmelag Mar 23, 2020
e36fe16
Table headings bold now
carmelag Mar 23, 2020
8bd9cb5
Conflics solved and sources endpoint added
carmelag Mar 23, 2020
936df66
Minor fixes applied
carmelag Mar 23, 2020
067b5d3
Multiline in table cell fixed
carmelag Mar 23, 2020
b279cce
Recovered response item replacing deaths
carmelag Mar 23, 2020
a2473c1
Multiline in table cell fixed for response definitions table
carmelag Mar 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Latest and location endpoints work
  • Loading branch information
@carmelag
carmelag committed Mar 23, 2020
commit fcd47508edaf020f6f684b90092930eb71dea68a
64 changes: 52 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Coronavirus Tracker API
Provides up-to-date data about Coronavirus outbreak. Includes numbers about confirmed cases, deaths and recovered.
Support multiple data sources.
Support multiple data-sources.

![Travis build](https://api.travis-ci.com/ExpDev07/coronavirus-tracker-api.svg?branch=master)
[![License](https://img.shields.io/github/license/ExpDev07/coronavirus-tracker-api)](LICENSE.md)
Expand All @@ -19,30 +19,33 @@ Support multiple data sources.
![Covid-19 Deaths](https://covid19-badges.herokuapp.com/deaths/latest)


## Endpoints
## API Endpoints

All endpoints are located at ``coronavirus-tracker-api.herokuapp.com/v2/`` and are accessible via https. For instance: you can get data per location by using this URL:
``https://coronavirus-tracker-api.herokuapp.com/v2/locations``

You can try to open the URL in your browser to further inspect the response.


### Picking data source
#### Available data-sources:

We provide multiple data-sources you can pick from, simply add the query parameter ``?source=your_source_of_choice`` to your requests. JHU will be used as a default if you don't provide one.
Currently 2 different data-sources are available to retrieve the data:

#### Available sources:

* **jhu** - https://github.com/CSSEGISandData/COVID-19 - Data repository operated by the Johns Hopkins University Center for Systems Science and Engineering (JHU CSSE).
* **jhu** - https://github.com/CSSEGISandData/COVID-19 - Worldwide Data repository operated by the Johns Hopkins University Center for Systems Science and Engineering (JHU CSSE).

* **csbs** - https://www.csbs.org/information-covid-19-coronavirus - U.S. County data that comes from the Conference of State Bank Supervisors.

* **... more to come later**.
__JHU__ data-source will be used as a default source if you don't specify a source parameter in your request.

### Latest Endpoint

Getting latest amount of total confirmed cases, deaths, and recoveries.

### Getting latest amount of total confirmed cases, deaths, and recoveries.
```http
GET /v2/latest
```

__Sample response__
```json
{
"latest": {
Expand All @@ -53,10 +56,20 @@ GET /v2/latest
}
```

### Getting all locations.
__Parameters__
| Query string parameter | Description | Type |
| ---------------------- | -------------------------------------------------------------------------------- | ------ |
| source | The data-source where data will be retrieved from *(jhu/csbs)*. Default is *jhu* | String |

### Locations Endpoint

Getting latest amount of total confirmed cases, deaths, and recoveries per location.

```http
GET /v2/locations
```

__Sample response__
```json
{
"latest": {
Expand Down Expand Up @@ -100,13 +113,40 @@ GET /v2/locations
]
}
```
| Query string parameter | Description | Type |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------- |
| source | The data-source where data will be retrieved from. __Value__ can be: __jhu/csbs__. |
| __Default__ is __jhu__ | String |
| country_code | The ISO ([alpha-2 country_code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)) to the Country/Province for which you're calling the Endpoint | String |
| timelines | To set the visibility of timelines (*daily tracking*).__Value__ can be: __0/1__. __Default__ is __0__ | Integer |


__Response definitions__
| Response Item | Description | Type |
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------- |
| {latest} | The total amount of confirmed cases, deaths and recoveries for all the locations | Object |
| {latest}/confirmed | The up-to-date total number of confirmed cases for all the locations within the data-source | Integer |
| {latest}/deaths | The up-to-date total amount of deaths for all the locations within the data-source | Integer |
| {latest}/recovered | The up-to-date total amount of recovered for all the locations within the data-source | Integer |
| {locations} | The collection of locations contained within the data-source | Object |
| {location} | Information that identifies a location | Object |
| {latest} | The amount of confirmed cases, deaths and recovered related to the specific location | Object |
| {locations}/{location}/{latest}/confirmed | The up-to-date number of confirmed cases related to the specific location | Integer |
| {locations}/{location}/{latest}/deaths | The up-to-date number of deaths related to the specific location | Integer |
| {locations}/{location}/{latest}/deaths | The up-to-date number of recovered related to the specific location | Integer |
| {locations}/{location}/id | The location id. This id number is assigned to the location by the data-source. | Integer |
| {locations}/{location}/country | The Country name | String |
| {locations}/{location}/country_code | The ISO ([alpha-2 country_code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)) Country code for the location. | String |
| {locations}/{location}/province | The province where the location belongs to. (Used only for __csbs data-source__ of US locations. __Empty__ with __jhu data-source__. | String |
| {locations}/{location}/{coordinates}/latitude | The location latitude | Float |
| {locations}/{location}/{coordinates}/longitude | The location longitude | Float |



Additionally, you can also filter by any attribute, including province and country ([alpha-2 country_code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
```http
GET /v2/locations?country_code=US
```

Include timelines.
```http
GET /v2/locations?timelines=1
```
Expand Down