Places

One region and its suburbs

A page of the region's suburbs, alphabetical, with the total for paging.

get/v1/countries/{country}/regions/{region}

Request

  • Base URL: https://api.postfinder.io
  • URL: https://api.postfinder.io/v1/countries/{country}/regions/{region}
  • 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.

Query parameters

limitinteger

How many suburbs. Outside 1 to 500, the default applies.

offsetinteger

How many to skip, for the next page.

Response

The region.

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.