Response types

spatialReference

The spatial reference of the output match location coordinates as specified by the wkid and latestWkid properties. The outSR input parameter determines the spatial reference.

findAddressCandidates

geocodeAddresses

reverseGeocode

address

The complete matching address returned for findAddressCandidates and geocodeAddresses geocode requests.

Example: 380 New York St, Redlands, California, 92373

findAddressCandidates

geocodeAddresses

address (reverseGeocode only)

The full street address of a location, including house number and street name.

Example: 380 New York St

reverseGeocode

location

The point coordinates of the output match location as specified by the x and y properties. The spatial reference of the x and y coordinates is defined by the spatialReference output field. Refer to the description of the locationType parameter for more information about how the location output field relates to the x and y output attributes.

For reverseGeocode specifically, refer to the description of the returnInputLocation parameter to learn how it can be used to modify the output location coordinates.

findAddressCandidates

geocodeAddresses

reverseGeocode

ResultID

This is only returned for geocodeAddresses requests. Each record in a batch geocode response includes a ResultID value, which equals the OBJECTID value of the corresponding input address record. It can be used to join the output fields in the response to the attributes in the original address table.

geocodeAddresses

Loc_name

The name of the locator used to return a particular match result.

findAddressCandidates

geocodeAddresses

Status

Indicates whether a geocode request results in a match, a tie, or is unmatched.

The possible values are the following:

• M —Matched. The returned address matches the request and is the highest scoring candidate.
• T —Tied. The returned address matches the request but has the same score as one or more additional candidates.
• U —Unmatched. No addresses match the request.

findAddressCandidates

geocodeAddresses

Score

A number from 1–100 indicating the degree to which the input tokens in a geocoding request match the address components in a candidate record. A score of 100 represents a perfect match, while lower scores represent decreasing match accuracy.

findAddressCandidates

geocodeAddresses

Match_addr

The complete address returned for the geocode request. The format is based on address standards for the country in which the address is located.

findAddressCandidates

geocodeAddresses

reverseGeocode

LongLabel

A longer version of the Match_addr value containing more administrative information.

findAddressCandidates

geocodeAddresses

reverseGeocode

ShortLabel

A shortened version of the Match_addr value.

findAddressCandidates

geocodeAddresses

reverseGeocode

Addr_type

The match level for a geocode request. Supported match levels vary in different countries.

The possible values are the following:

• Subaddress —A subset of a PointAddress value that represents a house or building subaddress location, such as an apartment unit, floor, or individual building within a complex. The UnitName , UnitType , LevelName , LevelType , BldgName , and BldgType field values help to distinguish subaddresses that may be associated with the same PointAddress value. Reference data consists of point features with an associated house number, street name, and subaddress elements, along with administrative divisions and optional postal code. Example: 3836 Emerald Ave, Suite C, La Verne, CA, 91750.
• PointAddress —A street address based on points that represent house and building locations. Typically, this is the most spatially accurate match level. Reference data contains address points with associated house numbers and street names, along with administrative divisions and optional postal code. The X / Y and geometry output values for a PointAddress match represent the street entry location for the address; this is the location used for routing operations. The DisplayX and DisplayY values represent the rooftop, or actual, location of the address. Example: 380 New York St, Redlands, CA, 92373.
• StreetAddress —A street address that differs from the PointAddress value because the house number is interpolated from a range of numbers. Reference data contains street center lines with house number ranges, along with administrative divisions and optional postal code information. Example: 647 Haight St, San Francisco, CA, 94117.
• StreetInt —A street address consisting of a street intersection along with city and optional state and postal code information. This is derived from StreetAddress reference data. Example: Redlands Blvd & New York St, Redlands, CA, 92373.
• StreetAddressExt —An interpolated street address match that is returned when =true and the input house number exceeds the house number range for the matched street segment.
• DistanceMarker —A street address that represents the linear distance along a street, typically in kilometers or miles, from a designated origin location. Example: Carr 682 KM 4, Barceloneta, 00617.
• StreetMidBlock —The estimated midpoint of a range of house numbers along a street segment that correspond to a city block. The location returned for a StreetMidBlock match is more precise than that of a StreetName match, but less precise than a StreetAddress match. This value is currently only functional for the United States. Example: 100 Block of Grant Ave, Millville, New Jersey.
• StreetBetween —The center point of a street that is located between two specified cross streets. The location returned for a StreetBetween match is more precise than that of a StreetName match, but less precise than a StreetAddress match. This Addr_type is currently only functional for the United States. Example: Davison Rd between Pine Hill Rd and Ridgetop Ln, Henniker, New Hampshire.
• StreetName —This is similar to a street address but without the house number. Reference data contains street centerlines with associated street names (no numbered address ranges), along with administrative divisions and optional postal code. Example: W Olive Ave, Redlands, CA, 92373.
• Locality —A place-name representing a populated place. The Type output field provides more detailed information about the type of populated place. Possible Type values for Locality matches include Block , Sector , Neighborhood , District , City , MetroArea , County , State or Province , Territory , Country , and Zone . Example: Bogotá, COL
• PostalLoc —A combination of postal code and city name. Reference data is typically a combination of postal boundaries and administrative (locality) boundaries. Example: 7132 Frauenkirchen.
• PostalExt —A postal code with an additional extension, such as the United States Postal Service ZIP+4. Reference data is postal code points with extensions. Example: 90210-3841.
• Postal —A postal code. Reference data is postal code points. Example: 90210 USA.
• POI —Points of interest. Reference data consists of businesses, landmarks, and geographic features. Example: Starbucks.
• LatLong —An x,y coordinate pair. The LatLong addr_type is returned when an x,y coordinate pair, such as 117.155579,32.703761, is the search input.
• XY —The match based on the assumption that the first coordinate of the input is longitude and the second is latitude.
• YX —This is returned as Addr_type for the candidate, which assumes that latitude is the first number in the input, followed by longitude .
• MGRS —A Military Grid Reference System (MGRS) location, such as 46VFM5319397841.
• USNG —A United States National Grid (USNG) location, such as 15TXN29753883. This Addr_type value is only returned when the category parameter is set to USNG in a findAddressCandidates or geocodeAddresses request.

