Get a crosswalk
Find out how a crosswalk was made and how reliable it is, without downloading its full list of mappings.
/crosswalks/{crosswalk-id}crosswalk-idstringrequiredA crosswalk id, e.g.
constituency-2010-to-2024-official-lookup-v2.
Returns
CrosswalkMetadataEnvelopeThe matching crosswalk's metadata.
apiVersionv1requiredatlasReleasestringrequiredThe immutable
/atlas-releasereleaseIdfor the artifacts that produced this response.metaobjectrequiredShowHide1 child field
nextCursorstring | nullrequiredOpaque cursor for the next page, or null at the end.
dataCrosswalkMetadatarequiredShowHide10 child fields
schemaVersion1requiredcontentHashstringrequiredidstringrequiredmethodCrosswalkMethodrequiredofficial-lookupandclean-containmentread an explicit code pair from a published file.area-overlapintersects the two releases' boundary geometries and weights each source by the area it shares with each target.population-overlapreweights an area-overlap crosswalk's pairs by the residents of the building blocks in each.geometric-containmentderives a hierarchy from geometry where no publisher lookup carries it.best-fitnames, for each child, the one parent holding most of its area where the two do not nest.extent-continuitypairs 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-continuityqualityCrosswalkQualityrequiredpublisher-suppliedmappings restate a publisher's own correspondence.derivedmappings are computed by the Atlas.One ofpublisher-suppliedderivedweightingCrosswalkWeightingrequiredfromCrosswalkSiderequiredShowHide2 child fields
geographystringrequiredboundaryReleasestringrequired
toCrosswalkSiderequiredShowHide2 child fields
geographystringrequiredboundaryReleasestringrequired
provenanceobjectrequiredvalidationobjectrequiredShowHide3 child fields
overlapAreaOverlapValidationoptionalPresent only for
area-overlapcrosswalks. Two independently generalised boundaries leave narrow slivers where they disagree. A pair whose widest intersecting piece is narrower thansliverWidthM(twice its area over its perimeter) is dropped as a sliver. The build fails unless every sliver is under half that width and every kept overlap at least twice it, and unless every source and target area is at leastminimumCoveragecovered by kept overlaps.ShowHide9 child fields
candidatePairCountintegerrequiredPairs whose bounding boxes meet, and so were clipped.
intersectingPairCountintegerrequiredsliverPairCountintegerrequiredsliverWidthMnumberrequiredwidestSliverWidthMnumber | nullrequirednarrowestOverlapWidthMnumberrequiredminimumCoveragenumberrequiredminimumSourceCoveragenumberrequiredminimumTargetCoveragenumberrequired
sourceNameConflictsobject[]requiredShowHide2 child fields
codestringrequirednamesstring[]required
endpointsobjectrequiredShowHide2 child fields
fromCrosswalkEndpointValidationrequiredtoCrosswalkEndpointValidationrequired
- 404No resource matches that identity.
Every error has the same shape. See Errors for how to handle them.
Show the precise behaviourHide the precise behaviour
Returns the crosswalk's method, quality, weighting, endpoints, provenance and validation facts, but not its full record set. Fetch /crosswalks/{crosswalk-id}/records for the mappings themselves.