AddressOutput

Table 1. Address Output
Response Element	Description
AddressLine1	First line of the address.
AddressLine2	Second line of the address.
ApartmentLabel	The type of unit, such as apartment, suite, or lot.
ApartmentLabel.Input	The type of unit, such as apartment, suite, or lot as it was input.
ApartmentNumber	Unit number.
ApartmentNumber.Input	Unit number as it was input
City	The municipality name. For Japan, the municipality subdivision (sub-city)
City.Input	The municipality name as it was input. For Japan, the municipality subdivision (sub-city)
Country	The three-letter ISO 3166-1 Alpha 3 country code. For Canada, the country code is CAN. Addresses for countries that do not have a dedicated geocoding stage return the country code associated with the input address. For example, Vatican City addresses return VAT in the Country field, regardless of whether VAT or ITA (Italy) was passed as the country code. Similarly, addresses in Martinique return MTQ (rather than FRA) in the Country field.
Country.Input	The three-letter ISO 3166-1 Alpha 3 country code as it was input. For Canada, the country code is CAN. Addresses for countries that do not have a dedicated geocoding stage return the country code associated with the input address. For example, Vatican City addresses return VAT in the Country field, regardless of whether VAT or ITA (Italy) was passed as the country code. Similarly, addresses in Martinique return MTQ (rather than FRA) in the Country field.
County	The meaning of county varies by country. CAN (Canada) - Not used
DataType	The returned numeric value represents a data vendor: 0 - USPS 1 - TIGER 2 - TomTom 3 - Sanborn Points 4 - Tele Atlas 5 - Geosys 6 - HERE 7 - TomTom Points 9 - Auxiliary 11 - HERE Points 12 - HERE Points 15 - HERE Points 20 - MapKing International 21 - PT. Duta Astakona Girinda 22 - Lepton 23 - IPC 24 - Map Information Solutions SDN BHD 25 - Critchlow 26 - MIS 27 - Ordnance Survey 28 - Spatial Platform 29 - Code Point 30 - Ordnance Survey AddressBase 31 - PMSA Point 32 - PMSA 33 - MBI 34 - PBS 35 - NE
FirmName	Name of the company or a place name.
FirmName.Input	Name of the company or a place name as it was input.
FormattedInputStreet.Input	The street as it was input.
Geocoder.MatchCode	–
HouseNumber	The building number for the matched location.
HouseNumber.Input	The building number for the matched location as it was input
HouseNumberHigh	The highest house number of the range in which the address resides.
HouseNumberLow	The lowest house number of the range in which the address resides.
HouseNumberParity	Indicates if the house number range contains even or odd numbers or both. E Even O Odd B Both U Unknown
IntersectionIdStreet2.Input	The second street in an intersection address as it was input.
IsCloseMatch	Indicates whether candidate is a close match.
Language	For reverse geocoded candidates, the two-character language code is returned.
LastLine	Complete last address line (city, state/province, and postal code).
Latitude	Latitude of the candidate.
LeadingDirectional	Street directional that precedes the street name. For example, the N in 138 N Main Street.
LeadingDirectional.Input	Street directional that precedes the street name as it was input.
Locality	The meaning of locality varies by country. Generally a locality is a village in rural areas or it may be a suburb in urban areas. When used, a locality typically appears on the last line of the address with the postcode. CAN (Canada)—Dissemination Area and Enumeration Area (DA and EA)
Locality.Input	The locality as it was input. CAN (Canada)—Dissemination Area and Enumeration Area (DA and EA)
Longitude	Longitude of the candidate.
NumberOfCandidateRanges	Indicates the number of ranges of which the candidate is a member. A candidate may be a part of multiple ranges if the candidate is a street instead of a building. To specify the number of ranges to return for each candidate, use the MaxRanges option.
NumberOfRangeUnits	Indicates the number of units included in the range. A unit is an address within a building, such as an apartment or office suite.
PBKey	A unique ID for the address for use as a lookup key.
PostalCode	The postal code for the address. The format of the postcode varies by country. Postcode data is not available for every country.
PostalCode.Addon	The second part of a postcode. For Canadian addresses this will be the LDU. This field is not used by most countries.
PostalCode.Addon.Input	The second part of a postcode as it was input. For Canadian addresses this will be the LDU. This field is not used by most countries.
PostalCode.Base	The first part of a postcode. For Canadian addresses this will be the FSA. This field is not used by most countries.
PostalCode.Base.Input	The first part of a postcode. For Canadian addresses this will be the FSA. This field is not used by most countries.
PreAddress	Miscellaneous information that appears before the street name.
PrivateMailbox	This field is not currently used.
Ranges	This is a list field containing the address ranges that exist on the street segment where the candidate address is located. A range is a series of addresses along a street segment. For example, 5400-5499 Main St. is an address range representing addresses in the 5400 block of Main St. A range may represent just odd or even addresses within a segment, or both odd and even addresses. A range may also represent a single building with multiple units, such as an apartment building. The Ranges field contains the following sub-fields:
	Address This is a list filed that contains sub-fields for any address elements (AddressLine1, City, and so on) that are different from the candidate's address. AdditionalFields A listing of country-specific information related to the address. The information contained in AdditionalFields varies by country. HouseNumberHigh The highest address number for the range. HouseNumberLow The lowest address number for the range.
	SegmentParity Indicates the side of the street where the range is located. One of the following: 0 It is not known which side of the street the range is located on. 1 The range is on the left side of the street. 2 The range is on the right side of the street.
	HouseNumberParity Indicates whether the range contains odd or even address numbers. One of the following: 0 The range contains both odd and even address numbers. 1 The range contains odd address numbers 2 The range contains even address numbers. -1 It is not known whether the range contains odd or even house numbers.
	TotalRangeUnitsReturned The number of unit ranges returned for the address. A unit is an address within a building, such as an apartment or suite. RangeUnits A list of the ranges of units within the building. An example of units are apartments or suites. Address This is a list filed that contains sub-fields for any address elements (AddressLine1, City, and so on) that are different from the candidate's address. UnitNumberHigh The highest unit number. UnitNumberLow The lowest unit number.