findAddressCandidates

geocodeAddresses

reverseGeocode

Type

The feature type for results returned by a search. The Type field only includes a value for candidates with Addr_type = POI or Locality . As an example, for Starbucks, Type=Coffee Shop .

findAddressCandidates

geocodeAddresses

reverseGeocode

PlaceName

The formal name of a geocode match candidate. Example: Paris or Starbucks.

findAddressCandidates

geocodeAddresses

reverseGeocode

Place_addr

The full street address of a place, including street, city, and region. Example: 275 Columbus Ave, New York, New York.

findAddressCandidates

geocodeAddresses

Phone

The primary phone number of a place of interest (POI). Example: Knott's Berry Farm, Phone=(714)220-5200 . For other searches, such as address, intersection, and postal code, the field is empty.

findAddressCandidates

geocodeAddresses

URL

The URL of the primary website for a place of interest (POI). Example: the University of Georgia, URL =http://www.uga.edu/ . For other searches, such as address, intersection, and postal code, the field is empty.

findAddressCandidates

geocodeAddresses

Rank

A floating-point number value indicating the priority of a result relative to other results with the same name. For example, there are cities in France and Texas named Paris. Paris, France, has a greater population than Paris, Texas, so it has a higher rank. The Rank field is used to sort results for ambiguous queries such as Lincoln, when no additional information (state) is available. Rank values are based on population or feature type.

findAddressCandidates

geocodeAddresses

AddBldg

The name of a building. Example: Empire State Building.

findAddressCandidates

geocodeAddresses

AddNum

The alphanumeric value that represents the portion of an address typically known as a house number or building number. Example: in the address 380 New York Street, AddNum = 380 .

This value is returned for PointAddress and StreetAddress matches only.

findAddressCandidates

geocodeAddresses

reverseGeocode

AddNumFrom

A value representing the beginning number of a street address range. It is relative to direction of feature digitization and is not always the smallest number in the range. This value is provided for StreetAddress results.

findAddressCandidates

geocodeAddresses

AddNumTo

A value representing the ending number of a street address range. It is relative to direction of feature digitization and is not always the largest number in the range. This value is provided for StreetAddress results.

findAddressCandidates

geocodeAddresses

AddRange

The full house number range for the street segment that an address lies on, in the format AddNumFrom-AddNumTo. For example, the AddRange value for street address 123 Main St may be 101-199.

findAddressCandidates

geocodeAddresses

Side

The side of the street where an address resides relative to the direction of feature digitization. This value is not relative to the direction of travel along the street. Possible values are R (right) and L (left).

findAddressCandidates

geocodeAddresses

StPreDir

An address element defining the direction of a street and occurs before the primary street name. Example: North in North Main Street.

findAddressCandidates

geocodeAddresses

StPreType

An address element defining the leading type of a street. Example: the Spanish term Avenida in Avenida Central or the French term Rue in Rue Lapin.

findAddressCandidates

geocodeAddresses

StName

An address element defining the primary name of a street. Example: Main in North Main Street.

findAddressCandidates

geocodeAddresses

StType

An address element defining the trailing type of a street. Example: Street in Main Street.

findAddressCandidates

geocodeAddresses

StDir

An address element defining the direction of a street, which occurs after the primary street name. Example: North in Main Street North.

findAddressCandidates

geocodeAddresses

BldgName

The name or number of a building subunit. Example: A in building A.

findAddressCandidates

