v20

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

Code

Given an area type / area code combination, produces the names, codes, and centroids for the ancestors of the area - i.e. larger, more general areas of which the requested area is a member.

get/code/{area_type}/{area_code}

Path parameters

area_type'nation' | 'region' | 'utla' | 'ltla' | 'msoa' | 'postcode' | 'nhsRegion' | 'nhsTrust' required

Type of the area whose ancestors are being requested.

area_codestring required

Code of the area whose ancestors are being requested.

Headers

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

Response

Returns ancestors of the area code.

ltlastring
ltlaCentroidnumber[]
ltlaNamestring
msoastring
msoaCentroidnumber[]
msoaNamestring
nationstring
nationCentroidnumber[]
nationNamestring
postcodestring
regionstring
regionCentroidnumber[]
regionNamestring
trimmedPostcodestring
utlastring
utlaCentroidnumber[]
utlaNamestring