Brazil (BRA)

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

Supported Geocoding Datasets

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

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 Portuguese, Spanish Yes Yes Yes Yes Yes Yes No
HERE No No No No No Yes Yes

Supported Operations

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

Rua Santo Antonio, 355
36800-200 Campinas, Sao Paulo
areaName1 String Specifies the state. Optional.
areaName2 String Not used.
areaName3 String Specifies the city or town.
areaName4 String Specifies the locality. Optional.
postalCode String For Brazil, use the complete eight-digit postcode for the most accurate results; however, you can use a five-digit postcode.
country String The three-letter ISO 3166-1 Alpha-3 country code. For Brazil, the country code is BRA. Required for forward geocoding.

Address Guidelines for Brazil

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 Brazilian addresses, see the Correios Brazil website: http://www.correios.com.br/default.cfm.

  • Required fields—Addresses must contain either a city or a postal code.
  • Thoroughfare types—Thoroughfare types (pre and post thoroughfare types) and their common abbreviations are recognized and fully supported on input and output. Following is a partial list of recognized thoroughfare types.

    ALAMEDA=AL,ALAMEDA,ALUA LALA
    ACESSO=AC,ACESSO
    ARCO=ARCO
    AUTO-ESTRADA=AUTO-EST,AUTO-ESTRADA
    AVENIDA=AV,AVDA,AVE,AVENIDA
    AZINHAGA=AZINHAGA
    BAIRRO=BAI,BAIRRO
    BALUARTE=BALUARTE
    BECO=BECO
    Many others are also recognized.

  • Numbers, numeric equivalents, and ordinals—Numbered streets are mapped to the named equivalents. Ordinals are also recognized in input addresses. For example, the following are all recognized in an input address:

    um, primera, primeiras, primeiro
    dois, segunda, segundos
    Many other numeric designations are also recognized.

  • Directionals in addresses—The following directionals are recognized in input addresses: norte, do norte, setentrional, sul, do sul, meridional, leste, este, do leste, do este, oriental, oeste, do oeste, ocidental
  • Common words and abbreviations—Common words, directionals, house number indicators, and abbreviations used in addresses are supported. This is a partial list of common words and abbreviations that are recognized. Many other common words are also handled.

    Common abbreviations

    aeroporto=aerop
    internacio=intern,int
    internacional=int
    international=int
    conselheiro=cnso
    desembargador=des
    regente=reg
    limitado=ltda,ltdo,ltd
    (and many other abbreviations)

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

There are no options specific to Brazil.

Output Fields

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

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 The state.
areaName2 Not used.
areaName3 The city or town.
areaName4 The locality.
postCode1 The 5-digit postal code.
postCode2 The 3-digit postal code extension.
country The three-letter ISO 3166-1 Alpha-3 country code. For Brazil, the country code is BRA.
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 Brazil does not have any custom output fields.