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"
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%
|
| BlurbText |
String or null |
Blurb text returned from ClassifiedInsights
|
| NumOfHouseForSale |
Integer or null |
To display the number of Properties for sale
|
| 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
|
| IsHomeTracked |
Boolean |
Indicates whether the currently authenticated user is tracking the property.
|
|
| Hits |
Integer |
Hits
|
| Error |
String or null |
Error
|
| 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%
|
| SuburbName |
String or null |
Name of the suburb
|
| SuburbUrl |
String or null |
Url to the suburb page
|
| Polylines |
Collection of String or null |
Specified the polylines that was used when searching.
|
|
| PropertiesForSale |
<SoldSearchResponse> or null |
To list down Properties that are currently for sale in the suburb
|
|
(This type has already been defined)
|
| PropertiesForRent |
<SoldSearchResponse> or null |
To list down Properties that are currently for rent in the suburb
|
|
(This type has already been defined)
|
| Error |
String or null |
Error message
|
| CityName |
String or null |
City name
|
| SuburbName |
String or null |
Suburb name
|
| SuburbId |
Integer |
Suburb id
|
| InsightCards |
Collection of <SuburbInsightCard> or null |
Suburb insight cards (e.g. Character & Vibe, Transport)
|
| Title |
String or null |
Title of the insight card
|
| IconUrl |
String or null |
Url of the icon representing the insight card
|
| IconAltText |
String or null |
Alt text for the icon
|
| Description |
String or null |
Description of the insight card
|
|
| Quote |
<SuburbQuote> or null |
Featured quote for the suburb
|
| ImageUrl |
String or null |
Url of the image accompanying the quote
|
| ImageAltText |
String or null |
Alt text for the image
|
| ImageLink |
<SuburbLink> or null |
Link the image points to
|
| Title |
String or null |
Display title of the link
|
| Href |
String or null |
Url the link points to
|
|
| Text |
String or null |
Quote text
|
| AuthorName |
String or null |
Name of the quote's author
|
| StoryLink |
<SuburbLink> or null |
Link to the full story
|
|
(This type has already been defined)
|
|
| RecentNews |
<SuburbRecentNews> or null |
Recent news articles related to the suburb
|
| Articles |
Collection of <SuburbNewsArticle> or null |
Recent news articles
|
| Title |
String or null |
Title of the article
|
| Url |
String or null |
Relative url of the article
|
| Category |
String or null |
Category the article belongs to
|
| Summary |
String or null |
Short summary of the article
|
| Image |
<SuburbNewsArticleImage> or null |
Image accompanying the article
|
| Url |
String or null |
Url of the image
|
| AltText |
String or null |
Alt text for the image
|
|
| Vertical |
String or null |
Vertical the article belongs to
|
| ReadTime |
String or null |
Estimated read time, in minutes
|
| UpdatedAt |
String or null |
Last updated date of the article
|
|
| ViewAllLink |
String or null |
Link to view all articles
|
|
| LifestyleOverview |
String or null |
Lifestyle overview copy for the suburb. HTML from the CMS.
|
{
"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,
"InsightCards": [
{
"Title": "ABC",
"IconUrl": "ABC",
"IconAltText": "ABC",
"Description": "ABC"
},
{
"Title": "ABC",
"IconUrl": "ABC",
"IconAltText": "ABC",
"Description": "ABC"
}
],
"Quote": {
"ImageUrl": "ABC",
"ImageAltText": "ABC",
"ImageLink": {
"Title": "ABC",
"Href": "ABC"
},
"Text": "ABC",
"AuthorName": "ABC",
"StoryLink": {
}
},
"RecentNews": {
"Articles": [
{
"Title": "ABC",
"Url": "ABC",
"Category": "ABC",
"Summary": "ABC",
"Image": {
"Url": "ABC",
"AltText": "ABC"
},
"Vertical": "ABC",
"ReadTime": "ABC",
"UpdatedAt": "ABC"
},
{
"Title": "ABC",
"Url": "ABC",
"Category": "ABC",
"Summary": "ABC",
"Image": {
"Url": "ABC",
"AltText": "ABC"
},
"Vertical": "ABC",
"ReadTime": "ABC",
"UpdatedAt": "ABC"
}
],
"ViewAllLink": "ABC"
},
"LifestyleOverview": "ABC"
}