POI Autocomplete API

This API returns matching points of interest based on a partial name and optional filters. It works in tandem with the POI Metadata API, which is used to collect additional metadata about the selected POI.

Endpoint

New Zealand

https://api.addressfinder.io/api/nz/points_of_interest/autocomplete

Parameters

Parameter	Default	Description
`key`		Your unique Addressfinder license key. Required string
`secret`		Your unique secret key. You can also pass it into the `Authorization` header. Required only for server-to-server calls. Optional string
`q`		The query string to match against POI names and addresses. Required string
`format`	`json`	The format of the response. Required string
`domain`		Used to identify your service in the Addressfinder Portal. Must be a registered domain in the Portal. Optional string
`max`	`10`	Maximum number of results to return (1–100). Optional integer
`highlight`		Set to `1` to include `highlighted_name_and_address` in results, wrapping matched text with `<span class='af_hl'></span>`. Optional integer

Responses

200 A list of matching points of interest

Name	Type	Description	Example
`completions`	array		-
`name_and_address`	string	Full name of the POI followed by its address.	Middlemore Hospital, 100 Hospital Road, Middlemore Hospital, Auckland 2024
`id`	string	The unique POI identifier.	3300
`highlighted_name_and_address`	string	Highlighted string (if `highlight=1`).	Hospital, 100 Hospital Road...
`success`	boolean	True if the request was successful.	true

400 Invalid input or missing parameters.

Name	Type	Description	Example
`error`	string		Missing required parameter 'q'

See API Error Reference for details.