Skip to main content
POST
/
api
/
trademe
/
properties
/
search
/trademe/properties/search
curl --request POST \
  --url https://api.anysite.io/api/trademe/properties/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "location": "<string>",
  "count": 2,
  "timeout": 300,
  "channel": "sale",
  "price_min": 1,
  "price_max": 1,
  "bedrooms_min": 1,
  "bedrooms_max": 1,
  "bathrooms_min": 1,
  "parking_min": 1,
  "living_areas_min": 1,
  "land_area_min": 1,
  "land_area_max": 1,
  "floor_area_min": 1,
  "floor_area_max": 1,
  "property_types": [],
  "sales_methods": [],
  "property_features": [],
  "keywords": "<string>",
  "open_homes_only": true,
  "new_homes_only": true,
  "home_income_only": true,
  "pets_ok": true,
  "available_now": true,
  "sort": "Default"
}
'
[
  {
    "id": 123,
    "@type": "@trademe_search_listing",
    "title": "<string>",
    "url": "<string>",
    "region": "<string>",
    "district": "<string>",
    "suburb": "<string>",
    "address": "<string>",
    "price_display": "<string>",
    "sale_method": "<string>",
    "sale_date": "<string>",
    "rent_per_week": 123,
    "available_date": "<string>",
    "property_type": "<string>",
    "bedrooms": 123,
    "bathrooms": 123,
    "parking": 123,
    "floor_area": 123,
    "latitude": 123,
    "longitude": 123,
    "image": "<string>",
    "images": [],
    "has_video": true,
    "is_featured": true,
    "listed_at": "<string>",
    "member_id": 123,
    "open_homes": [],
    "agency": {
      "id": 123,
      "@type": "@trademe_search_agency",
      "name": "<string>",
      "phone": "<string>",
      "website": "<string>",
      "image": "<string>"
    }
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
location
string
required

Location path: region, region/district or region/district/suburb (e.g. 'auckland', 'auckland/manukau-city', 'wellington/wellington-city/te-aro'). Use lowercase hyphenated names.

Minimum string length: 1
Examples:

"auckland"

"canterbury/christchurch-city"

​
count
integer
required

Max number of results to return

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
channel
enum<string>
default:sale

Which property listing channel to search.

Available options:
sale,
rent,
commercial-sale,
commercial-lease,
rural,
retirement
​
price_min
integer | null

Minimum price (NZD; per week for rent).

Required range: x >= 0
​
price_max
integer | null

Maximum price (NZD; per week for rent).

Required range: x >= 0
​
bedrooms_min
integer | null

Minimum number of bedrooms.

Required range: x >= 0
​
bedrooms_max
integer | null

Maximum number of bedrooms.

Required range: x >= 0
​
bathrooms_min
integer | null

Minimum number of bathrooms.

Required range: x >= 0
​
parking_min
integer | null

Minimum number of car parks.

Required range: x >= 0
​
living_areas_min
integer | null

Minimum number of living areas.

Required range: x >= 0
​
land_area_min
integer | null

Minimum land area (square metres).

Required range: x >= 0
​
land_area_max
integer | null

Maximum land area (square metres).

Required range: x >= 0
​
floor_area_min
integer | null

Minimum floor area (square metres).

Required range: x >= 0
​
floor_area_max
integer | null

Maximum floor area (square metres).

Required range: x >= 0
​
property_types
enum<string>[] | null

Restrict results to one or more property types.

Available options:
Apartment,
House,
Townhouse,
Unit,
Section,
BareLand,
Dwelling,
CarPark
​
sales_methods
enum<string>[] | null

Restrict results to one or more sale methods.

Available options:
PriceDisplayed,
Negotiation,
Auction,
Tender,
DeadlineSale
​
property_features
enum<string>[] | null

Require one or more property features.

Available options:
garage,
ensuite,
study,
toilet
​
keywords
string | null

Free-text keywords to match in listings.

​
open_homes_only
boolean | null

Only listings with an upcoming open home.

​
new_homes_only
boolean | null

Only new-build listings.

​
home_income_only
boolean | null

Only home & income properties.

​
pets_ok
boolean | null

Only rentals that allow pets.

​
available_now
boolean | null

Only rentals available now.

​
sort
enum<string>
default:Default

Result ordering.

Available options:
Default,
PriceAsc,
PriceDesc,
ExpiryDesc,
EarliestOpenHome

Response

Successful Response

​
id
integer
required
​
@type
string
default:@trademe_search_listing
​
title
string | null
​
url
string | null
​
region
string | null
​
district
string | null
​
suburb
string | null
​
address
string | null
​
price_display
string | null
​
sale_method
string | null
​
sale_date
string | null
​
rent_per_week
integer | null
​
available_date
string | null
​
property_type
string | null
​
bedrooms
integer | null
​
bathrooms
integer | null
​
parking
integer | null
​
floor_area
integer | null
​
latitude
number | null
​
longitude
number | null
​
image
string | null
​
images
string[]
​
has_video
boolean | null
​
is_featured
boolean | null
​
listed_at
string | null
​
member_id
integer | null
​
open_homes
TrademeOpenHome · object[]
​
agency
TrademeSearchAgency · object