ukhsa-internal / coronavirus-dashboard-api-v2-server

Coronavirus Dashboard API v.2.1

Coronavirus Dashboard API v.2.1

Source code for the Coronavirus API - version 2.1

This version introduces the batch downloads API that powers the Downloads page.

Other repositories

Different parts of the Coronavirus dashboard service are maintained in their respective repositories, itemised as follows:

• API v.1 - Main API service for the data, lookup tables, CMS, and metadata.
• API v.2.0 - Batch downloads service [DEPRECATED in favour of v2.1]
• Generic APIs - APIs that power the map, navigation, hierarchy, and relations
• Frontend Server - Home and postcode pages
• Coronavirus Dashboard - Details pages
• Easy-Read Server - Easy-read pages and PDF generator
• Layout CMS - Definition of contents
• Metadata - Description of metrics and textual contents
• ETL Service - Post-pipeline data processing and deployment
• Terraform - Infrastructure as Code [DEPRECATED in favour of ARM templates]

Development and contribution

We welcome contributions by everyone. Please read the contributions guide for additional information.

How can I help?

We have a public project management board that shows outstanding issues to which everyone can contribute. Pick a ticket, assign it to yourself and move it to the Doing column, and you will be all set to start. There is also the outstanding issues from which you can choose, but let us know that you are working on it so that multiple people don't end. up doing the same task.

No contribution is too small. We welcome help from everyone. Get in touch if you need additional information. We are here to help.

Credits

This service is developed and maintained by Public Health England.

coronavirus-dashboard-api-v2-server's Issues

reports of duplicated rows for downloads by MSOA

e.g. https://api.coronavirus.data.gov.uk/v2/data?areaType=msoa&areaCode=E06000052&metric=newCasesBySpecimenDateRollingSum&metric=newCasesBySpecimenDateRollingRate&format=csv

Downloads of MSOA cases data are returning empty files

API v2 returns no data from calls that are at MSOA level and include any of the cases metrics.
For example: https://api.coronavirus.data.gov.uk/v2/data?areaType=msoa&metric=newCasesBySpecimenDateRollingSum&metric=newCasesBySpecimenDateRollingRate&metric=newCasesBySpecimenDateChange&metric=newCasesBySpecimenDateChangePercentage&metric=newCasesBySpecimenDateDirection&format=csv

Queries from archives not returning data

There is a problem getting data from the archive that seems to be specific to 2021-02-24 and 2021-02-25.

This query returns a blank file:
https://api.coronavirus.data.gov.uk/v2/data?areaType=overview&metric=newDeaths28DaysByDeathDate&format=csv&release=2021-02-24

This query returns a 500 error:
https://api.coronavirus.data.gov.uk/v2/data?areaType=overview&metric=newDeaths28DaysByDeathDate&format=csv&release=2021-02-25

API not connecting

I'm trying to use the API through the link https://api.coronavirus.data.gov.uk/v2/data?areaType=ltla&metric=newCasesBySpecimenDateAgeDemographics&format=csv but get the error "Precondition failed: Missing or malformed URL parameter."

I've noticed on the website that the documentation for "Bulk downloads API (APIv2)" is down too, see screenshot below.

male / female case nested metrics

Highlighted via email:

Hello,

I’m wondering if you can help me?

We currently access the below site for some files:

https://coronavirus.data.gov.uk/details/download

When trying to extract the files using the below request link, we get an error, but for accessing all of the other files we need it seems to work fine.

https://api.coronavirus.data.gov.uk/v2/data?areaType=region&metric=maleCases&metric=femaleCases&format=csv

Please could you let us know if anything has changed, or if this is an issue that will be resolved?

Areas that are present at UTLA and LTLA not having data download available in both

Issue

For areas that are both UTLA and LTLA, the data download is empty for either LTLA or UTLA data

Examples

e.g. Stoke on Trent has no data in the UTLA download, but does have data for LTLA

Response needed

Discussed with Pouria who is amending the script to fix this issue

Feature Request: Return Last-Modified header with HTTP responses.

Hi there. I work in the Contain Data Platform Team over in NHS Digital, and we consume PHE's data for a few of our public-facing dashboards.

We've got some special cases in our pipeline code which use the COVID-19 Python SDK to get the update timestamps from the V1 API, but we've been a bit concerned about using the timestamp from one version of the API to decide whether to fetch a file from another version. It would be great if we were able to do a HEAD request on the API to see if the files have been updated, but the Last-Modified header is missing from the response.

Is this something that you'd be able to add? Alternatively, if the team are busy working on other improvements, would a pull request to add this functionality be welcome?

MSOA downloads not including City of London MSOA

MSOA E02000001 (City of London) is appearing in the cases map, but not in the downloads.

No data received from NHS Trust downloads

No data is returned from the following:

https://api.coronavirus.data.gov.uk/v2/data?areaType=nhsTrust&metric=newAdmissions&format=csv
https://api.coronavirus.data.gov.uk/v2/data?areaType=nhsTrust&metric=hospitalCases&format=csv

An LTLA API V2 download fails to return a file

Go to the Download page and download new cases by specimen date for LTLA Bolton, generating URL:

https://api.coronavirus.data.gov.uk/v2/data?areaType=ltla&areaCode=E08000001&metric=newCasesBySpecimenDate&format=csv

This returns an empty file.

An LTLA download from the API fails to return a file

Go to the Download page and download new cases by specimen date for LTLA Bolton, generating the URL:

https://api.coronavirus.data.gov.uk/v2/data?areaType=ltla&areaCode=E08000001&metric=newCasesBySpecimenDate&format=csv

This returns an empty file.

Encoding with `+` char not accepted

Space encoded as + character - e.g. areaName=Northern+Ireland are not accepted as valid parameters.

Some information requests yield 500 errors

Hi!

I was trying to get cumulative data for admissions by age, in England, with cumulative cases by specimen date.
This produces a 500 error.

Link:
https://coronavirus.data.gov.uk/api/v2/data?areaType=nation&areaCode=E92000001&metric=cumAdmissionsByAge&metric=cumCasesBySpecimenDate&format=csv

If I'm attempting to do something which is invalid, please add functionality to indicate so on the page. Otherwise, please fix (:
If I'm doing something that should be valid but somehow isn't, please implement some sort of error handling for that sort of eventuality.
Finally, if you just happen to encounter an error, please have some sort of error page, perhaps linking here to make an issue with what was done.

Thanks,
Ted

areaCode and areaName are switched in newCasesBySpecimenDateAgeDemographics JSON output

https://api.coronavirus.data.gov.uk/v2/data?areaType=nation&metric=newCasesBySpecimenDateAgeDemographics&format=json

areaCode should be E92000001 and areaType should be nation but they are being returned the opposite way round.

Incomplete data being returned

Hi,

Calling the api for some metrics is not returning a complete data set, this is the case for both json and csv. It is cut off mid way through, not missing days.

An example of one of the endpoints:

https://api.coronavirus.data.gov.uk/v2/data?areaType=ltla&format=json&metric=newCasesBySpecimenDateAgeDemographics

piping this into jq will give a validation error.