Living arrangements

England

Wales

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

Description

This method returns Census 2021 estimates that classify usual residents aged 16 years and over in households by their living arrangements.

The "living arrangements" classification combines responses to the question on marital and civil partnership status with information about whether or not a person is living in a couple. This topic is only applicable to people in households. Living arrangements differs from marital and civil partnership status because cohabiting takes priority over other categories. For example, if a person is divorced and cohabiting, then in results for living arrangements they are classified as cohabiting.

Living arrangements are split into 15 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. 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/living-arrangements/postcode/v1/W60WW?api_key=DEMO

Possible responses with examples

Code

Description

200

Success

{
  "data": {
    "residents": {
      "Total": 4993,
      "Living in a couple": 2382,
      "Living in a couple: Married or in a civil partnership": 1680,
      "Living in a couple: Married or in a civil partnership: Opposite-sex couple": 1622,
      "Living in a couple: Married or in a civil partnership: Same-sex couple": 58,
      "Living in a couple: Separated, but still married or in a civil partnership": 4,
      "Living in a couple: Cohabiting": 698,
      "Living in a couple: Cohabiting: Opposite-sex couple": 634,
      "Living in a couple: Cohabiting: Same-sex couple": 64,
      "Not living in a couple": 2611,
      "Not living in a couple: Single (never married and never registered a same-sex civil partnership)": 1872,
      "Not living in a couple: Married or in a registered civil partnership": 140,
      "Not living in a couple: Separated (including those who are married and those who are in civil partnerships)": 103,
      "Not living in a couple: Divorced or formerly in a civil partnership which is now legally dissolved": 335,
      "Not living in a couple: Widowed or surviving partner from a civil partnership": 161
    },
    "rank": {
      "Living in a couple": 4,
      "Living in a couple: Married or in a civil partnership": 4,
      "Living in a couple: Married or in a civil partnership: Opposite-sex couple": 4,
      "Living in a couple: Married or in a civil partnership: Same-sex couple": 8,
      "Living in a couple: Separated, but still married or in a civil partnership": 3,
      "Living in a couple: Cohabiting": 5,
      "Living in a couple: Cohabiting: Opposite-sex couple": 5,
      "Living in a couple: Cohabiting: Same-sex couple": 6,
      "Not living in a couple": 7,
      "Not living in a couple: Single (never married and never registered a same-sex civil partnership)": 7,
      "Not living in a couple: Married or in a registered civil partnership": 6,
      "Not living in a couple: Separated (including those who are married and those who are in civil partnerships)": 6,
      "Not living in a couple: Divorced or formerly in a civil partnership which is now legally dissolved": 5,
      "Not living in a couple: Widowed or surviving partner from a civil partnership": 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!"
}