SegmentCode	A unique ID that identifies a street segmentan individual address. In Japan, this is the Jusho code. A Jusho Code is a point ID that represents a unique address.
SegmentParity	Indicates which side of the street has odd numbers. L Left side of the street R Right side of the street B Both sides of the street U Undetermined
StateProvince	The meaning of State/Province varies by country. CAN (Canada) - Province
StreetDataType	The default search order rank of the database used to geocode the address. A value of "1" indicates that the database is first in the default search order, "2" indicates that the database is second in the default search order, and so on. The default database search order is specified in the Management Console.
StreetName	For most countries, this contains the street name.
StreetPrefix	The type of street when the street type appears before the base street name.
StreetSuffix	The type of street when the street type appears after the base street name.
TrailingDirectional	Street directional that follows the street name. For example, the N in 456 3rd St. N.
UnitNumberHigh	The highest unit number of the range in which the unit resides.
UnitNumberLow	The lowest unit number of the range in which the unit resides.
Return Parsed Address	The formatted input address can be returned along with a separate returned field for each input address element. Parsed Address Input elements are returned in separately labeled fields names with a .Input extension. See Result Codes.

AddressLine1

First line of the address.

AddressLine2

Second line of the address.

ApartmentLabel

The type of unit, such as apartment, suite, or lot.

ApartmentLabel.Input

The type of unit, such as apartment, suite, or lot as it was input.

ApartmentNumber

Unit number.

ApartmentNumber.Input

Unit number as it was input

City

The municipality name.

For Japan, the municipality subdivision (sub-city)

City.Input

The municipality name as it was input. For Japan, the municipality subdivision (sub-city)

Country

The three-letter ISO 3166-1 Alpha 3 country code.

For Canada, the country code is CAN.

Addresses for countries that do not have a dedicated geocoding stage return the country code associated with the input address. For example, Vatican City addresses return VAT in the Country field, regardless of whether VAT or ITA (Italy) was passed as the country code. Similarly, addresses in Martinique return MTQ (rather than FRA) in the Country field.

Country.Input

The three-letter ISO 3166-1 Alpha 3 country code as it was input.

For Canada, the country code is CAN.

Addresses for countries that do not have a dedicated geocoding stage return the country code associated with the input address. For example, Vatican City addresses return VAT in the Country field, regardless of whether VAT or ITA (Italy) was passed as the country code. Similarly, addresses in Martinique return MTQ (rather than FRA) in the Country field.

County

The meaning of county varies by country.

CAN (Canada) - Not used

DataType

The returned numeric value represents a data vendor:

0 - USPS
1 - TIGER
2 - TomTom
3 - Sanborn Points
4 - Tele Atlas
5 - Geosys
6 - HERE
7 - TomTom Points
9 - Auxiliary
11 - HERE Points
12 - HERE Points
15 - HERE Points
20 - MapKing International
21 - PT. Duta Astakona Girinda
22 - Lepton
23 - IPC
24 - Map Information Solutions SDN BHD
25 - Critchlow
26 - MIS
27 - Ordnance Survey
28 - Spatial Platform
29 - Code Point
30 - Ordnance Survey AddressBase
31 - PMSA Point
32 - PMSA
33 - MBI
34 - PBS
35 - NE

FirmName

Name of the company or a place name.

FirmName.Input

Name of the company or a place name as it was input.

FormattedInputStreet.Input

The street as it was input.

Geocoder.MatchCode

–

HouseNumber

The building number for the matched location.

HouseNumber.Input

The building number for the matched location as it was input

HouseNumberHigh

The highest house number of the range in which the address resides.

HouseNumberLow

