9 endpoints

Catalogue

Discover what data exists: the source datasets, the measures built from them, and where each one can be used.

• List datasetsList every source dataset behind the Atlas, where it came from, and fingerprints of the files it was built from.get/datasets
• Get a datasetGet one source dataset's details: its publisher, its source files and their hashes.get/datasets/{dataset-id}
• List measuresList every measure you can query, with its unit, what it covers and whether it can be added up. A great place to start exploring.get/measures
• Get a measureEverything about one measure: what it counts, its unit, whether it can be summed or averaged, and which periods and areas it's published for.get/measures/{measure-id}
• Check which boundaries fitFind out which boundary releases a measure's data can be drawn on, by checking that every area code it uses is present.get/measures/{measure-id}/compatibility
• Check a measure's coverageSee where a measure has data, and what share of its area codes appear in each boundary release.get/measures/{measure-id}/coverage
• Check a measure against itselfWhere the same measure is published for both small areas and large ones, adding the small ones up should reproduce the large ones. This runs that check and shows the two figures side by side, so you can see where they disagree and by how much.get/measures/{measure-id}/reconciliation
• Plan coverage by countryBefore you rank or map a measure across the UK, check what it actually covers. Ward population, for instance, is published for England and Wales and for neither Scotland nor Northern Ireland, so a ranking of UK wards would quietly leave two countries out. This tells you that first.get/measures/{measure-id}/coverage-plan
• Check a measure's qualityA pre-flight check before you request data: every source and period, how its records were produced, whether it can be aggregated and which boundaries it fits.get/measures/{measure-id}/quality