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.

Pricing

1 credit per 1 request.

Parameters

Name	Description
location path string	Postcode or coordinates in the lat,long format. Examples 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/{location}?api_key=DEMO

Possible responses with examples

Code

Description

200

Success

401

Unauthorized

402

Payment Required

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error