List every route

Returns the paths the API serves right now. Handy as a quick health check, or to see at a glance what's available.

get

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

Returns

RootEnvelope

Discovery document.

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.
dataRootDocumentrequired
ShowHide4 child fields
- namestringrequired
- openapistringoptional
  This OpenAPI description, the binding contract.
- documentationstringoptional
  The human landing page rendered from it.
- linksstring[]required

Technical notes

Show the precise behaviour

Lists the currently implemented resource paths.

Request

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

Response200

{
  "apiVersion": "v1",
  "atlasRelease": "sha256:9edc254c5d4cd0a90fc5d3b2544e5f64946d6d0e6a8b68860e3aa6f0ac8d0912",
  "data": {
    "name": "UK Data Atlas API",
    "links": [
      "/v1/openapi.yaml",
      "/v1/docs",
      "/v1/geographies",
      "/v1/map-resources",
      "/v1/map-resources/{geography}/{release}",
      "/v1/map-resources/{geography}/{release}.pmtiles",
      "/v1/map-resources/{geography}/{release}/tiles.json",
      "/v1/map-resources/{geography}/{release}/tiles/{z}/{x}/{y}.mvt",
      "/v1/map-resources/{geography}/{release}/features",
      "/v1/map-resources/{geography}/{release}/join/{measure-id}",
      "/v1/boundary-releases",
      "/v1/boundary-releases:resolve",
      "/v1/boundary-releases/{geography}/{release}",
      "/v1/documents/{document-id}.json",
      "/v1/datasets",
      "/v1/datasets/{dataset-id}",
      "/v1/measures",
      "/v1/measures/{measure-id}",
      "/v1/measures/{measure-id}/compatibility",
      "/v1/measures/{measure-id}/coverage",
      "/v1/measures/{measure-id}/quality",
      "/v1/data/{measure-id}",
      "/v1/data/{measure-id}/series",
      "/v1/data/{measure-id}/rankings",
      "/v1/data/{measure-id}/compare",
      "/v1/data/{measure-id}/aggregate",
      "/v1/areas",
      "/v1/areas/{geography}/{release}/{code}",
      "/v1/areas/{geography}/{release}/{code}/relationships",
      "/v1/areas/{geography}/{release}/{code}/geometry",
      "/v1/crosswalks",
      "/v1/crosswalks/{crosswalk-id}",
      "/v1/crosswalks/{crosswalk-id}/records",
      "/v1/relationship-candidates",
      "/v1/validation",
      "/v1/validation/boundary-releases/{geography}/{release}",
      "/v1/validation/crosswalks/{crosswalk-id}",
      "/v1/exports",
      "/v1/exports/{export-id}",
      "/v1/atlas-release"
    ]
  },
  "meta": {
    "nextCursor": null
  }
}