UK Data AtlasAPI

List areas

Page through areas, optionally narrowed to one geography and boundary release.

get
/areas

Good to know

  • To find an area by name, code or postcode, use Find a place instead.

Query parameters

  • geographystringoptional

    Restrict results to one geography type.

  • releasestringoptional

    Restrict results to one boundary release.

  • limitinteger 1–500optional

    How many records to return, 1 to 500.

    Default100
  • cursorstringoptional

    Opaque cursor from the previous response's nextCursor.

Returns

AreaListEnvelope

A cursor-paginated page of matching area identities.

  • apiVersionv1required
  • atlasReleasestringrequired

    The immutable /atlas-release releaseId for the artifacts that produced this response.

  • metaobjectrequired
    Show1 child field
    • nextCursorstring | nullrequired

      Opaque cursor for the next page, or null at the end.

  • dataArea[]required
    Show6 child fields
    • idstringrequired
    • geographystringrequired
    • boundaryReleasestringrequired
    • codestringrequired
    • namestringrequired
    • aliasesstring[]optional

When it goes wrong

  • 400A query parameter is malformed or its cursor is not valid for this result set.
  • 503The referenced build artifact has not been built yet.

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

Technical notes

Show the precise behaviour

Lists compiled area identities, optionally within one geography or boundary release (or latest for the newest unambiguous release), in a stable order with cursor pagination. To find an area by name, code or postcode, use /places?q=.