Search

Suggest suburbs and places as someone types

The site's own search box, as an endpoint.

Under two characters answers an empty list rather than matching most of the table; that is an answer, not an error. Debounce by at least 150ms in the client, since firing on every keystroke spends bandwidth for no better answer.

Rows come back most useful first, and each carries enough to build a link to the page it names without a second request.

get/v1/search

Request

  • Base URL: https://api.postfinder.io
  • URL: https://api.postfinder.io/v1/search
  • Auth: none required

Query parameters

qstring required

What has been typed so far.

limitinteger

How many rows. Outside 1 to 50, the default applies.

Response

Matching rows, best first. Empty for a term under two characters.

generated_atstring date-time required

When the answer was made. Answers are cached at the edge, so it can be up to an hour old.

Changes

No recorded changes to this operation across all 1 revision of this API.