Skip to content

Commit 9f4ab08

Browse files
committed
some other small fixes
1 parent 86f3c7c commit 9f4ab08

File tree

1 file changed

+24
-18
lines changed

1 file changed

+24
-18
lines changed

README.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,16 @@ Support multiple data-sources.
1818
![Covid-19 Recovered](https://covid19-badges.herokuapp.com/recovered/latest)
1919
![Covid-19 Deaths](https://covid19-badges.herokuapp.com/deaths/latest)
2020

21+
## Available data-sources:
22+
23+
Currently 2 different data-sources are available to retrieve the data:
24+
25+
* **jhu** - https://github.com/CSSEGISandData/COVID-19 - Worldwide Data repository operated by the Johns Hopkins University Center for Systems Science and Engineering (JHU CSSE).
26+
27+
* **csbs** - https://www.csbs.org/information-covid-19-coronavirus - U.S. County data that comes from the Conference of State Bank Supervisors.
28+
29+
__jhu__ data-source will be used as a default source if you don't specify a *source parameter* in your request.
30+
2131

2232
## API Reference
2333

@@ -31,16 +41,6 @@ curl https://coronavirus-tracker-api.herokuapp.com/v2/locations | json_pp
3141
```
3242

3343

34-
#### Available data-sources:
35-
36-
Currently 2 different data-sources are available to retrieve the data:
37-
38-
* **jhu** - https://github.com/CSSEGISandData/COVID-19 - Worldwide Data repository operated by the Johns Hopkins University Center for Systems Science and Engineering (JHU CSSE).
39-
40-
* **csbs** - https://www.csbs.org/information-covid-19-coronavirus - U.S. County data that comes from the Conference of State Bank Supervisors.
41-
42-
__jhu__ data-source will be used as a default source if you don't specify a source parameter in your request.
43-
4444
## API Endpoints
4545

4646
### Latest Endpoint
@@ -78,9 +78,9 @@ GET /v2/locations/:id
7878
```
7979

8080
__Path Parameters__
81-
| Path parameter | Required/Optional | Description | Type |
82-
| -------------- | ----------------- | ------------------------------------------------------------------ | ------- |
83-
| id | OPTIONAL | The location id for which you want to call the locations Endpoint. | Integer |
81+
| Path parameter | Required/Optional | Description | Type |
82+
| -------------- | ----------------- | ------------------------------------------------------------------------- | ------- |
83+
| id | OPTIONAL | The unique location id for which you want to call the Locations Endpoint. | Integer |
8484

8585

8686
#### Example Request
@@ -198,7 +198,7 @@ __Parameter: country_code__
198198
Getting data for the Country specified by the *country_code parameter*, in this case Italy - IT
199199

200200
```http
201-
GET https://coronavirus-tracker-api.herokuapp.com/v2/locations?country_code=IT
201+
GET /v2/locations?country_code=IT
202202
```
203203

204204
__Sample Response__
@@ -231,7 +231,7 @@ __Sample Response__
231231
```
232232

233233
__Parameter: source__
234-
Getting the data from the data-source (csbs)[https://www.csbs.org/information-covid-19-coronavirus]
234+
Getting the data from the data-source specified by the *source parameter*, in this case [csbs](https://www.csbs.org/information-covid-19-coronavirus)
235235

236236
```http
237237
GET /v2/locations?source=csbs
@@ -287,12 +287,18 @@ __Sample Response__
287287
```
288288

289289
__Parameter: timelines__
290-
Getting the data for all the locations including the daily tracking of confirmed cases, deaths and recovered
290+
Getting the data for all the locations including the daily tracking of confirmed cases, deaths and recovered per location.
291291

292292
```http
293-
GET https://coronavirus-tracker-api.herokuapp.com/v2/locations?timelines=1
293+
GET /v2/locations?timelines=1
294+
```
295+
Explore the response by opening the URL in your browser [https://coronavirus-tracker-api.herokuapp.com/v2/locations?timelines=1](https://coronavirus-tracker-api.herokuapp.com/v2/locations?timelines=1) or make the following curl call on your terminal:
296+
294297
```
295-
__NOTE:__ Timelines tracking starts from day 22nd January 2020 and ends to the last available day on the data-source.
298+
curl https://coronavirus-tracker-api.herokuapp.com/v2/locations?timelines=1 | json_pp
299+
```
300+
301+
__NOTE:__ Timelines tracking starts from day 22nd January 2020 and ends to the last available day in the data-source.
296302

297303
## Wrappers
298304

0 commit comments

Comments
 (0)