[ Whereis® API Home ] [ JSON API Home ] [ Services ] [ Map Services ]
Use the Address Validation - Unstructured 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 Unstructured geocode. For an explanation of the returned object, see <validation>.
URL
HTTP Post to <ENDPOINT>/service/validation/unstructured
Request format
{
"query": <string>,
"location":<latlon>,
"bounds":<bounds>,
"pagination": {
"size": <int>,
"start": <int>
}
}
Rules
Parameter | Mandatory? | Description |
query | Y | Submit address as a <string>, not as an address object |
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. |
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 |
pagination | expanded | Labelled attribute containing a size and start. |
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 requests
No Adjustments
Sample request - No Adjustments
{
"query":
"222 lonsdale st"
}
Sample response
Sample response - No Adjustments
{
"keywords":"",
"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
}
}
}
},
{
"adjustments":[
"NONE"
],
"geocodedAddress":{
"id":"property-3911929",
"centrePoint":{
"lon":145.215217,
"lat":-37.988367
},
"streetPoint":{
"lon":145.214672,
"lat":-37.988477
},
"approximated":false,
"granularity":"PROPERTY",
"address":{
"number":"222",
"street":{
"name":"LONSDALE",
"type":"ST",
"display":"LONSDALE ST"
},
"property":"222 LONSDALE ST",
"suburb":"DANDENONG",
"suburbVanities":[
"DANDENONG EAST",
"DANDENONG NORTH EAST",
"DANDENONG WEST"
],
"postcode":"3175",
"regions":[
"GREATER DANDENONG COUNCIL",
"GREATER MELBOURNE",
"MELBOURNE - SOUTH EASTERN SUBURBS"
],
"state":"VIC",
"display":"222 LONSDALE ST, DANDENONG, VIC 3175"
},
"geometry":{
"centre":{
"lon":145.215217,
"lat":-37.988367
},
"street":{
"lon":145.214672,
"lat":-37.988477
}
}
}
},
{
"adjustments":[
"NONE"
],
"geocodedAddress":{
"id":"property-100478328",
"centrePoint":{
"lon":143.829808,
"lat":-37.574493
},
"streetPoint":{
"lon":143.829783,
"lat":-37.574717
},
"approximated":false,
"granularity":"PROPERTY",
"address":{
"number":"222",
"street":{
"name":"LONSDALE",
"type":"ST",
"display":"LONSDALE ST"
},
"property":"222 LONSDALE ST",
"suburb":"REDAN",
"postcode":"3350",
"regions":[
"BALLARAT COUNCIL",
"GOLDFIELDS",
"GREATER BALLARAT"
],
"state":"VIC",
"display":"222 LONSDALE ST, REDAN, VIC 3350"
},
"geometry":{
"centre":{
"lon":143.829808,
"lat":-37.574493
},
"street":{
"lon":143.829783,
"lat":-37.574717
}
}
}
}
],
"pagination":{
"start":0,
"total":3
}
}
Suburb Adjusted
Sample request - Suburb Adjusted
{"query": "222 lonsdale st, clayton"}
Sample response - Suburb Adjusted
{
"keywords":"",
"results":[
{
"adjustments":[
"SUBURB_ADJUSTED_FOR_PROXIMITY"
],
"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
}
}
}
},
{
"adjustments":[
"SUBURB_ADJUSTED_FOR_PROXIMITY"
],
"geocodedAddress":{
"id":"property-3911929",
"centrePoint":{
"lon":145.215217,
"lat":-37.988367
},
"streetPoint":{
"lon":145.214672,
"lat":-37.988477
},
"approximated":false,
"granularity":"PROPERTY",
"address":{
"number":"222",
"street":{
"name":"LONSDALE",
"type":"ST",
"display":"LONSDALE ST"
},
"property":"222 LONSDALE ST",
"suburb":"DANDENONG",
"suburbVanities":[
"DANDENONG EAST",
"DANDENONG NORTH EAST",
"DANDENONG WEST"
],
"postcode":"3175",
"regions":[
"GREATER DANDENONG COUNCIL",
"GREATER MELBOURNE",
"MELBOURNE - SOUTH EASTERN SUBURBS"
],
"state":"VIC",
"display":"222 LONSDALE ST, DANDENONG, VIC 3175"
},
"geometry":{
"centre":{
"lon":145.215217,
"lat":-37.988367
},
"street":{
"lon":145.214672,
"lat":-37.988477
}
}
}
}
],
"pagination":{
"start":0,
"total":2
}
}
Location Approximated
Sample request - Location Approximated
{"query": "222 lonsdale drive"}
Sample response - Location Approximated
{
"keywords":"",
"results":[
{
"adjustments":[
"LOCATION_APPROXIMATED",
"STREET_SPELLING_ADJUSTED"
],
"geocodedAddress":{
"centrePoint":{
"lon":144.265279,
"lat":-36.707546
},
"streetPoint":{
"lon":144.265279,
"lat":-36.707546
},
"approximated":true,
"granularity":"PROPERTY",
"address":{
"number":"26",
"street":{
"name":"ROSSDALE",
"type":"DR",
"display":"ROSSDALE DR"
},
"property":"26 ROSSDALE DR",
"suburb":"EAGLEHAWK",
"postcode":"3556",
"state":"VIC",
"display":"26 ROSSDALE DR, EAGLEHAWK, VIC 3556"
},
"geometry":{
"centre":{
"lon":144.265279,
"lat":-36.707546
},
"street":{
"lon":144.265279,
"lat":-36.707546
}
}
}
}
],
"pagination":{
"start":0,
"total":1
}
}
NOTES
Because an unstructured address search uses bounds and location as 'hints' only, it can sometimes return results that are outside the specified bounds.