Get all suburbs details.

Get suburb details for all suburbs.

URL:	https://api.trademe.co.nz/v1/Property/Sold/Suburbs.{file_format}
HTTP Method:	GET
Requires Authentication?	Yes
Permission Required:	None
Supported Formats:	XML, JSON
Rate Limited?	Yes

URL parameters

file_format

Enumeration (required)

The format of the response.

xml	Serialize responses into XML.
json	Serialize responses into JSON.

Returns

Details of all suburbs.

Suburbs

Collection of <BaseSuburbDetails> or null

Suburbs

SuburbId	Integer	SuburbId
SuburbName	String or null	SuburbName
ParentId	Integer	ParentId
CityId	Integer	CityId
CityName	String or null	CityName
SuburbUrlSlug	String or null	SuburbUrlSlug

Error

String or null

Error

Example XML Response (switch to JSON)

<SoldSuburbsResponse xmlns="http://api.trademe.co.nz/v1">
  <Suburbs>
    <BaseSuburbDetails>
      <SuburbId>123</SuburbId>
      <SuburbName>ABC</SuburbName>
      <ParentId>123</ParentId>
      <CityId>123</CityId>
      <CityName>ABC</CityName>
      <SuburbUrlSlug>ABC</SuburbUrlSlug>
    </BaseSuburbDetails>
    <BaseSuburbDetails>
      <SuburbId>123</SuburbId>
      <SuburbName>ABC</SuburbName>
      <ParentId>123</ParentId>
      <CityId>123</CityId>
      <CityName>ABC</CityName>
      <SuburbUrlSlug>ABC</SuburbUrlSlug>
    </BaseSuburbDetails>
  </Suburbs>
  <Error>ABC</Error>
</SoldSuburbsResponse>

Example JSON Response (switch to XML)

{
  "Suburbs": [
    {
      "SuburbId": 123,
      "SuburbName": "ABC",
      "ParentId": 123,
      "CityId": 123,
      "CityName": "ABC",
      "SuburbUrlSlug": "ABC"
    },
    {
      "SuburbId": 123,
      "SuburbName": "ABC",
      "ParentId": 123,
      "CityId": 123,
      "CityName": "ABC",
      "SuburbUrlSlug": "ABC"
    }
  ],
  "Error": "ABC"
}