ons_geo_area_summary
Resolve any UK area code, postcode, or UPRN to a compact ONS geographic summary with inventory counts and population data. Get area type, level, and curated profile datasets for research.
Instructions
Resolve a compact OA/LSOA/MSOA/parish/ward/profile summary from an area code, postcode, or UPRN using cached ONS geographies, compact inventory counts, and curated NOMIS follow-up datasets.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| tool | No | ||
| uprn | No | ||
| postcode | No | ||
| targetLevel | No | ||
| derivationMode | No | exact | |
| includeInventory | No | ||
| includePopulation | No | ||
| profileCategories | No | ||
| inventoryResponseMode | No | summary | |
| includeProfileDatasets | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| area | Yes | ||
| input | Yes | ||
| anchor | Yes | ||
| counts | No | ||
| guidance | Yes | ||
| inventory | No | ||
| population | No | ||
| provenance | Yes | ||
| profileDatasets | No | ||
| workflowProfileUri | Yes |