Skip to main content

UK Geocoder Macro

This macro uses TomTom’s Geocoder API to geocode a file composed of UK addresses.

Macro Tool

This tool is a macro that requires a separate data install and license. To use this tool, contact your Account Executive.

Configure the Tool

There are 2 tabs that require your input to successfully configure this tool: Input and Output.

Input Tab

Configure the Address fields:

  • The Address field is required. You can geocode intersections in addition to specific addresses by putting intersections in the same field as regular addresses. Intersections should be formatted according to the pattern: ‘Street 1 & Street 2’.

  • TheDistrict is an optional field. Specifying a District is not required, but it improves result accuracy. If only some of your records have District, you can still specify this field, and the UK Geocoder uses it where it can.

  • The City field is required.

  • The Postal Code is an optional field. Specifying a Postal Code is not required, but it improves result accuracy. If only some of your records have District, you can still specify this field, and the UK Geocoder uses it where it can.

Output Tab

Use the check box to select any and all variables you would like included in the Geocoded output. Output fields include:

  • Country ISO3: GBR

  • State: Wales, Scotland, Northern Ireland, England

  • API-Output Address: The formatted address for the best match that the TomTom Geocoder API was able to find.

  • Geohash: The geohash of the match location. For more information about geohashes, go to http://en.wikipedia.org/wiki/Geohash.

  • Geolevel: The API code for the Geocoding Accuracy Level of each result. This code describes the precision of each result.

  • Geolevel - Detail: The full description of the Match Accuracy Level code.

  • Result Code: A combination of TomTom Geocoder API Status Codes that further describe the accuracy of each match. Two Status Codes are provided for each match, a Geocoding Level code and a Postal Matching code, and both are comprised of a Status and Info code, separated by a hyphen (for example, POCMATCH-POC). For a full description of these codes, go to http://developer.tomtom.com/docs/read/geocoding/Match_Levels.

Output

There are 2 outputs from this tool:

  • G anchor: Geocoded records stream out of the top of the tool, labeled with a G. This data stream includes all the fields you selected to output as a result of the geocoding process.

    This tool only returns fields that are output by the TomTom Geocoder API. If you want to include additional fields for use in a downstream process, you need to Join the additional fields back to the output of the tool. Records are output in the same order as they went in, so you can join by record position.

  • S anchor: A Data summary streams out of the right side of the tool, labeled with an S. The data stream includes 3 fields: Match Accuracy Level, Match Accuracy Level Detail, and a count of how many records fall into each level. There are 12 possible Match Accuracy Levels. They are listed below in order of best to worst:

Geolevel

Geoleve-Detail

addresspoint

Input address matches to an exact latitude/longitude location. The data returned is the entry point of the address.

house

Input address matches to a house number along an address range. The data returned is an interpolated location of the requested address within that range.

intersection

Input address matches to two streets that intersect. The data returned is the coordinate where the street edges cross.

postalcode-sub

Input address matches to an extended postcode (for example, USA ZIP+4, UK full postcode). The granularity of this result depends on the country's postal code scheme but is usually accurate to the desired block.

street

Input address matches to a street edge in the database. The data returned is associated to the midpoint of a street chain within a city. A house number will not be returned for this level of match.

postalcode-partial-sub

Input address matches to an extended postcode (for example, USA ZIP+2). The granularity of this depends on the country's postal code scheme but is usually accurate to the desired neighborhood.

district

Input address matches to a district/neighborhood. Returns the center point of the district.

postalcode-main

Input address matches to a main postal code (for example, USA ZIP, UK main postcode). The accuracy of this depends on the country's postal code scheme.

city

Input address matches to a city/locality. Returns the center point of the city.

state

Input address matches to a state. Returns state/province/administrative area coordinates.

Country

Input address matches to a country.

In this section: