Website logo

Get suburb details based on cityName, and suburbName.

Get suburb details based on cityName, and suburbName. Accepted combinations should be city name, followed with the suburb name. All space should be replaced with dash. E.g "new-plymouth/highlands-park"

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

URL parameters

cityName String (required)

suburbName String (required)

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

Returns

<SoldSuburbSearchResponse>

Details of the suburb, and its surrounding suburbs.

NearbySuburbs Collection of <SuburbDetails> or null

Wrapper to store nearby suburb details
SuburbName String or null

Name of the suburb
CityName String or null

Name of the city
Boundary Collection of String or null

The polyline that makes up this suburb
SuburbEstimate String or null

Formatted price of the suburb’s estimate; E.g 960K, 1.01M
SuburbEstimateDate String or null

Last updated date for SuburbEstimate; E.g 2023-11-02T00:00:00Z
CapitalGrowth String or null

Calculated value that indicates the capital growth of the suburb, in percentage unit. The formula to calculate the value will be the same used in Homes. E.g 5.1%
NumOfHouseForSaleLastMonth Integer or null

To display the number of Properties for sale last month
NumOfHouseSoldLastYear Integer or null

To display the number of Properties sold in the last 12 months
PropertiesRecentlySold <SoldSearchResponse> or null

To list down Properties that are recently sold in the suburb Filtered by ‘ForSale' = true, DateMax = today’s date, DateMin = start of last month; to get the number of houses for sale in the past month.
Cards Collection of <PropertyCard> or null

Cards
Date String or null

Date
DisplayPrice String or null

Display Price
DistanceToPoint Number or null

Distance To Point
FeaturedAt String or null

Featured At
FeaturedPlan Integer or null

Featured Plan
ListingId String or null

Listing Id
Point <GeoPoint> or null

Point
(This type has already been defined)
Price Number or null

Price
PropertyDetails <PropertyCardPropertyDetails> or null

Property Details
Address String or null

Address
DisplayAddress String or null

Display Address
CoverImageUrl String or null

Cover Image Url
CoverImageUrlSource String or null

Cover Image Url Source
NumBathrooms Integer or null

Num Bathrooms
LatestBedrooms String or null

Latest Bedrooms
NumCarSpaces Integer or null

Num Car Spaces
LatestCarSpaces String or null

Latest Car Spaces
LatestSource String or null

Latest Source
Headline String or null

Headline
EstimatedValueRevisionDate String or null

Estimated Value Revision Date
DisplayEstimatedLowerValueShort String or null

Display Estimated Lower Value Short
DisplayEstimatedUpperValueShort String or null

Display Estimated Upper Value Short
DisplayEstimatedValueShort String or null

Display Estimated Value Short
EstimatedRentalRevisionDate String or null

Estimated Rental Revision Date
DisplayEstimatedRentalLowerValueShort String or null

Display Estimated Rental Lower Value Short
DisplayEstimatedRentalUpperValueShort String or null

Display Estimated Rental Upper Value Short
EstimatedRentalYield String or null

Estimated Rental Yield
CapitalValue Number or null

Capital Value
ImprovementValue Number or null

Improvement Value
LandValue Number or null

Land Value
DisplayCapitalValueShort String or null

Display Capital Value Short
DisplayImprovementValueShort String or null

Display Improvement Value Short
DisplayLandValueShort String or null

Display Land Value Short
CurrentRevisionDate String or null

Current Revision Date
PreviousCapitalValue Number or null

Previous Capital Value
PreviousRevisionDate String or null

Previous Revision Date
SuburbId Integer or null

Suburb Id
CityId Integer or null

City Id
UnitIdentifier String or null

Unit Identifier
StreetNumber String or null

Street Number
StreetAlpha String or null

Street Alpha
Street String or null

Street
Suburb String or null

Suburb
City String or null

City
Ta String or null

Ta
NumBedrooms Integer or null

Num Bedrooms
LatestBathrooms Number or null

Latest Bathrooms
TradeMeSuburbId Integer or null

Trademe suburb id
TradeMeRegionId Integer or null

Trademe region id
TradeMeDistrictId Integer or null

Trademe district id
TradeMeCoverImageUrl String or null

Trademe cover image url
PropertyId String or null

Property Id
SalesCount Integer or null

Sales Count
State Integer or null

State
Url String or null

Url
DisplayShortPrice String or null

Display Short Price
TMListingId String or null

Last TM Listing Id
SuburbUrl String or null

Url
Hits Integer

Hits
Error String or null

Error
PropertiesForSale <SoldSearchResponse> or null

To list down Properties that are currently for sale in the suburb Filtered by ‘JustSold' = true, ‘OffMarket' = true, DateMax = today’s date, DateMin = start of last year of current month; to get the number of houses sold in the past 12 months.
(This type has already been defined)
Error String or null

