Skip to main content
POST
/trademe/properties/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
location
string
required
Minimum string length: 1
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
channel
enum<string>
default:sale
Available options:
sale,
rent,
commercial-sale,
commercial-lease,
rural,
retirement
price_min
integer | null
Required range: x >= 0
price_max
integer | null
Required range: x >= 0
bedrooms_min
integer | null
Required range: x >= 0
bedrooms_max
integer | null
Required range: x >= 0
bathrooms_min
integer | null
Required range: x >= 0
parking_min
integer | null
Required range: x >= 0
living_areas_min
integer | null
Required range: x >= 0
land_area_min
integer | null
Required range: x >= 0
land_area_max
integer | null
Required range: x >= 0
floor_area_min
integer | null
Required range: x >= 0
floor_area_max
integer | null
Required range: x >= 0
property_types
enum<string>[] | null
Available options:
Apartment,
House,
Townhouse,
Unit,
Section,
BareLand,
Dwelling,
CarPark
sales_methods
enum<string>[] | null
Available options:
PriceDisplayed,
Negotiation,
Auction,
Tender,
DeadlineSale
property_features
enum<string>[] | null
Available options:
garage,
ensuite,
study,
toilet
keywords
string | null
open_homes_only
boolean | null
new_homes_only
boolean | null
home_income_only
boolean | null
pets_ok
boolean | null
available_now
boolean | null
sort
enum<string>
default:Default
Available options:
Default,
PriceAsc,
PriceDesc,
ExpiryDesc,
EarliestOpenHome

Response

Successful Response

id
integer
required
@type
string
default:TrademeSearchListing
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
listed_at
string | null
member_id
integer | null
open_homes
object[]
agency
object | null