Skip to content
On this page

Geographic Address

An API that provides address autocomplete functionality for Australian addresses.

Endpointhttps://service-qualification.unitiwireless.com/api/v2/geographicAddress
OpenAPIDocs

Address database

The address database is not an off the shelf product or dataset such as the GNAF dataset, the reason for this is carriers such as Opticomm specialise in Greenfields deployments, meaning that addresses that can be serviced may not appear in the GNAF dataset for up to 3 months.

The address database is a combination of all supported carriers individual address lists, normalised and formatted to a consistent style.

WARNING

Address data is updated daily for all carriers aside from nbn®.

Autocomplete

An address string can be passed as a URL parameter i.e.

api/v2/geographicAddress?address=UNIT 103 267 - 277 CASTLEREAGH

The response contains matching results as well as their carrier/carrier ID pairs.

json
{
    "id": "69da24e6-3d4a-40a8-99ad-7d2ee2c6a6c7",
    "href": null,
    "@baseType": "GeographicSubAddress",
    "@type": "UnitiGeographicSubAddress",
    "@schemaLocation": null,
    "buildingName": "",
    "levelNumber": "",
    "levelType": "",
    "name": "UNIT 103, 267 - 277 CASTLEREAGH ST, SYDNEY, NSW 2000",
    "privateStreetName": "",
    "privateStreetNumber": null,
    "subAddressType": "",
    "subUnitNumber": "103",
    "subUnitType": "UNIT",
    "address": "UNIT 103, 267 - 277 CASTLEREAGH ST, SYDNEY, NSW 2000",
    "identifiers": [
        {
            "name": "OC",
            "value": "OPC100000209087",
            "type": "carrier"
        },
        {
            "name": "NB",
            "value": "LOC000057539959",
            "type": "carrier"
        }
    ]
},

These identifiers can then be used in a Service Qualification request.