Property Information API

Try it out

Find all information on a given property.

Endpoints

https://land-property-platform.herokuapp.com/property_info
for publicly available data

https://land-property-platform.herokuapp.com/property_info_sensitive
for sensitive data (will require API key in future phases)

Parameters

platform_property_id: (integer) The platform_property_id

address: (string) The address of the property as found in the database,

Examples

Requests

Request body:

{
    "address": "58, Mountain Road, Pontypandy"
}

Or curl request:

curl -X 'POST' \
  'https://land-property-platform.herokuapp.com/property_info' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "platform_property_id": 6
}'

Or using python:

import requests
import json


address = "58, Mountain Road, Pontypandy"
json_data = json.dumps({"address": address})
response = requests.post(
    "https://land-property-platform.herokuapp.com/property_info",
    data=json_data,
)

platform_property_id can be used instead of address. An example request body:

{
    "platform_property_id": 6
}

Response

Response body for /property_info (sensitive attributes and land extent will be excluded):

{
  "identifiers": {
    "uprn": 10015806605,
    "platform_property_id": 6,
    "address": "58, Mountain Road, Pontypandy"
  },
  "attributes": {
    "tax_zone": "north_zone",
    "attribute_a": 2
  },
  "geospatial": {
    "uprn_point_location": {
      "type": "Point",
      "coordinates": [
        257466.86,
        326552.57
      ]
    },
  }
}

Response body for /property_info_sensitive (all data):

{
  "identifiers": {
    "uprn": 10015806605,
    "platform_property_id": 6,
    "address": "58, Mountain Road, Pontypandy"
  },
  "attributes": {
    "attribute_a": 2,
    "buy_to_let": true,
    "attribute_b": 3,
    "tax_zone": "north_zone"
  },
  "geospatial": {
    "uprn_point_location": {
      "type": "Point",
      "coordinates": [
        257466.86,
        326552.57
      ]
    },
    "extent": "not in database"
  }
}

Response schema:

{
    # Property identifiers (request will have identified one of these)
    "identifiers": {
        "uprn": integer,
        "platform_property_id": integer,
        "address": string
    },
    # Property attributes
    "attributes": {
        "attribute": attribite value,
        ... : ...
    },
    # Geospatial information
    "geospatial": {
        "uprn_point_location": geojson | string,
        "extent": geojson | string
    }
}

Attributes

Attributes contain the know information on the property.

Second home

Attribute name: "second_home"
Possible values: true, false
Description: If true, the property is not a main residence.

Buy_to_let

Attribute name: "buy_to_let"
Possible values: true, false
Description: If true, the property is considered a buy-to-let property. Note that a property is not identified as a second home if it is a buy-to-let property.

Attribute a

Attribute name: "attribute_a"
Possible values: 1, 2
Description: A placeholder attribute which can hold integer values and has a multiplier effect on LLT.

Attribute b

Attribute name: "attribute_b"
Possible values: 1, 2, 3
Description: A placeholder attribute which can hold integer values and has a fixed addition effect on LLT.

Tax zone

Attribute name: "tax_zone"
Possible values: "north_zone", "south_zone"
Description: The tax zone that the property resides in.

Cross boarder

Attribute name: "cross_boarder"
Possible values: true
Description: The property has been flagged as crossing the Wales - England boarder.