UK Data AtlasAPI

Get a boundary release

Get the details of one boundary release: who published it, under what licence, and which countries it covers.

get
/boundary-releases/{geography}/{release}

Path parameters

  • geographystringrequired

    A geography type id, e.g. constituency or ward.

  • releasestringrequired

    A boundary release id, e.g. 2024-07-uk-bgc, or latest for the geography's newest release: the one /boundary-releases:resolve chooses for the furthest date. A response to latest names the release it read in Content-Location. A geography whose newest month holds several releases that differ in more than coverage, or that has a release whose id carries no month, is refused with 409 and the releases that could be newest.

Returns

BoundaryReleaseEnvelope

The matching boundary release.

  • 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.

  • dataBoundaryReleaserequired
    Show9 child fields
    • idstringrequired
    • geographystringrequired
    • titlestringrequired
    • descriptionstringoptional
    • temporalCoveragestringoptional
    • coverageobjectrequired
      Show1 child field
      • countriesstring[]required
    • sourceobjectrequired
      Show4 child fields
      • publisherstringrequired
      • urlstringrequired
      • retrievedAtstringoptional
      • licenceobjectrequired
        Show2 child fields
        • namestringrequired
        • urlstringoptional
    • metadataHashstringrequired
    • downloadsBoundaryReleaseDownloadsrequired

      Where to get the whole release: its vector tiles, and every generalisation tier as GeoJSON and as GeoParquet. A release whose areas are not a coverage, because some edge lies on more than two of them, cannot be tiled or generalised with shared borders: it is untiled, with the reason, and downloadable whole at full detail only. A release with no readable geometry is unavailable. Either stays available area by area.

When it goes wrong

  • 404No resource matches that identity.

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