geocodeAddresses

BldgType

The classification of a building subunit. Examples are building, hangar, and tower.

findAddressCandidates

geocodeAddresses

LevelType

The classification of a floor subunit. Examples are floor, level, department, and wing.

findAddressCandidates

geocodeAddresses

LevelName

The name or number of a floor subunit. Example: 3 in level 3.

findAddressCandidates

geocodeAddresses

UnitType

The classification of a unit subunit. Examples are unit, apartment, flat, office, and suite.

findAddressCandidates

geocodeAddresses

UnitName

The name or number of a unit subunit. Example: 2B in apartment 2B.

findAddressCandidates

geocodeAddresses

SubAddr

The full subunit value for a candidate with Addr_type=Subaddress that includes <subunit type> + <subunit name> . For example, if the subaddress candidate is an apartment unit, SubAddr = UnitType + UnitName . Example: Apt 4B

findAddressCandidates

geocodeAddresses

StAddr

The street address of a place, without city and region. Example: 275 Columbus Ave.

findAddressCandidates

geocodeAddresses

Block

The name of the block-level administrative division for a candidate. The Block value is the smallest administrative area for a country. It can be described as a subdivision of sector or neighborhood or a named city block. It is not commonly used.

findAddressCandidates

geocodeAddresses

reverseGeocode

Sector

The name of the sector-level administrative division for a candidate. The Sector value is a subdivision of a neighborhood or district, or represents a collection of blocks. It is not commonly used.

findAddressCandidates

geocodeAddresses

reverseGeocode

Nbrhd

The name of the neighborhood-level administrative division for a candidate. The Nbhrhd value is a subsection of a city or district.

findAddressCandidates

geocodeAddresses

Neighborhood

The name of the neighborhood-level administrative division for a candidate. The Neighborhood value is a subsection of a city or district.

reverseGeocode

District

The name of the district-level administrative division for a candidate. Such as a subdivision of a city.

findAddressCandidates

geocodeAddresses

reverseGeocode

City

The name of the city-level administrative division for a candidate. The City value is a subdivision of a subregion or region.

findAddressCandidates

geocodeAddresses

reverseGeocode

MetroArea

The name of the metropolitan area-level administrative division for a candidate. It is an urban area consisting of a large city and the smaller cities surrounding it. The value can potentially intersect multiple subregions or regions. An example is Kolkata Metropolitan Area in India.

findAddressCandidates

geocodeAddresses

reverseGeocode

Subregion

The name of the subregion-level administrative division for a candidate. The Subregion value is a subdivision of a region.

findAddressCandidates

geocodeAddresses

reverseGeocode

Region

The name of the region-level administrative division for a candidate. It is a subdivision of a country or territory. It is typically the largest administrative area for a country if the Territory administrative division is not used.

findAddressCandidates

geocodeAddresses

reverseGeocode

RegionAbbr

The abbreviated region name. The RegionAbbr value for California is CA.

findAddressCandidates

geocodeAddresses

reverseGeocode

Territory

The name of the territory-level administrative division for a candidate. It is a subdivision of country. It is not commonly used. The Sudeste macroregion of Brazil, which encompasses the states of Espírito Santo, Minas Gerais, Rio de Janeiro and São Paulo, is an example.

findAddressCandidates

geocodeAddresses

reverseGeocode

Postal

An alphanumeric address element defining the primary postal code. Example: V7M 2B4 for a Canadian postal code and 92374 for a United States postal code.

findAddressCandidates

geocodeAddresses

reverseGeocode

PostalExt

An alphanumeric address element defining the postal code extension. Example: 8100 in USA postal code 92373-8110.

findAddressCandidates

geocodeAddresses

reverseGeocode

Country

A 3-character code for a country. Example: Canada is CAN. A list of supported countries and codes is available in Geocode data coverage. This field is returned by the findAddressCandidates and geocodeAddresses operations.

findAddressCandidates

geocodeAddresses

CountryCode

A 3-character code for a country. Example: Canada is CAN. A list of supported countries and codes is available in Geocode data coverage.

reverseGeocode

CntryName

The full country name for an address candidate. Example: 日本 (Japan). The name may be in the same language as the input address or in the language specified by the langCode parameter for the request. If the full country name is not available in the specified language, the primary language of the country that the address candidate is in is used. Information about supported languages by country is available in Geocode data coverage. This field is returned by the findAddressCandidates , geocodeAddresses , and reverseGeocode operations.

findAddressCandidates

geocodeAddresses

reverseGeocode

LangCode

A 3-character language code representing the language of the address. Example: ENG is English.

findAddressCandidates

geocodeAddresses

Distance

The physical distance in meters from a candidate to a specified location. The Distance output value is calculated for each candidate when the Location input parameter is passed in a request using the findAddressCandidates operation. If the Location parameter is not passed in a request, the value of Distance is zero.

