Search API

API Endpoints

Housing and Property

Desirability Scores

Tokens
× 1

API Credit Cost

Endpoint Overview

The Desirability Scores endpoint calculates a score for a postcode area based on factors like crime rates, amenities, and green spaces.

Coverage

EnglandEngland
ScotlandScotland
WalesWales
N. IrelandN. Ireland

Update Frequency

Monthly

Request Format

HTTP Method:

GET

To use the API you should send an HTTP request to the following endpoint URL. This will return a JSON response.

https://api.postcodearea.co.uk/v1/desirability-rankings/?key=&postcode={postcode}

Note that your key has automatically been added to the API endpoint for convenience.

Querystring Parameters:

{postcode}

A valid UK postcode (e.g., SW1A 1AA). Note that you can send the postcode with or without the space separating the outward and inward codes. For example, both "SW1A 1AA" and "SW1A1AA" are both valid.

{api_key}

A valid API key that authenticates your account.

Authorisation

For every endpoint request your API Key should be sent as part of the querystring:

https://api.postcodearea.co.uk/v1/desirability-rankings/?key={api_key}&postcode=WS3+3PD

For example:

https://api.postcodearea.co.uk/v1/desirability-rankings/?key=&postcode=WS3+3PD

Example Request and Response

If the above URL endpoint exists and the API key is valid, our system will return the following example response:

https://api.postcodearea.co.uk/v1/desirability-rankings/?key=&postcode=WS3+3PD
{"data":[{"Postcode":"ST20 0LY","AB Social Status":7,"Affordability":8,"Attractions and Culture":3,"Childcare":7,"Cleanliness":0,"Credit Score":7,"Disabled Accessibility":2,"Diversity":0,"Eco Score":0,"Economic Growth":4,"Economy":0,"Education":5,"Exclusivity Score":0,"Further Education":3,"Green Spaces":5,"Healthcare":9,"Income":4,"International Travel":4,"Internet Speeds":7,"Job Centres":0,"LGBTQ Score":1,"Leisure Centres":6,"Libraries":10,"Nightlife":5,"Occupation":6,"Politics - Authoritarian":9,"Politics - Left":5,"Politics - Libertarian":1,"Politics - Right":5,"Private Outdoor Space":9,"Property Yield":2,"Quietness":0,"Recreation":3,"Rental Affordability":9,"Restaurants":6,"Retirement Housing":10,"Safety":9,"Schools":8,"Shopping":2,"Tech Score":0,"Transport":6}],"response_time":0.0156,"Source":"PostcodeArea API","Output Area":"Postcode","Radius":10,"Distance Unit":"Mile","Records":1,"Unique Fields":1,"Referrer":"api.postcodearea.co.uk"}

Error Handling

HTTP Status Code Error Message Reason
400 Invalid postcode format The postcode provided is not valid.
401 Unauthorised request API key missing or invalid.
404 Postcode not found No data available for the given postcode.
404 No Results Found No data available for the given radius.
429 Too many requests Exceeded rate limit.
500 Internal server error An unexpected issue occurred.

Caching Policy

You may temporarily cache data retrieved from the API for performance optimisation purposes, provided that the cached data is:

  1. Stored in-memory only (e.g., application-level cache).
  2. Retained for no longer than one hour.

Caching API data to any persistent storage, including but not limited to databases, files, or external systems, constitutes a breach of our API Terms and Conditions. Such actions are strictly prohibited to ensure data accuracy and compliance with our licensing agreements.

If you have specific requirements for extended caching, you must seek prior written consent from us.

Get started today

Ready to use this data for your own business or organisation? Sign up today and get immediate access to all the PostcodeArea API endpoints.

Sign up and access the API-or-Explore the docs

Share this page