Retrieve Property, Jobs and Services regions
Returns a three-tier locality hierarchy of regions, districts and their respective suburbs (including adjacent suburbs, if they have them). These values are used in Trade Me Property, Trade Me Jobs and Services.
This API is identical to the localities API. Use that one instead.
|Supported Formats:||XML, JSON|
|file_format||Enumeration (required)||The format of the response.|
Query String parameters
The type of listing to include in the count property, if with_counts is true. Valid values are "HOUSES_TO_BUY", "HOUSES_TO_RENT", "COMMERCIAL_FOR_SALE", "COMMERCIAL_FOR_LEASE", "FLATMATES_WANTED", "RURAL", "RETIREMENT_VILLAGES" and "LIFESTYLE". Defaults to "HOUSES_TO_BUY".
Indicates whether to include the listing count for each locality. Defaults to false. This option currently does not work.
Collection of <Locality>
A list of all localities.
The ID of the region.
|Name||String or null||
The name of the region.
|Districts||Collection of <District> or null||
The list of districts that belong to this region.
The number of items being sold in this region.