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 NearbySuburbs
SuburbName String or null SuburbName
CityName String or null CityName
Boundary Collection of String or null Boundary
SuburbEstimate String or null SuburbEstimate
SuburbEstimateDate String or null SuburbEstimateDate
CapitalGrowth String or null CapitalGrowth
BlurbText String or null BlurbText
NumOfHouseForSale Integer or null NumOfHouseForSale
NumOfHouseSoldLastYear Integer or null NumOfHouseSoldLastYear
PropertiesRecentlySold <SoldSearchResponse> or null PropertiesRecentlySold
Cards Collection of <PropertyCard> or null Cards
Date String or null Date
DisplayPrice String or null DisplayPrice
DistanceToPoint Number or null DistanceToPoint
FeaturedAt String or null FeaturedAt
FeaturedPlan Integer or null FeaturedPlan
ListingId String or null ListingId
Point <GeoPoint> or null Point
(This type has already been defined)
Price Number or null Price
PropertyDetails <PropertyCardPropertyDetails> or null PropertyDetails
Address String or null Address
DisplayAddress String or null DisplayAddress
CoverImageUrl String or null CoverImageUrl
CoverImageUrlSource String or null CoverImageUrlSource
NumBathrooms Integer or null NumBathrooms
LatestBedrooms String or null LatestBedrooms
NumCarSpaces Integer or null NumCarSpaces
LatestCarSpaces String or null LatestCarSpaces
LatestSource String or null LatestSource
Headline String or null Headline
EstimatedValueRevisionDate String or null EstimatedValueRevisionDate
DisplayEstimatedLowerValueShort String or null DisplayEstimatedLowerValueShort
DisplayEstimatedUpperValueShort String or null DisplayEstimatedUpperValueShort
DisplayEstimatedValueShort String or null DisplayEstimatedValueShort
EstimatedRentalRevisionDate String or null EstimatedRentalRevisionDate
DisplayEstimatedRentalLowerValueShort String or null DisplayEstimatedRentalLowerValueShort
DisplayEstimatedRentalUpperValueShort String or null DisplayEstimatedRentalUpperValueShort
EstimatedRentalYield String or null EstimatedRentalYield
CapitalValue Number or null CapitalValue
ImprovementValue Number or null ImprovementValue
LandValue Number or null LandValue
DisplayCapitalValueShort String or null DisplayCapitalValueShort
DisplayImprovementValueShort String or null DisplayImprovementValueShort
DisplayLandValueShort String or null DisplayLandValueShort
CurrentRevisionDate String or null CurrentRevisionDate
PreviousCapitalValue Number or null PreviousCapitalValue
PreviousRevisionDate String or null PreviousRevisionDate
SuburbId Integer or null SuburbId
CityId Integer or null CityId
UnitIdentifier String or null UnitIdentifier
StreetNumber String or null StreetNumber
StreetAlpha String or null StreetAlpha
Street String or null Street
Suburb String or null Suburb
City String or null City
Ta String or null Ta
NumBedrooms Integer or null NumBedrooms
LatestBathrooms Number or null LatestBathrooms
TradeMeSuburbId Integer or null TradeMeSuburbId
TradeMeRegionId Integer or null TradeMeRegionId
TradeMeDistrictId Integer or null TradeMeDistrictId
TradeMeCoverImageUrl String or null TradeMeCoverImageUrl
PropertyId String or null PropertyId
SalesCount Integer or null SalesCount
State Integer or null State
Url String or null Url
DisplayShortPrice String or null DisplayShortPrice
TMListingId String or null TMListingId
SuburbUrl String or null SuburbUrl
IsHomeTracked Boolean IsHomeTracked
Hits Integer Hits
Error String or null Error
SuburbEstimate String or null SuburbEstimate
SuburbEstimateDate String or null SuburbEstimateDate
CapitalGrowth String or null CapitalGrowth
SuburbName String or null SuburbName
SuburbUrl String or null SuburbUrl
Polylines Collection of String or null Polylines
PropertiesForSale <SoldSearchResponse> or null PropertiesForSale
(This type has already been defined)
PropertiesForRent <SoldSearchResponse> or null PropertiesForRent
(This type has already been defined)
Error String or null Error
CityName String or null CityName
SuburbName String or null SuburbName
SuburbId Integer SuburbId

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>
  <BlurbText>ABC</BlurbText>
  <NumOfHouseForSale>123</NumOfHouseForSale>
  <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>
        <IsHomeTracked>false</IsHomeTracked>
      </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>
        <IsHomeTracked>false</IsHomeTracked>
      </PropertyCard>
    </Cards>
    <Hits>123</Hits>
    <Error>ABC</Error>
    <SuburbEstimate>ABC</SuburbEstimate>
    <SuburbEstimateDate>ABC</SuburbEstimateDate>
    <CapitalGrowth>ABC</CapitalGrowth>
    <SuburbName>ABC</SuburbName>
    <SuburbUrl>ABC</SuburbUrl>
    <Polylines>
      <string>ABC</string>
      <string>ABC</string>
    </Polylines>
  </PropertiesRecentlySold>
  <PropertiesForSale />
  <PropertiesForRent />
  <Error>ABC</Error>
  <CityName>ABC</CityName>
  <SuburbName>ABC</SuburbName>
  <SuburbId>123</SuburbId>
</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",
  "BlurbText": "ABC",
  "NumOfHouseForSale": 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",
        "IsHomeTracked": false
      },
      {
        "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",
        "IsHomeTracked": false
      }
    ],
    "Hits": 123,
    "Error": "ABC",
    "SuburbEstimate": "ABC",
    "SuburbEstimateDate": "ABC",
    "CapitalGrowth": "ABC",
    "SuburbName": "ABC",
    "SuburbUrl": "ABC",
    "Polylines": [
      "ABC",
      "ABC"
    ]
  },
  "PropertiesForSale": {
  },
  "PropertiesForRent": {
  },
  "Error": "ABC",
  "CityName": "ABC",
  "SuburbName": "ABC",
  "SuburbId": 123
}