> ## Documentation Index
> Fetch the complete documentation index at: https://docs.loqate.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Property Intelligence (UK) in a Capture Retrieve call

> Request UK property attributes, such as bedrooms, age, energy rating and distance to water, alongside a standard address Retrieve.

## Overview

Property Intelligence supplies data on residential properties in England, Wales and Scotland. Northern Ireland has limited coverage. The Isle of Man and Channel Islands are not covered.

**1. Find the address.**

Use [Capture Find](https://docs.loqate.com/api-reference/address-capture/find.md) to get the `Id` of a UK address.

**2. Choose your fields**

Pick fields from the [field reference](#field-reference).

**3. Call Retrieve**

Pass each field as `FieldNFormat={FieldName}` and read the values from `FieldN`.

> [!NOTE]
>
> **Property Intelligence is a Premium Dataset.** Please contact your account manager to activate this on your account.

## Build a request

### Parameters

| Parameter | Required | Description |
| - | - | - |
| `Field1Format` … `Field20Format` | For PI fields | A field name in braces, such as `{Bedrooms}`. Separate several names in one parameter with commas. |
| `Fields` | Above 20 | Number of `FieldX` slots to return. The default is 20 and the maximum is 50. |

> [!NOTE]
>
> **Field limit.** A request returns 20 by default and 50 `FieldX` slots at most. If you need more than 20, add `Fields=`.

### Example request

```text Example URL theme={null}
https://api.addressy.com/Capture/Interactive/Retrieve/v1.30/json6.ws
  ?Key=AA11-AA11-AA11-AA11
  &Id=GB|RM|B|53165155|ENG
  &Field1Format={PropertyTypeDescription}
  &Field2Format={Bedrooms}
  &Field3Format={AgeDescription}
  &Field4Format={EnergyRating}
  &Field5Format={Watercourse200M}
  &Field6Format={UPRN}
```

```javascript JavaScript theme={null}
const fields = ["PropertyTypeDescription", "Bedrooms", "AgeDescription", "EnergyRating"];

const params = new URLSearchParams({ Key: "AA11-AA11-AA11-AA11", Id: addressId });
fields.forEach((f, i) => params.set(`Field${i + 1}Format`, `{${f}}`));
// More than 20 fields? params.set("Fields", fields.length);

const res  = await fetch(
  `https://api.addressy.com/Capture/Interactive/Retrieve/v1.30/json6.ws?${params}`);
const item = (await res.json()).Items[0];

// FieldN holds the value requested as FieldNFormat
const result = Object.fromEntries(fields.map((f, i) => [f, item[`Field${i + 1}`]]));
```

## Read the response

Each requested field comes back in the matching `FieldN` property of `Items[0]`, alongside the standard address fields. Every value is a string.

```json theme={null}
{
  "Items": [{
    "Id": "GB|RM|B|53165155|ENG",
    "Line1": "14 Eden Grove",
    "PostalCode": "CW4 8FP",
    "Field1": "Detached",
    "Field2": "3",
    "Field3": "1980 to date (Modern)",
    "Field4": "C",
    "Field5": "No",
    "Field6": "10014460505"
  }]
}
```

In this example, `Field1` is `PropertyTypeDescription`, `Field2` is `Bedrooms`, and so on in request order.

## Field reference

Use the **Retrieve field** name inside braces in FieldNFormat. Retrieve returns every value as a string. Fields marked England & Wales only aren't populated for Scotland or Northern Ireland.

### Property identifiers and location

| Retrieve field | Type | Description |
| - | - | - |
| `UPRN` | Integer | **UPRN.** Unique Property Reference Number from Ordnance Survey. |
| `UDPRN` | Integer | **UDPRN.** Unique Delivery Point Reference Number from Royal Mail. |
| `Easting` | Float | **Easting.** Ordnance Survey National Grid easting. |
| `Northing` | Float | **Northing.** Ordnance Survey National Grid northing. |
| `Latitude` | Float | **Latitude.** Latitude in ETRS89, converted from easting/northing using OSTN02. |
| `Longitude` | Float | **Longitude.** Longitude in ETRS89, converted from easting/northing using OSTN02. |
| `OA11CD` | Text | **Output area (Census 2011).** Census 2011 Output Area code from the ONS Postcode Directory. |
| `LSOA11CD` | Text | **Lower super output area (Census 2011).** Census 2011 LSOA code from the ONS Postcode Directory. |
| `OA21CD` | Text | **Output area (Census 2021).** Census 2021 Output Area code from the ONS Postcode Directory. |
| `LSOA21CD` | Text | **Lower super output area (Census 2021).** Census 2021 LSOA code from the ONS Postcode Directory. |

### Property

| Retrieve field | Type | Description |
| - | - | - |
| `PropertyTypeDescription` | Text | **Property type.** Detached, semi-detached, terraced or flat. |
| `Floors` | Text | **Number of floors.** Estimated number of floors, based on building height. |
| `Bedrooms` | Text | **Number of bedrooms.** Number of bedrooms. |
| `Bathrooms` | Text | **Number of bathrooms.** Number of bathrooms. |
| `TotalRooms` | Text | **Total rooms.** Number of rooms, excluding bathrooms and kitchens. |
| `FloorArea` | Text | **Floor area (m²).** Liveable floor area in square metres. |
| `Extensions` | Text | **Number of extensions.** Number of extensions; typically 1, up to 4. |
| `FlatFloor` | Text | **Storey of flat.** Storey on which a flat sits. Empty where not a flat or not available; may be modelled from source text. *England & Wales only* |
| `TopFloorFlat` | Text | **Top-floor flat.** Whether a flat is on the top floor of the building. *England & Wales only* |
| `IsMultires` | Text | **Multi-residential.** Flags multi-residential properties. |

### Age and listing

| Retrieve field | Type | Description |
| - | - | - |
| `AgeDescription` | Text | **Construction period.** Construction period of the building. |
| `AgeEarliest` | Text | **Earliest year of period.** Earliest year of the construction period. Returned alongside AgeDescription. |
| `AgeLatest` | Text | **Latest year of period.** Latest year of the construction period. Empty for 1980 to date. |
| `YearBuilt` | Text | **Year built.** Year built. Only available for buildings in Land Registry Price Paid data, built after 1995. |
| `ListedStatus` | Text | **Listed building.** Grade of listing, from Historic England, Cadw or Historic Environment Scotland. |

### Building geometry

| Retrieve field | Type | Description |
| - | - | - |
| `Cadastral` | Text | **Cadastral polygon area (m²).** Area of the cadastral parcel the building sits in, from Land Registry. *England & Wales only* |
| `Height` | Text | **Height (m).** Building height in metres. |
| `Footprint` | Text | **Footprint (m²).** Approximate building footprint in square metres. |
| `Volume` | Text | **Volume (m³).** Approximate building volume in cubic metres. |
| `AvgRoofSlope` | Text | **Average roof slope.** Average roof slope. Can identify flat roofs. |
| `FlatRoofFraction` | Text | **Flat roof fraction.** Estimated fraction of the building with a flat roof. |
| `GeocodeMultiplicity` | Text | **Geocode multiplicity.** Number of property geocodes within the building footprint at 1.8 m above ground. |

### Sale history and value

| Retrieve field | Type | Description |
| - | - | - |
| `LastTransactionPrice` | Text | **Last transaction price.** Price paid at the last Land Registry transaction (back to 1995). *England & Wales only* |
| `LastTransactionDate` | Text | **Last transaction date.** Date of the last Land Registry transaction (back to 1995). *England & Wales only* |
| `LastTransactionDurationType` | Text | **Last transaction duration type.** Duration type of the last transaction. *England & Wales only* |
| `EstCurrentValue` | Text | **Estimated current value.** Estimated current value, based on Land Registry data. *England & Wales only* |
| `NTransactions` | Text | **Number of transactions.** Number of Land Registry transactions (back to 1995). *England & Wales only* |
| `EstimatedCouncilTax` | Text | **Estimated council tax band.** Council tax band estimated from price at reference years, using Land Registry data. |

### Energy and construction

| Retrieve field | Type | Description |
| - | - | - |
| `WallType` | Text | **Wall type.** Type of wall construction. |
| `MainFuel` | Text | **Main central heating fuel.** Main central heating fuel. |
| `EnergyRating` | Text | **Energy rating.** Energy rating from the EPC. |
| `EpcInspectionDate` | Text | **EPC inspection date.** Inspection date on the EPC. |
| `Tenure` | Text | **Tenure.** Owner-occupier, rented or social housing. |

### Environment and risk

| Retrieve field | Type | Description |
| - | - | - |
| `Watercourse200M` | Text | **Within 200 m of watercourse.** Whether a watercourse is within 200 metres. |
| `DistanceToWater` | Text | **Distance to watercourse (m).** Distance to a watercourse, if within 200 metres. 0.0 when Watercourse200M is No. |
| `DistanceToTree` | Text | **Distance to tree (m).** Distance from the nearest tree over 10 m tall to the property geocode. |
| `BurglaryRate` | Text | **Burglary rate.** Burglaries per property per year, averaged over the LSOA. *England & Wales only* |

### Location and use

| Retrieve field | Type | Description |
| - | - | - |
| `DistanceToRoad` | Text | **Distance to road (m).** Distance to the centre line of the nearest road. Not necessarily accessible. |
| `RoadClass` | Text | **Road class.** Road class, from Ordnance Survey. |
| `BusinessUsage` | Text | **Business usage.** Flags potential business usage. |
| `PlanningClassification` | Text | **Planning classification.** Use class under the Town and Country Planning (Use Classes) Order 1987, for non-domestic properties. |
| `CongestionZone` | Text | **Congestion zone.** Whether the property is in the London Congestion Zone. |

## Flat file reference

Property Intelligence is also available as a flat file for GB. The data dictionary lists every field in the file with examples and fill rates.

[Property Intelligence data dictionary](https://docs.loqate.com/location-solutions/premium-data-sets/property-intelligence-data-directory.md)