Discover terrain products

See which terrain product families exist and whether a versioned source is currently available.

get

https://api.ukdataatlas.com/v1/terrain

Returns

Envelope

Versioned terrain product definitions and their required metadata.

apiVersionv1required
atlasReleasestringrequired
The immutable /atlas-release releaseId for the artifacts that produced this response.
metaobjectrequired
ShowHide1 child field
- nextCursorstring | nullrequired
  Opaque cursor for the next page, or null at the end.

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.

The terrain catalogue distinguishes bare-earth elevation (a digital terrain model) from surface elevation (a digital surface model), and declares slope, aspect, contours and hillshade separately. A product marked not-published has no values, tiles or contours to fetch; it exists so a client can discover the service boundary without treating a planned layer as data. Before a product becomes available, its version must state its CRS, vertical datum, resolution, processing, uncertainty, licence and immutable content hash.

Request

curl "https://api.ukdataatlas.com/v1/terrain"

Response200

{
  "apiVersion": "v1",
  "atlasRelease": "sha256:5c4aa4529cbfbd5e4c844c55cddba1ef04a7bf76f3eaa085a357fff401af6d0c",
  "data": {
    "schemaVersion": 1,
    "contentHash": "sha256:4c7869c07f9e3e20de6f2b1af8a2a9a20e6cde1d4b68fdfeee3fb712f73b6611",
    "publicationRequirements": [
      "vertical CRS or datum, including the geoid model where applicable",
      "cell resolution or contour interval",
      "uncertainty or stated accuracy"
    ],
    "products": [
      {
        "id": "terrain-elevation",
        "label": "Bare-earth elevation",
        "kind": "raster",
        "measurement": "Elevation of the terrain surface after buildings and vegetation are removed.",
        "unit": "metres",
        "availability": {
          "status": "not-published",
          "reason": "No versioned terrain source has been ingested and validated for this product yet."
        },
        "intendedCoverage": {
          "countries": [
            "GB-ENG",
            "GB-NIR",
            "GB-SCT",
            "GB-WLS"
          ]
        }
      }
    ]
  },
  "meta": {
    "nextCursor": null
  }
}

Discover terrain products

Returns

When it goes wrong

Technical notes