List crosswalk mappings

Page through a crosswalk's mappings, or filter them to one source area.

get
/crosswalks/{crosswalk-id}/records
  • crosswalk-idstringrequired

    A crosswalk id, e.g. constituency-2010-to-2024-official-lookup-v2.

  • sourcestringoptional

    Filter to the record whose source code matches exactly. Omit to return a cursor-paginated list. A source lookup returns at most one record and has no next cursor.

  • limitinteger 1–500optional

    Maximum records to return when source is omitted.

    Default100
  • cursorstringoptional

    Opaque cursor from the previous response's nextCursor.

Returns

CrosswalkRecordListEnvelope

One page of matching records, or an empty array if source matched nothing. Bulk consumers should prefer downloading the static crosswalk artifact until an export endpoint exists. Records of an area-overlap crosswalk also carry each source's area and coverage and each target's weight, overlap area and shares.

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

  • dataCrosswalkRecord | AreaOverlapRecord[]required
  • 404No resource matches that identity.

Every error has the same shape. See Errors for how to handle them.