Get a named location

Get one named location's description, the area codes it's made from and its bounds.

get

https://api.ukdataatlas.com/v1/locations/{location-id}

Path parameters

location-idstringrequired
A curated named location id from GET /v1/locations, e.g. greater-manchester.

Query parameters

asOfstringoptional
Select the member codes effective on this date. Omit it to return the complete dated definition.
includestring[]optional
capabilities lists, under capabilities, the compiled releases where the location's member codes can be read directly (direct), plus each materialised crosswalk view into those members (members) and out to its parents (parents). A view is a link with the exact geography, release and crosswalk to request; the API never chooses a crosswalk silently. A partial direct view contains some, but not all, listed member codes. A not-built result identifies a deployment that has not loaded the projection inventory.
One ofcapabilities

Returns

object

The location's definition, source codes and bounds.

When it goes wrong

404No resource matches that identity.

Every error has the same shape. See Errors for how to handle them.

Request

curl "https://api.ukdataatlas.com/v1/locations/london"

Response200

{
  "apiVersion": "v1",
  "atlasRelease": "sha256:5c4aa4529cbfbd5e4c844c55cddba1ef04a7bf76f3eaa085a357fff401af6d0c",
  "data": {
    "id": "london",
    "label": "London",
    "kind": "region",
    "source": {
      "publisher": "Office for National Statistics",
      "lookup": "local-authority-to-region/2025-04-en",
      "code": "E12000007"
    },
    "definitionRevision": 2,
    "memberGeography": "localAuthority",
    "memberCodes": [
      "E09000001"
    ],
    "validity": {
      "from": null,
      "to": null
    },
    "bbox": [
      -0.5
    ]
  },
  "meta": {
    "nextCursor": null
  }
}