v20

latestOpenAPI 3.0.1Open Government Licence v3.0.raw.githubusercontent.com2021-12-142314272.1 KB

SOA

Given an area type / area code combination, produces the latest available record for a Super Output Area (SOA).

get/soa/{area_type}/{area_code}/{metric}

Path parameters

area_type'nation' | 'region' | 'utla' | 'ltla' | 'msoa' | 'nhsRegion' | 'nhsTrust' required
Example:msoa

Type of the area for which the latest data is requested.

area_codestring required
Example:E02004402

Code of the area for which the latest data is requested.

metricstring required
Example:newCasesBySpecimenDate

Name of the metric for which the latest data is requested. Consult the 'Download Data' section of the site for available metrics.

Query parameters

datestring

Record date. If not defined, the latest available record will be returned.

Headers

Accept'application/json' required
Accept-Encoding'deflate' | 'gzip' | 'br'

Response

Returns the latest available record for the given Super Output Area (SOA).

areaCodestring
areaNamestring
areaTypestring
datestring
metricstring
payloadobject

Example response

{
  "areaCode": "string",
  "areaName": "string",
  "areaType": "string",
  "date": "string",
  "metric": "string",
  "payload": {}
}