Geocoding Options

This table lists the configuration options for GeocodeAddressCAN.

Parameter

Description

Option.OffsetFromCorner

Specifies the distance to offset the street end points in street-level matching. The distance is specified in the units you specify in the OffsetUnits option.This value is used to prevent addresses at street corners from being given the same geocode as the intersection. The Default offset is 7 meters.

Option.OffsetUnits

Specifies the unit of measurement for the street offset and corner offset options.

One of these:
  • ft = Feet
  • mi = Miles
  • m = Meters
  • km = Kilometers

The default is m = Meters.

Option.MaxCandidates

If you select this option, specify the maximum number of candidates to return using the MaxCandidates option (see below).

Y
Default value 1.
N
No, do not return candidates. Addresses that result in multiple candidates will fail to geocode.

Option.CoordinateSystem

The coordinate system used to determine the latitude and longitude coordinates. A coordinate system specifies a map projection, coordinate units, etc. An example is EPSG:4326. EPSG stands for European Petroleum Survey Group.

Legal Value: EPSG:4326 = EPSG:4326

Default Value: EPSG:4326 = EPSG:4326

Option.OffsetFromStreet

Indicates the offset distance from the street segments to use in street-level geocoding. The distance is specified in the units you specify in the OffsetUnits option. The default value varies by country. For most countries, the default is 7 meters.

The offset distance is used in street-level geocoding to prevent the geocode from being in the middle of a street. It compensates for the fact that street-level geocoding returns a latitude and longitude point in the center of the street where the address is located. Since the building represented by an address is not on the street itself, you do not want the geocode for an address to be a point on the street. Instead, you want the geocode to represent the location of the building which sits next to the street.

For example, an offset of 40 feet means that the geocode will represent a point 40 feet back from the center of the street. The distance is calculated perpendicular to the portion of the street segment for the address. Offset is also used to prevent addresses across the street from each other from being given the same point. The diagram below shows an offset point in relation to the original point.

Option.FallbackToPostal

Specifies whether to attempt to determine a postal code centroid when an address-level geocode cannot be determined. For Argentina, you must use HERE data for postal geocoding.

This option is not available for Bahamas, Hong Kong, Macau, Philippines, Uruguay, and Venezuela. For Argentina, you must use HERE data for postal geocoding. The majority of African countries and Middle Eastern countries do not include postal code data, and therefore do not support postal centroid geocoding.

Y
Yes, determine a postal code centroid when an address-level centroid cannot be determined. Default.
N
No, do not determine a postal code centroid when an address-level centroid cannot be determined.

Option.GeocodeLevel

Specifies how precisely you want to geocode addresses. One of these:

StreetAddress
The geocoder attempts to geocode addresses to a street address, but some matches may end up at a less precise location such as a postal code centroid, intersection, or shape path.
PostalCentroid
This option is not available for this country. For Argentina, you must use HERE data for postal geocoding. The majority of African countries and Middle Eastern countries do not include postal code data, and therefore do not support postal centroid geocoding.If postal code data is available, the geocoder attempts to geocode addresses to the most precise postal code it finds. The advantage of postal code centroid matching is the speed of the operation. The disadvantage of postal code matching is that the geocoder only examines the PostalCode field. If you use street address precision, the geocoder looks at both the street name and the PostalCode field and attempts to return street-level coordinates and optionally fall back to postal code coordinates.
GeographicCentroid
The geocoder attempts to geocode addresses to the geographic centroid of a city or state. This option is not available for the United Kingdom (GBR).

Option.FallbackToGeographic

Specifies whether to attempt to return a city, county, or state centroid when an address-level geocode cannot be determined. The geocoder returns the most precise geographic centroid that it can based on the input. For example, if the input contains a valid city and state, a city centroid would be returned.

Note: There are approximately 300 major cities that can be geocoded to a city centroid level even if a valid state is not provided in the input.

Geographic centroid geocodes are indicated by value in the LocationCode output field that begins with "G". For more information, see Geographic Centroid Location Codes.

Note: This option is not available if you set MatchMode to CASS.
Y
Yes, attempt to determine the geographic centroid when an address-level geocode cannot be determined.
N
No, do not attempt to determine the geographic centroid when an address-level geocode cannot be determined. Default.

Option.Interpolation

Specifies whether to perform address point interpolation. This option only works if you have a point database installed. This option is available for selected countries only.

Address point interpolation uses point data to refine geocode results. By default, the geocoding process estimates the location of an address based on the street numbers at either end of street segment. For example, if a street segment runs from 100 Main St. to 200 Main St., then a request for 150 Main St. will return a location in the middle of the segment. With interpolation, the geocoder finds the position of 180 Main St. in the point data, and it is about two-thirds of the way down the street. Using this information, the geocoder can estimate the position of 150 Main St. based on 100 and 180 Main St. In this case, the geocoder estimates the location of the address slightly away from the center of the segment.

Y
Yes, perform address point interpolation.
N
No, do not perform address point interpolation. Default.