TradeMeProperty
get/trademe_property/search_rent
Request
- Base URL: https://scrappa.co/api
- URL: https://scrappa.co/api/trademe_property/search_rent
- Auth: API key in header X-API-KEY
Query parameters
pageinteger nullable
Page number, 1-based. Defaults to 1.
rowsinteger nullable
Listings per page, 1 to 100. Defaults to 22.
price_mininteger nullable
Minimum price in NZD per week.
price_maxinteger nullable
Maximum price in NZD per week.
bedrooms_mininteger nullable
Minimum number of bedrooms.
bedrooms_maxinteger nullable
Maximum number of bedrooms.
bathrooms_mininteger nullable
Minimum number of bathrooms.
property_typestring nullable
Property type slug, for example house, apartment, unit or townhouse.
regioninteger nullable
Region id from the localities endpoint, e.g. 15 for Wellington.
districtinteger nullable
District id from the localities endpoint, e.g. 47 for Wellington city.
suburbstring nullable
Suburb ids from the localities endpoint, separated by commas, e.g. 53,57.
search_stringstring nullable
Free-text keyword search, e.g. beach.
sort_order'Default' | 'PriceAsc' | 'PriceDesc' | 'ExpiryDesc' | 'EarliestOpenHome' | 'null' nullable
Default, PriceAsc, PriceDesc, ExpiryDesc or EarliestOpenHome.
pets_okboolean nullable
Set to true to return only rentals that allow pets.
Response
string required
Changes
No recorded changes to this operation across all 3 revisions of this API.