Website logo

Get region details based on regionId.

Get region details based on regionId. The regionId is the region's locality id, as used by v1/Localities/Region/{regionId}. E.g 3 for Canterbury

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

URL parameters

regionId Integer (required)

file_format Enumeration (required) The format of the response.
xml Serialize responses into XML.
json Serialize responses into JSON.

Returns

<SoldRegionSearchResponse>

Details of the region.

RegionId Integer

Region id, as used by v1/Localities/Region/{regionId}

RegionName String or null

Region name; E.g Canterbury

Example XML Response (switch to JSON)

<SoldRegionSearchResponse xmlns="http://api.trademe.co.nz/v1">
  <RegionId>123</RegionId>
  <RegionName>ABC</RegionName>
</SoldRegionSearchResponse>

Example JSON Response (switch to XML)

{
  "RegionId": 123,
  "RegionName": "ABC"
}