Portugal (PRT)

This chapter defines the supported Geocode datasets, operations, and input and output field information for Portugal.

Supported Geocode Datasets

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

Geocode Dataset Maximum Precision Postcodes Language Geocode Level
TomTom Address Points Yes Portuguese Premium & Advanced
NAVTEQ Address Points Yes Portuguese Premium

Supported Operations

The following operations are supported for Portugal:
  • 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.

Input Fields

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

Field Name 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:

Rua Miguel Bombarda 49
2775-153 Parede
areaName1 String Specifies the region. Optional.
areaName2 String Not used.
areaName3 String Specifies the city or town. This may also be the town alias. For example, Lisbon, Lisbonne, Lissabon, and Lisbona are aliases for Lisboa. Optional.
areaName4 String Specifies the locality. Optional.
postalCode String Portugal uses a four-digit postal code beginning with a number between 1 and 9. More recently, Portugal instituted a seven-digit postcode with a dash and three additional digits following the first four digits. The Geocoder ignores the additional three digits and returns the four-digit postal code. Optional.
country String ISO 3166-1 Alpha-3 country code or country name. For Portugal, the country code is PRT. Required for forward geocoding.

Address Guidelines for Portugal

Follow these suggestions to ensure that your input address data is in the best format possible for optimum matching and geocoding. For additional information on Portugal addresses, see the CTT Portugal Post website: www.ctt.pt.

  • Required fields—Addresses must contain either a city or a postal code.
  • Thoroughfare types—Thoroughfare types and their common abbreviations are recognized and fully supported on input and output.
  • Common words and abbreviations—The geocoder recognizes common words, directionals, house number indicators, and abbreviations used in addresses and can geocode these addresses successfully.
  • Numbers, numeric equivalents, and ordinals—Numbered streets are mapped to the named equivalents. Ordinals are also recognized in input addresses.

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:

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

Where:
  • [street_info] consists of the street name, street type and any pre- or post-directional information (e.g. East, West, etc.). Optional.
  • [address_number] is optional.
  • [postal_code] is the postal code.
  • [area] is the city only, or city plus supporting information, such as state, province, locality.
  • 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

The following table lists the options that are unique for Portugal. These custom fields are applicable to the Geocode operation and are optional input parameters.

Option Name Description
USE_ADDRESS_POINT_INTERPOLATION When set to true, enables address point interpolation. Default = false. Supported in forward geocoding only.
Note: The address point interpolation feature requires that you have a point-level geocoding dataset installed.
USE_CENTERLINE_OFFSET When set to true, calculates the centerline offset for point addresses. Default = false. Supported in forward geocoding only.
Note: The centerline feature requires that you have a point-level geocoding dataset installed.
A centerline point match is indicated by a result code beginning with SC.
CENTERLINE_OFFSET When USE_CENTERLINE_OFFSET is enabled, this specifies the distance to offset the point from centerline. Default = 0. Supported in forward geocoding only.
CENTERLINE_OFFSET_UNIT When USE_CENTERLINE_OFFSET is enabled, this specifies the unit type for the centerline offset. Valid values = feet, meters. Default = meters. Supported in forward geocoding only.

Parsed Address Output Fields

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

To return the Parsed Address fields, send the returnAllCandidateInfo preference true in POST request.

Note: The placeName, addressNumber, unitType and unitValue field values are only returned when the Geocode 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 The region.
areaName2 Not used.
areaName3 The city or town.
areaName4 The locality.
postCode1 The first 4 digits of the postal code.
postCode2 Not used.
country The three-letter ISO 3166-1 Alpha-3 country code. For Portugal, the country code is PRT.
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 Portugal does not have any custom output fields.