Places

Places in a suburb, filtered

Filter one suburb's places by operator or category.

The suburb is named by its numeric id, which no other endpoint returns; for most uses the suburb endpoint, which takes slugs, is the one to call.

get/v1/places

Request

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

Query parameters

localityinteger required

The suburb's numeric id.

brandstring

An operator key: auspost.

category'post-offices' | 'post-boxes' | 'express-post-boxes' | 'parcel-lockers' | 'drop-off-points' | 'collection-points'

A kind of place.

limitinteger

How many places. Outside 1 to 200, the default applies.

Response

The places, by name.

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.

next_cursorstring

Reserved for paging. Never set today: the first page is the whole answer, up to limit.

Changes

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