Error message

Example XML Response (switch to JSON) 

<SoldSuburbSearchResponse xmlns="http://api.trademe.co.nz/v1">
  <NearbySuburbs>
    <SuburbDetails>
      <SuburbName>ABC</SuburbName>
      <CityName>ABC</CityName>
      <Boundary>
        <string>ABC</string>
        <string>ABC</string>
      </Boundary>
    </SuburbDetails>
    <SuburbDetails>
      <SuburbName>ABC</SuburbName>
      <CityName>ABC</CityName>
      <Boundary>
        <string>ABC</string>
        <string>ABC</string>
      </Boundary>
    </SuburbDetails>
  </NearbySuburbs>
  <SuburbEstimate>ABC</SuburbEstimate>
  <SuburbEstimateDate>ABC</SuburbEstimateDate>
  <CapitalGrowth>ABC</CapitalGrowth>
  <NumOfHouseForSaleLastMonth>123</NumOfHouseForSaleLastMonth>
  <NumOfHouseSoldLastYear>123</NumOfHouseSoldLastYear>
  <PropertiesRecentlySold>
    <Cards>
      <PropertyCard>
        <Date>ABC</Date>
        <DisplayPrice>ABC</DisplayPrice>
        <DistanceToPoint>123.0</DistanceToPoint>
        <FeaturedAt>ABC</FeaturedAt>
        <FeaturedPlan>123</FeaturedPlan>
        <ListingId>ABC</ListingId>
        <Point />
        <Price>123.0</Price>
        <PropertyDetails>
          <Address>ABC</Address>
          <DisplayAddress>ABC</DisplayAddress>
          <CoverImageUrl>ABC</CoverImageUrl>
          <CoverImageUrlSource>ABC</CoverImageUrlSource>
          <NumBathrooms>123</NumBathrooms>
          <LatestBedrooms>ABC</LatestBedrooms>
          <NumCarSpaces>123</NumCarSpaces>
          <LatestCarSpaces>ABC</LatestCarSpaces>
          <LatestSource>ABC</LatestSource>
          <Headline>ABC</Headline>
          <EstimatedValueRevisionDate>ABC</EstimatedValueRevisionDate>
          <DisplayEstimatedLowerValueShort>ABC</DisplayEstimatedLowerValueShort>
          <DisplayEstimatedUpperValueShort>ABC</DisplayEstimatedUpperValueShort>
          <DisplayEstimatedValueShort>ABC</DisplayEstimatedValueShort>
          <EstimatedRentalRevisionDate>ABC</EstimatedRentalRevisionDate>
          <DisplayEstimatedRentalLowerValueShort>ABC</DisplayEstimatedRentalLowerValueShort>
          <DisplayEstimatedRentalUpperValueShort>ABC</DisplayEstimatedRentalUpperValueShort>
          <EstimatedRentalYield>ABC</EstimatedRentalYield>
          <CapitalValue>123.0</CapitalValue>
          <ImprovementValue>123.0</ImprovementValue>
          <LandValue>123.0</LandValue>
          <DisplayCapitalValueShort>ABC</DisplayCapitalValueShort>
          <DisplayImprovementValueShort>ABC</DisplayImprovementValueShort>
          <DisplayLandValueShort>ABC</DisplayLandValueShort>
          <CurrentRevisionDate>ABC</CurrentRevisionDate>
          <PreviousCapitalValue>123.0</PreviousCapitalValue>
          <PreviousRevisionDate>ABC</PreviousRevisionDate>
          <SuburbId>123</SuburbId>
          <CityId>123</CityId>
          <UnitIdentifier>ABC</UnitIdentifier>
          <StreetNumber>ABC</StreetNumber>
          <StreetAlpha>ABC</StreetAlpha>
          <Street>ABC</Street>
          <Suburb>ABC</Suburb>
          <City>ABC</City>
          <Ta>ABC</Ta>
          <NumBedrooms>123</NumBedrooms>
          <LatestBathrooms>123.0</LatestBathrooms>
          <TradeMeSuburbId>123</TradeMeSuburbId>
          <TradeMeRegionId>123</TradeMeRegionId>
          <TradeMeDistrictId>123</TradeMeDistrictId>
          <TradeMeCoverImageUrl>ABC</TradeMeCoverImageUrl>
        </PropertyDetails>
        <PropertyId>ABC</PropertyId>
        <SalesCount>123</SalesCount>
        <State>123</State>
        <Url>ABC</Url>
        <DisplayShortPrice>ABC</DisplayShortPrice>
        <TMListingId>ABC</TMListingId>
        <SuburbUrl>ABC</SuburbUrl>
      </PropertyCard>
      <PropertyCard>
        <Date>ABC</Date>
        <DisplayPrice>ABC</DisplayPrice>
        <DistanceToPoint>123.0</DistanceToPoint>
        <FeaturedAt>ABC</FeaturedAt>
        <FeaturedPlan>123</FeaturedPlan>
        <ListingId>ABC</ListingId>
        <Point />
        <Price>123.0</Price>
        <PropertyDetails>
          <Address>ABC</Address>
          <DisplayAddress>ABC</DisplayAddress>
          <CoverImageUrl>ABC</CoverImageUrl>
          <CoverImageUrlSource>ABC</CoverImageUrlSource>
          <NumBathrooms>123</NumBathrooms>
          <LatestBedrooms>ABC</LatestBedrooms>
          <NumCarSpaces>123</NumCarSpaces>
          <LatestCarSpaces>ABC</LatestCarSpaces>
          <LatestSource>ABC</LatestSource>
          <Headline>ABC</Headline>
          <EstimatedValueRevisionDate>ABC</EstimatedValueRevisionDate>
          <DisplayEstimatedLowerValueShort>ABC</DisplayEstimatedLowerValueShort>
          <DisplayEstimatedUpperValueShort>ABC</DisplayEstimatedUpperValueShort>
          <DisplayEstimatedValueShort>ABC</DisplayEstimatedValueShort>
          <EstimatedRentalRevisionDate>ABC</EstimatedRentalRevisionDate>
          <DisplayEstimatedRentalLowerValueShort>ABC</DisplayEstimatedRentalLowerValueShort>
          <DisplayEstimatedRentalUpperValueShort>ABC</DisplayEstimatedRentalUpperValueShort>
          <EstimatedRentalYield>ABC</EstimatedRentalYield>
          <CapitalValue>123.0</CapitalValue>
          <ImprovementValue>123.0</ImprovementValue>
          <LandValue>123.0</LandValue>
          <DisplayCapitalValueShort>ABC</DisplayCapitalValueShort>
          <DisplayImprovementValueShort>ABC</DisplayImprovementValueShort>
          <DisplayLandValueShort>ABC</DisplayLandValueShort>
          <CurrentRevisionDate>ABC</CurrentRevisionDate>
          <PreviousCapitalValue>123.0</PreviousCapitalValue>
          <PreviousRevisionDate>ABC</PreviousRevisionDate>
          <SuburbId>123</SuburbId>
          <CityId>123</CityId>
          <UnitIdentifier>ABC</UnitIdentifier>
          <StreetNumber>ABC</StreetNumber>
          <StreetAlpha>ABC</StreetAlpha>
          <Street>ABC</Street>
          <Suburb>ABC</Suburb>
          <City>ABC</City>
          <Ta>ABC</Ta>
          <NumBedrooms>123</NumBedrooms>
          <LatestBathrooms>123.0</LatestBathrooms>
          <TradeMeSuburbId>123</TradeMeSuburbId>
          <TradeMeRegionId>123</TradeMeRegionId>
          <TradeMeDistrictId>123</TradeMeDistrictId>
          <TradeMeCoverImageUrl>ABC</TradeMeCoverImageUrl>
        </PropertyDetails>
        <PropertyId>ABC</PropertyId>
        <SalesCount>123</SalesCount>
        <State>123</State>
        <Url>ABC</Url>
        <DisplayShortPrice>ABC</DisplayShortPrice>
        <TMListingId>ABC</TMListingId>
        <SuburbUrl>ABC</SuburbUrl>
      </PropertyCard>
    </Cards>
    <Hits>123</Hits>
    <Error>ABC</Error>
  </PropertiesRecentlySold>
  <PropertiesForSale />
  <Error>ABC</Error>
