Get Place Data
Retrieve a place record by ID or postcode, enriched with average property floor areas by type.
query Parameters
place_idInternal place ID. Provide either this or postcode, not both.
postcodeUK postcode, e.g. 'SW1A 1AA'. Provide either this or place_id, not both.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Responses
Place data with average property sizes by type
place_idInternal ID which can be used for other API endpoints. This ID is fixed and can be stored for future ref.
Full postcode.
Outcode is the first section of a Postcode such as 'SN6'. There are roughly 2500 in the UK which each cover around 20,000 addresses.
Town name.
OS ID for mapping purposes or using with third party OS datasets.
County the place is located.
The internal ID for the Town which the place is located in.
Easting of property.
Northing of property.
Positional quality indicator.
Geo country code.
Region code.
Local authority code.
Ward code.
Parlimentary constituency code.
European electoral code.
Primary care trust code.
Lower super output area code.
Middle super output area code.
Output area code for profiling population output type.
Postcode level longitude.
Postcode level latitude.
Level of accuracy (postcode).
Geo position.
Used for third party data look ups on Socrata.
Used for third party data look ups on the census database.
Outer postcode.
Average floor area of detached houses in this area.
Average floor area of flats in this area.
Average floor area of semi-detached houses in this area.
Average floor area of terrace houses in this area.
Average floor area of bungalows in this area.
Get Nearby Schools
Find the 20 nearest schools to a postcode or lat/lng location, with full school details.
query Parameters
postcodeUK postcode, e.g. 'SW1A 1AA'. Provide either this or lat/lng, not both.
latLatitude of the location (UK only). Must be provided together with lng.
lngLongitude of the location (UK only). Must be provided together with lat.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Responses
List of 20 nearest schools with details
school_urnUnique reference number for the school.
latLatitude of the school location.
lngLongitude of the school location.
distance_mDistance in metres from the search location to the school.
Name of the school.
Phase of education, e.g. 'Primary', 'Secondary'.
Type of school, e.g. 'Voluntary controlled', 'Academy'.
Age range of pupils, e.g. '2-9', '11-18'.
Gender composition, e.g. 'Mixed', 'Boys', 'Girls'.
Whether the school has a nursery (1 = yes, 0 = no).
Religious character of the school, e.g. 'Church of England'.
Name of the headteacher.
Full address of the school.
Contact phone number for the school.
School website URL.
Local authority the school belongs to.
JSON summary of pupil demographics (gender, age range, totals).
JSON summary of average class sizes.
JSON summary of pupil numbers per year group.
JSON breakdown of pupil ethnicities as percentages.
Latest Ofsted inspection rating, e.g. 'Good', 'Outstanding'.
Date of the latest Ofsted inspection.
URL to the Ofsted inspection report.
JSON inspection scores for Welsh schools (Estyn).
JSON extracted strengths and weaknesses from inspection report.
Approximate catchment area description, e.g. '~ 7.49 Miles'.
Catchment radius in miles.
JSON admissions data including acceptance rates by year.
JSON Ofsted Parent View survey results.
JSON Key Stage 2 results data.
Get Broadband Data
Retrieve broadband availability, speed, and usage data for a place by ID or postcode.
query Parameters
place_idInternal place ID. Provide either this or postcode, not both.
postcodeUK postcode, e.g. 'SW1A 1AA'. Provide either this or place_id, not both.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Responses
Broadband availability and speed data for a place
Availability ratio of super fast broadband.
Availability ratio of ultra fast broadband.
Premises unable to achieve 2mbps speed.
Premises unable to achieve 5mbps speed.
Premises unable to achieve 10mbps speed.
Median download speeds.
Avg download speeds.
Min download speeds.
Max download speeds.
Avg download speeds.
Avg basic download speeds.
Avg SFBB download speeds.
Avg UFBB download speeds.
Median upload speeds.
Avg upload speeds.
Min upload speeds.
Max upload speeds.
Avg upload speeds.
Avg basic upload speeds.
Avg SFBB upload speeds.
Avg UFBB upload speeds.
Number of connections to 2mbps.
Number of connections to 5mbps.
Number of connections to 10mbps.
Number of connections to 30mbps.
Number of connections to over 30mbps.
Number of connections to 300mbps.
Average mb data usage per month.
Average mb line data usage per month.
Average mb basic data usage per month.
Average mb SFBB data usage per month.
Average mb data UFBB usage per month.
FTTP availability (1 = true, 0 = false).
Get Demographics
Core socioeconomic area profile for one postcode, LSOA, or local authority. Merges census age distribution, usual residents, population density, migration indicators, current occupation, and economic activity status into one response.
query Parameters
postcodeuk full postcode
lsoauk lsoa code
local_authority_codeuk local authority code
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Responses
Core socioeconomic area profile
Get Households
Housing-specific profile for one postcode, LSOA, or local authority. Merges census household composition, household size, household tenure, and household deprivation into one response.
query Parameters
postcodeuk full postcode
lsoauk lsoa code
local_authority_codeuk local authority code
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Responses
Housing-specific profile
Get Income
Average household income for one postcode, LSOA, or local authority. Returns estimated annual income with upper and lower confidence limits.
query Parameters
postcodeuk full postcode
lsoauk lsoa code
local_authority_codeuk local authority code
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Responses
Average household income for an area
countGet Crime
Local crime data by type for one postcode, LSOA, or local authority. Returns crime category counts, composite totals, and rates per 1,000 residents.
query Parameters
postcodeuk full postcode
lsoauk lsoa code
local_authority_codeuk local authority code
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Responses
Local crime data by type
countGet Census Indices
Combined census indices for one postcode, LSOA, or local authority. Returns population, household, income, occupation, economic activity, and crime metrics.
query Parameters
postcodeuk full postcode
lsoauk lsoa code
local_authority_codeuk local authority code
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Responses
Census indices for an area
count