UK Data AtlasAPI

Compare location memberships

See which member codes a named location kept, gained or lost between two dates.

get
/locations/{location-id}/comparison

Good to know

  • The comparison covers the location's direct members only; it does not convert them through a crosswalk.

Path parameters

  • location-idstringrequired

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

Query parameters

  • fromstringrequired
  • tostringrequired

Returns

object

Retained, added and removed direct member codes.

When it goes wrong

  • 400A query parameter is malformed or its cursor is not valid for this result set.
  • 404No resource matches that identity.

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