Parameters for Addresses Outside the U.S.

Option.CloseMatchesOnly

Specifies whether to return only those geocoded results that are close match candidates. For example, if there are 10 candidates and two of them are close candidates, and you enable this option, only the two close matching candidates would be returned instead of all 10. To specify what is considered a close match, use the MustMatch options. Address candidates are ranked according to how closely the input address matches these preferences.

Y

Yes, return only close matches.

N

No, do not return only close matches. Default.

Option.ExpandCandidates

This option applies to U.K. addresses only.

Specifies whether to return multiple close matches (one for each delivery point on the street). By default, if a street has multiple addresses/delivery points, the geocoder returns a single close match, with each individual delivery point available as a range.

Option.GeocodeLevel

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

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

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 determine a geographic region centroid when an address-level geocode cannot be determined. This option is not available for the United Kingdom (GBR).

Y

Yes, determine a geographic centroid when an address-level centroid cannot be determined. Default.

N

No, do not determine a geographic centroid when an address-level centroid cannot be determined.

Option.FallbackToPostal

Specifies whether to attempt to determine a postal code centroid when an address-level geocode cannot be determined.

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.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.

Option.KeepMultimatch

Specifies whether to return results when the address matches to multiple candidates in the database. If this option is not selected, an address that results in multiple candidates will fail to geocode.

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

Y

Yes, return candidates when multiple candidates are found. Default.

N

No, do not return candidates. Addresses that result in multiple candidates will fail to geocode.

MatchModeInt

Specifies how to determine whether a candidate is a close match. One of the following:

CustomMode

This option allows you to specify which parts of a candidate address must match the input address to be considered a close match. Use the MustMatch<Element> options to specify the address elements you want. This is the default value for most countries.

ExactMode

All of a candidate address's elements must match in order for the candidate to be considered a close match.

Note that for IND, Exact match mode returns the sublocality and place name information

CloseMode

Only the candidate address's house number must match in order for the candidate to be considered a close match. For Chile, China, Great Britain, Estonia, India, Indonesia, Latvia, Lithuania, Slovakia, Slovenia, Taiwan, and South Africa, only the street name and town must match.

RelaxedMode

All candidate addresses are considered a close match.

Option.MustMatchInput

Specifies whether candidates must match all non-blank input fields to be considered a close match. For example, if an input address contains a city and postal code, then candidates for this address must match the city and postal code to be considered a close match.

Y

Yes, a candidate must match all input to be considered a close match.

N

No, a candidate does not have to match all input to be considered a close match. Default.

Option.MustMatchHouseNumber

Specifies whether candidates must match the house number to be considered a close match.

If you select this option you should also require an exact match on street name. This option does not significantly affect performance. It does, however, affect the type of match if the candidate address corresponds to a segment that does not contain any ranges. The type of match can also be affected when the house number range for a candidate does not contain the input house number. If you relax the house number, you should set the maximum ranges to be returned to a value higher than 0.

Y

Yes, a candidate must match the house number to be considered a close match.

N

No, a candidate does not have to match the house number to be considered a close match.

Option.MustMatchStreet

Specifies whether candidates must match the street name to be considered a close match.

If a close match is found, the geocoder attempts expanded street name manipulation, which looks for candidates with names that sound like the input address or that are spelled improperly. This slows down performance but increases the match rate . If the geocoding database is indexed, the performance impact is reduced.

Y

Yes, a candidate must match the street name to be considered a close match.

N

No, a candidate does not have to match the street name to be considered a close match.

Option.MustMatchLocality

Specifies whether candidates must match the locality (or equivalent) to be considered a close match. The meaning of Locality varies for different countries.

If you do not require exact matches on locality, the geocoder searches on the street address matched to the particular postal code, and considers other localities that do not match the name, but do match the postal code.

Y

Yes, a candidate must match the locality to be considered a close match.

N

No, a candidate does not have to match the locality to be considered a close match.

Option.MustMatchCity

Specifies whether candidates must match the city to be considered a close match. If you do not require exact matches on city, the geocoder searches on the street address matched to the particular postal code, and considers other cities that do not match the name, but do match the postal code.

Y

Yes, a candidate must match the city to be considered a close match.

N

No, a candidate does not have to match the city to be considered a close match.

Option.MustMatchCounty

Specifies whether candidates must match the county (or equivalent) to be considered a close match. The meaning of county varies for different countries.

One of the following:

Y

Yes, a candidate must match the county to be considered a close match.

N

No, a candidate does not have to match the county to be considered a close match.

Option.MustMatchStateProvince

Specifies whether candidates must match the state or province (or equivalent) to be considered a close match.

One of the following:

Y

Yes, a candidate must match the state or province to be considered a close match.

N

No, a candidate does not have to match the state or province to be considered a close match.

Option.MustMatchPostalCode

Specifies whether candidates must match the postal code to be considered a close match. If you do not require exact match on postal codes, the geocoder searches a wider area for a match. While this results in slower performance, the match rate is higher because the request does not need to match exactly when it compares match candidates.

Specifies whether candidates must match the postal code to be considered a close match. If you do not require exact match on postal codes, the geocoder searches a wider area for a match. While this results in slower performance, the match rate is higher because the request does not need to match exactly when it compares match candidates.

Y

Yes, a candidate must match the postal code to be considered a close match.

N

No, a candidate does not have to match the postal code to be considered a close match.

Option.MustMatchPostDistrict

Specifies whether the postal district portion of the postcode must match in order for the match to be considered a close match.

UK postcodes are divided into two sections: the outward code, which is to the left of the space, and the inward code, which is to the right. The outward code represents the postal district. For example, in the postcode CB3 OHH, the postal district is CB3, which is Cambridge.