UK Data AtlasAPI

Get TileJSON

The TileJSON 3.0 document you give a map library like MapLibre, including the attribution your map needs to display.

get
/map-resources/{geography}/{release}/tiles.json

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

TileJsonEnvelope

TileJSON 3.0 describing the tile endpoint.

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

  • dataobjectrequired

    TileJSON 3.0, with the archive's content hash added.

    Show12 child fields
    • tilejsonstringrequired
    • namestringoptional
    • descriptionstringoptional
    • attributionstringoptional
    • schemestringoptional
    • formatstringoptional
    • tilesstring[]required
    • minzoomintegerrequired
    • maxzoomintegerrequired
    • boundsnumber[]required
    • centernumber[]optional
    • vector_layersobject[]required

When it goes wrong

  • 404No resource matches that identity.
  • 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

TileJSON 3.0 for this resource, including the attribution a map must display. A tile cannot carry a licence, so a client handed only a tile URL would have nothing to show; this is the document that supplies it.