|
简体中文 | English | Advanced Documentation | API Generator |
|
This is a free COVID-19/2019-nCoV Realtime Infection Data API. Data source is Ding Xiang Yuan, it is free to everyone who need it.
| GitHub Project | https://github.com/BlankerL/DXY-COVID-19-Crawler |
|
|
| Data Warehouse | https://github.com/BlankerL/DXY-COVID-19-Data |
|
|
For Researchers and API users
1. This project is for free and non-commercial usage, I will not be responsible for any copyright dispute;
2. The data is from Ding Xiang Yuan, I personally do not own the data. If you would like to use this data to do scientific research, please contact Ding Xiang Yuan to get authorized;
3. If you are not familiar with API usage and only want to use this data for scientific research, you can move Data Warehouse to download the CSV files;
4. Any changes to this project will be announced on GitHub. If you can not find satisfying answers, please open an issue on GitHub first;
5. If you have any difficulty, please contact me, you can find my information on My GitHub Homepage;
6. The first document of Area API have systematic error, but errors of later ones will be within 1 minutes;
7. Begining at 17: 15 on January 30, 2019, the number of API calls is counted. But the frequency of API called from single IP will never be recorded.
8. Some data are found as noise because Ding Xiang Yuan mis-input the data. This project just crawl and store the data, and will not deal with noise data, so please clean the data on your own. You can also move here to report potential noise data, I will check and fix them regularly.
Announcement
1. Because of the heavy traffic of the API, starting from March 19, 2020, time-series data are not available on the API anymore. You can get the time-series data directly from the Data Warehouse.
Request API: /nCoV/api/overall
Request Method: GET
Return data from 4:00 pm, January 24, 2020 to the present. The state of virus research and the national epidemic overview, you can specify the returned data as the latest published data or time series data.
| Parameter | Explanation |
|---|---|
| latest |
1: Return the latest data (by default) 0: Return the time series data (Not supported anymore, please refer to the data warehouse) |
Returned Data
| Parameter | Explanation |
|---|---|
| generalRemark | National epidemic overview |
| remarkX | Remark from 1-5 |
| note1 | Name of the virus |
| note2 | Source of infection |
| note3 | Way of spreading |
| currentConfirmedCount(Incr) |
Number of current remaining confirmed patients (increased from yesterday) The value is: confirmedCount(Incr) - curedCount(Incr) - deadCount(Incr) |
| confirmedCount(Incr) | Number of confirmed patients (increased from yesterday) |
| suspectedCount(Incr) | Number of suspected infection (increased from yesterday) |
| curedCount(Incr) | Number of cured patients (increased from yesterday) |
| deadCount(Incr) | Number of death (increased from yesterday) |
| seriousCount(Incr) | Number of critically ill (increased from yesterday) |
| updateTime | The latest updated time |
Request API: /nCoV/api/provinceName
Request Method: GET
Return the list of countries, provinces, municipalities in the database.
| Parameter | Explanation | lang |
The language of returned data. Chinese: zh (by default) English: en |
|---|
Examples
1. /nCoV/api/provinceName
Return the Chinese version of countries/province/municipalities list.
2. /nCoV/api/provinceName?lang=en
Return the English version of countries/province/municipalities list.
Request API: /nCoV/api/area
Request Method: GET
Return data from 3:00 am, January 22, 2020 to the present. The data is city-level Chinese infection information and country-level of other countries infection. You can request to get latest data or time series data.
Remark: Only province-level data are available from 3:00 am, January 22, 2020 to 3:40 am, January 24, 2020. Ding Xiang Yuan publish city-level data beginning from January 24, 2020.
| Parameter | Explanation |
|---|---|
| latest |
1: Return the latest data (by default) 0: Return the time series data (Not supported anymore, please refer to the data warehouse) |
| province |
Chinese version of province, municipalities or countries outside China. For example, 美国，湖北省，北京市，香港。 The list of province name is available on /nCoV/api/provinceName?lang=zh. |
| provinceEng |
English version of province, municipalities or countries outside China. For example, United States of America, Hubei, Beijing, Hong Kong. The list of province name is available on /nCoV/api/provinceName?lang=en. Please pay attention to the upper/lower case, it should be the same as entries in /nCoV/api/provinceName?lang=en. |
Returned Data
| Parameter | Explanation |
|---|---|
| locationId |
ID of cities In mainland China, the locationId is zip code, Outsides mainland China, the explanation of locationId is not sure |
| continent(English)Name | (English) name of the continent |
| country(English)Name | (English) name of the country |
| province(English)Name | (English) name of the province, municipalities or countries outside China. |
| provinceShortName | Short name of province, municipalities or countries outside China. |
| currentConfirmedCount |
Number of current remaining confirmed patients The value is: confirmedCount - curedCount - deadCount |
| confirmedCount | Number of confirmed patients |
| suspectedCount | Number of suspected infection |
| curedCount | Number of cured patients |
| deadCount | Number of death |
| comment | Other information |
| cities | Cities or district within a province or municipality |
| updateTime | The latest updated time |
Examples
1. /nCoV/api/area?latest=1&provinceEng=Hubei
Return the latest data in Hubei Province.
2. /nCoV/api/area?latest=0&provinceEng=Hubei
Return the time series data in Hubei Province.
3. /nCoV/api/area?latest=1
Return the latest infection data in China (city-level) and other countries (national-level).