StreetCheck Web API Documentation

Available Endpoints

The StreetCheck API contains a number of endpoints, with the majority being based around retrieving data for a specific postcode. We also have searchable endpoints for when you only know a partial postcode.

APIDescription
GET api/v1/postcode/startingwith/{partialPostcode}

This endpoint allows searching for postcodes starting with a certain pattern. This endpoint must be given at least the first half of a postcode e.g. SN5 in the case of SN5 5RF.

GET api/v1/postcode/{postcode}

This is the starting point for most applications, and provides the overview data about a postcode's address, parliamentary constituency etc.

It will also provide a brief commentary about the postcode and surrounding area.

GET api/v1/postcode/{postcode}/broadband

This endpoint provides a summary of the broadband availability in the postcode.

Please be aware that some postcodes contain businesses with highspeed lines, where the residential properties do not support Superfast. As a result, the figures for average/median speed and the boolean value "superfastBroadbandAvailable" should be given more sway than the maximum.

GET api/v1/postcode/{postcode}/nearbyservices

This endpoint provides a summary of the nearest services to the postcode.

- For all postcodes, nearest GPs/doctors and hospitals are provided, and also nearest schools and railway stations.
- For London postcodes, Tube and DLR stations are also listed.
- Additionally, in England the nearest dentists and opticians are provided.

Distance figures are as the crow flies. If you include England NHS data you must include a link to the NHS choices link given in the nhsChoicesLink field of that record.

GET api/v1/postcode/{postcode}/saleprices

This endpoint provides a full list of all the property sales in the given postcode since 1995, sorted by date(newest first). Due to land registration being a devolved power, data is currently available for England and Wales only.

GET api/v1/postcode/{postcode}/demographics

For the given postcode, this endpoint provides extensive demographic data, split into various sections such as housing tenure, age, gender etc. It will also provide a brief commentary about each of these sections, as shown on the postcode pages of the website.

This endpoint also exposes a "chart" property for each section. This is a URL to an image showing the information in the section as a pie or bar chart, which you can embed into your application. The chart images are in PNG format, with a size of 600x338 pixels.

GET api/v1/postcodedistrict/{district}/demographics

This endpoint allows searching for demographic data for an entire postcode district.

For the given district, this endpoint provides extensive demographic data, split into various sections such as housing tenure, age, gender etc. It will also provide a brief commentary about each of these sections, as shown on the postcode district pages of the website.

This endpoint also exposes a "chart" property for each section. This is a URL to an image showing the information in the section as a pie or bar chart, which you can embed into your application. The chart images are in PNG format, with a size of 600x338 pixels.

Back to Top