Postcode details

gethttps://crystalroof.co.uk/customer-api/geography/postcode-details/v1/{location}

Description

This method returns detailed geographic information about the given postcode including year of introduction/termination, coordinates, country code/name, region code/name, county code/name, LAD code/name, built-up area code/name, MSOA code/name, LSOA code/name, OA code/name, postcode area, postcode district, postcode sector.

If coordinates are provided, the method will find the closest postcode to the given coordinates.

Parameters

Name	Description
location path string	Postcode or coordinates in the lat,long 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/geography/postcode-details/v1/W60WW?api_key=DEMO

Possible responses with examples

Code

Description

200

Success

{
  "data": {
    "postcode": "W6 0WW",
    "introduction": "2004-06",
    "termination": null,
    "countryCode": "E92000001",
    "countryName": "England",
    "regionCode": "E12000007",
    "regionName": "London",
    "countyCode": "E99999999",
    "countyName": "England (UA/MD/LB)",
    "ladCode": "E09000013",
    "ladName": "Hammersmith and Fulham",
    "wardCode": "E05013746",
    "wardName": "Ravenscourt",
    "builtUpAreaCode": "E34004707",
    "builtUpAreaName": "Greater London",
    "easting": 522070,
    "northing": 178926,
    "latitude": "51.496105",
    "longitude": "-0.242921",
    "oa11": "E00009658",
    "lsoa11": "E01001931",
    "msoa11": "E02000382",
    "oa21": "E00183158",
    "lsoa21": "E01001931",
    "msoa21": "E02000382",
    "postcodeArea": "W",
    "postcodeDistrict": "W6",
    "postcodeSector": "W6 0"
  },
  "dataDate": "2023-11",
  "refreshedDate": "2023-11-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!"
}