Ireland (IRL)

This section defines the supported geocoding datasets, operations, and input and output field information for Ireland.

Supported Geocoding Datasets

The following table lists the supported geocoding dataset(s) with the available geocoding levels for Ireland.

Note:

Custom User Dictionaries are not supported.

Geocoding Dataset City Centroid Suburb/Village Centroid Postal Centroid Street Centroid Interpolated Street Address Point-level Address Point of Interest
TomTom English, Irish Yes Yes Yes Yes Yes Yes No

Supported Operations

The following operations are supported for Ireland:
  • Geocoding—Takes one or more addresses as input and returns latitude/longitude coordinates and other information.
  • Reverse Geocoding—Takes one or more latitude and longitude coordinates as input and returns the address of the location.
  • Interactive Geocoding— Returns potential match candidates as the adddress is typed in.
  • Global Key Lookup—Returns geocode candidates when given a unique key as input. USA MLD and AUS GNAF data only.

Input Fields

The input address may contain some or all of the following address elements.

Parameter Type Description
placeName String Specifies the building name, place name, Point of Interest (POI), company or firm name associated with the input address. Optional.
mainAddress String Single Line Input—If no other address field is populated, then the mainAddress entry will be treated as a single line input. Single line input can consist of multiple input address fields ; these should be entered in the typical address order for the country. For more details, refer to the section "Single Line Input" below.

Street Address—If the post address components (city, postalCode, etc.) are provided separately or in the lastLine field, then the contents of mainAddress will be treated as the street address part and can include company name, house number, building names and street names. Optional.

Street Intersection Input—To enter an intersection, specify the two street names separated by a double ampersand (&&).
lastLine String The last line of the address. Optional. For example:

7 Irvine Court
Dublin 3
areaName1 String Not used.
areaName2 String Specifies the province. Optional.
areaName3 String Specifies the city or town. Optional.
areaName4 String Not used.
postalCode String Specifies Dublin's postal district. Ireland does not have a postal code system; however, Dublin is divided into postal districts. Optional.
country String The three-letter ISO 3166-1 Alpha-3 country code. For Ireland, the country code is IRL. Required for forward geocoding.

Address Guidelines for Ireland

Follow these suggestions to ensure that your input address data is in the best format possible for optimum matching and geocoding. For additional information about the Ireland postal system, see the An Post website: www.anpost.ie.

  • Required fields—Addresses must contain a city. IRL has very limited postal code data.
  • Thoroughfare types—Thoroughfare types (pre and post thoroughfare types) and their common abbreviations are recognized and fully supported on input and output. The following table provides a partial list of recognized thoroughfare types. Many others are also recognized.

    Pre-Thoroughfare Types

    Post Thoroughfare Types

    Áirse

    Street (Also: St.,ST,STR)

    Ard

    Terrace (Also: TCE)

    Arda

    Third

    Ardán

    Track (Also: TRK,TCK)

    Ascaill

    Vale

    Barra

    Valley

    Bealach

    View

    Bogha

    Village

    Bóithrín

    Walk (Also: WK)

    Bóthar

    Way (Also: WY)

    Brí

    Wood(s)

    Bruach

    Yard (Also: Yd.)

    Búlbhard

    		  
  • Directionals—The geocoder recognizes the following directionals: North, N, Nth, South, S, Sth, East, E, Est, West, W, Wst, NE, NW Sea SW Lower, LW, LR, Upper, UP, Upp, Uppe, upr, Thuaidh, Thoirm, Thiar, Theas
  • Common abbreviations—The geocoder recognizes common abbreviations used in addresses and can geocode these addresses successfully. This is a partial list of abbreviations that are understood by the geocoder. Many other common abbreviations are also handled.

    Word

    Abbreviation

    saint

    st., st

    great

    gt., gt

    north

    n, nth

    south

    s, sth

    east

    e, est

    west

    w, wst

    northeast

    ne

    northwest

    nw

    southeast

    se

    southwest

    sw

    lower

    lw, lr

    upper

    up, upp, uppe

    mount

    mnt, mt

    and

    &

    football

    f

    club

    c

    limited

    ltd

    park

    pk

    estate

    est

    gardens

    gdns

    building

    bld

    industrial

    ind

    industries

    ind

    number

    num

    center

    cnt, centre

    centre

    cnt, center

    country

    co

    market

    mrkt

    square

    s

Single Line Input

Instead of entering each address component in separate fields, you can enter the entire address in the mainAddress input field with the address elements ordered as follows:

[address_number][street_info][area][postal_code]

Where:
  • [address_number] is optional.
  • [street_info] consists of the street name, street type and any pre- or post-directional information (for example, East, West, etc.).
  • [area] is the city only, or city plus supporting information, such as state, province, locality.
  • [postal_code] is the Dublin postal district for addresses in Dublin.
  • Either the [area] or [postal_code] is required.
For best results, put a comma between the street information and the last address line information.

Custom Options

There are no options specific to Ireland.

Output Fields

The following table lists the address fields returned for a candidate located in Ireland.

Note: The placeName, addressNumber, unitType and unitValue field values are only returned when a geocoding dataset that supports street address interpolation is installed.
Field Name Description
mainAddressLine The street address which may include company name, house number, building names and street names.
addressLastLine The last line of the address.
placeName The building name, place name, Point of Interest (POI), company or firm name associated with the address.
areaName1 Not used.
areaName2 The province.
areaName3 The city or town.
areaName4 Not used.
postCode1 Dublin's postal district code; otherwise, not used.
postCode2 Not used.
country The three-letter ISO 3166-1 Alpha-3 country code. For Ireland, the country code is IRL.
addressNumber The address number.
streetName The street or road name.
unitType The unit type such as APT, STE, etc.
unitValue The unit value/number, such as "3B".
customFields Ireland does not have any custom output fields.