Build the request URL

Use the form below to build your request URL from the parameters. A URL string will be generated from these parameters and sent to the API in order to provide insight into how the API works and the responses it returns.

Field Name	Value	Type	Description
key *		String	Your unique licence key (find on Portal overview page).
secret *		String	Your unique secret key (find on Portal overview page).
q *		String	The query string to be matched with the location.
format *		String	The format of the response.
	Options json json for a response in json format. xml xml for a response in xml format.
location_types		String	Show only locations of the supplied type. Use a comma to separate multiple values.
	Options Street street Locality / Suburb locality State state
state_codes		String	Filter the results according to the states or territories. Use a comma to separate multiple values.
	Options Australian Capital Territory ACT New South Wales NSW Northern Territory NT Queensland QLD South Australia SA Tasmania TAS Victoria VIC Western Australia WA Other territories OT
domain		String	Used to identify which of your services is calling the API for activity monitoring purposes. This domain needs to be registered in the portal. FAQ: learn more about the domain parameter
max		Integer	The maximum number of results to return. A number between 1 and 100. The default is 10 results.
highlight		Integer	Returns an additional attribute in the response called highlighted_a. This attribute wraps the matching terms in the address with <span class='af_hl'></span> in order to highlight those terms.
	Options Highlighted 1

Request URL

        
          /* Click the button above to see a real API response here */
          {
            "success": true
          }