Get by postcode

GET

/locations/postcode/{postCode}

• Production

Returns all suburbs associated with a given Australian postcode.

Authorizations

• apiKeyAuth
• basicAuth

Parameters

Path Parameters

postCode

required

string

Example

2000

Australian postcode (4 digits)

Responses

200

Locations for the given postcode

object

locations

Array<object>

object

id

Unique location identifier

integer

Example

12345

postcode

Australian postcode (4 digits)

string

Example

2000

locality

Suburb or locality name (uppercase)

string

Example

SYDNEY

state

Australian state or territory abbreviation

string

Allowed values: NSW VIC QLD SA WA TAS NT ACT

Example

NSW

priority

Priority ranking for search result ordering

integer

Example

1

Example

{
  "locations": [
    {
      "id": 12345,
      "postcode": "2000",
      "locality": "SYDNEY",
      "state": "NSW",
      "priority": 1
    },
    {
      "id": 12346,
      "postcode": "2000",
      "locality": "HAYMARKET",
      "state": "NSW",
      "priority": 1
    },
    {
      "id": 12347,
      "postcode": "2000",
      "locality": "THE ROCKS",
      "state": "NSW",
      "priority": 1
    }
  ]
}

404

Postcode not found

object

error

Error code or type

string

Example

validation_error

message

Human-readable error message

string

Example

The sender postcode field is required.