UK Data AtlasAPI

List map resources

List the boundary releases that are ready to draw as vector tiles. Releases are tiled deliberately, not automatically, so this list is short.

get
/map-resources

Returns

MapResourceListEnvelope

One entry per published map resource.

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

  • dataMapResourceSummary[]required
    Show5 child fields
    • idstringrequired

      The boundary release identity, {geography}/{release}.

    • geographystringrequired
    • boundaryReleasestringrequired
    • titlestringrequired
    • hrefstringrequired

When it goes wrong

  • 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

A map resource is one boundary release prepared for drawing: tiles whose borders are compiled once and shared, so neighbours cannot be drawn two different ways. Releases are published deliberately rather than every release being tiled, so this list is short.