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	Description	Test Value
`key`	Your unique Addressfinder license key. Type: `string` `required`
`secret`	Your unique secret key from Portal Credentials. You can also pass your secret key into the `Authorization` header of the request. Only required for server-to-server calls. Type: `string`
`q`	The query string to match against POI names and addresses. Type: `string` `required`
`format`	The format of the response. Default value: `json` Type: `string` `required`
`domain`	Used to identify your service in the Addressfinder Portal. Must be a registered domain in the Portal. Type: `string`
`max`	Maximum number of results to return (1–100). Default value: `10` Type: `integer`
`highlight`	Set to `1` to include `highlighted_name_and_address` in results, wrapping matched text with `<span class='af_hl'></span>`. Type: `integer`

Responses

200 A list of matching points of interest

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

400 Invalid input or missing parameters.

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

See API Error Reference for details.