v18

Swagger 2.0raw.githubusercontent.com2026-03-120013.8 KB

address

Get List of Addresses

returns a list of addresses matching the search string

get/addresses

Query parameters

qstring required

search string

pinteger

page number

Response

successful query

slastring required

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

scorenumber required

strength of the match relative to the other matches

Example response

[
  {
    "sla": "LEVEL 25, TOWER 3, 300 BARANGAROO AV, BARANGAROO NSW 2000",
    "score": 1,
    "links": {
      "self": {
        "href": "/addresses/GANT_718592778"
      }
    }
  },
  {
    "sla": "109 KIRRIBILLI AV, KIRRIBILLI NSW 2061",
    "score": 0.985051936618461,
    "links": {
      "self": {
        "href": "/addresses/GANT_718592782"
      }
    }
  }
]