Datasets
Last updated
Last updated
This page details the output results returned by the dataset query parameter for DPA or LPI.
The default is DPA. You can query both datasets by separating the values with a comma (DPA,LPI).
Please read this page in conjunction with Technical specification (see in particular the Response > results (array of object) > DPA (object) / LPI (object) dropdown of each query type.)
A Delivery Point Address (DPA) is one that Ordnance Survey has matched against a Royal Mail PAF address, including addresses within Northern Ireland, Channel Islands and Isle of Man. Not every property record has an associated DPA record. See AddressBase Premium technical guide for more information.
| Key | Description | Format | Size | Multiplicity |
|---|---|---|---|---|
A Land Property Identifier (LPI) address is a structured text entry that identifies a Basic Land and Property Unit (BLPU) within AddressBase® Premium and does not need to receive deliveries from the Royal Mail to exist. This means that some non-postal objects (for example, a church) can be included.
The AddressBase Premium data structure provides the facility to describe a BLPU by more than one LPI. In England and Scotland there is one Approved LPI, whereas in Wales there are two Approved LPIs (English and Welsh). See AddressBase Premium technical guide for more information.
| Key | Description | Format | Size | Multiplicity |
|---|---|---|---|---|
UPRN
The Unique Property Reference Number. For addresses in Northern Ireland, an empty string is returned.
integer
12
1
UDPRN
Royal Mail's Unique Delivery Point Reference Number.
integer
8
1
ADDRESS
String containing the concatenated address.
char
472
1
PO_BOX_NUMBER
Post Office Box (PO Box®) number.
char
6
0..1
ORGANISATION_NAME
The organisation name is the business name given to a delivery point within a building or small group of buildings. This field could also include entries for churches, public houses and libraries.
char
60
0..1
DEPARTMENT_NAME
In a few organisations, department name is indicated because mail is received by subdivisions of the main organisation at distinct delivery points.
char
60
0..1
SUB_BUILDING_NAME
The sub-building name and/or number are identifiers for subdivision of properties.
char
30
0..1
BUILDING_NAME
The building name is a description applied to a single building or a small group of buildings.
char
50
0..1
BUILDING_NUMBER
The building number, or postal number, is a number given to a single building or a small group of buildings.
integer
4
0..1
DEPENDENT_THOROUGHFARE_NAME
In certain places, for example, town centres, there are named thoroughfares within other named thoroughfares.
char
80
0..1
THOROUGHFARE_NAME
A road, track or named access route on which there are Royal Mail delivery points.
char
80
0..1
DOUBLE_DEPENDENT_LOCALITY
To distinguish between similar or same thoroughfares within a dependent locality.
char
35
0..1
DEPENDENT_LOCALITY
Dependent locality areas may define an area within a post town.
char
35
0..1
POST_TOWN
The town or city in which the Royal Mail sorting office is located.
char
30
1
POSTCODE
A postcode is an abbreviated form of address made up of combinations of between five and seven alphanumeric characters.
char
8
1
RPC
char
1
1
X_COORDINATE
Easting coordinates in metres, defining the location in the British National Grid spatial reference system.
float
6 (2)
1
Y_COORDINATE
Northing coordinates in metres, defining the location in the British National Grid spatial reference system.
float
7 (2)
1
LNG
Longitude coordinate, defined based on the requested projection.
float
9
0..1
LAT
Latitude coordinate, defined based on the requested projection.
float
9
0..1
STATUS
The status of the feature (i.e. APPROVED, ALTERNATIVE, PROVISIONAL, HISTORICAL). The AddressBase Premium product uses codes of 1,3,6,8 for these however the Address API will provide the text interpretation above.
char
11
1
MATCH (Conditional) - Only returned for find resource
The match score for the query against the returned address from 0 to 1. Resources other than Find will return a fixed value of 1.0.
float
1 (1)
0..1
MATCH_DESCRIPTION (Conditional) - Only returned for find resource
The description of the match. Exact: 1.0 (note: extra information in the input address that doesn’t match the ABPREM version is ignored). Good: 0.8 – 0.9 (most of the address matches, but a part of it may be different, such as a different postcode). Partial: 0.7 (address could represent the same address but has some significant differences). No Match: < 0.7. Resources other than Find will return a fixed value of Exact.
char
8
0..1
LANGUAGE
A code identifying the language in use for the record.
char
2
1
LOCAL_CUSTODIAN_CODE
Unique identifier of the Local Land and Property Gazetteer (LLPG) Custodian responsible for the maintenance of this record. Download the Local Custodian code list (ZIP).
integer
4
1
LOCAL_CUSTODIAN_CODE_DESCRIPTION
Description of the Local Land and Property Gazetteer (LLPG) Custodian responsible for the maintenance of this record.
char
as per code definition document
1
CLASSIFICATION_CODE
A description that describes the classification of the record, for example, CE01HE is a higher education establishment.
char
1, 2, 4, 6
1
CLASSIFICATION_CODE_DESCRIPTION
A description that describes the classification of the record, for example, CE01HE is a higher education establishment.
char
as per code definition document
1
POSTAL_ADDRESS_CODE
A code that describes the type of postal delivery that the object is subject to.
char
1
1
POSTAL_ADDRESS_CODE_DESCRIPTION
A description that describes the type of postal delivery that the object is subject to.
char
100
1
LOGICAL_STATUS_CODE
integer
1
1
BLPU_STATE_CODE
integer
1
1
BLPU_STATE_CODE_DESCRIPTION
A description for the physical nature of the property or land object. These are used to represent the physical state or the feature.
char
as per code definition document
0..1
TOPOGRAPHY_LAYER_TOID
Unique key for the application cross reference record.
char
20
1
PARENT_UPRN
UPRN of the parent record.
integer
12
0..1
LAST_UPDATE_DATE
Date this record was last updated.
date
date
1
ENTRY_DATE
Date of the data entry.
date
date
1
LEGAL_NAME
Registered legal name of organisation.
char
60
0..1
BLPU_STATE_DATE
Date at which the BLPU achieved its current state in the real-world.
date
date
0..1
DELIVERY_POINT_SUFFIX
A code to uniquely identify an individual delivery point within a postcode.
char
2
1
PARISH_CODE
Office for National Statistics (ONS) Parish code.
char
9
1
WARD_CODE
Office for National Statistics (ONS) Ward code.
char
9
1
UPRN
Foreign key used to reference the delivery point address to the corresponding BLPU.
integer
12
1
ADDRESS
Concatenated Address field.
char
504
1
LANGUAGE
A code identifying the language in use for the record.
char
2
1
USRN
Foreign key linking the Street record to the LPI record.
integer
8
1
LPI_KEY
Unique key for the LPI.
char
14
1
LEVEL
Memorandum of the vertical position of the address.
char
30
0..1
ORGANISATION
Name of current occupier on the fascia of the BLPU.
char
100
1
SAO_START_NUMBER
The number of the secondary addressable object (SAO) or the start of the number range.
integer
4
0..1
SAO_START_SUFFIX
The suffix to the sao_start_number field.
char
2
0..1
SAO_END_NUMBER
The end of the number range for the SAO.
integer
4
0..1
SAO_END_SUFFIX
The suffix to the sao_end_number field.
char
2
0..1
SAO_TEXT
Contains the building name or description for the SAO.
char
90
0..1
PAO_START_NUMBER
The number of the primary addressable object (PAO) or the start of the number range.
integer
4
0..1
PAO_START_SUFFIX
The suffix to the pao_start_number field.
char
2
0..1
PAO_END_NUMBER
The end of the number range for the PAO.
integer
4
0..1
PAO_END_SUFFIX
The suffix to the pao_end_number field.
char
2
0..1
PAO_TEXT
Contains the building name or description for the PAO.
char
90
0..1
STREET_DESCRIPTION
Name, description or street number.
char
100
0..1
LOCALITY_NAME
A LOCALITY defines an area or geographical identifier within a town, village or hamlet.
char
35
0..1
TOWN_NAME
Town name.
char
30
0..1
ADMINISTRATIVE_AREA
Local Highway Authority name.
char
30
0..1
AREA_NAME
Third level of geographic area name, for example, to record island names or property groups such as crofts.
char
35
0..1
POSTCODE_LOCATOR
Postcode of the coordinate for the BLPU based purely on a spatial match against Code-Point® with polygons. This field must be used in conjunction with the RPC field to determine the accuracy of its position.
char
8
1
RPC
char
1
1
X_COORDINATE
Easting coordinates in metres, defining the location in the British National Grid spatial reference system.
float
6 (2)
1
Y_COORDINATE
Northing coordinates in metres, defining the location in the British National Grid spatial reference system.
float
7 (2)
1
LNG
Longitude coordinate, defined based on the requested projection.
float
9
0..1
LAT
Latitude coordinate, defined based on the request projection.
float
9
0..1
STATUS
The status of the feature (i.e. APPROVED, ALTERNATIVE, PROVISIONAL, HISTORICAL). The AddressBase Premium product uses codes of 1,3,6,8 for these however the Address API will provide the text interpretation above.
char
11
1
MATCH (Conditional) - Only returned for find resource
The match score for the query against the returned address from 0 to 1. Resources other than Find will return a fixed value of 1.0.
float
1 (1)
0..1
MATCH_DESCRIPTION (Conditional) - Only returned for find resource
The description of the match. Exact: 1.0 (note: extra information in the input address that doesn’t match the ABPREM version is ignored). Good: 0.8 – 0.9 (most of the address matches, but a part of it may be different, such as a different postcode). Partial: 0.7 (address could represent the same address but has some significant differences). No Match: < 0.7. Resources other than Find will return a fixed value of Exact.
char
8
0..1
LOCAL_CUSTODIAN_CODE
Unique identifier of the Local Land and Property Gazetteer (LLPG) Custodian responsible for the maintenance of this record. Download the Local Custodian code list (ZIP).
integer
4
1
LOCAL_CUSTODIAN_CODE_DESCRIPTION
Description of the Local Land and Property Gazetteer (LLPG) Custodian responsible for the maintenance of this record.
char
as per code definition document
1
CLASSIFICATION_CODE
A code that describes the classification of the record, for example, CE01HE is a higher education establishment. Download the AddressBase classification code list (ZIP).
char
1, 2, 4, 6
1
CLASSIFICATION_CODE_DESCRIPTION
A description that describes the classification of the record, for example, CE01HE is a higher education establishment.
char
as per code definition document
1
POSTAL_ADDRESS_CODE
A code that describes the type of postal delivery that the object is subject to.
char
1
1
POSTAL_ADDRESS_CODE_DESCRIPTION
A description that describes the type of postal delivery that the object is subject to.
char
100
1
STREET_STATE_CODE
A code identifying the current state of the Street.
integer
1
0..1
STREET_STATE_CODE_DESCRIPTION
A description identifying the current state of the Street.
char
100
0..1
STREET_CLASSIFICATION_CODE
A code for the primary street classification.
char
2
0..1
STREET_CLASSIFICATION_CODE_DESCRIPTION
A description for the primary street classification.
char
as per code definition document
1
LOGICAL_STATUS_CODE
integer
1
1
BLPU_STATE_CODE
integer
1
1
BLPU_STATE_CODE_DESCRIPTION
A description for the physical nature of the property or land object. These are used to represent the physical state or the feature.
char
1
0..1
TOPOGRAPHY_LAYER_TOID
Unique key for the application cross reference record.
char
20
1
PARENT_UPRN
UPRN of the parent record.
integer
12
0..1
LAST_UPDATE_DATE
Date this record was last updated.
date
date
1
ENTRY_DATE
Date of the data entry.
date
date
1
LEGAL_NAME
Registered legal name of organisation.
char
60
0..1
BLPU_STATE_DATE
Date at which the BLPU achieved its current state in the real-world.
date
date
0..1
LPI_LOGICAL_STATUS_CODE
integer
1
1
LPI_LOGICAL_STATUS_CODE_DESCRIPTION
A description of the Logical Status reflects where the LPI has reached in its life cycle. Logical status is important in identification of the addresses’ requirements, for example, whether it is an alternative address or an historic address.
char
as per code definition document
0..1
PARISH_CODE
Office for National Statistics (ONS) Parish code.
char
9
1
WARD_CODE
Office for National Statistics (ONS) Ward code.
char
9
1
Representative Point Code: this describes the accuracy of the coordinate that has been allocated to the BLPU. See for more information.
A code for the logical status of the BLPU. See for more information.
A code for the physical nature of the property or land object. These are used to represent the physical state or the feature. See for more information.
Representative Point Code: this describes the accuracy of the coordinate that has been allocated to the BLPU. See for more information.
A code for the logical status of the BLPU. See for more information.
A code for the physical nature of the property or land object. These are used to represent the physical state or the feature. See for more information.
A code for the logical status of this record. See for more information.