Occupancy rating for bedrooms

England

Wales

gethttps://crystalroof.co.uk/customer-api/housing/occupancy-rating-for-bedrooms/postcode/v1/{location}

Description

This method returns Census 2021 estimates that classify households by occupancy rating based on the number of bedrooms in the household.

Occupancy rating for bedrooms defines whether a household's accommodation is overcrowded, ideally occupied or under-occupied. This is calculated by comparing the number of bedrooms the household requires to the number of available bedrooms.

The number of bedrooms the household requires is calculated according to the Bedroom Standard, where the following should have their own bedroom:

married or cohabiting couple
single parent
person aged 16 years and over
pair of same-sex persons aged 10 to 15 years
person aged 10 to 15 years paired with a person under 10 years of the same sex
pair of children aged under 10 years, regardless of their sex
person aged under 16 years who cannot share a bedroom with someone in 4, 5 or 6 above

An occupancy rating of:

-1 or less: implies that a household's accommodation has fewer bedrooms than required (overcrowded)
+1 or more: implies that a household's accommodation has more bedrooms than required (under-occupied)
0: suggests that a household's accommodation has an ideal number of bedrooms

“Occupancy rating for bedrooms” is split into 6 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/occupancy-rating-for-bedrooms/postcode/v1/W60WW?api_key=DEMO

Possible responses with examples

Code

Description

200

Success

{
  "data": {
    "residents": {
      "Total": 85,
      "Occupancy rating of bedrooms: +2 or more": 3,
      "Occupancy rating of bedrooms: +1": 11,
      "Occupancy rating of bedrooms: 0": 55,
      "Occupancy rating of bedrooms: -1": 13,
      "Occupancy rating of bedrooms: -2 or less": 3
    },
    "rank": {
      "Occupancy rating of bedrooms: +2 or more": 1,
      "Occupancy rating of bedrooms: +1": 2,
      "Occupancy rating of bedrooms: 0": 9,
      "Occupancy rating of bedrooms: -1": 7,
      "Occupancy rating of bedrooms: -2 or less": 4
    }
  },
  "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!"
}