Ordnance Survey Places (Preview)
The OS Places API provides a detailed view of an address and its life cycle. It contains all the records of AddressBase Premium and so provides all the information relating to an address or property from creation to retirement. It contains local authority, Ordnance Survey and Royal Mail addresses, current addresses, and alternatives for current addresses, provisional addresses (such as planning developments) and historic information.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Ordnance Survey |
| URL | https://www.ordnancesurvey.co.uk/business-government |
| technicalservices@os.uk |
| Connector Metadata | |
|---|---|
| Publisher | Ordnance Survey |
| Website | https://www.ordnancesurvey.co.uk/business-government |
| Privacy policy | https://www.ordnancesurvey.co.uk/governance/policies/privacy |
| Categories | Data;Business Intelligence |
Ordnance Survey Places lets users identify addresses accurately. Searches interrogate the Local Authority and the Royal Mail address datasets.
Requests can be made using a full or partial address, a postcode, or a unique property ID. Searches can also find addresses closest to a given point or all the addresses known within a user-defined area or circle.
Prerequisites
OS Places API requires an active license with Ordnance Survey. Customers must either sign up for a free trial, or premium subscriptions to generate access key required login to the API Connector.
How to get credentials
To find out more about subscription place options contact Ordnance Survey here: https://developer.ordnancesurvey.co.uk/content/contact-us
Getting started with your connector
The API documentation can be found here https://apidocs.os.uk/docs/os-places-overview
Our getting started guide covers how to build an app in power platform using Ordnance Survey's Places connector and can be found here: https://github.com/OrdnanceSurvey/OS-Places-MS-Power-Platform-Connector
Perform a free text address search in power apps: This can be done by adding a text box and a button to a simple canvas. By setting the button's OnSelect to:
Set (searchResults, OSPlaces.Find ('Search Bar'.Text).results) & UpdateContext({NoSearch: true})
The results from the search bar can be sent to the OSPlaces.Find definition and the results are stored in a variable called searchResults. The variable can be displayed as a gallery or data table in the canvas.
This approach is suitable for Find, Postcode, UPRN and coordinate defintions and is a good way to get started with the connector.
Known issues and limitations
The Match and Cleanse resources are not part of this connector as this has primarliy been designed as an address query tool and not a database cleansing tool within Power Platform.
FAQ
If you have any questions about using this connector please see our FAQs: https://developer.ordnancesurvey.co.uk/os-apis-developer-portal-faqs
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Bounding box operation |
Takes two points and creates a bounding box. All addresses within this bounding box are then returned. |
| Find Operation |
A free text search designed for quick use e.g. form filling. |
| Nearest operation |
Takes a pair of coordinates (X and Y) as an input to determine the closest address. |
| Polygon Operation |
A POST Request that takes a geoJSON polygon or multi-polygon object and returns all addresses that are in the object. |
| Postcode operation |
A search based on a property's postcode. The minimum for the resource is the area and district e.g. SO16, and will accept a full postcode consisting of the area, district, sector and unit e.g. SO16 0AS |
| Radius operation |
Takes a pair of coordinates as the centre for a circle and returns all addresses that are intersected by it. |
| UPRN Operation |
A search that takes a Unique Property Reference Number (UPRN) as the search parameter. |
Bounding box operation
Takes two points and creates a bounding box. All addresses within this bounding box are then returned.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Bounding box
|
bbox | True | string |
A pair of comma-separated coordinates with an accuracy of two decimal places or less, that specify the lower left and upper right coordinates of the bounding box. The maximum size of the bounding box is 1 km2. If the bounding box exceeds this, an error message is returned. The precision of the coordinates is to an accuracy of 8 metres. |
|
Result format
|
format | string |
The format in which the response will be returned. Default: JSON. Accepted values: JSON, XML |
|
|
Limit results
|
maxresults | integer |
The maximum number of results to return. Default: 100 |
|
|
Offset the result
|
offset | integer |
Offset the list of returned by this amount. |
|
|
Local Authority (LPI) and/or Royal Mail (DPA) address results
|
dataset | string |
The address dataset to return. Multiple values can be sent, separated by a comma. Default: DPA. Accepted values: DPA, LPI |
|
|
Language
|
lr | string |
Which language of addresses to return. Valid languages are English and Welsh. Filter only applicable to DPA dataset. Default value is both languages. Default: EN, CY. |
|
|
Filter
|
fq | string |
A filter that allows filtering of results by classification code and/or logical status code. Filtering for classification code will accept wildcard (*) searches. Multiple searches can be done on classification code seperating the classification code parameter with a space. Classification code filters can be ran with logical status code filters by using the parameter multiple times: fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6 |
|
|
Output spatial reference system
|
output_srs | string |
The intended output spatial reference system. Default: EPSG:27700. |
|
|
Input coordinate reference system
|
srs | string |
The spatial reference system for the input coordinate set. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
uri
|
header.uri | string |
uri |
|
query
|
header.query | string |
query |
|
offset
|
header.offset | integer |
offset |
|
totalresults
|
header.totalresults | integer |
totalresults |
|
format
|
header.format | string |
format |
|
dataset
|
header.dataset | string |
dataset |
|
lr
|
header.lr | string |
lr |
|
maxresults
|
header.maxresults | integer |
maxresults |
|
matchprecision
|
header.matchprecision | integer |
matchprecision |
|
epoch
|
header.epoch | string |
epoch |
|
output_srs
|
header.output_srs | string |
output_srs |
|
results
|
results | array of object |
results |
|
UPRN
|
results.DPA.UPRN | string |
UPRN |
|
ADDRESS
|
results.DPA.ADDRESS | string |
ADDRESS |
|
ORGANISATION_NAME
|
results.DPA.ORGANISATION_NAME | string |
ORGANISATION_NAME |
|
BUILDING_NUMBER
|
results.DPA.BUILDING_NUMBER | string |
BUILDING_NUMBER |
|
THOROUGHFARE_NAME
|
results.DPA.THOROUGHFARE_NAME | string |
THOROUGHFARE_NAME |
|
DEPENDENT_LOCALITY
|
results.DPA.DEPENDENT_LOCALITY | string |
DEPENDENT_LOCALITY |
|
POST_TOWN
|
results.DPA.POST_TOWN | string |
POST_TOWN |
|
POSTCODE
|
results.DPA.POSTCODE | string |
POSTCODE |
|
RPC
|
results.DPA.RPC | string |
RPC |
|
X_COORDINATE
|
results.DPA.X_COORDINATE | float |
X_COORDINATE |
|
Y_COORDINATE
|
results.DPA.Y_COORDINATE | float |
Y_COORDINATE |
|
STATUS
|
results.DPA.STATUS | string |
STATUS |
|
LOGICAL_STATUS_CODE
|
results.DPA.LOGICAL_STATUS_CODE | string |
LOGICAL_STATUS_CODE |
|
CLASSIFICATION_CODE
|
results.DPA.CLASSIFICATION_CODE | string |
CLASSIFICATION_CODE |
|
CLASSIFICATION_CODE_DESCRIPTION
|
results.DPA.CLASSIFICATION_CODE_DESCRIPTION | string |
CLASSIFICATION_CODE_DESCRIPTION |
|
LOCAL_CUSTODIAN_CODE
|
results.DPA.LOCAL_CUSTODIAN_CODE | integer |
LOCAL_CUSTODIAN_CODE |
|
LOCAL_CUSTODIAN_CODE_DESCRIPTION
|
results.DPA.LOCAL_CUSTODIAN_CODE_DESCRIPTION | string |
LOCAL_CUSTODIAN_CODE_DESCRIPTION |
|
POSTAL_ADDRESS_CODE
|
results.DPA.POSTAL_ADDRESS_CODE | string |
POSTAL_ADDRESS_CODE |
|
POSTAL_ADDRESS_CODE_DESCRIPTION
|
results.DPA.POSTAL_ADDRESS_CODE_DESCRIPTION | string |
POSTAL_ADDRESS_CODE_DESCRIPTION |
|
BLPU_STATE_CODE
|
results.DPA.BLPU_STATE_CODE | string |
BLPU_STATE_CODE |
|
BLPU_STATE_CODE_DESCRIPTION
|
results.DPA.BLPU_STATE_CODE_DESCRIPTION | string |
BLPU_STATE_CODE_DESCRIPTION |
|
TOPOGRAPHY_LAYER_TOID
|
results.DPA.TOPOGRAPHY_LAYER_TOID | string |
TOPOGRAPHY_LAYER_TOID |
|
LAST_UPDATE_DATE
|
results.DPA.LAST_UPDATE_DATE | string |
LAST_UPDATE_DATE |
|
ENTRY_DATE
|
results.DPA.ENTRY_DATE | string |
ENTRY_DATE |
|
BLPU_STATE_DATE
|
results.DPA.BLPU_STATE_DATE | string |
BLPU_STATE_DATE |
|
LANGUAGE
|
results.DPA.LANGUAGE | string |
LANGUAGE |
|
MATCH
|
results.DPA.MATCH | float |
MATCH |
|
MATCH_DESCRIPTION
|
results.DPA.MATCH_DESCRIPTION | string |
MATCH_DESCRIPTION |
|
UPRN
|
results.LPI.UPRN | string |
UPRN |
|
ADDRESS
|
results.LPI.ADDRESS | string |
ADDRESS |
|
USRN
|
results.LPI.USRN | string |
USRN |
|
LPI_KEY
|
results.LPI.LPI_KEY | string |
LPI_KEY |
|
PAO_START_NUMBER
|
results.LPI.PAO_START_NUMBER | string |
PAO_START_NUMBER |
|
STREET_DESCRIPTION
|
results.LPI.STREET_DESCRIPTION | string |
STREET_DESCRIPTION |
|
TOWN_NAME
|
results.LPI.TOWN_NAME | string |
TOWN_NAME |
|
ADMINISTRATIVE_AREA
|
results.LPI.ADMINISTRATIVE_AREA | string |
ADMINISTRATIVE_AREA |
|
POSTCODE_LOCATOR
|
results.LPI.POSTCODE_LOCATOR | string |
POSTCODE_LOCATOR |
|
RPC
|
results.LPI.RPC | string |
RPC |
|
X_COORDINATE
|
results.LPI.X_COORDINATE | float |
X_COORDINATE |
|
Y_COORDINATE
|
results.LPI.Y_COORDINATE | float |
Y_COORDINATE |
|
STATUS
|
results.LPI.STATUS | string |
STATUS |
|
LOGICAL_STATUS_CODE
|
results.LPI.LOGICAL_STATUS_CODE | string |
LOGICAL_STATUS_CODE |
|
CLASSIFICATION_CODE
|
results.LPI.CLASSIFICATION_CODE | string |
CLASSIFICATION_CODE |
|
CLASSIFICATION_CODE_DESCRIPTION
|
results.LPI.CLASSIFICATION_CODE_DESCRIPTION | string |
CLASSIFICATION_CODE_DESCRIPTION |
|
LOCAL_CUSTODIAN_CODE
|
results.LPI.LOCAL_CUSTODIAN_CODE | integer |
LOCAL_CUSTODIAN_CODE |
|
LOCAL_CUSTODIAN_CODE_DESCRIPTION
|
results.LPI.LOCAL_CUSTODIAN_CODE_DESCRIPTION | string |
LOCAL_CUSTODIAN_CODE_DESCRIPTION |
|
POSTAL_ADDRESS_CODE
|
results.LPI.POSTAL_ADDRESS_CODE | string |
POSTAL_ADDRESS_CODE |
|
POSTAL_ADDRESS_CODE_DESCRIPTION
|
results.LPI.POSTAL_ADDRESS_CODE_DESCRIPTION | string |
POSTAL_ADDRESS_CODE_DESCRIPTION |
|
BLPU_STATE_CODE_DESCRIPTION
|
results.LPI.BLPU_STATE_CODE_DESCRIPTION | string |
BLPU_STATE_CODE_DESCRIPTION |
|
TOPOGRAPHY_LAYER_TOID
|
results.LPI.TOPOGRAPHY_LAYER_TOID | string |
TOPOGRAPHY_LAYER_TOID |
|
LAST_UPDATE_DATE
|
results.LPI.LAST_UPDATE_DATE | string |
LAST_UPDATE_DATE |
|
ENTRY_DATE
|
results.LPI.ENTRY_DATE | string |
ENTRY_DATE |
|
STREET_STATE_CODE
|
results.LPI.STREET_STATE_CODE | string |
STREET_STATE_CODE |
|
STREET_STATE_CODE_DESCRIPTION
|
results.LPI.STREET_STATE_CODE_DESCRIPTION | string |
STREET_STATE_CODE_DESCRIPTION |
|
STREET_CLASSIFICATION_CODE
|
results.LPI.STREET_CLASSIFICATION_CODE | string |
STREET_CLASSIFICATION_CODE |
|
STREET_CLASSIFICATION_CODE_DESCRIPTION
|
results.LPI.STREET_CLASSIFICATION_CODE_DESCRIPTION | string |
STREET_CLASSIFICATION_CODE_DESCRIPTION |
|
LPI_LOGICAL_STATUS_CODE
|
results.LPI.LPI_LOGICAL_STATUS_CODE | string |
LPI_LOGICAL_STATUS_CODE |
|
LPI_LOGICAL_STATUS_CODE_DESCRIPTION
|
results.LPI.LPI_LOGICAL_STATUS_CODE_DESCRIPTION | string |
LPI_LOGICAL_STATUS_CODE_DESCRIPTION |
|
LANGUAGE
|
results.LPI.LANGUAGE | string |
LANGUAGE |
|
MATCH
|
results.LPI.MATCH | float |
MATCH |
|
MATCH_DESCRIPTION
|
results.LPI.MATCH_DESCRIPTION | string |
MATCH_DESCRIPTION |
Find Operation
A free text search designed for quick use e.g. form filling.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The address query.
|
query | True | string |
The free text search parameter. |
|
Result format
|
format | string |
The format in which the response will be returned. Default: JSON. Accepted values: 'JSON', 'XML' |
|
|
Limit results
|
maxresults | integer |
The maximum number of results to return. Default: 100 |
|
|
Offset the result
|
offset | integer |
Offset the list of returned by this amount. |
|
|
Local Authority (LPI) and/or Royal Mail (DPA) address results
|
dataset | string |
The address dataset to return. Multiple values can be sent, separated by a comma. Default: DPA. Accepted Values: DPA, LPI |
|
|
Language
|
lr | string |
Which language of addresses to return. Valid languages are English and Welsh. Filter only applicable to DPA dataset. Default value is both languages. Default: EN, CY. |
|
|
Limit results based on address matching score
|
minmatch | number |
The minimum match score a result has to have to be returned. Accepted values: 0.1 - 1.0 (inclusive) |
|
|
Match score precision
|
matchprecision | integer |
The decimal point position at which the match score value is to be truncated. Accepted values: 1-10 |
|
|
Filter
|
fq | string |
A filter that allows filtering of results by classification code and/or logical status code. Filtering for classification code will accept wildcard (*) searches. Multiple searches can be done on classification code seperating the classification code parameter with a space. Classification code filters can be ran with logical status code filters by using the parameter multiple times: fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6 |
|
|
Output spatial reference system
|
output_srs | string |
The intended output spatial reference system. Default: EPSG:27700. Accepted values: BNG, EPSG:27700, WGS84, EPSG:4326, EPSG:3857, EPSG:4258 |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
uri
|
header.uri | string |
uri |
|
query
|
header.query | string |
query |
|
offset
|
header.offset | integer |
offset |
|
totalresults
|
header.totalresults | integer |
totalresults |
|
format
|
header.format | string |
format |
|
dataset
|
header.dataset | string |
dataset |
|
lr
|
header.lr | string |
lr |
|
maxresults
|
header.maxresults | integer |
maxresults |
|
matchprecision
|
header.matchprecision | integer |
matchprecision |
|
epoch
|
header.epoch | string |
epoch |
|
output_srs
|
header.output_srs | string |
output_srs |
|
results
|
results | array of object |
results |
|
UPRN
|
results.DPA.UPRN | string |
UPRN |
|
ADDRESS
|
results.DPA.ADDRESS | string |
ADDRESS |
|
ORGANISATION_NAME
|
results.DPA.ORGANISATION_NAME | string |
ORGANISATION_NAME |
|
BUILDING_NUMBER
|
results.DPA.BUILDING_NUMBER | string |
BUILDING_NUMBER |
|
THOROUGHFARE_NAME
|
results.DPA.THOROUGHFARE_NAME | string |
THOROUGHFARE_NAME |
|
DEPENDENT_LOCALITY
|
results.DPA.DEPENDENT_LOCALITY | string |
DEPENDENT_LOCALITY |
|
POST_TOWN
|
results.DPA.POST_TOWN | string |
POST_TOWN |
|
POSTCODE
|
results.DPA.POSTCODE | string |
POSTCODE |
|
RPC
|
results.DPA.RPC | string |
RPC |
|
X_COORDINATE
|
results.DPA.X_COORDINATE | float |
X_COORDINATE |
|
Y_COORDINATE
|
results.DPA.Y_COORDINATE | float |
Y_COORDINATE |
|
STATUS
|
results.DPA.STATUS | string |
STATUS |
|
LOGICAL_STATUS_CODE
|
results.DPA.LOGICAL_STATUS_CODE | string |
LOGICAL_STATUS_CODE |
|
CLASSIFICATION_CODE
|
results.DPA.CLASSIFICATION_CODE | string |
CLASSIFICATION_CODE |
|
CLASSIFICATION_CODE_DESCRIPTION
|
results.DPA.CLASSIFICATION_CODE_DESCRIPTION | string |
CLASSIFICATION_CODE_DESCRIPTION |
|
LOCAL_CUSTODIAN_CODE
|
results.DPA.LOCAL_CUSTODIAN_CODE | integer |
LOCAL_CUSTODIAN_CODE |
|
LOCAL_CUSTODIAN_CODE_DESCRIPTION
|
results.DPA.LOCAL_CUSTODIAN_CODE_DESCRIPTION | string |
LOCAL_CUSTODIAN_CODE_DESCRIPTION |
|
POSTAL_ADDRESS_CODE
|
results.DPA.POSTAL_ADDRESS_CODE | string |
POSTAL_ADDRESS_CODE |
|
POSTAL_ADDRESS_CODE_DESCRIPTION
|
results.DPA.POSTAL_ADDRESS_CODE_DESCRIPTION | string |
POSTAL_ADDRESS_CODE_DESCRIPTION |
|
BLPU_STATE_CODE
|
results.DPA.BLPU_STATE_CODE | string |
BLPU_STATE_CODE |
|
BLPU_STATE_CODE_DESCRIPTION
|
results.DPA.BLPU_STATE_CODE_DESCRIPTION | string |
BLPU_STATE_CODE_DESCRIPTION |
|
TOPOGRAPHY_LAYER_TOID
|
results.DPA.TOPOGRAPHY_LAYER_TOID | string |
TOPOGRAPHY_LAYER_TOID |
|
LAST_UPDATE_DATE
|
results.DPA.LAST_UPDATE_DATE | string |
LAST_UPDATE_DATE |
|
ENTRY_DATE
|
results.DPA.ENTRY_DATE | string |
ENTRY_DATE |
|
BLPU_STATE_DATE
|
results.DPA.BLPU_STATE_DATE | string |
BLPU_STATE_DATE |
|
LANGUAGE
|
results.DPA.LANGUAGE | string |
LANGUAGE |
|
MATCH
|
results.DPA.MATCH | float |
MATCH |
|
MATCH_DESCRIPTION
|
results.DPA.MATCH_DESCRIPTION | string |
MATCH_DESCRIPTION |
|
UPRN
|
results.LPI.UPRN | string |
UPRN |
|
ADDRESS
|
results.LPI.ADDRESS | string |
ADDRESS |
|
USRN
|
results.LPI.USRN | string |
USRN |
|
LPI_KEY
|
results.LPI.LPI_KEY | string |
LPI_KEY |
|
PAO_START_NUMBER
|
results.LPI.PAO_START_NUMBER | string |
PAO_START_NUMBER |
|
STREET_DESCRIPTION
|
results.LPI.STREET_DESCRIPTION | string |
STREET_DESCRIPTION |
|
TOWN_NAME
|
results.LPI.TOWN_NAME | string |
TOWN_NAME |
|
ADMINISTRATIVE_AREA
|
results.LPI.ADMINISTRATIVE_AREA | string |
ADMINISTRATIVE_AREA |
|
POSTCODE_LOCATOR
|
results.LPI.POSTCODE_LOCATOR | string |
POSTCODE_LOCATOR |
|
RPC
|
results.LPI.RPC | string |
RPC |
|
X_COORDINATE
|
results.LPI.X_COORDINATE | float |
X_COORDINATE |
|
Y_COORDINATE
|
results.LPI.Y_COORDINATE | float |
Y_COORDINATE |
|
STATUS
|
results.LPI.STATUS | string |
STATUS |
|
LOGICAL_STATUS_CODE
|
results.LPI.LOGICAL_STATUS_CODE | string |
LOGICAL_STATUS_CODE |
|
CLASSIFICATION_CODE
|
results.LPI.CLASSIFICATION_CODE | string |
CLASSIFICATION_CODE |
|
CLASSIFICATION_CODE_DESCRIPTION
|
results.LPI.CLASSIFICATION_CODE_DESCRIPTION | string |
CLASSIFICATION_CODE_DESCRIPTION |
|
LOCAL_CUSTODIAN_CODE
|
results.LPI.LOCAL_CUSTODIAN_CODE | integer |
LOCAL_CUSTODIAN_CODE |
|
LOCAL_CUSTODIAN_CODE_DESCRIPTION
|
results.LPI.LOCAL_CUSTODIAN_CODE_DESCRIPTION | string |
LOCAL_CUSTODIAN_CODE_DESCRIPTION |
|
POSTAL_ADDRESS_CODE
|
results.LPI.POSTAL_ADDRESS_CODE | string |
POSTAL_ADDRESS_CODE |
|
POSTAL_ADDRESS_CODE_DESCRIPTION
|
results.LPI.POSTAL_ADDRESS_CODE_DESCRIPTION | string |
POSTAL_ADDRESS_CODE_DESCRIPTION |
|
BLPU_STATE_CODE_DESCRIPTION
|
results.LPI.BLPU_STATE_CODE_DESCRIPTION | string |
BLPU_STATE_CODE_DESCRIPTION |
|
TOPOGRAPHY_LAYER_TOID
|
results.LPI.TOPOGRAPHY_LAYER_TOID | string |
TOPOGRAPHY_LAYER_TOID |
|
LAST_UPDATE_DATE
|
results.LPI.LAST_UPDATE_DATE | string |
LAST_UPDATE_DATE |
|
ENTRY_DATE
|
results.LPI.ENTRY_DATE | string |
ENTRY_DATE |
|
STREET_STATE_CODE
|
results.LPI.STREET_STATE_CODE | string |
STREET_STATE_CODE |
|
STREET_STATE_CODE_DESCRIPTION
|
results.LPI.STREET_STATE_CODE_DESCRIPTION | string |
STREET_STATE_CODE_DESCRIPTION |
|
STREET_CLASSIFICATION_CODE
|
results.LPI.STREET_CLASSIFICATION_CODE | string |
STREET_CLASSIFICATION_CODE |
|
STREET_CLASSIFICATION_CODE_DESCRIPTION
|
results.LPI.STREET_CLASSIFICATION_CODE_DESCRIPTION | string |
STREET_CLASSIFICATION_CODE_DESCRIPTION |
|
LPI_LOGICAL_STATUS_CODE
|
results.LPI.LPI_LOGICAL_STATUS_CODE | string |
LPI_LOGICAL_STATUS_CODE |
|
LPI_LOGICAL_STATUS_CODE_DESCRIPTION
|
results.LPI.LPI_LOGICAL_STATUS_CODE_DESCRIPTION | string |
LPI_LOGICAL_STATUS_CODE_DESCRIPTION |
|
LANGUAGE
|
results.LPI.LANGUAGE | string |
LANGUAGE |
|
MATCH
|
results.LPI.MATCH | float |
MATCH |
|
MATCH_DESCRIPTION
|
results.LPI.MATCH_DESCRIPTION | string |
MATCH_DESCRIPTION |
Nearest operation
Takes a pair of coordinates (X and Y) as an input to determine the closest address.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
A set of comma-separated coordinates
|
point | True | string |
One comma-separated coordinate set that specifies the coordinate to which the nearest record in a straight line should be found. The maximum distance the search will try is 1,000 metres. The precision of the coordinates is to two decimal places (that is, 1 cm accuracy). |
|
Search radius
|
radius | integer |
The radius in metres to search within. Maximum is 1,000 metres. If the radius exceeds that amount then an error message will be returned (see below). The precision of the distance is to two decimal places (that is, 1 cm accuracy). Default: 100. |
|
|
Result format
|
format | string |
The format in which the response will be returned. Default: JSON. Accepted values: JSON, XML |
|
|
Local Authority (LPI) and/or Royal Mail (DPA) address results
|
dataset | string |
The address dataset to return. Multiple values can be sent, separated by a comma. Default: DPA. Accepted values: DPA, LPI |
|
|
Language
|
lr | string |
Which language of addresses to return. Valid languages are English and Welsh. Filter only applicable to DPA dataset. Default value is both languages. Default: EN, CY |
|
|
Filter
|
fq | string |
A filter that allows filtering of results by classification code and/or logical status code. Filtering for classification code will accept wildcard (*) searches. Multiple searches can be done on classification code seperating the classification code parameter with a space. Classification code filters can be ran with logical status code filters by using the parameter multiple times: fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6 |
|
|
Output spatial reference system
|
output_srs | string |
The intended output spatial reference system. Default: EPSG:27700. Accepted values: BNG, EPSG:27700, WGS84, EPSG:4326, EPSG:3857, EPSG:4258 |
|
|
Input spatial reference system
|
srs | string |
The spatial reference system for the input coordinate set. Accepted values: 'BNG', 'EPSG:27700', 'WGS84', 'EPSG:4326', 'EPSG:3857', 'EPSG:4258' |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
uri
|
header.uri | string |
uri |
|
query
|
header.query | string |
query |
|
offset
|
header.offset | integer |
offset |
|
totalresults
|
header.totalresults | integer |
totalresults |
|
format
|
header.format | string |
format |
|
dataset
|
header.dataset | string |
dataset |
|
lr
|
header.lr | string |
lr |
|
maxresults
|
header.maxresults | integer |
maxresults |
|
matchprecision
|
header.matchprecision | integer |
matchprecision |
|
epoch
|
header.epoch | string |
epoch |
|
output_srs
|
header.output_srs | string |
output_srs |
|
results
|
results | array of object |
results |
|
UPRN
|
results.DPA.UPRN | string |
UPRN |
|
ADDRESS
|
results.DPA.ADDRESS | string |
ADDRESS |
|
ORGANISATION_NAME
|
results.DPA.ORGANISATION_NAME | string |
ORGANISATION_NAME |
|
BUILDING_NUMBER
|
results.DPA.BUILDING_NUMBER | string |
BUILDING_NUMBER |
|
THOROUGHFARE_NAME
|
results.DPA.THOROUGHFARE_NAME | string |
THOROUGHFARE_NAME |
|
DEPENDENT_LOCALITY
|
results.DPA.DEPENDENT_LOCALITY | string |
DEPENDENT_LOCALITY |
|
POST_TOWN
|
results.DPA.POST_TOWN | string |
POST_TOWN |
|
POSTCODE
|
results.DPA.POSTCODE | string |
POSTCODE |
|
RPC
|
results.DPA.RPC | string |
RPC |
|
X_COORDINATE
|
results.DPA.X_COORDINATE | float |
X_COORDINATE |
|
Y_COORDINATE
|
results.DPA.Y_COORDINATE | float |
Y_COORDINATE |
|
STATUS
|
results.DPA.STATUS | string |
STATUS |
|
LOGICAL_STATUS_CODE
|
results.DPA.LOGICAL_STATUS_CODE | string |
LOGICAL_STATUS_CODE |
|
CLASSIFICATION_CODE
|
results.DPA.CLASSIFICATION_CODE | string |
CLASSIFICATION_CODE |
|
CLASSIFICATION_CODE_DESCRIPTION
|
results.DPA.CLASSIFICATION_CODE_DESCRIPTION | string |
CLASSIFICATION_CODE_DESCRIPTION |
|
LOCAL_CUSTODIAN_CODE
|
results.DPA.LOCAL_CUSTODIAN_CODE | integer |
LOCAL_CUSTODIAN_CODE |
|
LOCAL_CUSTODIAN_CODE_DESCRIPTION
|
results.DPA.LOCAL_CUSTODIAN_CODE_DESCRIPTION | string |
LOCAL_CUSTODIAN_CODE_DESCRIPTION |
|
POSTAL_ADDRESS_CODE
|
results.DPA.POSTAL_ADDRESS_CODE | string |
POSTAL_ADDRESS_CODE |
|
POSTAL_ADDRESS_CODE_DESCRIPTION
|
results.DPA.POSTAL_ADDRESS_CODE_DESCRIPTION | string |
POSTAL_ADDRESS_CODE_DESCRIPTION |
|
BLPU_STATE_CODE
|
results.DPA.BLPU_STATE_CODE | string |
BLPU_STATE_CODE |
|
BLPU_STATE_CODE_DESCRIPTION
|
results.DPA.BLPU_STATE_CODE_DESCRIPTION | string |
BLPU_STATE_CODE_DESCRIPTION |
|
TOPOGRAPHY_LAYER_TOID
|
results.DPA.TOPOGRAPHY_LAYER_TOID | string |
TOPOGRAPHY_LAYER_TOID |
|
LAST_UPDATE_DATE
|
results.DPA.LAST_UPDATE_DATE | string |
LAST_UPDATE_DATE |
|
ENTRY_DATE
|
results.DPA.ENTRY_DATE | string |
ENTRY_DATE |
|
BLPU_STATE_DATE
|
results.DPA.BLPU_STATE_DATE | string |
BLPU_STATE_DATE |
|
LANGUAGE
|
results.DPA.LANGUAGE | string |
LANGUAGE |
|
MATCH
|
results.DPA.MATCH | float |
MATCH |
|
MATCH_DESCRIPTION
|
results.DPA.MATCH_DESCRIPTION | string |
MATCH_DESCRIPTION |
|
UPRN
|
results.LPI.UPRN | string |
UPRN |
|
ADDRESS
|
results.LPI.ADDRESS | string |
ADDRESS |
|
USRN
|
results.LPI.USRN | string |
USRN |
|
LPI_KEY
|
results.LPI.LPI_KEY | string |
LPI_KEY |
|
PAO_START_NUMBER
|
results.LPI.PAO_START_NUMBER | string |
PAO_START_NUMBER |
|
STREET_DESCRIPTION
|
results.LPI.STREET_DESCRIPTION | string |
STREET_DESCRIPTION |
|
TOWN_NAME
|
results.LPI.TOWN_NAME | string |
TOWN_NAME |
|
ADMINISTRATIVE_AREA
|
results.LPI.ADMINISTRATIVE_AREA | string |
ADMINISTRATIVE_AREA |
|
POSTCODE_LOCATOR
|
results.LPI.POSTCODE_LOCATOR | string |
POSTCODE_LOCATOR |
|
RPC
|
results.LPI.RPC | string |
RPC |
|
X_COORDINATE
|
results.LPI.X_COORDINATE | float |
X_COORDINATE |
|
Y_COORDINATE
|
results.LPI.Y_COORDINATE | float |
Y_COORDINATE |
|
STATUS
|
results.LPI.STATUS | string |
STATUS |
|
LOGICAL_STATUS_CODE
|
results.LPI.LOGICAL_STATUS_CODE | string |
LOGICAL_STATUS_CODE |
|
CLASSIFICATION_CODE
|
results.LPI.CLASSIFICATION_CODE | string |
CLASSIFICATION_CODE |
|
CLASSIFICATION_CODE_DESCRIPTION
|
results.LPI.CLASSIFICATION_CODE_DESCRIPTION | string |
CLASSIFICATION_CODE_DESCRIPTION |
|
LOCAL_CUSTODIAN_CODE
|
results.LPI.LOCAL_CUSTODIAN_CODE | integer |
LOCAL_CUSTODIAN_CODE |
|
LOCAL_CUSTODIAN_CODE_DESCRIPTION
|
results.LPI.LOCAL_CUSTODIAN_CODE_DESCRIPTION | string |
LOCAL_CUSTODIAN_CODE_DESCRIPTION |
|
POSTAL_ADDRESS_CODE
|
results.LPI.POSTAL_ADDRESS_CODE | string |
POSTAL_ADDRESS_CODE |
|
POSTAL_ADDRESS_CODE_DESCRIPTION
|
results.LPI.POSTAL_ADDRESS_CODE_DESCRIPTION | string |
POSTAL_ADDRESS_CODE_DESCRIPTION |
|
BLPU_STATE_CODE_DESCRIPTION
|
results.LPI.BLPU_STATE_CODE_DESCRIPTION | string |
BLPU_STATE_CODE_DESCRIPTION |
|
TOPOGRAPHY_LAYER_TOID
|
results.LPI.TOPOGRAPHY_LAYER_TOID | string |
TOPOGRAPHY_LAYER_TOID |
|
LAST_UPDATE_DATE
|
results.LPI.LAST_UPDATE_DATE | string |
LAST_UPDATE_DATE |
|
ENTRY_DATE
|
results.LPI.ENTRY_DATE | string |
ENTRY_DATE |
|
STREET_STATE_CODE
|
results.LPI.STREET_STATE_CODE | string |
STREET_STATE_CODE |
|
STREET_STATE_CODE_DESCRIPTION
|
results.LPI.STREET_STATE_CODE_DESCRIPTION | string |
STREET_STATE_CODE_DESCRIPTION |
|
STREET_CLASSIFICATION_CODE
|
results.LPI.STREET_CLASSIFICATION_CODE | string |
STREET_CLASSIFICATION_CODE |
|
STREET_CLASSIFICATION_CODE_DESCRIPTION
|
results.LPI.STREET_CLASSIFICATION_CODE_DESCRIPTION | string |
STREET_CLASSIFICATION_CODE_DESCRIPTION |
|
LPI_LOGICAL_STATUS_CODE
|
results.LPI.LPI_LOGICAL_STATUS_CODE | string |
LPI_LOGICAL_STATUS_CODE |
|
LPI_LOGICAL_STATUS_CODE_DESCRIPTION
|
results.LPI.LPI_LOGICAL_STATUS_CODE_DESCRIPTION | string |
LPI_LOGICAL_STATUS_CODE_DESCRIPTION |
|
LANGUAGE
|
results.LPI.LANGUAGE | string |
LANGUAGE |
|
MATCH
|
results.LPI.MATCH | float |
MATCH |
|
MATCH_DESCRIPTION
|
results.LPI.MATCH_DESCRIPTION | string |
MATCH_DESCRIPTION |
Polygon Operation
A POST Request that takes a geoJSON polygon or multi-polygon object and returns all addresses that are in the object.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Reference point
|
referencepoint | integer |
Reference point geometry is the basis from which the distance value is calculated. Output is ordered by ascending distance from given reference point only if parameter has been specified. |
|
|
Limit results
|
maxresults | integer |
The maximum number of results to return. Default: 100 |
|
|
Local Authority (LPI) and/or Royal Mail (DPA) address results
|
dataset | string |
The address dataset to return. Multiple values can be sent, separated by a comma. Default: DPA. Accepted values: DPA, LPI |
|
|
Offset the result
|
offset | integer |
Offset the list of returned by this amount. |
|
|
Language
|
lr | string |
Which language of addresses to return. Valid languages are English and Welsh. Filter only applicable to DPA dataset. Default value is both languages. Default: EN, CY. |
|
|
Filter
|
fq | string |
A filter that allows filtering of results by classification code and/or logical status code. Filtering for classification code will accept wildcard (*) searches. Multiple searches can be done on classification code seperating the classification code parameter with a space. Classification code filters can be ran with logical status code filters by using the parameter multiple times: fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6 |
|
|
Output spatial reference system
|
output_srs | string |
The intended output spatial reference system. Default: EPSG:27700. Accepted values: 'BNG', 'EPSG:27700', 'WGS84', 'EPSG:4326', 'EPSG:3857', 'EPSG:4258' |
|
|
Input coordinate reference system
|
srs | string |
The spatial reference system for the input coordinate set. |
|
|
Content-Type
|
Content-type | True | string |
The Content-Type header. Accepted values: 'application/json' |
|
type
|
type | True | string |
The first name:value pair for the geoJSON polygon. Accepted values: A feature |
|
geometry
|
geometry | True | string |
Here is where the polygon object is placed. Accepted values: A polygon object |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
uri
|
header.uri | string |
uri |
|
query
|
header.query | string |
query |
|
offset
|
header.offset | integer |
offset |
|
totalresults
|
header.totalresults | integer |
totalresults |
|
format
|
header.format | string |
format |
|
dataset
|
header.dataset | string |
dataset |
|
lr
|
header.lr | string |
lr |
|
maxresults
|
header.maxresults | integer |
maxresults |
|
matchprecision
|
header.matchprecision | integer |
matchprecision |
|
epoch
|
header.epoch | string |
epoch |
|
output_srs
|
header.output_srs | string |
output_srs |
|
results
|
results | array of object |
results |
|
UPRN
|
results.DPA.UPRN | string |
UPRN |
|
ADDRESS
|
results.DPA.ADDRESS | string |
ADDRESS |
|
ORGANISATION_NAME
|
results.DPA.ORGANISATION_NAME | string |
ORGANISATION_NAME |
|
BUILDING_NUMBER
|
results.DPA.BUILDING_NUMBER | string |
BUILDING_NUMBER |
|
THOROUGHFARE_NAME
|
results.DPA.THOROUGHFARE_NAME | string |
THOROUGHFARE_NAME |
|
DEPENDENT_LOCALITY
|
results.DPA.DEPENDENT_LOCALITY | string |
DEPENDENT_LOCALITY |
|
POST_TOWN
|
results.DPA.POST_TOWN | string |
POST_TOWN |
|
POSTCODE
|
results.DPA.POSTCODE | string |
POSTCODE |
|
RPC
|
results.DPA.RPC | string |
RPC |
|
X_COORDINATE
|
results.DPA.X_COORDINATE | float |
X_COORDINATE |
|
Y_COORDINATE
|
results.DPA.Y_COORDINATE | float |
Y_COORDINATE |
|
STATUS
|
results.DPA.STATUS | string |
STATUS |
|
LOGICAL_STATUS_CODE
|
results.DPA.LOGICAL_STATUS_CODE | string |
LOGICAL_STATUS_CODE |
|
CLASSIFICATION_CODE
|
results.DPA.CLASSIFICATION_CODE | string |
CLASSIFICATION_CODE |
|
CLASSIFICATION_CODE_DESCRIPTION
|
results.DPA.CLASSIFICATION_CODE_DESCRIPTION | string |
CLASSIFICATION_CODE_DESCRIPTION |
|
LOCAL_CUSTODIAN_CODE
|
results.DPA.LOCAL_CUSTODIAN_CODE | integer |
LOCAL_CUSTODIAN_CODE |
|
LOCAL_CUSTODIAN_CODE_DESCRIPTION
|
results.DPA.LOCAL_CUSTODIAN_CODE_DESCRIPTION | string |
LOCAL_CUSTODIAN_CODE_DESCRIPTION |
|
POSTAL_ADDRESS_CODE
|
results.DPA.POSTAL_ADDRESS_CODE | string |
POSTAL_ADDRESS_CODE |
|
POSTAL_ADDRESS_CODE_DESCRIPTION
|
results.DPA.POSTAL_ADDRESS_CODE_DESCRIPTION | string |
POSTAL_ADDRESS_CODE_DESCRIPTION |
|
BLPU_STATE_CODE
|
results.DPA.BLPU_STATE_CODE | string |
BLPU_STATE_CODE |
|
BLPU_STATE_CODE_DESCRIPTION
|
results.DPA.BLPU_STATE_CODE_DESCRIPTION | string |
BLPU_STATE_CODE_DESCRIPTION |
|
TOPOGRAPHY_LAYER_TOID
|
results.DPA.TOPOGRAPHY_LAYER_TOID | string |
TOPOGRAPHY_LAYER_TOID |
|
LAST_UPDATE_DATE
|
results.DPA.LAST_UPDATE_DATE | string |
LAST_UPDATE_DATE |
|
ENTRY_DATE
|
results.DPA.ENTRY_DATE | string |
ENTRY_DATE |
|
BLPU_STATE_DATE
|
results.DPA.BLPU_STATE_DATE | string |
BLPU_STATE_DATE |
|
LANGUAGE
|
results.DPA.LANGUAGE | string |
LANGUAGE |
|
MATCH
|
results.DPA.MATCH | float |
MATCH |
|
MATCH_DESCRIPTION
|
results.DPA.MATCH_DESCRIPTION | string |
MATCH_DESCRIPTION |
|
UPRN
|
results.LPI.UPRN | string |
UPRN |
|
ADDRESS
|
results.LPI.ADDRESS | string |
ADDRESS |
|
USRN
|
results.LPI.USRN | string |
USRN |
|
LPI_KEY
|
results.LPI.LPI_KEY | string |
LPI_KEY |
|
PAO_START_NUMBER
|
results.LPI.PAO_START_NUMBER | string |
PAO_START_NUMBER |
|
STREET_DESCRIPTION
|
results.LPI.STREET_DESCRIPTION | string |
STREET_DESCRIPTION |
|
TOWN_NAME
|
results.LPI.TOWN_NAME | string |
TOWN_NAME |
|
ADMINISTRATIVE_AREA
|
results.LPI.ADMINISTRATIVE_AREA | string |
ADMINISTRATIVE_AREA |
|
POSTCODE_LOCATOR
|
results.LPI.POSTCODE_LOCATOR | string |
POSTCODE_LOCATOR |
|
RPC
|
results.LPI.RPC | string |
RPC |
|
X_COORDINATE
|
results.LPI.X_COORDINATE | float |
X_COORDINATE |
|
Y_COORDINATE
|
results.LPI.Y_COORDINATE | float |
Y_COORDINATE |
|
STATUS
|
results.LPI.STATUS | string |
STATUS |
|
LOGICAL_STATUS_CODE
|
results.LPI.LOGICAL_STATUS_CODE | string |
LOGICAL_STATUS_CODE |
|
CLASSIFICATION_CODE
|
results.LPI.CLASSIFICATION_CODE | string |
CLASSIFICATION_CODE |
|
CLASSIFICATION_CODE_DESCRIPTION
|
results.LPI.CLASSIFICATION_CODE_DESCRIPTION | string |
CLASSIFICATION_CODE_DESCRIPTION |
|
LOCAL_CUSTODIAN_CODE
|
results.LPI.LOCAL_CUSTODIAN_CODE | integer |
LOCAL_CUSTODIAN_CODE |
|
LOCAL_CUSTODIAN_CODE_DESCRIPTION
|
results.LPI.LOCAL_CUSTODIAN_CODE_DESCRIPTION | string |
LOCAL_CUSTODIAN_CODE_DESCRIPTION |
|
POSTAL_ADDRESS_CODE
|
results.LPI.POSTAL_ADDRESS_CODE | string |
POSTAL_ADDRESS_CODE |
|
POSTAL_ADDRESS_CODE_DESCRIPTION
|
results.LPI.POSTAL_ADDRESS_CODE_DESCRIPTION | string |
POSTAL_ADDRESS_CODE_DESCRIPTION |
|
BLPU_STATE_CODE_DESCRIPTION
|
results.LPI.BLPU_STATE_CODE_DESCRIPTION | string |
BLPU_STATE_CODE_DESCRIPTION |
|
TOPOGRAPHY_LAYER_TOID
|
results.LPI.TOPOGRAPHY_LAYER_TOID | string |
TOPOGRAPHY_LAYER_TOID |
|
LAST_UPDATE_DATE
|
results.LPI.LAST_UPDATE_DATE | string |
LAST_UPDATE_DATE |
|
ENTRY_DATE
|
results.LPI.ENTRY_DATE | string |
ENTRY_DATE |
|
STREET_STATE_CODE
|
results.LPI.STREET_STATE_CODE | string |
STREET_STATE_CODE |
|
STREET_STATE_CODE_DESCRIPTION
|
results.LPI.STREET_STATE_CODE_DESCRIPTION | string |
STREET_STATE_CODE_DESCRIPTION |
|
STREET_CLASSIFICATION_CODE
|
results.LPI.STREET_CLASSIFICATION_CODE | string |
STREET_CLASSIFICATION_CODE |
|
STREET_CLASSIFICATION_CODE_DESCRIPTION
|
results.LPI.STREET_CLASSIFICATION_CODE_DESCRIPTION | string |
STREET_CLASSIFICATION_CODE_DESCRIPTION |
|
LPI_LOGICAL_STATUS_CODE
|
results.LPI.LPI_LOGICAL_STATUS_CODE | string |
LPI_LOGICAL_STATUS_CODE |
|
LPI_LOGICAL_STATUS_CODE_DESCRIPTION
|
results.LPI.LPI_LOGICAL_STATUS_CODE_DESCRIPTION | string |
LPI_LOGICAL_STATUS_CODE_DESCRIPTION |
|
LANGUAGE
|
results.LPI.LANGUAGE | string |
LANGUAGE |
|
MATCH
|
results.LPI.MATCH | float |
MATCH |
|
MATCH_DESCRIPTION
|
results.LPI.MATCH_DESCRIPTION | string |
MATCH_DESCRIPTION |
Postcode operation
A search based on a property's postcode. The minimum for the resource is the area and district e.g. SO16, and will accept a full postcode consisting of the area, district, sector and unit e.g. SO16 0AS
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
A UK style postcode
|
postcode | True | string |
The postcode search parameter. |
|
Result format
|
format | string |
The format in which the response will be returned. Default: JSON. Accepted values: 'JSON', 'XML' |
|
|
Limit results
|
maxresults | integer |
The maximum number of results to return. Default: 100 |
|
|
Offset the result
|
offset | integer |
Offset the list of returned by this amount. |
|
|
Local Authority (LPI) and/or Royal Mail (DPA) address results
|
dataset | string |
The address dataset to return. Multiple values can be sent, separated by a comma. Default: DPA. Accepted values: DPA, LPI |
|
|
Language
|
lr | string |
Which language of addresses to return. Valid languages are English and Welsh. Filter only applicable to DPA dataset. Default value is both languages. Default: EN, CY. |
|
|
Filter
|
fq | string |
A filter that allows filtering of results by classification code and/or logical status code. Filtering for classification code will accept wildcard (*) searches. Multiple searches can be done on classification code seperating the classification code parameter with a space. Classification code filters can be ran with logical status code filters by using the parameter multiple times: fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6 |
|
|
Output spatial reference system
|
output_srs | string |
The intended output spatial reference system. Default: EPSG:27700. Accepted values: BNG, EPSG:27700, WGS84, EPSG:4326, EPSG:3857, EPSG:4258 |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
uri
|
header.uri | string |
uri |
|
query
|
header.query | string |
query |
|
offset
|
header.offset | integer |
offset |
|
totalresults
|
header.totalresults | integer |
totalresults |
|
format
|
header.format | string |
format |
|
dataset
|
header.dataset | string |
dataset |
|
lr
|
header.lr | string |
lr |
|
maxresults
|
header.maxresults | integer |
maxresults |
|
matchprecision
|
header.matchprecision | integer |
matchprecision |
|
epoch
|
header.epoch | string |
epoch |
|
output_srs
|
header.output_srs | string |
output_srs |
|
results
|
results | array of object |
results |
|
UPRN
|
results.DPA.UPRN | string |
UPRN |
|
ADDRESS
|
results.DPA.ADDRESS | string |
ADDRESS |
|
ORGANISATION_NAME
|
results.DPA.ORGANISATION_NAME | string |
ORGANISATION_NAME |
|
BUILDING_NUMBER
|
results.DPA.BUILDING_NUMBER | string |
BUILDING_NUMBER |
|
THOROUGHFARE_NAME
|
results.DPA.THOROUGHFARE_NAME | string |
THOROUGHFARE_NAME |
|
DEPENDENT_LOCALITY
|
results.DPA.DEPENDENT_LOCALITY | string |
DEPENDENT_LOCALITY |
|
POST_TOWN
|
results.DPA.POST_TOWN | string |
POST_TOWN |
|
POSTCODE
|
results.DPA.POSTCODE | string |
POSTCODE |
|
RPC
|
results.DPA.RPC | string |
RPC |
|
X_COORDINATE
|
results.DPA.X_COORDINATE | float |
X_COORDINATE |
|
Y_COORDINATE
|
results.DPA.Y_COORDINATE | float |
Y_COORDINATE |
|
STATUS
|
results.DPA.STATUS | string |
STATUS |
|
LOGICAL_STATUS_CODE
|
results.DPA.LOGICAL_STATUS_CODE | string |
LOGICAL_STATUS_CODE |
|
CLASSIFICATION_CODE
|
results.DPA.CLASSIFICATION_CODE | string |
CLASSIFICATION_CODE |
|
CLASSIFICATION_CODE_DESCRIPTION
|
results.DPA.CLASSIFICATION_CODE_DESCRIPTION | string |
CLASSIFICATION_CODE_DESCRIPTION |
|
LOCAL_CUSTODIAN_CODE
|
results.DPA.LOCAL_CUSTODIAN_CODE | integer |
LOCAL_CUSTODIAN_CODE |
|
LOCAL_CUSTODIAN_CODE_DESCRIPTION
|
results.DPA.LOCAL_CUSTODIAN_CODE_DESCRIPTION | string |
LOCAL_CUSTODIAN_CODE_DESCRIPTION |
|
POSTAL_ADDRESS_CODE
|
results.DPA.POSTAL_ADDRESS_CODE | string |
POSTAL_ADDRESS_CODE |
|
POSTAL_ADDRESS_CODE_DESCRIPTION
|
results.DPA.POSTAL_ADDRESS_CODE_DESCRIPTION | string |
POSTAL_ADDRESS_CODE_DESCRIPTION |
|
BLPU_STATE_CODE
|
results.DPA.BLPU_STATE_CODE | string |
BLPU_STATE_CODE |
|
BLPU_STATE_CODE_DESCRIPTION
|
results.DPA.BLPU_STATE_CODE_DESCRIPTION | string |
BLPU_STATE_CODE_DESCRIPTION |
|
TOPOGRAPHY_LAYER_TOID
|
results.DPA.TOPOGRAPHY_LAYER_TOID | string |
TOPOGRAPHY_LAYER_TOID |
|
LAST_UPDATE_DATE
|
results.DPA.LAST_UPDATE_DATE | string |
LAST_UPDATE_DATE |
|
ENTRY_DATE
|
results.DPA.ENTRY_DATE | string |
ENTRY_DATE |
|
BLPU_STATE_DATE
|
results.DPA.BLPU_STATE_DATE | string |
BLPU_STATE_DATE |
|
LANGUAGE
|
results.DPA.LANGUAGE | string |
LANGUAGE |
|
MATCH
|
results.DPA.MATCH | float |
MATCH |
|
MATCH_DESCRIPTION
|
results.DPA.MATCH_DESCRIPTION | string |
MATCH_DESCRIPTION |
|
UPRN
|
results.LPI.UPRN | string |
UPRN |
|
ADDRESS
|
results.LPI.ADDRESS | string |
ADDRESS |
|
USRN
|
results.LPI.USRN | string |
USRN |
|
LPI_KEY
|
results.LPI.LPI_KEY | string |
LPI_KEY |
|
PAO_START_NUMBER
|
results.LPI.PAO_START_NUMBER | string |
PAO_START_NUMBER |
|
STREET_DESCRIPTION
|
results.LPI.STREET_DESCRIPTION | string |
STREET_DESCRIPTION |
|
TOWN_NAME
|
results.LPI.TOWN_NAME | string |
TOWN_NAME |
|
ADMINISTRATIVE_AREA
|
results.LPI.ADMINISTRATIVE_AREA | string |
ADMINISTRATIVE_AREA |
|
POSTCODE_LOCATOR
|
results.LPI.POSTCODE_LOCATOR | string |
POSTCODE_LOCATOR |
|
RPC
|
results.LPI.RPC | string |
RPC |
|
X_COORDINATE
|
results.LPI.X_COORDINATE | float |
X_COORDINATE |
|
Y_COORDINATE
|
results.LPI.Y_COORDINATE | float |
Y_COORDINATE |
|
STATUS
|
results.LPI.STATUS | string |
STATUS |
|
LOGICAL_STATUS_CODE
|
results.LPI.LOGICAL_STATUS_CODE | string |
LOGICAL_STATUS_CODE |
|
CLASSIFICATION_CODE
|
results.LPI.CLASSIFICATION_CODE | string |
CLASSIFICATION_CODE |
|
CLASSIFICATION_CODE_DESCRIPTION
|
results.LPI.CLASSIFICATION_CODE_DESCRIPTION | string |
CLASSIFICATION_CODE_DESCRIPTION |
|
LOCAL_CUSTODIAN_CODE
|
results.LPI.LOCAL_CUSTODIAN_CODE | integer |
LOCAL_CUSTODIAN_CODE |
|
LOCAL_CUSTODIAN_CODE_DESCRIPTION
|
results.LPI.LOCAL_CUSTODIAN_CODE_DESCRIPTION | string |
LOCAL_CUSTODIAN_CODE_DESCRIPTION |
|
POSTAL_ADDRESS_CODE
|
results.LPI.POSTAL_ADDRESS_CODE | string |
POSTAL_ADDRESS_CODE |
|
POSTAL_ADDRESS_CODE_DESCRIPTION
|
results.LPI.POSTAL_ADDRESS_CODE_DESCRIPTION | string |
POSTAL_ADDRESS_CODE_DESCRIPTION |
|
BLPU_STATE_CODE_DESCRIPTION
|
results.LPI.BLPU_STATE_CODE_DESCRIPTION | string |
BLPU_STATE_CODE_DESCRIPTION |
|
TOPOGRAPHY_LAYER_TOID
|
results.LPI.TOPOGRAPHY_LAYER_TOID | string |
TOPOGRAPHY_LAYER_TOID |
|
LAST_UPDATE_DATE
|
results.LPI.LAST_UPDATE_DATE | string |
LAST_UPDATE_DATE |
|
ENTRY_DATE
|
results.LPI.ENTRY_DATE | string |
ENTRY_DATE |
|
STREET_STATE_CODE
|
results.LPI.STREET_STATE_CODE | string |
STREET_STATE_CODE |
|
STREET_STATE_CODE_DESCRIPTION
|
results.LPI.STREET_STATE_CODE_DESCRIPTION | string |
STREET_STATE_CODE_DESCRIPTION |
|
STREET_CLASSIFICATION_CODE
|
results.LPI.STREET_CLASSIFICATION_CODE | string |
STREET_CLASSIFICATION_CODE |
|
STREET_CLASSIFICATION_CODE_DESCRIPTION
|
results.LPI.STREET_CLASSIFICATION_CODE_DESCRIPTION | string |
STREET_CLASSIFICATION_CODE_DESCRIPTION |
|
LPI_LOGICAL_STATUS_CODE
|
results.LPI.LPI_LOGICAL_STATUS_CODE | string |
LPI_LOGICAL_STATUS_CODE |
|
LPI_LOGICAL_STATUS_CODE_DESCRIPTION
|
results.LPI.LPI_LOGICAL_STATUS_CODE_DESCRIPTION | string |
LPI_LOGICAL_STATUS_CODE_DESCRIPTION |
|
LANGUAGE
|
results.LPI.LANGUAGE | string |
LANGUAGE |
|
MATCH
|
results.LPI.MATCH | float |
MATCH |
|
MATCH_DESCRIPTION
|
results.LPI.MATCH_DESCRIPTION | string |
MATCH_DESCRIPTION |
Radius operation
Takes a pair of coordinates as the centre for a circle and returns all addresses that are intersected by it.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
A set of comma-separated coordinates
|
point | True | string |
One comma-separated coordinate set in BNG that specifies the coordinate at the centre of the search circle. The precision of the coordinates is two decimal places (that is, 1 cm accuracy). |
|
Search radius
|
radius | integer |
The radius to search within in metres. The maximum radius is 1,000 metres. If above then an error message is returned. The precision of the distance is to two decimal places (that is, 1 cm accuracy). Default: 100. Accepted values: 0.01 - 1000 |
|
|
Result format
|
format | string |
The format in which the response will be returned. Default: JSON. Accepted values JSON, XML |
|
|
Limit results
|
maxresults | integer |
The maximum number of results to return. Default: 100 |
|
|
Offset the result
|
offset | integer |
Offset the list of returned by this amount. |
|
|
Local Authority (LPI) and/or Royal Mail (DPA) address results
|
dataset | string |
The address dataset to return. Multiple values can be sent, separated by a comma. Default: DPA. Accepted values: DPA, LPI |
|
|
Language
|
lr | string |
Which language of addresses to return. Valid languages are English and Welsh. Filter only applicable to DPA dataset. Default value is both languages. Default: EN, CY |
|
|
Filter
|
fq | string |
A filter that allows filtering of results by classification code and/or logical status code. Filtering for classification code will accept wildcard (*) searches. Multiple searches can be done on classification code seperating the classification code parameter with a space. Classification code filters can be ran with logical status code filters by using the parameter multiple times: fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6 |
|
|
Output spatial reference system
|
output_srs | string |
The intended output spatial reference system. Default: EPSG:27700. Accepted values: 'BNG', 'EPSG:27700', 'WGS84', 'EPSG:4326', 'EPSG:3857', 'EPSG:4258' |
|
|
Input spatial reference system
|
srs | string |
The spatial reference system for the input coordinate set. Accepted values: 'BNG', 'EPSG:27700', 'WGS84', 'EPSG:4326', 'EPSG:3857', 'EPSG:4258' |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
uri
|
header.uri | string |
uri |
|
query
|
header.query | string |
query |
|
offset
|
header.offset | integer |
offset |
|
totalresults
|
header.totalresults | integer |
totalresults |
|
format
|
header.format | string |
format |
|
dataset
|
header.dataset | string |
dataset |
|
lr
|
header.lr | string |
lr |
|
maxresults
|
header.maxresults | integer |
maxresults |
|
matchprecision
|
header.matchprecision | integer |
matchprecision |
|
epoch
|
header.epoch | string |
epoch |
|
output_srs
|
header.output_srs | string |
output_srs |
|
results
|
results | array of object |
results |
|
UPRN
|
results.DPA.UPRN | string |
UPRN |
|
ADDRESS
|
results.DPA.ADDRESS | string |
ADDRESS |
|
ORGANISATION_NAME
|
results.DPA.ORGANISATION_NAME | string |
ORGANISATION_NAME |
|
BUILDING_NUMBER
|
results.DPA.BUILDING_NUMBER | string |
BUILDING_NUMBER |
|
THOROUGHFARE_NAME
|
results.DPA.THOROUGHFARE_NAME | string |
THOROUGHFARE_NAME |
|
DEPENDENT_LOCALITY
|
results.DPA.DEPENDENT_LOCALITY | string |
DEPENDENT_LOCALITY |
|
POST_TOWN
|
results.DPA.POST_TOWN | string |
POST_TOWN |
|
POSTCODE
|
results.DPA.POSTCODE | string |
POSTCODE |
|
RPC
|
results.DPA.RPC | string |
RPC |
|
X_COORDINATE
|
results.DPA.X_COORDINATE | float |
X_COORDINATE |
|
Y_COORDINATE
|
results.DPA.Y_COORDINATE | float |
Y_COORDINATE |
|
STATUS
|
results.DPA.STATUS | string |
STATUS |
|
LOGICAL_STATUS_CODE
|
results.DPA.LOGICAL_STATUS_CODE | string |
LOGICAL_STATUS_CODE |
|
CLASSIFICATION_CODE
|
results.DPA.CLASSIFICATION_CODE | string |
CLASSIFICATION_CODE |
|
CLASSIFICATION_CODE_DESCRIPTION
|
results.DPA.CLASSIFICATION_CODE_DESCRIPTION | string |
CLASSIFICATION_CODE_DESCRIPTION |
|
LOCAL_CUSTODIAN_CODE
|
results.DPA.LOCAL_CUSTODIAN_CODE | integer |
LOCAL_CUSTODIAN_CODE |
|
LOCAL_CUSTODIAN_CODE_DESCRIPTION
|
results.DPA.LOCAL_CUSTODIAN_CODE_DESCRIPTION | string |
LOCAL_CUSTODIAN_CODE_DESCRIPTION |
|
POSTAL_ADDRESS_CODE
|
results.DPA.POSTAL_ADDRESS_CODE | string |
POSTAL_ADDRESS_CODE |
|
POSTAL_ADDRESS_CODE_DESCRIPTION
|
results.DPA.POSTAL_ADDRESS_CODE_DESCRIPTION | string |
POSTAL_ADDRESS_CODE_DESCRIPTION |
|
BLPU_STATE_CODE
|
results.DPA.BLPU_STATE_CODE | string |
BLPU_STATE_CODE |
|
BLPU_STATE_CODE_DESCRIPTION
|
results.DPA.BLPU_STATE_CODE_DESCRIPTION | string |
BLPU_STATE_CODE_DESCRIPTION |
|
TOPOGRAPHY_LAYER_TOID
|
results.DPA.TOPOGRAPHY_LAYER_TOID | string |
TOPOGRAPHY_LAYER_TOID |
|
LAST_UPDATE_DATE
|
results.DPA.LAST_UPDATE_DATE | string |
LAST_UPDATE_DATE |
|
ENTRY_DATE
|
results.DPA.ENTRY_DATE | string |
ENTRY_DATE |
|
BLPU_STATE_DATE
|
results.DPA.BLPU_STATE_DATE | string |
BLPU_STATE_DATE |
|
LANGUAGE
|
results.DPA.LANGUAGE | string |
LANGUAGE |
|
MATCH
|
results.DPA.MATCH | float |
MATCH |
|
MATCH_DESCRIPTION
|
results.DPA.MATCH_DESCRIPTION | string |
MATCH_DESCRIPTION |
|
UPRN
|
results.LPI.UPRN | string |
UPRN |
|
ADDRESS
|
results.LPI.ADDRESS | string |
ADDRESS |
|
USRN
|
results.LPI.USRN | string |
USRN |
|
LPI_KEY
|
results.LPI.LPI_KEY | string |
LPI_KEY |
|
PAO_START_NUMBER
|
results.LPI.PAO_START_NUMBER | string |
PAO_START_NUMBER |
|
STREET_DESCRIPTION
|
results.LPI.STREET_DESCRIPTION | string |
STREET_DESCRIPTION |
|
TOWN_NAME
|
results.LPI.TOWN_NAME | string |
TOWN_NAME |
|
ADMINISTRATIVE_AREA
|
results.LPI.ADMINISTRATIVE_AREA | string |
ADMINISTRATIVE_AREA |
|
POSTCODE_LOCATOR
|
results.LPI.POSTCODE_LOCATOR | string |
POSTCODE_LOCATOR |
|
RPC
|
results.LPI.RPC | string |
RPC |
|
X_COORDINATE
|
results.LPI.X_COORDINATE | float |
X_COORDINATE |
|
Y_COORDINATE
|
results.LPI.Y_COORDINATE | float |
Y_COORDINATE |
|
STATUS
|
results.LPI.STATUS | string |
STATUS |
|
LOGICAL_STATUS_CODE
|
results.LPI.LOGICAL_STATUS_CODE | string |
LOGICAL_STATUS_CODE |
|
CLASSIFICATION_CODE
|
results.LPI.CLASSIFICATION_CODE | string |
CLASSIFICATION_CODE |
|
CLASSIFICATION_CODE_DESCRIPTION
|
results.LPI.CLASSIFICATION_CODE_DESCRIPTION | string |
CLASSIFICATION_CODE_DESCRIPTION |
|
LOCAL_CUSTODIAN_CODE
|
results.LPI.LOCAL_CUSTODIAN_CODE | integer |
LOCAL_CUSTODIAN_CODE |
|
LOCAL_CUSTODIAN_CODE_DESCRIPTION
|
results.LPI.LOCAL_CUSTODIAN_CODE_DESCRIPTION | string |
LOCAL_CUSTODIAN_CODE_DESCRIPTION |
|
POSTAL_ADDRESS_CODE
|
results.LPI.POSTAL_ADDRESS_CODE | string |
POSTAL_ADDRESS_CODE |
|
POSTAL_ADDRESS_CODE_DESCRIPTION
|
results.LPI.POSTAL_ADDRESS_CODE_DESCRIPTION | string |
POSTAL_ADDRESS_CODE_DESCRIPTION |
|
BLPU_STATE_CODE_DESCRIPTION
|
results.LPI.BLPU_STATE_CODE_DESCRIPTION | string |
BLPU_STATE_CODE_DESCRIPTION |
|
TOPOGRAPHY_LAYER_TOID
|
results.LPI.TOPOGRAPHY_LAYER_TOID | string |
TOPOGRAPHY_LAYER_TOID |
|
LAST_UPDATE_DATE
|
results.LPI.LAST_UPDATE_DATE | string |
LAST_UPDATE_DATE |
|
ENTRY_DATE
|
results.LPI.ENTRY_DATE | string |
ENTRY_DATE |
|
STREET_STATE_CODE
|
results.LPI.STREET_STATE_CODE | string |
STREET_STATE_CODE |
|
STREET_STATE_CODE_DESCRIPTION
|
results.LPI.STREET_STATE_CODE_DESCRIPTION | string |
STREET_STATE_CODE_DESCRIPTION |
|
STREET_CLASSIFICATION_CODE
|
results.LPI.STREET_CLASSIFICATION_CODE | string |
STREET_CLASSIFICATION_CODE |
|
STREET_CLASSIFICATION_CODE_DESCRIPTION
|
results.LPI.STREET_CLASSIFICATION_CODE_DESCRIPTION | string |
STREET_CLASSIFICATION_CODE_DESCRIPTION |
|
LPI_LOGICAL_STATUS_CODE
|
results.LPI.LPI_LOGICAL_STATUS_CODE | string |
LPI_LOGICAL_STATUS_CODE |
|
LPI_LOGICAL_STATUS_CODE_DESCRIPTION
|
results.LPI.LPI_LOGICAL_STATUS_CODE_DESCRIPTION | string |
LPI_LOGICAL_STATUS_CODE_DESCRIPTION |
|
LANGUAGE
|
results.LPI.LANGUAGE | string |
LANGUAGE |
|
MATCH
|
results.LPI.MATCH | float |
MATCH |
|
MATCH_DESCRIPTION
|
results.LPI.MATCH_DESCRIPTION | string |
MATCH_DESCRIPTION |
UPRN Operation
A search that takes a Unique Property Reference Number (UPRN) as the search parameter.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Valid UPRN
|
uprn | True | integer |
Integer in format of a Unique Property Reference Number (UPRN) |
|
Result format
|
format | string |
The format in which the response will be returned. Default: JSON. Accepted values: JSON, XML |
|
|
Local Authority (LPI) and/or Royal Mail (DPA) address results
|
dataset | string |
The address dataset to return. Multiple values can be sent, separated by a comma. Default: DPA. Accepted values: DPA, LPI |
|
|
Language
|
lr | string |
Which language of addresses to return. Valid languages are English and Welsh. Filter only applicable to DPA dataset. Default value is both languages. Default: EN, CY. |
|
|
Filter
|
fq | string |
A filter that allows filtering of results by classification code and/or logical status code. Filtering for classification code will accept wildcard (*) searches. Multiple searches can be done on classification code seperating the classification code parameter with a space. Classification code filters can be ran with logical status code filters by using the parameter multiple times: fq=classification_code:CI classification_code:RD&fq=LOGICAL_STATUS_CODE:6" |
|
|
Output spatial reference system
|
output_srs | string |
The intended output spatial reference system. Default: EPSG:27700. Accepted values: BNG, EPSG:27700, WGS84, EPSG:4326, EPSG:3857, EPSG:4258 |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
uri
|
header.uri | string |
uri |
|
query
|
header.query | string |
query |
|
offset
|
header.offset | integer |
offset |
|
totalresults
|
header.totalresults | integer |
totalresults |
|
format
|
header.format | string |
format |
|
dataset
|
header.dataset | string |
dataset |
|
lr
|
header.lr | string |
lr |
|
maxresults
|
header.maxresults | integer |
maxresults |
|
matchprecision
|
header.matchprecision | integer |
matchprecision |
|
epoch
|
header.epoch | string |
epoch |
|
output_srs
|
header.output_srs | string |
output_srs |
|
results
|
results | array of object |
results |
|
UPRN
|
results.DPA.UPRN | string |
UPRN |
|
ADDRESS
|
results.DPA.ADDRESS | string |
ADDRESS |
|
ORGANISATION_NAME
|
results.DPA.ORGANISATION_NAME | string |
ORGANISATION_NAME |
|
BUILDING_NUMBER
|
results.DPA.BUILDING_NUMBER | string |
BUILDING_NUMBER |
|
THOROUGHFARE_NAME
|
results.DPA.THOROUGHFARE_NAME | string |
THOROUGHFARE_NAME |
|
DEPENDENT_LOCALITY
|
results.DPA.DEPENDENT_LOCALITY | string |
DEPENDENT_LOCALITY |
|
POST_TOWN
|
results.DPA.POST_TOWN | string |
POST_TOWN |
|
POSTCODE
|
results.DPA.POSTCODE | string |
POSTCODE |
|
RPC
|
results.DPA.RPC | string |
RPC |
|
X_COORDINATE
|
results.DPA.X_COORDINATE | float |
X_COORDINATE |
|
Y_COORDINATE
|
results.DPA.Y_COORDINATE | float |
Y_COORDINATE |
|
STATUS
|
results.DPA.STATUS | string |
STATUS |
|
LOGICAL_STATUS_CODE
|
results.DPA.LOGICAL_STATUS_CODE | string |
LOGICAL_STATUS_CODE |
|
CLASSIFICATION_CODE
|
results.DPA.CLASSIFICATION_CODE | string |
CLASSIFICATION_CODE |
|
CLASSIFICATION_CODE_DESCRIPTION
|
results.DPA.CLASSIFICATION_CODE_DESCRIPTION | string |
CLASSIFICATION_CODE_DESCRIPTION |
|
LOCAL_CUSTODIAN_CODE
|
results.DPA.LOCAL_CUSTODIAN_CODE | integer |
LOCAL_CUSTODIAN_CODE |
|
LOCAL_CUSTODIAN_CODE_DESCRIPTION
|
results.DPA.LOCAL_CUSTODIAN_CODE_DESCRIPTION | string |
LOCAL_CUSTODIAN_CODE_DESCRIPTION |
|
POSTAL_ADDRESS_CODE
|
results.DPA.POSTAL_ADDRESS_CODE | string |
POSTAL_ADDRESS_CODE |
|
POSTAL_ADDRESS_CODE_DESCRIPTION
|
results.DPA.POSTAL_ADDRESS_CODE_DESCRIPTION | string |
POSTAL_ADDRESS_CODE_DESCRIPTION |
|
BLPU_STATE_CODE
|
results.DPA.BLPU_STATE_CODE | string |
BLPU_STATE_CODE |
|
BLPU_STATE_CODE_DESCRIPTION
|
results.DPA.BLPU_STATE_CODE_DESCRIPTION | string |
BLPU_STATE_CODE_DESCRIPTION |
|
TOPOGRAPHY_LAYER_TOID
|
results.DPA.TOPOGRAPHY_LAYER_TOID | string |
TOPOGRAPHY_LAYER_TOID |
|
LAST_UPDATE_DATE
|
results.DPA.LAST_UPDATE_DATE | string |
LAST_UPDATE_DATE |
|
ENTRY_DATE
|
results.DPA.ENTRY_DATE | string |
ENTRY_DATE |
|
BLPU_STATE_DATE
|
results.DPA.BLPU_STATE_DATE | string |
BLPU_STATE_DATE |
|
LANGUAGE
|
results.DPA.LANGUAGE | string |
LANGUAGE |
|
MATCH
|
results.DPA.MATCH | float |
MATCH |
|
MATCH_DESCRIPTION
|
results.DPA.MATCH_DESCRIPTION | string |
MATCH_DESCRIPTION |
|
UPRN
|
results.LPI.UPRN | string |
UPRN |
|
ADDRESS
|
results.LPI.ADDRESS | string |
ADDRESS |
|
USRN
|
results.LPI.USRN | string |
USRN |
|
LPI_KEY
|
results.LPI.LPI_KEY | string |
LPI_KEY |
|
PAO_START_NUMBER
|
results.LPI.PAO_START_NUMBER | string |
PAO_START_NUMBER |
|
STREET_DESCRIPTION
|
results.LPI.STREET_DESCRIPTION | string |
STREET_DESCRIPTION |
|
TOWN_NAME
|
results.LPI.TOWN_NAME | string |
TOWN_NAME |
|
ADMINISTRATIVE_AREA
|
results.LPI.ADMINISTRATIVE_AREA | string |
ADMINISTRATIVE_AREA |
|
POSTCODE_LOCATOR
|
results.LPI.POSTCODE_LOCATOR | string |
POSTCODE_LOCATOR |
|
RPC
|
results.LPI.RPC | string |
RPC |
|
X_COORDINATE
|
results.LPI.X_COORDINATE | float |
X_COORDINATE |
|
Y_COORDINATE
|
results.LPI.Y_COORDINATE | float |
Y_COORDINATE |
|
STATUS
|
results.LPI.STATUS | string |
STATUS |
|
LOGICAL_STATUS_CODE
|
results.LPI.LOGICAL_STATUS_CODE | string |
LOGICAL_STATUS_CODE |
|
CLASSIFICATION_CODE
|
results.LPI.CLASSIFICATION_CODE | string |
CLASSIFICATION_CODE |
|
CLASSIFICATION_CODE_DESCRIPTION
|
results.LPI.CLASSIFICATION_CODE_DESCRIPTION | string |
CLASSIFICATION_CODE_DESCRIPTION |
|
LOCAL_CUSTODIAN_CODE
|
results.LPI.LOCAL_CUSTODIAN_CODE | integer |
LOCAL_CUSTODIAN_CODE |
|
LOCAL_CUSTODIAN_CODE_DESCRIPTION
|
results.LPI.LOCAL_CUSTODIAN_CODE_DESCRIPTION | string |
LOCAL_CUSTODIAN_CODE_DESCRIPTION |
|
POSTAL_ADDRESS_CODE
|
results.LPI.POSTAL_ADDRESS_CODE | string |
POSTAL_ADDRESS_CODE |
|
POSTAL_ADDRESS_CODE_DESCRIPTION
|
results.LPI.POSTAL_ADDRESS_CODE_DESCRIPTION | string |
POSTAL_ADDRESS_CODE_DESCRIPTION |
|
BLPU_STATE_CODE_DESCRIPTION
|
results.LPI.BLPU_STATE_CODE_DESCRIPTION | string |
BLPU_STATE_CODE_DESCRIPTION |
|
TOPOGRAPHY_LAYER_TOID
|
results.LPI.TOPOGRAPHY_LAYER_TOID | string |
TOPOGRAPHY_LAYER_TOID |
|
LAST_UPDATE_DATE
|
results.LPI.LAST_UPDATE_DATE | string |
LAST_UPDATE_DATE |
|
ENTRY_DATE
|
results.LPI.ENTRY_DATE | string |
ENTRY_DATE |
|
STREET_STATE_CODE
|
results.LPI.STREET_STATE_CODE | string |
STREET_STATE_CODE |
|
STREET_STATE_CODE_DESCRIPTION
|
results.LPI.STREET_STATE_CODE_DESCRIPTION | string |
STREET_STATE_CODE_DESCRIPTION |
|
STREET_CLASSIFICATION_CODE
|
results.LPI.STREET_CLASSIFICATION_CODE | string |
STREET_CLASSIFICATION_CODE |
|
STREET_CLASSIFICATION_CODE_DESCRIPTION
|
results.LPI.STREET_CLASSIFICATION_CODE_DESCRIPTION | string |
STREET_CLASSIFICATION_CODE_DESCRIPTION |
|
LPI_LOGICAL_STATUS_CODE
|
results.LPI.LPI_LOGICAL_STATUS_CODE | string |
LPI_LOGICAL_STATUS_CODE |
|
LPI_LOGICAL_STATUS_CODE_DESCRIPTION
|
results.LPI.LPI_LOGICAL_STATUS_CODE_DESCRIPTION | string |
LPI_LOGICAL_STATUS_CODE_DESCRIPTION |
|
LANGUAGE
|
results.LPI.LANGUAGE | string |
LANGUAGE |
|
MATCH
|
results.LPI.MATCH | float |
MATCH |
|
MATCH_DESCRIPTION
|
results.LPI.MATCH_DESCRIPTION | string |
MATCH_DESCRIPTION |