Matchcode Eircode Web Service Product Information
The introduction of Eircode in summer 2015 is the Republic of Ireland’s first public database of unique identifiers for all addresses. It will assist citizens, businesses and public bodies to locate every individual address in the State. The Eircode Address Database and the Eircode Address File each contain all 2.2 million business and residential addresses in Ireland. Matchcode360 offers two versions of this data set ECAD & ECAF, which carry alternative royalty costs.- ECAF: Includes 2.2 million USP Postal Addresses with individual Eircode for each
- ECAD: Includes the above along with Geo-code of the centroid of the address and additional address information
Input Format
The ExecuteCapture method takes in a ExecuteCaptureRequest data structure, which contains all the information necessary to carry out the request. Type: ExecuteCaptureRequest| Field Name | Type | Description |
|---|---|---|
| securityHeader | SecurityHeader | The username and authentication token used to access the system. |
| profileRequest | ProfileRequestCapture | Details of the request |
| Profile | GUID |
|---|---|
| EIRCODE | 6A5507FB-A79A-4008-BFC5-3E56CB851B79 |
Search Criteria
The Eircode search criteria should be entered into the IdmDataSearchAddress data structure, which is located within the input details as follows: ExecuteCapture → ProfileRequestCapture → ProfileRequestCaptureData → address The search address object is the same that is used in the Address Lookup request, described here. In the Eircode web service, the postcode input field is used as the Eircode input.Additional Request Options
The additional search options, used for configuring options such as casing or transliteration of output results, can be set in the IdmRequestOptions structure located in the ProfileRequestCaptureData.options property.Additional Return Data
Additional data can be returned, or excluded from being returned, for each address by providing one or more values in the IdmRequestOption.relatedDataItems property. For each value provided, the corresponding additional data is returned, and the corresponding additional data for all the values not provided are not returned. The following values are supported by this service, when using the ECAF dataset:| Key Mnemonic | Description | Returned By Default |
|---|---|---|
| COUNTRYCODE | Country code | Yes |
| ECAF_ID | Unique 10 digit identification number | Yes |
| Key Mnemonic | Description | Returned By Default |
|---|---|---|
| COUNTRYCODE | Country code | Yes |
| ECAD_ID | Unique 10 digit identification number | Yes |
| LA_ID | Unique Identifier for Local Authority | Yes |
| DED_ID | Unique Identifier for Electoral Divisions | Yes |
| SMALL_AREA_ID | Unique Identifier for the Small Area | Yes |
| TOWNLOAND_ID | Unique Identifier for Townland | Yes |
| ADMIN_GAELTACHT | A Yes/No field indicating whether or not the official Irish language version provided by The Placenames Branch replaces unofficial translations provided by GeoDirectory | Yes |
| NUA | The NUA field contains a Y value when the address is a non-unique address, and N when it is a unique address | Yes |
| BUILDING_ID | Unique 10 digit identification number for the Building | Yes |
| BUILDING_TYPE_ID | The Type of Building e.g. Bungalow, Detached etc | Yes |
| HOLIDAY_HOME | A Yes/No field, indicating whether or not the building is a holiday home. NOTE: This field is provided for future proofing, no data currently available to Eircode | Yes |
| UNDER_CONS | A Yes/No field, indicating whether or not the building is under construction | Yes |
| BUILDING_USE | R- Residential, C-Commercial, B-Both or U-Unknown | Yes |
| BLD_VACANT | A Yes/No field, indicating whether or not the building is vacant | Yes |
| ING_EAST | Irish National Grid Easting Co-ordinate | Yes |
| ING_NORTH | Irish National Grid Northing Co-ordinate | Yes |
| ITM_EAST | ITM Easting Co-ordinate | Yes |
| ITM_NORTH | ITM Northing Co-ordinate | Yes |
| ETRS89_LAT | ETRS89 Latitude Co-ordinate | Yes |
| ETRS89_LONG | ETRS89 Longitude Co-ordinate | Yes |
| ING_MIN_EAST | Irish National Grid Minimum Easting Coordinate | Yes |
| ING_MIN_NORTH | Irish National Grid Minimum Northing Coordinate | Yes |
| ING_MAX_EAST | Irish National Grid Maximum Easting Coordinate | Yes |
| ING_MAX_NORTH | Irish National Grid Maximum Northing Coordinate | Yes |
| ITM_MIN_EAST | ITM (Irish Transverse Mercator) Minimum Easting Coordinate | Yes |
| ITM_MIN_NORTH | ITM Minimum Northing Coordinate | Yes |
| ITM_MAX_EAST | ITM Maximum Easting Coordinate | Yes |
| ITM_MAX_NORTH | ITM Maximum Northing Coordinate | Yes |
| ETRS89_MIN_LAT | ETRS89 (European Terrestrial Reference System) Minimum Latitude Coordinate | Yes |
| ETRS89_MIN_LONG | ETRS89 Minimum Longitude Coordinate | Yes |
| ETRS89_MAX_LAT | ETRS89 Maximum Latitude Coordinate | Yes |
| ETRS89_MAX_LONG | ETRS89 Maximum Longitude Coordinate | Yes |
| SPATIAL_ACCURACY | Describes Accuracy Level of Geo-Coordinates | Yes |
| BLD_TYPE_NAME | The full text description of the type of building | Yes |
| BLD_TYPE_CODE | The code for the type of building | Yes |
| ORGANISATION_ID | Unique 10 digit identification number for Organisations | Yes |
| ORG_VACANT | A Yes/No field, indicating whether or not the organisation location is vacant | Yes |
| NACE_CODE | The NACE (Nomenclature of Economic Activities) Code for the Category. NOTE: This field is provided for future proofing, no data currently available to Eircode | Yes |
| NACE_CATEGORY | The NACE (Nomenclature of Economic Activities) Code for the Category. NOTE: This field is provided for future proofing, no data currently available to Eircode. NACE Category NACE_CATEGORY Name of the NACE Category. NOTE: This field is provided for future proofing, no data currently available to Eircode | Yes |
Address Filters
Addresses which have been found by the web service, which match a particular kind of address, can be filtered out from the search results by using the address filters functionality described here.Output Format
The results of the Eircode web service search are returned in a ProfileResponseDetails structure with a ProfileResponseDetail.responseType of ‘CAPTURE’. The ProfileResponseDetails structure contains a single CaptureResponse data structure which holds an array of IdmDataAddress records containing the returned address data. ExecuteCaptureResponse > ProfileResponse [0] > ProfileResponseDetails [0] > CaptureResponse > CaptureResponseData > IdmDataAddress [n] In the Eircode web service, the postcode output field is used as the Eircode output. Additional data from a search may be returned in the additionalItems of the IdmDataAddress.Output Fields
Apart from the standard address fields, the following additional fields are returned by the service. For all Eircode searches, the additional items of each address will contain a pair with a key of “DATASOURCE”, and a value of “ECAF” or “ECAD”, indicating from which dataset the address came from.ECAF Specific
| Field | Related Data Item Key | Location In Response |
|---|---|---|
| ECAF_ID | ECAF_ID | IdmDataAddress → additionalItems → ECAF_ID |
ECAD Specific
| Field | Related Data Item Key | Location In Response |
|---|---|---|
| ECAD_ID | ECAD_ID | IdmDataAddress → additionalItems → ECAD_ID |
| LA_ID | LA_ID | IdmDataAddress → additionalItems → LA_ID |
| DED_ID | DED_ID | IdmDataAddress → additionalItems → DED_ID |
| SMALL_AREA_ | ID SMALL_AREA_ID | IdmDataAddress → additionalItems → SMALL_AREA_ID |
| TOWNLOAND_ID | TOWNLOAND_ID | IdmDataAddress → additionalItems → TOWNLOAND_ID |
| ADMIN_GAELTACHT | ADMIN_GAELTACHT | IdmDataAddress → additionalItems → ADMIN_GAELTACHT |
| NUA | NUA | IdmDataAddress → additionalItems → NUA |
| BUILDING_ID | BUILDING_ID | IdmDataAddress → additionalItems → BUILDING_ID |
| BUILDING_TYPE_ID | BUILDING_TYPE_ID | IdmDataAddress → additionalItems → BUILDING_TYPE_ID |
| HOLIDAY_HOME | HOLIDAY_HOME | IdmDataAddress → additionalItems → HOLIDAY_HOME |
| UNDER_CONS | UNDER_CONS | IdmDataAddress → additionalItems → UNDER_CONS |
| BUILDING_USE | BUILDING_USE | IdmDataAddress → additionalItems → BUILDING_USE |
| BLD_VACANT | BLD_VACANT | IdmDataAddress → additionalItems → BLD_VACANT |
| ING_EAST | ING_EAST | IdmDataAddress → additionalItems → ING_EAST |
| ING_NORTH | ING_NORTH | IdmDataAddress → additionalItems → ING_NORTH |
| ITM_EAST | ITM_EAST | IdmDataAddress → additionalItems → ITM_EAST |
| ITM_NORTH | ITM_NORTH | IdmDataAddress → additionalItems → ITM_NORTH |
| ETRS89_LAT | ETRS89_LAT | IdmDataAddress → additionalItems → ETRS89_LAT |
| ETRS89_LONG | ETRS89_LONG | IdmDataAddress → additionalItems → ETRS89_LONG |
| ING_MIN_EAST | ING_MIN_EAST | IdmDataAddress → additionalItems → ING_MIN_EAST |
| ING_MIN_NORTH | ING_MIN_NORTH | IdmDataAddress → additionalItems → ING_MIN_NORTH |
| ING_MAX_EAST | ING_MAX_EAST | IdmDataAddress → additionalItems → ING_MAX_EAST |
| ING_MAX_NORTH | ING_MAX_NORTH | IdmDataAddress → additionalItems → ING_MAX_NORTH |
| ITM_MIN_EAST | ITM_MIN_EAST | IdmDataAddress → additionalItems → ITM_MIN_EAST |
| ITM_MIN_NORTH | ITM_MIN_NORTH | IdmDataAddress → additionalItems → ITM_MIN_NORTH |
| ITM_MAX_EAST | ITM_MAX_EAST | IdmDataAddress → additionalItems → ITM_MAX_EAST |
| ITM_MAX_NORTH | ITM_MAX_NORTH | IdmDataAddress → additionalItems → ITM_MAX_NORTH |
| ETRS89_MIN_LAT | ETRS89_MIN_LAT | IdmDataAddresss → additionalItems → ETRS89_MIN_LAT |
| ETRS89_MIN_LONG | ETRS89_MIN_LONG | IdmDataAddress → additionalItems → ETRS89_MIN_LONG |
| ETRS89_MAX_LAT | ETRS89_MAX_LAT | IdmDataAddress → additionalItems → ETRS89_MAX_LAT |
| ETRS89_MAX_LONG | ETRS89_MAX_LONG | IdmDataAddress → additionalItems → ETRS89_MAX_LONG |
| SPATIAL_ACCURACY | SPATIAL_ACCURACY | IdmDataAddress → additionalItems → SPATIAL_ACCURACY |
| BLD_TYPE_NAME | BLD_TYPE_NAME | IdmDataAddress → additionalItems → BLD_TYPE_NAME |
| BLD_TYPE_CODE | BLD_TYPE_CODE | IdmDataAddress → additionalItems → BLD_TYPE_CODE |
| ORGANISATION_ID | ORGANISATION_ID | IdmDataAddress → additionalItems → ORGANISATION_ID |
| ORG_VACANT | ORG_VACANT | IdmDataAddress → additionalItems → ORG_VACANT |
| NACE_CODE | NACE_CODE | IdmDataAddress → additionalItems → NACE_CODE |
| NACE_CATEGORY | NACE_CATEGORY | IdmDataAddress → additionalItems → NACE_CATEGORY |

