UK Data AtlasAPI

List crosswalks

A crosswalk maps one set of areas onto another, such as wards to local authorities, or 2010 constituencies to 2024 ones. This lists every crosswalk the Atlas publishes.

get
/crosswalks

Returns

CrosswalkSummaryListEnvelope

The current crosswalk inventory.

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

  • dataCrosswalkSummary[]required
    Show9 child fields
    • idstringrequired
    • fromCrosswalkSiderequired
      Show2 child fields
      • geographystringrequired
      • boundaryReleasestringrequired
    • toCrosswalkSiderequired
      Show2 child fields
      • geographystringrequired
      • boundaryReleasestringrequired
    • methodCrosswalkMethodrequired

      official-lookup and clean-containment read an explicit code pair from a published file. area-overlap intersects the two releases' boundary geometries and weights each source by the area it shares with each target. population-overlap reweights an area-overlap crosswalk's pairs by the residents of the building blocks in each. geometric-containment derives a hierarchy from geometry where no publisher lookup carries it. best-fit names, for each child, the one parent holding most of its area where the two do not nest. extent-continuity pairs the codes two releases of one geography share, as identity only where their geometries differ by no more than generalisation slivers.

      One ofofficial-lookupclean-containmentarea-overlappopulation-overlapgeometric-containmentbest-fitextent-continuity
    • qualityCrosswalkQualityrequired

      publisher-supplied mappings restate a publisher's own correspondence. derived mappings are computed by the Atlas.

      One ofpublisher-suppliedderived
    • weightingCrosswalkWeightingrequired
    • recordCountintegerrequired
    • artifactstringrequired
    • contentHashstringrequired

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.