Skip to content

Commit e8cd213

Browse files
committed
Started adding documentation for NYT source
1 parent 8751f7e commit e8cd213

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ Currently 2 different data-sources are available to retrieve the data:
3636

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

39+
* **nyt** - https://github.com/nytimes/covid-19-data - The New York Times is releasing a series of data files with cumulative counts of coronavirus cases in the United States, at the state and county level, over time.
40+
3941
__jhu__ data-source will be used as a default source if you don't specify a *source parameter* in your request.
4042

4143
## API Reference
@@ -71,7 +73,8 @@ __Sample response__
7173
{
7274
"sources": [
7375
"jhu",
74-
"csbs"
76+
"csbs",
77+
"nyt"
7578
]
7679
}
7780
```
@@ -87,7 +90,7 @@ GET /v2/latest
8790
__Query String Parameters__
8891
| __Query string parameter__ | __Description__ | __Type__ |
8992
| -------------------------- | -------------------------------------------------------------------------------- | -------- |
90-
| source | The data-source where data will be retrieved from *(jhu/csbs)*. Default is *jhu* | String |
93+
| source | The data-source where data will be retrieved from *(jhu/csbs/nyt)*. Default is *jhu* | String |
9194

9295
__Sample response__
9396
```json
@@ -117,7 +120,7 @@ __Path Parameters__
117120
__Query String Parameters__
118121
| __Query string parameter__ | __Description__ | __Type__ |
119122
| -------------------------- | -------------------------------------------------------------------------------- | -------- |
120-
| source | The data-source where data will be retrieved from *(jhu/csbs)*. Default is *jhu* | String |
123+
| source | The data-source where data will be retrieved from *(jhu/csbs/nyt)*. Default is *jhu* | String |
121124

122125
#### Example Request
123126
```http
@@ -160,7 +163,7 @@ GET /v2/locations
160163
__Query String Parameters__
161164
| __Query string parameter__ | __Description__ | __Type__ |
162165
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------- |
163-
| source | The data-source where data will be retrieved from.<br>__Value__ can be: *jhu/csbs*. __Default__ is *jhu* | String |
166+
| source | The data-source where data will be retrieved from.<br>__Value__ can be: *jhu/csbs/nyt*. __Default__ is *jhu* | String |
164167
| 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 |
165168
| timelines | To set the visibility of timelines (*daily tracking*).<br>__Value__ can be: *0/1*. __Default__ is *0* (timelines are not visible) | Integer |
166169

0 commit comments

Comments
 (0)