Search residential property for sale on Trade Me (New Zealand). Filter by price, bedrooms, bathrooms, property type, region, district, suburb and keyword, sort the results and page through them with page and rows. Each listing returns id, url, title, price text, price, dates in ISO 8601 UTC, location, bedrooms, bathrooms, areas, parking, photos, agency and open homes when present. Use the localities endpoint to find region, district and suburb ids. total_count can be an approximate count. A valid search with no hits returns an empty listings list and is a successful, billable response.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
This endpoint has no required query parameters.
13 optional filters available.
integer
Optional
Page number, 1-based. Defaults to 1.
1
integer
Optional
Listings per page, 1 to 100. Defaults to 22.
2
integer
Optional
Minimum price in NZD.
10
integer
Optional
Maximum price in NZD.
10
integer
Optional
Minimum number of bedrooms.
10
integer
Optional
Maximum number of bedrooms.
10
integer
Optional
Minimum number of bathrooms.
10
string
Optional
Property type slug, for example house, apartment, unit or townhouse. Unknown values are ignored by Trade Me.
example
integer
Optional
Region id from the localities endpoint, e.g. 15 for Wellington.
15
integer
Optional
District id from the localities endpoint, e.g. 47 for Wellington city.
47
string
Optional
One or more suburb ids from the localities endpoint, separated by commas, e.g. 53,57.
example
string
Optional
Free-text keyword search, up to 100 characters, e.g. beach.
example
string
Optional
Default, PriceAsc, PriceDesc, ExpiryDesc or EarliestOpenHome. Defaults to Default.
example
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/trademe_property/search_sale?region=15&district=47&rows=2",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: YOUR_API_KEY_HERE"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
<?php
use Illuminate\Support\Facades\Http;
$response = Http::timeout(30)
->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
->get('https://scrappa.co/api/trademe_property/search_sale?region=15&district=47&rows=2');
if ($response->successful()) {
echo $response->body();
} else {
echo "Error: " . $response->status();
}
const options = {
method: 'GET',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE'
}
};
fetch('https://scrappa.co/api/trademe_property/search_sale?region=15&district=47&rows=2', options)
.then(response => {
if (!response.ok) {
throw new Error(`HTTP error! status: ${response.status}`);
}
return response.text();
})
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
const axios = require('axios');
const options = {
method: 'GET',
url: 'https://scrappa.co/api/trademe_property/search_sale?region=15&district=47&rows=2',
headers: {
x-api-key: 'YOUR_API_KEY_HERE',
}
};
try {
const response = await axios(options);
console.log(response.data);
} catch (error) {
console.error('Error:', error.message);
}
require 'net/http'
require 'uri'
uri = URI.parse("https://scrappa.co/api/trademe_property/search_sale?region=15&district=47&rows=2")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'
request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'
begin
response = http.request(request)
puts response.body
rescue => e
puts "Error: #{e.message}"
end
import http.client
import json
conn = http.client.HTTPSConnection("scrappa.co")
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
conn.request("GET", "/api/trademe_property/search_sale?region=15&district=47&rows=2", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
except Exception as e:
print(f"Error: {e}")
finally:
conn.close()
import requests
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
response = requests.get('https://scrappa.co/api/trademe_property/search_sale?region=15&district=47&rows=2', headers=headers)
response.raise_for_status()
print(response.text)
except requests.exceptions.RequestException as e:
print(f"Error: {e}")
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;
public class ApiExample {
public static void main(String[] args) {
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://scrappa.co/api/trademe_property/search_sale?region=15&district=47&rows=2")
.addHeader("x-api-key", "YOUR_API_KEY_HERE")
.build();
try (Response response = client.newCall(request).execute()) {
if (response.isSuccessful()) {
System.out.println(response.body().string());
} else {
System.out.println("Error: " + response.code());
}
} catch (IOException e) {
System.out.println("Error: " + e.getMessage());
}
}
}
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("GET", "https://scrappa.co/api/trademe_property/search_sale?region=15&district=47&rows=2", nil)
if err != nil {
fmt.Println("Error creating request:", err)
return
}
req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")
resp, err := client.Do(req)
if err != nil {
fmt.Println("Error making request:", err)
return
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
fmt.Println("Error reading response:", err)
return
}
fmt.Println(string(body))
}
#!/bin/bash
curl -X GET \
-H "x-api-key: YOUR_API_KEY_HERE" \
"https://scrappa.co/api/trademe_property/search_sale?region=15&district=47&rows=2"
using System;
using System.Net.Http;
using System.Threading.Tasks;
class Program
{
static async Task Main()
{
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");
try
{
var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/trademe_property/search_sale?region=15&district=47&rows=2"));
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
catch (Exception ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}
import axios from 'axios';
async function run(): Promise<void> {
try {
const response = await axios({
method: 'GET',
url: 'https://scrappa.co/api/trademe_property/search_sale?region=15&district=47&rows=2',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE',
},
});
console.log(response.data);
} catch (error) {
console.error('Error:', error);
}
}
void run();
use reqwest::Client;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = Client::new();
let response = client
.get("https://scrappa.co/api/trademe_property/search_sale?region=15&district=47&rows=2")
.header("x-api-key", "YOUR_API_KEY_HERE")
.send()
.await?;
println!("{}", response.text().await?);
Ok(())
}
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
success
data
meta
{
"success": true,
"data": {
"total_count": 956,
"page": 1,
"page_size": 2,
"has_more": true,
"listings": [
{
"id": 6048028595,
"url": "https://www.trademe.co.nz/a/listing/6048028595",
"title": "Pure magic on The Crescent",
"category": "For Sale",
"property_type": "House",
"price_text": "Price by negotiation",
"start_date": "2026-07-23T08:08:27Z",
"end_date": "2026-10-31T19:43:27Z",
"region": "Wellington",
"district": "Wellington",
"suburb": "Roseneath",
"address": "51 The Crescent",
"location": {
"latitude": -41.290889,
"longitude": 174.8002205
},
"bedrooms": 4,
"bathrooms": 2,
"floor_area_sqm": 315,
"land_area_sqm": 407,
"image_url": "https://trademe.tmcdn.co.nz/photoserver/thumb/2327656526.jpg",
"photo_urls": [
"https://trademe.tmcdn.co.nz/photoserver/thumb/2327656528.jpg",
"https://trademe.tmcdn.co.nz/photoserver/thumb/2327656532.jpg"
],
"agency": "Luxe Realty, (Licensed: REAA 2008)",
"open_homes": [
{
"start": "2026-10-18T00:30:00Z",
"end": "2026-10-18T01:00:00Z"
}
],
"is_featured": true,
"has_video": true
}
]
},
"meta": {
"endpoint_family": "search_sale",
"billable": true
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
HTTP NOT_FOUND
The listing was not found or has expired. Not billed.
HTTP UPSTREAM_UNAVAILABLE
Trade Me could not be reached. Not billed.
HTTP UPSTREAM_BLOCKED
Trade Me rejected the request. Not billed.
HTTP upstream_unavailable
The upstream service is temporarily unavailable. Please retry shortly.
HTTP PARSER_DRIFT
Trade Me returned an unexpected payload shape. Not billed.
HTTP UPSTREAM_ERROR
Trade Me rejected the request parameters. Not billed.
Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.