Autocomplete Response Fields

Below table lists the response fields returned:

Table 1.
Response Element	Type	Descrition
address	ResponseAddress	Displays components of the address
addressLines	<String> array	All address components are formatted and presented according to UPU standards. `"PRIME MINISTER& FIRST LORD OF THE TREASURY", "10 DOWNING STREET", "LONDON", "SW1A 2AA", "UNITED KINGDOM"`
addressNumber	String	House or building number.`"10"` or `"630"`
admin1	AdminField	Specifies the largest geographic area, typically a state or province.`"New York"` or `"Maharashtra"`. The field can contain either longName or shortName. Note: Only a few countries support shortName. In most cases, shortName and longName will have the same value.
admin2	AdminField	Specifies the secondary geographic area, typically a county or district.`"Douglas County"` or `"West Mumbai"`. The field can contain either longName or shortName. Note: Only a few countries support shortName. In most cases, shortName and longName will have the same value.
borough	AdminField	Unit of local government or other administrative subdivision.`"Vazira"` or `"Manhattan"`
building	String	A roofed and walled structure built for permanent use.
city	AdminField	Specifies a city or town name.`"New York City"`
country	CountryField	Values are based on the ISO 3166-1 standard for country codes (returned in alpha-2, alpha-3, or numeric format).
customFields	Object	Returns additional information about the address.
explanation	Explanation	Describes the level of matching for each component of an address.
floor	String	Each level within a building.
formattedAddress	String	All address components are formatted and presented according to UPU standards. `"PRIME MINISTER& FIRST LORD OF THE TREASURY, 10 DOWNING STREET, LONDON, SW1A 2AA"` or `"630 168TH ST, NEW YORK NY 10032-3725"`
formattedLocationAddress	String	Location portion of the address, formatted to the country's standard.`"LONDON SW1A 2AA"` or `"NEW YORK, NY 10032-3725"`
formattedStreetAddress	String	Street portion of the address, including the directional and street suffix, formatted to the country's standard.`"10 DOWNING STREET"` or `"630 W 168TH ST"`
geometry	Geometry	Provides the candidate's geometry.
location	Location	Describes the location type and coordinates.
neighborhood	AdminField	Specifies a city subdivision or locality.`""`
parsed	ParsedAddress	Shows how the address was parsed, using the specified addressing process.
placeName	String	If applicable, indicates the name of the candidate's place or building.`"PRIME MINISTER& FIRST LORD OF THE TREASURY"`
postalCode	String	Postal codes are provided in separate segments and must be combined to create the full postal code.`"80125"`
postalCodeExt	String	Secondary postal code, if one exists. For example, in the US, a ZIP+4 is 80125-8012.`"8012"`
properties	Object	crsName - The coordinate reference system (CRS) used for the candidate's geocode. Expressed in epsg:nnnn format; the default is `epsg:4326`.
room	String	A single room within a building.
score	Integer	Provides a number from 0-100 to indicate how much the input was changed in order to match to the output candidate. It looks at certain fields including the house and unit numbers, street name, directional, and type, as well as postcode and area name fields. A score of 100 means that all the input fields checked exactly matched the output candidate. Available for all countries and the calculation is consistent from one country to another.
street	String	Street name only (no directional or street suffix).`"FRASER RIVER"` or `"168TH"`
suburb	AdminField	Mixed-use or residential area within commuting distance of a city or urban area.`""`
type	String	`Feature`
unit	String	The unit number, such as `"3B"`.
unitType	String	A group or suite of rooms within a building that are under common ownership or tenancy, typically having a common entrance. (`APT`, `STE`, `FLAT`, etc.).