Skip to content

API Reference

Data Model

Properties

The core concept of the PropEco API is a Property to which we associate various datasets. Properties are identified by a Unique Property Reference Number (or UPRN).

Coordinate Systems

Throughout the PropEco API, geographical locations of properties and other features are provided, and in some cases used in queries. We use two different coordinate systems to reference geographical locations:

Here is an example location as seen from our /properties/{uprn} endpoint:

{
    "uprn": "1",
    "x_coord": 358260.66,
    "y_coord": 172796.5,
    "latitude": 51.4526008,
    "longitude": -2.602075,
    ...
}

Coverage

At present, the API provides full coverage of England, Scotland and Wales.

Note that some of the underlying data sources are provided at a national or even regional level and so we cannot guarantee that the same amount of information will be available for every property or location.

Moreover, the format of some datasets (e.g., flood risk assessments and energy performance certificates) varies between Scotland, England and Wales. Where this is the case, it is reflected in the API response.

Sources & attribution

The API incorporates several open source data sources. These are licensed under the Open Government Licence.

  • Contains OS data © Crown Copyright and database right (2023)
  • Contains British Geological Survey materials © UKRI 2023
  • Contains Royal Mail data © Royal Mail copyright and database right 2023
  • Source: Office for National Statistics licensed under the Open Government Licence v.3.0
  • © Environment Agency copyright and/or database right 2015. All rights reserved.
  • Some features of this information are based on digital spatial data licensed from the Centre for Ecology & Hydrology © NERC (CEH). Defra, Met Office and DARD Rivers Agency © Crown copyright. © Cranfield University. © James Hutton Institute. Contains OS data © Crown copyright and database right 2015. Land & Property Services © Crown copyright and database right.
  • © Environment Agency copyright and/or database right 2018. All rights reserved.
  • Some features of this map are based on digital spatial data from the Centre for Ecology & Hydrology, © NERC (CEH) © Crown copyright and database rights 2018 Ordnance Survey 100024198
  • © Historic England 2023
  • © Historic Environment Scotland 2023
  • Contains HM Land Registry data © Crown copyright and database right 2020.
  • Crown 2023 copyright Defra via uk-air.defra.gov.uk.
  • Contains public sector information licensed under the Open Government Licence.
  • Designated Historic Asset GIS Data, The Welsh Historic Environment Service (Cadw), 2023, licensed under the Open Government.
  • Contains Natural Resources Wales information © Natural Resources Wales and database right. All rights reserved. Some features of this information are based on digital spatial data licensed from the UK Centre for Ecology & Hydrology © UKCEH. Defra, Met Office and DARD Rivers Agency © Crown copyright. © Cranfield University. © James Hutton Institute. Contains OS data © Crown copyright and database right.

Updates

We aim to incorporate any updates to underlying data sources within 48 hours.

Roadmap

Over the coming months, we will be adding new data sources to the existing endpoints. We also plan to add new endpoints, including a dedicated overheating API. All updates will be non-breaking changes. We will inform existing users and update the docs as soon as these go live.