Skip to content

Commit 80d036b

Browse files
authored
Merge pull request #4 from bemolxd/master
Spell check, minor
2 parents d702c15 + 1b84a9a commit 80d036b

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# COVID-19 API
2-
Ultra simple REST API for apps which neeeds COVID-19. Code is in very early stage, so feel free to open issues or create pull requests. Available here: `https://covid-19-data.herokuapp.com/`
2+
Ultra simple REST API for apps which neeeds COVID-19. Code is in very early stage, so feel free to open issues or create pull requests. Available here: `https://covid-19-data.herokuapp.com/`
33

44
## Country codes
55

@@ -14,15 +14,15 @@ API uses [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)
1414

1515
### Version 1.1.0 changes
1616

17-
Before update Diamond Princess and Channel Islands was identified as DP and CI. Update 1.1.0 uses Alpha-3 user-assigned codes, as pointed in Issue #1. However, due to compability reasons, DP and CI code will work correctly, so there is no need to change code based on this API.
17+
Before update Diamond Princess and Channel Islands was identified as DP and CI. Update 1.1.0 uses Alpha-3 user-assigned codes, as pointed in Issue #1. However, due to compatibility reasons, DP and CI code will work correctly, so there is no need to change code based on this API.
1818

1919
## Endpoints
2020

2121
All paths starts with `/api` .
2222

2323
### Cases
2424

25-
#### `/api/cases/global`
25+
#### `/api/cases/global`
2626
Returns full information about all countries. Data should be sorted, but it's not guaranteed. If there is no informations about country stats, key for country doesnt exist. All countries accessible using [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)
2727

2828
Example response:
@@ -37,7 +37,7 @@ Example response:
3737
"deaths": 1,
3838
"recovered": 0,
3939
"mortalityRate": 0.0147,
40-
"revoveryRate": 0
40+
"recoveryRate": 0
4141
},
4242
"name": "Poland"
4343
},
@@ -48,7 +48,7 @@ Example response:
4848
"deaths": 5,
4949
"recovered": 2,
5050
"mortalityRate": 0.0781,
51-
"revoveryRate": 0.0313
51+
"recoveryRate": 0.0313
5252
},
5353
"name": "Philippines"
5454
}
@@ -58,7 +58,7 @@ Example response:
5858
}
5959
```
6060

61-
#### `/api/cases/total`
61+
#### `/api/cases/total`
6262

6363
Returns summary informations.
6464

@@ -73,15 +73,15 @@ Example response:
7373
"deaths": 5391,
7474
"recovered": 70914,
7575
"mortalityRate": 0.0375,
76-
"revoveryRate": 0.493
76+
"recoveryRate": 0.493
7777
},
7878
"name": "Globally"
7979
},
8080
"provider": "TheBaseLab"
8181
}
8282
```
8383

84-
#### `/api/cases/:code`
84+
#### `/api/cases/:code`
8585

8686
Returns informations about disease spread in selected coutry. Code is [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) string. For non-existent records (country codes not stores) `404` is returned
8787

@@ -96,7 +96,7 @@ Example response:
9696
"deaths": 1,
9797
"recovered": 0,
9898
"mortalityRate": 0.0147,
99-
"revoveryRate": 0
99+
"recoveryRate": 0
100100
},
101101
"name": "Poland"
102102
},
@@ -111,4 +111,3 @@ You can create your own instance on any hosting provider. If you want to run thi
111111
## Special thanks
112112

113113
Special thanks to [ThaBaseLab](https://coronavirus.thebaselab.com/) for allowing data usage.❤️
114-

0 commit comments

Comments
 (0)