Find matching points of interest by providing a partial name

This API call takes a partial name and various other optional parameters and returns a list of complete matching points of interest and their associated addresses.

This form performs actual queries against the API. You can use this form to get an idea about how the API works and the sort of responses that are returned.

Send a GET request to: https://api.addressfinder.io/api/nz/points_of_interest

Request

Auto-fill fields

Populate Sample Parameters

Key

Required. A unique key allocated by AddressFinder for your Account. The key is included in your welcome email.

Format

Required. Default is json.

Q

Required. The partial name to search for e.g. Middlemore Hospital

Max (Optional)

Optional. Set the maximum number of results to return. A number from 1 to 100. Default is 10.

Highlight (Optional)

Optional. Return a highlighted version of the points of interest. 1 for yes or 0 for no. Defaults to 0.

Secret (Optional)

Optional in most cases. Only required for authenticating direct API calls (not from a browser). The secret can be downloaded from the AddressFinder portal.

Domain (Optional)

Optional. Can only be provided for direct API calls (not from a browser). The domain can be used to identify which service is calling the API.

Callback (Optional)

Optional. For JSONP.

---

Docs Preview Mode (Optional)

• HTML
• Raw API response
• Window
• Map

How would you like the API response rendered?

Response