</SoldSuburbSearchResponse>

Example JSON Response (switch to XML) 

{
  "NearbySuburbs": [
    {
      "SuburbName": "ABC",
      "CityName": "ABC",
      "Boundary": [
        "ABC",
        "ABC"
      ]
    },
    {
      "SuburbName": "ABC",
      "CityName": "ABC",
      "Boundary": [
        "ABC",
        "ABC"
      ]
    }
  ],
  "SuburbEstimate": "ABC",
  "SuburbEstimateDate": "ABC",
  "CapitalGrowth": "ABC",
  "NumOfHouseForSaleLastMonth": 123,
  "NumOfHouseSoldLastYear": 123,
  "PropertiesRecentlySold": {
    "Cards": [
      {
        "Date": "ABC",
        "DisplayPrice": "ABC",
        "DistanceToPoint": 123.0,
        "FeaturedAt": "ABC",
        "FeaturedPlan": 123,
        "ListingId": "ABC",
        "Point": {
        },
        "Price": 123.0,
        "PropertyDetails": {
          "Address": "ABC",
          "DisplayAddress": "ABC",
          "CoverImageUrl": "ABC",
          "CoverImageUrlSource": "ABC",
          "NumBathrooms": 123,
          "LatestBedrooms": "ABC",
          "NumCarSpaces": 123,
          "LatestCarSpaces": "ABC",
          "LatestSource": "ABC",
          "Headline": "ABC",
          "EstimatedValueRevisionDate": "ABC",
          "DisplayEstimatedLowerValueShort": "ABC",
          "DisplayEstimatedUpperValueShort": "ABC",
          "DisplayEstimatedValueShort": "ABC",
          "EstimatedRentalRevisionDate": "ABC",
          "DisplayEstimatedRentalLowerValueShort": "ABC",
          "DisplayEstimatedRentalUpperValueShort": "ABC",
          "EstimatedRentalYield": "ABC",
          "CapitalValue": 123.0,
          "ImprovementValue": 123.0,
          "LandValue": 123.0,
          "DisplayCapitalValueShort": "ABC",
          "DisplayImprovementValueShort": "ABC",
          "DisplayLandValueShort": "ABC",
          "CurrentRevisionDate": "ABC",
          "PreviousCapitalValue": 123.0,
          "PreviousRevisionDate": "ABC",
          "SuburbId": 123,
          "CityId": 123,
          "UnitIdentifier": "ABC",
          "StreetNumber": "ABC",
          "StreetAlpha": "ABC",
          "Street": "ABC",
          "Suburb": "ABC",
          "City": "ABC",
          "Ta": "ABC",
          "NumBedrooms": 123,
          "LatestBathrooms": 123.0,
          "TradeMeSuburbId": 123,
          "TradeMeRegionId": 123,
          "TradeMeDistrictId": 123,
          "TradeMeCoverImageUrl": "ABC"
        },
        "PropertyId": "ABC",
        "SalesCount": 123,
        "State": 123,
        "Url": "ABC",
        "DisplayShortPrice": "ABC",
        "TMListingId": "ABC",
        "SuburbUrl": "ABC"
      },
      {
        "Date": "ABC",
        "DisplayPrice": "ABC",
        "DistanceToPoint": 123.0,
        "FeaturedAt": "ABC",
        "FeaturedPlan": 123,
        "ListingId": "ABC",
        "Point": {
        },
        "Price": 123.0,
        "PropertyDetails": {
          "Address": "ABC",
          "DisplayAddress": "ABC",
          "CoverImageUrl": "ABC",
          "CoverImageUrlSource": "ABC",
          "NumBathrooms": 123,
          "LatestBedrooms": "ABC",
          "NumCarSpaces": 123,
          "LatestCarSpaces": "ABC",
          "LatestSource": "ABC",
          "Headline": "ABC",
          "EstimatedValueRevisionDate": "ABC",
          "DisplayEstimatedLowerValueShort": "ABC",
          "DisplayEstimatedUpperValueShort": "ABC",
          "DisplayEstimatedValueShort": "ABC",
          "EstimatedRentalRevisionDate": "ABC",
          "DisplayEstimatedRentalLowerValueShort": "ABC",
          "DisplayEstimatedRentalUpperValueShort": "ABC",
          "EstimatedRentalYield": "ABC",
          "CapitalValue": 123.0,
          "ImprovementValue": 123.0,
          "LandValue": 123.0,
          "DisplayCapitalValueShort": "ABC",
          "DisplayImprovementValueShort": "ABC",
          "DisplayLandValueShort": "ABC",
          "CurrentRevisionDate": "ABC",
          "PreviousCapitalValue": 123.0,
          "PreviousRevisionDate": "ABC",
          "SuburbId": 123,
          "CityId": 123,
          "UnitIdentifier": "ABC",
          "StreetNumber": "ABC",
          "StreetAlpha": "ABC",
          "Street": "ABC",
          "Suburb": "ABC",
          "City": "ABC",
          "Ta": "ABC",
          "NumBedrooms": 123,
          "LatestBathrooms": 123.0,
          "TradeMeSuburbId": 123,
          "TradeMeRegionId": 123,
          "TradeMeDistrictId": 123,
          "TradeMeCoverImageUrl": "ABC"
        },
        "PropertyId": "ABC",
        "SalesCount": 123,
        "State": 123,
        "Url": "ABC",
        "DisplayShortPrice": "ABC",
        "TMListingId": "ABC",
        "SuburbUrl": "ABC"
      }
    ],
    "Hits": 123,
    "Error": "ABC"
  },
  "PropertiesForSale": {
  },
  "Error": "ABC"
}