[ Whereis® API Home ] [ JSON API Home ] [ Object Index ] [ Address Types ]
Structured address definition. Required when performing a structured address search and returned as part of the <geocode> object from any geocode or reverse-geocode operation.
Parameters required and returned as part of the <address> object vary slightly, depending on the granularity of the location they represent.
Format
{
"display":<string>,
"number":<string>,
"street":<street>,
"property":<string>,
"intersection":[<street>],
"suburb":<string>,
"region":<string>,
"type":<string>,
"postcode":<string>,
"state":<string>,
"regions":[<string>]
}
Parameters
R = Return parameter only
Name | Mandatory? | Description |
display | R | Similar to a “ToString” property. Where present, may be used to identify the address to an end-user |
number | N | Street number, as a string |
street | N | A <street> object, not a string |
property | N | A string combining street number and street |
intersection | N | Defines a cross-street. Used only when dealing with addresses at intersection granularity |
suburb | N | Suburb name |
region | N | Region name |
type | N | Not to be confused with a street type This parameter is populated only when the address represents a region. May be one of: "CBD", "LGA", "MAJOR CITY REGIONS", "METRO TOURIST", "NATIONAL PARK", "REGION", "RURAL TOURIST", "SELECTED", "TOURIST" |
postcode | N | As a string |
state | N | May be in full or abbreviated. Abbreviations must be in upper case. |
regions | R | Where present, returns the names of all regions to which the address belongs |
Recognised region names are data dependent and may vary. To obtain a current list, perform a Get details by state request, with levelOfDetail set to "REGIONS".