The lowest house number of the range in which the address resides.

HouseNumberParity

Indicates if the house number range contains even or odd numbers or both.

E: Even
O: Odd
B: Both
U: Unknown

IntersectionIdStreet2.Input

The second street in an intersection address as it was input.

IsCloseMatch

Indicates whether candidate is a close match.

Language

For reverse geocoded candidates, the two-character language code is returned.

LastLine

Complete last address line (city, state/province, and postal code).

Latitude

Latitude of the candidate.

LeadingDirectional

Street directional that precedes the street name. For example, the N in 138 N Main Street.

LeadingDirectional.Input

Street directional that precedes the street name as it was input.

Locality

The meaning of locality varies by country. Generally a locality is a village in rural areas or it may be a suburb in urban areas. When used, a locality typically appears on the last line of the address with the postcode.

CAN (Canada)—Dissemination Area and Enumeration Area (DA and EA)

Locality.Input

The locality as it was input.

CAN (Canada)—Dissemination Area and Enumeration Area (DA and EA)

Longitude

Longitude of the candidate.

NumberOfCandidateRanges

Indicates the number of ranges of which the candidate is a member. A candidate may be a part of multiple ranges if the candidate is a street instead of a building. To specify the number of ranges to return for each candidate, use the MaxRanges option.

NumberOfRangeUnits

Indicates the number of units included in the range. A unit is an address within a building, such as an apartment or office suite.

PBKey

A unique ID for the address for use as a lookup key.

PostalCode

The postal code for the address. The format of the postcode varies by country. Postcode data is not available for every country.

PostalCode.Addon

The second part of a postcode. For Canadian addresses this will be the LDU. This field is not used by most countries.

PostalCode.Addon.Input

The second part of a postcode as it was input. For Canadian addresses this will be the LDU. This field is not used by most countries.

PostalCode.Base

The first part of a postcode. For Canadian addresses this will be the FSA. This field is not used by most countries.

PostalCode.Base.Input

The first part of a postcode. For Canadian addresses this will be the FSA. This field is not used by most countries.

PreAddress

Miscellaneous information that appears before the street name.

PrivateMailbox

This field is not currently used.

Ranges

This is a list field containing the address ranges that exist on the street segment where the candidate address is located.

A range is a series of addresses along a street segment. For example, 5400-5499 Main St. is an address range representing addresses in the 5400 block of Main St. A range may represent just odd or even addresses within a segment, or both odd and even addresses. A range may also represent a single building with multiple units, such as an apartment building.

The Ranges field contains the following sub-fields:

Address: This is a list filed that contains sub-fields for any address elements (AddressLine1, City, and so on) that are different from the candidate's address.
AdditionalFields: A listing of country-specific information related to the address. The information contained in AdditionalFields varies by country.
HouseNumberHigh: The highest address number for the range.
HouseNumberLow: The lowest address number for the range.

SegmentParity

Indicates the side of the street where the range is located. One of the following:

0: It is not known which side of the street the range is located on.
1: The range is on the left side of the street.
2: The range is on the right side of the street.

HouseNumberParity

Indicates whether the range contains odd or even address numbers. One of the following:

0: The range contains both odd and even address numbers.
1: The range contains odd address numbers
2: The range contains even address numbers.
-1: It is not known whether the range contains odd or even house numbers.

TotalRangeUnitsReturned

The number of unit ranges returned for the address. A unit is an address within a building, such as an apartment or suite.

RangeUnits

A list of the ranges of units within the building. An example of units are apartments or suites.

Address: This is a list filed that contains sub-fields for any address elements (AddressLine1, City, and so on) that are different from the candidate's address.
UnitNumberHigh: The highest unit number.
UnitNumberLow: The lowest unit number.

SegmentCode

A unique ID that identifies a street segmentan individual address. In Japan, this is the Jusho code. A Jusho Code is a point ID that represents a unique address.

SegmentParity

Indicates which side of the street has odd numbers.

L: Left side of the street
R: Right side of the street
B: Both sides of the street
U: Undetermined

StateProvince

The meaning of State/Province varies by country.

CAN (Canada) - Province

StreetDataType

The default search order rank of the database used to geocode the address. A value of "1" indicates that the database is first in the default search order, "2" indicates that the database is second in the default search order, and so on.

The default database search order is specified in the Management Console.

StreetName

For most countries, this contains the street name.

StreetPrefix

The type of street when the street type appears before the base street name.

StreetSuffix

The type of street when the street type appears after the base street name.

TrailingDirectional

Street directional that follows the street name. For example, the N in 456 3rd St. N.

UnitNumberHigh

The highest unit number of the range in which the unit resides.

UnitNumberLow

The lowest unit number of the range in which the unit resides.

Return Parsed Address

The formatted input address can be returned along with a separate returned field for each input address element. Parsed Address Input elements are returned in separately labeled fields names with a .Input extension. See Result Codes.