[ Whereis® API Home ] [ JSON API Home ] [ Services ] [ Geocoding Services ]
Use structured geocode to obtain the coordinates that correspond to a given <address>. Returns a <geocode> object, including a location's centre point and street point, based on a structured address definition.
Compare Unstructured geocode. For an explanation of the returned object, see <geocode>.
URL
HTTP Post to <ENDPOINT>/service/geocode/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": [
{
"id": "property-260035486",
"centrePoint": {
"lon": 144.965601,
"lat": -37.81125
},
"streetPoint": {
"lon": 144.9656,
"lat": -37.81125
},
"approximated": false,
"granularity": "PROPERTY",
"address": {
"number": "222",
"street": {
"name": "LONSDALE",
"type": "ST",
"display": "LONSDALE ST"
},
"property": "222 LONSDALE ST",
"suburb": "MELBOURNE",
"postcode": "3000",
"regions": [
"GREATER MELBOURNE",
"MELBOURNE - INNER CITY SUBURBS",
"MELBOURNE CBD",
"MELBOURNE LGA"
],
"state": "VIC",
"display": "222 LONSDALE ST, MELBOURNE, VIC 3000"
},
"geometry": {
"centre": {
"lon": 144.965601,
"lat": -37.81125
},
"street": {
"lon": 144.9656,
"lat": -37.81125
}
}
}
],
"pagination": {
"start": 0,
"total": 1
}
}
A street with a street type in the name, for example "The Avenue" or "The Boulevard" should be formatted like this:
"street": {
"name": "The Avenue"
}A street with a street type in the name and a street type, for example "High Street Road" should be formatted like this:
"street": {
"name": "High Street",
"type:" "Road"
}A street which is an exit for another street, for example "Kings Way Exit" should be formatted like this:
"street": {
"name": "Kings Way Exit"
}