findAddressCandidates

X

The primary x-coordinate of an address returned by the ArcGIS Geocoding service in spatial reference WGS84 (WKID 4326).

findAddressCandidates

geocodeAddresses

reverseGeocode

Y

The primary y-coordinate of an address returned by the ArcGIS Geocoding service in spatial reference WGS84 (WKID 4326).

findAddressCandidates

geocodeAddresses

reverseGeocode

InputX

The x-coordinate that was submitted in a reverseGeocode request for the location parameter

reverseGeocode

InputY

The y-coordinate that was submitted in a reverseGeocode request for the location parameter

reverseGeocode

DisplayX

The display x-coordinate of an address returned by the ArcGIS Geocoding service in spatial reference WGS84 (WKID 4326). For most types of matches, the X and DisplayX values are the same. For matches of Addr_type , PointAddress , and Subaddress specifically, the values may be different. In general, for PointAddress and Subaddress matches, DisplayX represents the x-coordinate value of the building rooftop or parcel centroid for the address, and the X value represents the x-coordinate of the street-side location for the address. There are exceptions however. Some address data sources used by the ArcGIS Geocoding service only provide the rooftop location of PointAddress and Subaddress features. However, for some PointAddress and Subaddress features, only the street-side location is available. For these cases, the X and DisplayX values are equivalent.

findAddressCandidates

geocodeAddresses

DisplayY

The display y-coordinate of an address returned by the ArcGIS Geocoding service in spatial reference WGS84 (WKID 4326). For most types of matches, the Y and DisplayY values are the same. For matches of Addr_type , PointAddress , and Subaddress specifically, the values may be different. In general, for PointAddress and Subaddress matches, DisplayY represents the y-coordinate value of the building rooftop or parcel centroid for the address, and the Y value represents the y-coordinate of the street-side location for the address. There are exceptions however. Some address data sources used by the ArcGIS Geocoding service only provide the rooftop location of PointAddress and Subaddress features. However, for some PointAddress and Subaddress features, only the street-side location is available. For these cases, the Y and DisplayY values are equivalent.

findAddressCandidates

geocodeAddresses

Xmin

The minimum x-coordinate for the display extent of a feature returned by the ArcGIS Geocoding service. The Xmin , Xmax , Ymin , and Ymax values can be combined to set the map extent for displaying a geocode result. The extent coordinates use the WGS84 spatial reference.

findAddressCandidates

geocodeAddresses

Xmax

The maximum x-coordinate for the display extent of a feature returned by the ArcGIS Geocoding service. The Xmin , Xmax , Ymin , and Ymax values can be combined to set the map extent for displaying a geocode result. The extent coordinates use the WGS84 spatial reference.

findAddressCandidates

geocodeAddresses

Ymin

The minimum y-coordinate for the display extent of a feature returned by the ArcGIS Geocoding service. The Xmin , Xmax , Ymin , and Ymax values can be combined to set the map extent for displaying a geocode result. The extent coordinates use the WGS84 spatial reference.

findAddressCandidates

geocodeAddresses

Ymax

The maximum y-coordinate for the display extent of a feature returned by the ArcGIS Geocoding service. The Xmin , Xmax , Ymin , and Ymax values can be combined to set the map extent for displaying a geocode result. The extent coordinates use the WGS84 spatial reference.

findAddressCandidates

geocodeAddresses

ExInfo

A collection of strings from the input that could not be matched to any part of an address and were used to score or penalize the result.

findAddressCandidates

geocodeAddresses

extent

The minimum bounding rectangle of the output match feature as specified by the Xmin , Ymin , Xmax , and Ymax field values. The spatial reference of the x- and y-coordinates is defined by the spatialReference output field. This is always returned by default for findAddressCandidates geocode requests only.

findAddressCandidates

StrucType

A designation for a structure or building that describes its primary usage. These are the possible values:

• Residential —A dwelling where people live.
• Commercial —A business facility, such as an office building, store, or warehouse.

Only geocoding candidates that have Addr_type values of PointAddress or Subaddress will include a value for the StrucType field.

findAddressCandidates

geocodeAddresses

reverseGeocode

StrucDet

Related to StrucType. A more detailed usage description for a structure or building.

For addresses with StrucType value Residential, the following StrucDet values are supported:

• Single Family —A detached single-family dwelling.
• Multifamily —A building that includes multiple separate housing units, such as an apartment building.

For addresses with StrucType value Commercial, the following StrucDet values are supported:

• Agricultural
• Industrial
• Lodging
• Medical
• Office
• Recreation
• Retail
• Transport
• Utilities
• Warehouse

Only geocoding candidates that have Addr_type values of PointAddress or Subaddress will include a value for the StrucDet field.

findAddressCandidates

geocodeAddresses

reverseGeocode