Get nearby property listings

Get for sale listings nearby

URL:	https://api.trademe.co.nz/v1/Property/Homes/NearbyListings.{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.

Query String parameters

limit

Integer (optional)

Maximum number of results to return

photo_size

Enumeration (optional)

The size of the images to return in the results. Defaults to Thumbnail

Thumbnail	The thumbnail sized photo (always 85x64, with white borders).
List	The list view sized photo (scaled down to fit 160x120).
Medium	The medium sized photo (scaled down to fit 175x175).
Gallery	The gallery sized photo (scaled down to fit 233x176).
Large	The large sized photo (scaled down to fit 352x264).
FullSize	The full sized photo (scaled down to fit 670x502).
JobSearchCard	The SearchCard photo (scaled down to fit 670x502).

property_id

String (optional)

Property Id to query to Homes

Returns

A PropertyListingsResponse object that contain some details about the nearby properties

Error

String or null

Error

Listings

Collection of <NearbyListedProperty> or null

Details of the nearby property listing

ListingId	Long Integer	The ID of the listing.
Title	String or null	The listing title.
Subtitle	String or null	The subtitle, if present.
Address	String or null	The address to display.
Bedrooms	Integer or null	The number of bedrooms in the property.
Bathrooms	Integer	The number of bathrooms in the property.
Parking	String or null	Information on the availability of parking.
TotalParking	Integer	total garage parking and offstreet parking
Area	Integer	The area of the house, in square metres.
LandArea	Integer	The area of the land, in square metres.
District	String or null	The name of the district the property is located in.
PhotoUrls	Collection of String or null	A collection of photo urls for the listing
PropertyId	String or null	The property ID. This is different from the listing ID.
DistrictId	Integer	The ID of the district where this property is located.
Region	String or null	The name of the region where this item is located.
Suburb	String or null	The name of the suburb where this item is located.
SuburbId	Integer	The ID of the suburb where this item is located. Only populated by the property search API, which means it uses the three-tier region/district/suburb system.
PriceDisplay	String or null	The price, in a format suitable for displaying to the user. Some categories may have special pricing rules, e.g. properties may have "Price by negotiation".
AsAt	DateTime	The date and time the response was generated on the server.
EndDate	DateTime	The date the listing will end.
CanonicalPath	String or null	The canonical path to the listing.

Example XML Response (switch to JSON)

<PropertyListingsResponse xmlns="http://api.trademe.co.nz/v1">
  <Error>ABC</Error>
  <Listings>
    <NearbyListedProperty>
      <ListingId>123</ListingId>
      <Title>ABC</Title>
      <Subtitle>ABC</Subtitle>
      <Address>ABC</Address>
      <Bedrooms>123</Bedrooms>
      <Bathrooms>123</Bathrooms>
      <Parking>ABC</Parking>
      <TotalParking>123</TotalParking>
      <Area>123</Area>
      <LandArea>123</LandArea>
      <District>ABC</District>
      <PhotoUrls>
        <PhotoUrl>ABC</PhotoUrl>
        <PhotoUrl>ABC</PhotoUrl>
      </PhotoUrls>
      <PropertyId>ABC</PropertyId>
      <DistrictId>123</DistrictId>
      <Region>ABC</Region>
      <Suburb>ABC</Suburb>
      <SuburbId>123</SuburbId>
      <PriceDisplay>ABC</PriceDisplay>
      <AsAt>2018-01-01T00:00:00Z</AsAt>
      <EndDate>2018-01-01T00:00:00Z</EndDate>
      <CanonicalPath>ABC</CanonicalPath>
    </NearbyListedProperty>
    <NearbyListedProperty>
      <ListingId>123</ListingId>
      <Title>ABC</Title>
      <Subtitle>ABC</Subtitle>
      <Address>ABC</Address>
      <Bedrooms>123</Bedrooms>
      <Bathrooms>123</Bathrooms>
      <Parking>ABC</Parking>
      <TotalParking>123</TotalParking>
      <Area>123</Area>
      <LandArea>123</LandArea>
      <District>ABC</District>
      <PhotoUrls>
        <PhotoUrl>ABC</PhotoUrl>
        <PhotoUrl>ABC</PhotoUrl>
      </PhotoUrls>
      <PropertyId>ABC</PropertyId>
      <DistrictId>123</DistrictId>
      <Region>ABC</Region>
      <Suburb>ABC</Suburb>
      <SuburbId>123</SuburbId>
      <PriceDisplay>ABC</PriceDisplay>
      <AsAt>2018-01-01T00:00:00Z</AsAt>
      <EndDate>2018-01-01T00:00:00Z</EndDate>
      <CanonicalPath>ABC</CanonicalPath>
    </NearbyListedProperty>
  </Listings>
</PropertyListingsResponse>

Example JSON Response (switch to XML)

{
  "Error": "ABC",
  "Listings": [
    {
      "ListingId": 123,
      "Title": "ABC",
      "Subtitle": "ABC",
      "Address": "ABC",
      "Bedrooms": 123,
      "Bathrooms": 123,
      "Parking": "ABC",
      "TotalParking": 123,
      "Area": 123,
      "LandArea": 123,
      "District": "ABC",
      "PhotoUrls": [
        "ABC",
        "ABC"
      ],
      "PropertyId": "ABC",
      "DistrictId": 123,
      "Region": "ABC",
      "Suburb": "ABC",
      "SuburbId": 123,
      "PriceDisplay": "ABC",
      "AsAt": "\/Date(1514764800)\/",
      "EndDate": "\/Date(1514764800)\/",
      "CanonicalPath": "ABC"
    },
    {
      "ListingId": 123,
      "Title": "ABC",
      "Subtitle": "ABC",
      "Address": "ABC",
      "Bedrooms": 123,
      "Bathrooms": 123,
      "Parking": "ABC",
      "TotalParking": 123,
      "Area": 123,
      "LandArea": 123,
      "District": "ABC",
      "PhotoUrls": [
        "ABC",
        "ABC"
      ],
      "PropertyId": "ABC",
      "DistrictId": 123,
      "Region": "ABC",
      "Suburb": "ABC",
      "SuburbId": 123,
      "PriceDisplay": "ABC",
      "AsAt": "\/Date(1514764800)\/",
      "EndDate": "\/Date(1514764800)\/",
      "CanonicalPath": "ABC"
    }
  ]
}