Mean household income

England

Wales

gethttps://crystalroof.co.uk/customer-api/income/mean-household-income/postcode/v1/{location}

Description

Estimates of mean annual household income for the year 2022 for small areas (Middle layer Super Output Areas, or MSOAs). The results are determined by the inclusion of the submitted postcode/coordinates/UPRN within the corresponding MSOA.

Date of the next update to be announced.

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
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/income/mean-household-income/postcode/v1/W60WW?api_key=DEMO

Possible responses with examples

Code

Description

200

Success

{
  "data": {
    "totalMeanAnnualIncome": 64200,
    "totalMeanAnnualIncomeRank": 8
  },
  "dataDate": "2022",
  "refreshedDate": "2023-10-01"
}

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!"
}