Household composition

England

Wales

gethttps://crystalroof.co.uk/customer-api/demographics-and-migration/household-composition/postcode/v1/{location}

Description

This method returns Census 2021 estimates that classify households by the relationships between household members.

One-family households are classified by: - the number of dependent children, - family type (married, civil partnership or cohabiting couple family, or lone parent family).

Other households are classified by: - the number of people - the number of dependent children - whether the household consists only of students or only of people aged 66 and over.

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/demographics-and-migration/household-composition/postcode/v1/W60WW?api_key=DEMO

Possible responses with examples

Code

Description

200

Success

{
  "data": {
    "residents": {
      "Total": 84,
      "One person household": 30,
      "One person household: Aged 66 years and over": 4,
      "One person household: Other": 26,
      "Single family household": 43,
      "Single family household: All aged 66 years and over": 1,
      "Single family household: Married or civil partnership couple": 17,
      "Single family household: Married or civil partnership couple: No children": 7,
      "Single family household: Married or civil partnership couple: Dependent children": 9,
      "Single family household: Married or civil partnership couple: All children non-dependent": 1,
      "Single family household: Cohabiting couple family": 10,
      "Single family household: Cohabiting couple family: No children": 5,
      "Single family household: Cohabiting couple family: With dependent children": 5,
      "Single family household: Cohabiting couple family: All children non-dependent": 0,
      "Single family household: Lone parent family": 14,
      "Single family household: Lone parent family: With dependent children": 11,
      "Single family household: Lone parent family: All children non-dependent": 3,
      "Single family household: Other single family household": 1,
      "Single family household: Other single family household: Other family composition": 1,
      "Other household types": 11,
      "Other household types: With dependent children": 6,
      "Other household types: Other, including all full-time students and all aged 66 years and over": 5,
      "Single-family household: no children": 12,
      "Single-family household: with dependent children": 25,
      "Single-family household: with non-dependent children": 4
    },
    "rank": {
      "One person household": 6,
      "One person household: Aged 66 years and over": 2,
      "One person household: Other": 7,
      "Single family household": 4,
      "Single family household: All aged 66 years and over": 1,
      "Single family household: Married or civil partnership couple": 3,
      "Single family household: Married or civil partnership couple: No children": 4,
      "Single family household: Married or civil partnership couple: Dependent children": 3,
      "Single family household: Married or civil partnership couple: All children non-dependent": 1,
      "Single family household: Cohabiting couple family": 5,
      "Single family household: Cohabiting couple family: No children": 4,
      "Single family household: Cohabiting couple family: With dependent children": 5,
      "Single family household: Cohabiting couple family: All children non-dependent": 1,
      "Single family household: Lone parent family": 6,
      "Single family household: Lone parent family: With dependent children": 6,
      "Single family household: Lone parent family: All children non-dependent": 3,
      "Single family household: Other single family household": 3,
      "Single family household: Other single family household: Other family composition": 3,
      "Other household types": 5,
      "Other household types: With dependent children": 5,
      "Other household types: Other, including all full-time students and all aged 66 years and over": 4,
      "Single-family household: no children": 4,
      "Single-family household: with dependent children": 6,
      "Single-family household: with non-dependent children": 2
    }
  },
  "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!"
}