[ Whereis® API Home ] [ JSON API Home ] [ Services ] [ Geocoding Services ]
Use reverse geocode to identify the property, street or intersection located at a given longitude and latitude.
Returns a list of the nearest <geocode> objects to a specified longitude and latitude and (optionally) within a prescribed radius. By default, this service searches at property granularity and returns just one result. Multiple results may be returned if equally close results are found.
Where possible, each returned <geocode> object includes an ID that can be used to reliably retrieve the same location in a subsequent search, using get details by ID.URL
HTTP POST to <ENDPOINT>/service/geocode/reverse
Request format
{
"location":<point>,
"granularity":[<string>],
"radius":<int>
}
Rules
Parameter | Mandatory? | Description |
location | Y | The list of results will be ordered by distance from the point specified in the "location" |
granularity | N | Array containing one or more of: "PROPERTY","STREET","INTERSECTION" If not entered, returns finest granularity found |
radius | N | Distance in metres The list will not include addresses with a centre point more than <radius> distance from <location>. Max = 300000, default = 50 |
pagination | N | Parameter is allowed but not functional |
size | N | Parameter is allowed but not functional |
Sample request
{
"location":{
"lon":144.962832,
"lat":-37.813389
},
"granularity":["PROPERTY"],
"radius": 500
}
Sample response
{
"results": [
{
"id": "property-163257851",
"centrePoint": {
"lon": 144.962758,
"lat": -37.81353
},
"streetPoint": {
"lon": 144.96276,
"lat": -37.81353
},
"approximated": false,
"granularity": "PROPERTY",
"address": {
"number": "205",
"street": {
"name": "ELIZABETH",
"type": "ST",
"display": "ELIZABETH ST"
},
"property": "205 ELIZABETH ST",
"suburb": "MELBOURNE",
"postcode": "3000",
"regions": [
"GREATER MELBOURNE",
"MELBOURNE - INNER CITY SUBURBS",
"MELBOURNE CBD",
"MELBOURNE LGA"
],
"state": "VIC",
"display": "205 ELIZABETH ST, MELBOURNE, VIC 3000"
},
"geometry": {
"centre": {
"lon": 144.962758,
"lat": -37.81353
},
"street": {
"lon": 144.96276,
"lat": -37.81353
}
},
"distance": 16
}
],
"pagination": {
"total": 1,
"start": 0
}
}