Address Location Web Service

API Reference Guide


Service URL
Example usage
Parameters
Response
Appendix - Road Name Types


The NSW Address Location Service allows the user to enter an address and pinpoint the location of that address.


Service URL

http://mapsq.six.nsw.gov.au/services/public/Address_Location


Example usage

http://mapsq.six.nsw.gov.au/services/public/Address_Location?houseNumber=346&roadName=Panorama&roadType=Ave&suburb=Bathurst&postCode=2795&projection=EPSG%3A4326

Parameters

Parameter Details
houseNumber Description: The house number. May be in the form of a number or alphanumeric, e.g. 12 or 12A.

Values: String

Example: '12', '12A'
roadName* Description: The road name not including the type.

Values: String

Example: 'Panorama','george'
roadType Description: The road type. Both full names and abbreviations may be used. See appendix for complete list of abbreviations.

Values: String

Example: 'Road', 'Rd', 'parade', 'pde'
suburb** Description: The suburb name.

Values: String

Example: 'Bathurst', 'parramatta'
postCode Description: The postcode.

Values: Integer

Example: 2795
projection Description: The address location's coordinate system in the output. Valid values are 'EPSG:3857' (Web Mercator) or 'EPSG:4326' (Geographic)

Values: String

Example: 'EPSG:3857', 'EPSG:4326'

* Road name is mandatory

** Either a suburb or a postcode must be input. At least one of the fields is required, however both may be used.


Response

The service will respond with a JSON object such as the following:

{
  "addressResult": {
    "addresses": [
      {
        "houseNumberFirst": 346,
        "houseNumberFirstSuffix": null,
        "houseNumberSecond": 0,
        "houseNumberSecondSuffix": null,
        "objectId": 5230635,
        "propid": 3523531,
        "postCode": 2795,
        "roadName": "Panorama",
        "roadSuffix": null,
        "roadType": "Avenue",
        "shortAddressString": "346 PANORAMA AVENUE BATHURST",
        "suburbName": "Bathurst",
        "addressType": "Assigned",
        "council": "Bathurst Regional",
        "addressString": "346null Panorama Avenue nullBathurst 2795",
        "houseNumberString": "346",
        "addressPoint": {
          "addressPointType": null,
          "addressPointUncertainty": null,
          "addressstringOid": 0,
          "containment": null,
          "createDate": null,
          "gurasId": null,
          "objectId": null,
          "prowayOid": null,
          "waypointOid": null,
          "coordRefSys": "EPSG:4283",
          "centreX": 149.5667881214216,
          "centreY": -33.430237352201004
        }
      }
    ],
    "errMsg": null,
    "numRecs": 1,
    "searchMethod": {
      "methodDescriptions": [
        "Input parameters matched",
        "Address Returned"
      ]
    }
  }
}
Field Details
errMsg Description: An error message string if an error occured.

Values: String || null
numRecs Description: The number of address records found.

Values: Ingeter
searchMethod Description: The method(s) used to locate the address. See the Search Method section for further details.

Values: SearchMethod

Example: ['Input parameters matched', 'Addresses Returned']
addresses Description: An array of address records. See the AddressRecord section for further details.

Values: array of AddressRecords

AddressRecord

Field Details
objectId Description: Unique identifier for the address record.

Values: Long
houseNumberFirst Description: The number portion of first house number.

Values: Integer
houseNumberFirstSuffix Description: The suffix for the first house number

Values: String || null
houseNumberSecond Description: The number portion of the second house number.

Values: Integer
houseNumberSecondSuffix Description: The suffix for the second house number.

Values: String || null
houseNumberString Description: The house number as a string (combines first and second plus their suffixes).

Values: String
roadName Description: The road name only.

Values: String
roadType Description: The road type. Will use the complete name rather than the type abbreviation.

Values: String
roadSuffix Description: The road suffix.

Values: String

Example: 'West', 'East'
suburbName Description: The suburb name.

Values: String
postCode Description: The post code.

Values: Long
shortAddressString Description: A string representing the address in short format.

Values: String
council Description: The council name.

Values: String
addressType Description: The address type.

Values: String

Possible values are:
  • Official
  • Alias
  • Assigned
  • Verified
addressPoint Description: The location of the address. See AddressPoint section for further details.

Values: AddressPoint

AddressPoint

Field Details
coordRefSys Description: The coordinate system used for the point. Will output 'EPSG:3857' (Web Mercator) or 'EPSG:4326' (Geographic).

Values: String

