Data Settings

Edited

Geocodes allows you to retrieve geographic information related to an address that you retrieve from our service. These geocodes can be set within your integration in the Settings tab under Data.

Note: Geocodes are available for Plus and Enterprise plans.

Location

Returns location data such as Latitude and Longitude.

Field Info

Description

longitude

Longitude of matched address

latitude

Latitude of matched address

crs

Coordinate reference system

accuracy

Returns the accuracy of the matched address.

Possible options:
BUILDING
STREET
POSTCODE
LOCALITY

gb_identifiers

Returns identifiers for the UK such as UDPRN, UPRN, USRN.

Field Info

Description

uprn

Unique Property Reference Number

udprn

Unique Delivery Point Reference Number

umrrn

Unique Multiple Residence Reference Number

usrn

Unique Street Reference Number

gb_location

Returns UK location data such as easting and northing.

Field Info

Description

easting

Easting coordinates of matched address

northing

Northing coordinates of matched address

crs

Coordinate reference system

ie_admin

Returns IE admin data.

Field Info

Description

smallAreaId_2017

Small Area ID - 2017 data

smallAreaId_2015

Small Area ID - 2015 data

laId_2017

Local Authority ID - 2017 data

laId_2015

Local Authority ID - 2015 data

leaId_2019

Local Electoral Area ID - 2019 data

leaId_2018

Local Electoral Area ID - 2018 data

dedId_2017

Electoral District - 2017 data

dedId_2015

Electoral District - 2015 data

countyId

County ID

gaeltacht

A true/false field,  that highlights if the ecadId supplied is in a Gaeltacht area.

ie_building

Returns IE building data.

Field Info

Description

ecadId

Unique 10 digit identification number

buildingTypeId

Type of Building
Possible options:
1 - Detached
2 - Semi-Detached
3 - Terraced
6 - Duplex
7 - Bungalow
8 - Temporary Dwelling

underConstruction

A true/false field, indicating whether or not the building is under construction

buildingUse

Possible options:
R - Residential
C - Commercial
B - Both
U - Unknown

vacant

A true/false field, indicating whether or not the building is under construction

ie_postalAddress

Returns the postal address for the given IE address - this is returned in English and Irish.

ie_geographicAddress

Returns the geographic address for the given IE address - this is returned in English and Irish.

ie_location

Returns IE location data for given address.

Field Info

Description

ing

Irish national grid information, including easting, northing and may include a bounding box

itm

Irish transverse mercator, including easting, northing and may include a bounding box

accuracy

The accuracy level of the geo-coordinate provided.
Possible options:
1 - OSI Map
2 - OSI Ortho
3 - General
4 - Unverified