Find us on GitHub

Addressr by Mountain Pass
 1.0.0 
OAS 2.0

[ Base URL: addressr.p.rapidapi.com/ ]

Australian Address Validation, Search and Autocomplete

address

returns a list of addresses matching the search string

Parameters

NameDescription
q *
string
(query)

search string

Responses

CodeDescription
200

successful query

[
  {
    "sla": "LEVEL 25, TOWER 3, 300 BARANGAROO AV, BARANGAROO NSW 2000",
    "highlight": {
      "sla": "<em>LEVEL</em> <em>25</em>, <em>TOWER</em> <em>3</em>, <em>300</em> BARANGAROO AV, BARANGAROO NSW 2000\n"
    },
    "score": 1,
    "pid": "GANSW719386656"
  },
  {
    "sla": "UNIT 1, 109 KIRRIBILLI AV, KIRRIBILLI NSW 2061\n",
    "ssla": "1/109 KIRRIBILLI AV, KIRRIBILLI NSW 2061\n",
    "highlight": {
      "sla": "UNIT 1, <em>109</em> <em>KIRRIBILLI</em> <em>AV</em>, <em>KIRRIBILLI</em> NSW 2061\n",
      "ssla": "1/<em>109</em> <em>KIRRIBILLI</em> <em>AV</em>, <em>KIRRIBILLI</em> NSW 2061\n"
    },
    "score": 0.985051936618461,
    "pid": "GANSW717102496"
  }
]

Headers:

NameDescriptionType
link

rfc5988 Links

array
link-template

rfc6570 Links Templates

array
400

invalid query

500

unexpected error

503

service unavailable

returns detailed information about a specific address

Parameters

NameDescription
addressId *
string
(path)

ID of the address.

Responses

CodeDescription
200

successful query

{
  "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",
      "number": 64,
      "suffix": "QG"
    },
    "number": {
      "prefix": "RMB",
      "number": 20114,
      "suffix": "AA",
      "last": {
        "prefix": "RMB",
        "number": "20114",
        "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",
    "confidence": 0
  },
  "sla": "LEVEL 25, TOWER 3, 300 BARANGAROO AV, BARANGAROO NSW 2000",
  "ssla": "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"
  ],
  "geo": {
    "level": {
      "code": 7,
      "name": "LOCALITY,STREET, ADDRESS"
    },
    "geocodes": [
      {
        "default": true,
        "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"
      }
    ]
  }
}

Headers:

NameDescriptionType
link

rfc5988 Links

array
link-template

rfc6570 Links Templates

array
404

not found

500

unexpected error

503

service unavailable

default

returns a list of available APIs within the Link headers

Parameters

No parameters

Responses

CodeDescription
200

successful operation

{}

Headers:

NameDescriptionType
link

rfc5988 Links

array
link-template

rfc6570 Links Templates

array
500

unexpected error

503

service unavailable