Sign in

v

latestSwagger 2.0raw.githubusercontent.com2026-08-093715.3 KB
address

Get Address

returns detailed information about a specific address

get/addresses/{addressId}

Path parameters

addressIdstring required

ID of the address.

Response

successful query

pidstring required

The Persistent Identifier is unique to the real world feature this record represents.

slastring required

The full address flattened to a single line. The primary use is for search results and for autocomplete.

mlastring[] required

The full address flattened to at most four lines. The primary use is for address labels

smlastring[]

The full address flattened to at most four lines. The primary use is for address labels

precedencestring

DEPRECATED - do not depend on this field. It carries the source dataset's primary/secondary flag and has never been part of any published spec. It is documented here only so its removal is announced rather than silent. (Swagger 2.0 has no deprecated keyword for schema properties, so the signal is carried in this description; the OpenAPI 3 spec served at /api-docs sets deprecated: true.)

sla_range_expandedstring[]

DEPRECATED - do not depend on this field, and do not use it for search. It holds the two endpoint forms of a range address, but it has NEVER been searchable: it was written to a path the index mapping does not cover, so no query has ever matched it. Range addresses are already reachable by either endpoint without it. Scheduled for removal; retained for now only so the response body and ETag of existing range addresses do not change. (Swagger 2.0 has no deprecated keyword for schema properties, so the signal is carried in this description; the OpenAPI 3 spec served at /api-docs sets deprecated: true.)

Example response

{
  "pid": "GANSW719386656",
  "structured": {
    "buildingName": "Vickery Lodge",
    "lotNumber": {
      "prefix": "A",
      "number": "CP",
      "suffix": "B"
    },
    "flat": {
      "type": {
        "name": "Tower",
        "code": "Twr"
      },
      "prefix": "CT",
      "number": 20114,
      "suffix": "AG"
    },
    "level": {
      "type": {
        "na,e": "Observation Deck",
        "code": "OD"
      },
      "prefix": "A",
      "suffix": "QG"
    },
    "number": {
      "prefix": "RMB",
      "suffix": "AA",
      "last": {
        "prefix": "RMB",
        "suffix": "C"
      }
    },
    "street": {
      "name": "Barangaroo",
      "type": {
        "name": "Av",
        "code": "Avenue"
      },
      "suffix": {
        "name": "Deviation",
        "code": "De"
      }
    },
    "locality": {
      "name": "Sydney",
      "class": {
        "code": "G",
        "name": "GAZETTED LOCALITY"
      }
    },
    "state": {
      "name": "New South Wales",
      "abbreviation": "NSW"
    },
    "postcode": "2000"
  },
  "sla": "LEVEL 25, TOWER 3, 300 BARANGAROO AV, BARANGAROO NSW 2000",
  "mla": [
    "LEVEL 25",
    "TOWER 3",
    "300 BARANGAROO AV",
    "BARANGAROO NSW 2000"
  ],
  "smla": [
    "LEVEL 25",
    "TOWER 3",
    "300 BARANGAROO AV",
    "BARANGAROO NSW 2000"
  ],
  "geocoding": {
    "level": {
      "code": 7,
      "name": "LOCALITY,STREET, ADDRESS"
    },
    "geocodes": [
      {
        "latitude": -33.85351875,
        "longitude": 150.8947369,
        "reliability": {
          "code": 2,
          "name": "WITHIN ADDRESS SITE BOUNDARY OR ACCESS POINT"
        },
        "type": {
          "code": 2,
          "name": "PROPERTY CENTROID"
        },
        "description": "REAR"
      }
    ]
  }
}