Car or van availability

England

Wales

gethttps://crystalroof.co.uk/customer-api/housing/car-or-van-availability/postcode/v1/{location}

Description

This method returns Census 2021 estimates on the number of cars or vans available to members of households.

Number of cars or vans is the number of cars or vans owned or available for use by household members.

Vehicles included:

pick-ups, camper vans and motor homes
vehicles that are temporarily not working
vehicles that have failed their MOT
vehicles owned or used by a lodger
company cars or vans if they're available for private use

Vehicles not included:

motorbikes, trikes, quad bikes or mobility scooters
vehicles that have a Statutory Off Road Notification (SORN)
vehicles owned or used only by a visitor
vehicles that are kept at another address or not easily accessed

The number of cars or vans in an area relates only to households. Cars or vans used by communal establishment residents are not counted.

Households with 10 to 20 cars or vans are counted as having only 10.

Households with more than 20 cars or vans were treated as invalid and a value imputed.

Number of cars or vans is split into 5 categories including total.

The estimates are as at Census Day, 21 March 2021.

Parameters

Name	Description
location path string	Postcode, coordinates in the lat,long format or UPRN in the uprn12345678 format. Examples Postcode with or without space. This argument is case-insensitive. Value
area_type query enum	Area types used in Census 2021. The method returns results based on the inclusion of the postcode/coordinate/UPRN within the designated geographical area. For instance, when using 'oa' as a parameter, the returned results will be for the Output Area that contains the specified postcode/coordinate/UPRN. oa - Output area (OA), the smallest geographical area used in the census, comprises 25-40 households and a population of 100-625 persons. lsoa - Lower layer Super Output Area (LSOA), a small geographical area used in the census, comprises 400-1200 households and a population of 1000-3000 persons. Lower layer Super Output Areas (LSOAs) are made up of groups of OAs, usually four or five. msoa - Middle layer Super Output Area (MSOA), a small geographical area used in the census, comprises 2,000-6,000 households and a population of 5,000 and 15,000 persons. MSOAs are made up of groups of LSOAs, usually four or five. MSOAs fit within local authorities. lad - Local Authority District. There are a total of 296 districts in England made up of 36 metropolitan boroughs, 32 London boroughs, 164 two-tier non-metropolitan districts and 62 unitary authorities, City of London district and Isles of Scilly district. In Wales, there are 22 local authorities, which are named principal areas.. region - nine regions of England (London, the North East, North West, Yorkshire, East Midlands, West Midlands, South East, East of England and the South West) and Wales as a whole. country - constituent countries of the UK: England, Scotland, Wales and Northern Ireland. Value
api_key query enum	Your API key. `DEMO` key allows you to test the method in the `W6 0` postcode sector, or in the `[[51.492, -0.25], [51.502, -0.225]]` rectangle. Value

Request URL:

https://crystalroof.co.uk/customer-api/housing/car-or-van-availability/postcode/v1/W60WW?api_key=DEMO

Possible responses with examples

Code

Description

200

Success

{
  "data": {
    "residents": {
      "Total": 85,
      "No cars or vans in household": 49,
      "1 car or van in household": 35,
      "2 cars or vans in household": 1,
      "3 or more cars or vans in household": 0
    },
    "rank": {
      "No cars or vans in household": 8,
      "1 car or van in household": 5,
      "2 cars or vans in household": 1,
      "3 or more cars or vans in household": 1
    }
  },
  "dataDate": "2021-03-21",
  "refreshedDate": "2021-03-21"
}

401

Unauthorized

{
  "error": "No such API key or it is not valid anymore."
}

402

Payment Required

{
  "error": "You have exhausted the available calls provided by your package."
}

403

Forbidden

{
  "error": "API key is invalid for the given action."
}

404

Not Found

{
  "error": "Can't find such location."
}

429

Too Many Requests

{
  "error": "Too many requests have been sent in one second."
}

500

Internal Server Error

{
  "error": "We have already started working on a resolution!"
}