Location Metadata

The location autocomplete service returns useful information about each location. On selection of a location, the widget can be configured to collect the information documented in the response spec below.

Ready to integrate? Read the step-by-step guide here.

Location Metadata response specification (AU)

Property	Type	Description	Example
`full_location`	String	Full location string.	Mathers Road East, WALKERVILLE VIC 3959
`location_type`	String	The kind of location. Valid values include street, locality or state.	street
`latitude`	String	Latitude coordinate (in WGS84 format).	-38.77287906
`longitude`	String	Longitude coordinate (in WGS84 format).	146.10907797
`street_name`	String	Holds the name of the street. Note: This attribute response does not contain the street type.	Mathers
`street_type`	String	The type of street.	Road
`street_suffix`	String	The suffix of the street. Typically contains a compass direction.	East
`street`	String	The full street name. Note: This attribute response contains the street name, street type and street suffix.	Mathers Road East
`locality_name`	String	The locality/suburb of this address.	WALKERVILLE
`state_territory`	String	The Australian state or territory containing the location	VIC
`postcode`	String	The postcode assigned to a locality (for 'locality' locations), or to the locality a street is in (for 'street' locations).	3959
`success`	Boolean	Indicates if the request was successful or not.	true

Location Autocomplete parameters (location_params)

This table contains parameters and options that can be used to control which locations are searched and returned for display in the drop down.

Property	Type	Description
`location_types`	String	Show only locations of the supplied type. Use a comma to separate multiple values.
`state_codes`	String	Filter the results according to the states or territories. Use a comma to separate multiple values.
`max`	Integer	The maximum number of results to return. A number between 1 and 100. The default is 10 results.

Location Metadata response specification (NZ)

Property	Type	Description	Example
`a`	String	Canonical location as supplied by Land Information New Zealand.	Seaview Road, Glenfield, Auckland
`pxid`	String	Unique location identifier.	1-.3.19.1.h
`street`	String	Holds the full name of the street. Note: The street attribute also includes the Street Type.	Seaview Road
`suburb`	String	The suburb or locality of the address as assigned by Land Information New Zealand.	Glenfield
`city`	String	The city, town or locality name as assigned by Land Information New Zealand.	Auckland
`region`	String	The Regional Authority in which this location exists. Note: Regional Authorities are the top tier of local government in New Zealand.	Auckland Region
`x`	String	Longitude coordinate (in WGS84 format).	174.643199
`y`	String	Latitude coordinate (in WGS84 format).	-36.426956
`success`	Boolean	Indicates if the request was successful or not.	true

Location Autocomplete parameters (location_params)

This table contains parameters and options that can be used to control which locations are searched and returned for display in the drop down.

Property	Type	Description
`street`	String	This filter restricts results to streets
`suburb`	String	This filter restricts results to suburbs.
`city`	String	This filter restricts results to cities.
`region`	String	This filter restricts results to regions.
`region_code`	String	Only return locations within the boundary of the selected region (Regional Authority).
`strict`	String	Determines how closely matched the results should be to the q parameter.
`max`	Integer	The maximum number of results to return. A number between 1 and 100. The default is 10 results.