Places

One suburb: every place in it

Every open place in the suburb, with counts per category and operator and the nearest suburbs, which is the page a suburb has on the site.

get/v1/localities/{country}/{region}/{locality}

Request

  • Base URL: https://api.postfinder.io
  • URL: https://api.postfinder.io/v1/localities/{country}/{region}/{locality}
  • Auth: none required

Path parameters

countrystring required

Country slug as the site's URLs use it: australia, new-zealand, united-kingdom, united-states, canada.

regionstring required

Region slug.

localitystring required

Suburb slug.

Response

The suburb.

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.