Website logo

Get search card based on address, points, or polyline

Get search card based on address, points, or polyline

URL: https://api.trademe.co.nz/v1/Property/Sold/Search.{file_format}
HTTP Method: POST
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.

POST Data

<SoldSearchRequest>

Address String (optional)

Address to search for, either by input from Users or from the respond from AddressContract. Can be partial address, or fully formed address. Act as the center point of the Polyline
Filter String (optional)

Required when making a request to /address/search. Refer to AddressContract's type_filter param.
Latitude Number (optional)

Center latitude of the search area Or minimum latitude when maxLatitude is provided
Longitude Number (optional)

Center longitude of the search area Or minimum longitude when maxLongitude is provided
Radius Number (optional)

Radius of the polyline when only center latitude and longitude is provided
Polylines Collection of String (optional)

The boundary which defines which Properties should be included in the search result. Returned by linz/boundary/point in base64 encoded format, so should be decoded before it can be used.
Limit Integer (optional)

Control the number of search result returned at a time
Page Integer (optional)

Controls the page number when querying to /map/cards
Sort <Sort> (optional)

The 'sort by' object that defines how the search result is sorted on. To be used when querying /map/cards. Examples: Not specified = Featured First order: date, direction: asc = Latest order: price, direction: asc = Highest price order: price, direction: desc = Lowest price
Order String (optional)

Order
Direction String (optional)

Direction
JustSold Boolean (optional)

An additional filter to only show Properties that are recently sold To be used as just_sold parameter when querying /map/cards.
OffMarket Boolean (optional)

An additional filter to include Properties that are not currently for sale. Default to true. To be used as off_market parameter when querying /map/cards.
DateMin String (optional)

An additional filter to include Properties with date value at least from this value
DateMax String (optional)

An additional filter to include Properties with date value at most from this value
ForSale Boolean (optional)

An additional filter to include Properties that are currently for sale. To be used as for_sale parameter when querying /map/cards.
ForRent Boolean (optional)

An additional filter to include Properties that not currently for rent. To be used as for_rent parameter when querying /map/cards.
MaxLatitude Number (optional)

MaxLatitude to be used in conjunction with Latitude to define a search area When MaxLatitude and MaxLongitude is specified, polyline will be generated to cover the area within the two coordinates.
MaxLongitude Number (optional)

MaxLongitude to be used in conjunction with Longitude to define a search area When MaxLatitude and MaxLongitude is specified, polyline will be generated to cover the area within the two coordinates.
RequestPolyline Boolean (optional)

When this variable is set to true, the respond will return the polyline used to make the Search

Returns

<SoldSearchResponse>

A list of search cards from an area

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
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%
Polylines Collection of String or null

Specified the polylines that was used when searching.

Example XML Request (switch to JSON) 

<SoldSearchRequest xmlns="http://api.trademe.co.nz/v1">
  <Address>ABC</Address>
  <Filter>ABC</Filter>
  <Latitude>123.0</Latitude>
  <Longitude>123.0</Longitude>
  <Radius>123.0</Radius>
  <Polylines>
    <string>ABC</string>
    <string>ABC</string>
  </Polylines>
  <Limit>123</Limit>
  <Page>123</Page>
  <Sort>
    <Order>ABC</Order>
    <Direction>ABC</Direction>
  </Sort>
  <JustSold>false</JustSold>
  <OffMarket>false</OffMarket>
  <DateMin>ABC</DateMin>
  <DateMax>ABC</DateMax>
  <ForSale>false</ForSale>
  <ForRent>false</ForRent>
  <MaxLatitude>123.0</MaxLatitude>
  <MaxLongitude>123.0</MaxLongitude>
  <RequestPolyline>false</RequestPolyline>
</SoldSearchRequest>

Example JSON Request (switch to XML) 

{
  "Address": "ABC",
  "Filter": "ABC",
  "Latitude": 123.0,
  "Longitude": 123.0,
  "Radius": 123.0,
  "Polylines": [
    "ABC",
    "ABC"
  ],
  "Limit": 123,
  "Page": 123,
  "Sort": {
    "Order": "ABC",
    "Direction": "ABC"
  },
  "JustSold": false,
  "OffMarket": false,
  "DateMin": "ABC",
  "DateMax": "ABC",
  "ForSale": false,
  "ForRent": false,
  "MaxLatitude": 123.0,
  "MaxLongitude": 123.0,
  "RequestPolyline": false
}

Example XML Response (switch to JSON) 

<SoldSearchResponse xmlns="http://api.trademe.co.nz/v1">
  <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>
  <SuburbEstimate>ABC</SuburbEstimate>
  <SuburbEstimateDate>ABC</SuburbEstimateDate>
  <CapitalGrowth>ABC</CapitalGrowth>
  <Polylines>
    <string>ABC</string>
    <string>ABC</string>
  </Polylines>
</SoldSearchResponse>

Example JSON Response (switch to XML) 

{
  "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",
  "SuburbEstimate": "ABC",
  "SuburbEstimateDate": "ABC",
  "CapitalGrowth": "ABC",
  "Polylines": [
    "ABC",
    "ABC"
  ]
}