[ Whereis® API Home ] [ JSON API Home ] [ Services ] [ Address Validation Services ]
Use the Address Validation - Structured to validate a given address. Returns a list of <validation> objects, including a <geocode> object and a list of Adjustments made to the requested address to find a result..
Compare Structured geocode. For an explanation of the returned object, see <validation>.
URL
HTTP Post to <ENDPOINT>/service/validation/structured
Request format
{
"address": <address>,
"location":<point>,
"bounds":<bounds>,
"pagination": {
"size": <int>,
"start": <int>
}
}
Rules
Parameter | Mandatory? | Description |
address | Y | Submit all known information in a structured <address> object. |
location | N | A <point> object, used as the second hint. If a match cannot be found within the current bounds or close to the current location, the search extends Australia-wide. |
bounds | N | In an unstructured search, bounds are not used as an absolute limit. They are taken as the first hint. That is, if a match for the address string can be found within the current bounds, it will be favoured. |
pagination | expanded |
|
size | N | Maximum number of results to return. Min = 1, Max = 200 Default = 20 |
start | N | First result to return. If "size" is 20 and your request returns a "total" of 30, submit a second request with "start" = 21 to retrieve the remaining results. |
Sample request
{
"address":
{
"number":222,
"street":
{
"name":"Lonsdale",
"type":"St"
},
"suburb":"Melbourne",
"postcode":"3000",
"state":"VIC"
}
}
Sample response
{
"results":[
{
"adjustments":[
"NONE"
],
"geocodedAddress":{
"id":"property-362838",
"centrePoint":{
"lon":144.965509,
"lat":-37.810921
},
"streetPoint":{
"lon":144.965608,
"lat":-37.811274
},
"approximated":false,
"granularity":"PROPERTY",
"address":{
"number":"222",
"street":{
"name":"LONSDALE",
"type":"ST",
"display":"LONSDALE ST"
},
"property":"222 LONSDALE ST",
"suburb":"MELBOURNE",
"suburbVanities":[
"MELB"
],
"postcode":"3000",
"regions":[
"GREATER MELBOURNE",
"MELBOURNE - INNER CITY SUBURBS",
"MELBOURNE CBD",
"MELBOURNE COUNCIL"
],
"state":"VIC",
"display":"222 LONSDALE ST, MELBOURNE, VIC 3000"
},
"geometry":{
"centre":{
"lon":144.965509,
"lat":-37.810921
},
"street":{
"lon":144.965608,
"lat":-37.811274
}
}
}
}
],
"pagination":{
"start":0,
"total":1
}
}