[ Whereis® API Home ] [ JSON API Home ] [ Object Index ] [ Return Types ]
Wraps an <address> object, providing extra information such as its centre point and granularity
<geocode> objects are returned by structured and unstructured searches, reverse geocode operations and in the Get details by ID response.
Parameters
Name | Type | Description |
id | string | Provides a handle to re-request a validated location, using get details-by ID. IDs are returned for locations at intersection or property granularity - provided the property location was not "approximated" (see next). |
approximated | Boolean | Only applies to addresses at property granularity. Indicates whether or not an address location has been estimated.If approximated = true, we have been unable to resolve the street number to a property, so we have approximated its position in the street. An approximated geocode will not contain a property center point or an id. When approximation = false, it does not mean that the match is exact, only that the street number of the geocoded address is taken from our property record data. |
| address | <address> | A structured location definition
|
granularity | string | Specifies the scale of the returned address, which may be "PROPERTY", "STREET", "INTERSECTION", "SUBURB", "STATE", or "REGION" |
streetPoint | <point> | Specifies a point which may be used for routing purposes. Typically, streetPoint is on a navigable street and identifies a location different from centrePoint. |
centrePoint | <point> | Specifies the actual centre of the geocoded location, which may fall within a field, building, yard, and so on, and may be unsuitable for routing |
bounds | <bounds> | A rectangular area that entirely contains the geocoded location. Only returned for locations at the granularity of postcode, region, state, or suburb |
Example
{
"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
}
}
}