Example: 'EPSG:3857', 'EPSG:4326'
centreX Description: X coordinate for the centroid of the address.

Values: Double
centreY Description: Y coordinate for the centroid of the address.

Values: Double

SearchMethod

Field Details
methodDescriptions Description: Contains a list of methods used to find the address.

Values: String array

The address results in some cases may not be what the user is expecting. For instance the suburb name returned may be different to the name entered or the house number may also be different. To understand the reason the address is returned as it is the search methods output should be examined. The search methods describe what processes were used to find the address. Multiple methods may be used so the search methods contain a list of methods.

The methods used and their explanations are as follows:

Method Description
Input parameters matched An exact match of the input parameters were found with no alteration.
Road type ignored The road type entered was ignored in the search.
Suburb ignored The suburb name entered was ignored in the search.
Postcode ignored The postcode entered was ignored in the search.
Road type and postcode ignored Both road type and postcode were ignored in the search.
Road type and suburb ignored Both road type and suburb were ignored in the search.
Closest house number found The closest house number was found. If the house number input was even then the closest even number is found and similar for odd numbers.
Alternate place name used Used the alternate place names database to find an alternate name for the suburb.
Suburb not matched, used suburbs postcode Used the postcode of the suburb name instead as no match was found with that suburb name.
Address Returned A single address result was returned.
Addresses Returned Multiple address results returned.

Appendix - Road Name Types

Road Type Abbreviation Road Type Abbreviation Road Type Abbreviation
ACCESSACCSALLEYALLYALLEYWAYALWY
AMBLEAMBLAPPROACHAPPARCADEARC
ARTERIALARTLARTERYARTAVENUEAVE
BANANBABENDBENDBOARDWALKBWLK
BOULEVARDBVDBRACEBRCEBRAEBRAE
BREAKBRKBROADWAYBDWYBROWBROW
BYPASSBYPABYWAYBYWYCAUSEWAYCAUS
CENTRECTRCHASECHCIRCLECIR
CIRCLETCLTCIRCUITCCTCIRCUSCRCS
CLOSECLCOMMONCMMNCONCOURSECON
COPSECPSCORNERCNRCOURTCT
COURTYARDCTYDCOVECOVECRESCENTCR
CRESTCRSTCROSSCRSSCROSSINGCRSG
CUL-DE-SACCSACCUTTINGCUTTDALEDALE
DEVIATIONDEVNDIPDIPDISTRIBUTORDSTR
DRIVEDRDRIVEWAYDRWYEDGEEDGE
ELBOWELBENDENDENTRANCEENT
ESPLANADEESPEXPRESSWAYEXPEXTENSIONEXTN
FAIRWAYFAWYFIRETRACKFTRKFIRETRAILFITR
FOLLOWFOLWFOOTWAYFTWYFORMATIONFORM
FREEWAYFWYFRONTAGEFRTGGAPGAP
GARDENGDNGARDENSGDNSGATEGATE
GLADEGLDGLENGLENGRANGEGRA
GREENGRNGROVEGRHEIGHTSHTS
HIGHROADHRDHIGHWAYHWYHILLHILL
INTERCHANGEINTGJUNCTIONJNCKEYKEY
LANELANELANEWAYLNWYLINELINE
LINKLINKLOOKOUTLKTLOOPLOOP
MALLMALLMEANDERMNDRMEWSMEWS
MOTORWAYMWYNOOKNOOKOUTLOOKOTLK
PARADEPDEPARKWAYPKWYPASSPASS
PASSAGEPSGEPATHPATHPATHWAYPHWY
PIAZZAPIAZPLACEPLPLAZAPLZA
POCKETPKTPOINTPNTPORTPORT
PROMENADEPROMQUADRANTQDRTQUAYQY
QUAYSQYSRAMBLERMBLRAMPRAMP
RESTRESTRETREATRTTRIDGERDGE
RINGRINGRISERISEROADRD
ROADSRDSROTARYRTYROUTERTE
ROWROWRUERUESERVICEWAYSVWY
SHUNTSHUNSPURSPURSQUARESQ
STAIRSSTRSSTEPSSTPSSTREETST
STRIPSTRPSUBWAYSBWYTARNTARN
TERRACETCETHOROUGHFARETHORTOLLWAYTLWY
TOPTOPTORTORTRACKTRK
TRAILTRLTURNTURNUNDERPASSUPAS
VALEVALEVIADUCTVIADVIEWVIEW
VISTAVSTAWALKWALKWALKWAYWKWY
WAYWAYWHARFWHRFWYNDWYND