Skip to content
Scrappa Get API key
Trade Me Property API 1 credit/request

Trade Me Property Rental Search API Documentation

GET https://scrappa.co/api/trademe_property/search_rent?rows=2&page=1

Search rental property on Trade Me (New Zealand). Same filters, sorting and paging as the sale search, with prices in NZD per week and an optional pets_ok filter. Each listing returns id, url, title, weekly price (price_per_week) and price text, available_from as YYYY-MM-DD, dates in ISO 8601 UTC, location, bedrooms, bathrooms, parking, photos, agency and open homes when present. A valid search with no hits returns an empty listings list and is a successful, billable response.

Trade Me Property Rental Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/trademe_property/search_rent?rows=2&page=1
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "success": true,
    "data": {
        "total_count": 11881,
        "page": 1,
        "page_size": 2,
        "has_more": true,
        "listings": [
            {
                "id": 6176096818,
                "url": "https://www.trademe.co.nz/a/listing/6176096818",
                "title": "Milford, 4 bedrooms, $2500 pw",
                "category": "To Rent",
                "property_type": "House",
...

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.

14 optional filters available.

page integer Optional

Page number, 1-based. Defaults to 1.

Example value 1
rows integer Optional

Listings per page, 1 to 100. Defaults to 22.

Example value 2
price_min integer Optional

Minimum price in NZD per week.

Example value 10
price_max integer Optional

Maximum price in NZD per week.

Example value 10
bedrooms_min integer Optional

Minimum number of bedrooms.

Example value 10
bedrooms_max integer Optional

Maximum number of bedrooms.

Example value 10
bathrooms_min integer Optional

Minimum number of bathrooms.

Example value 10
property_type string Optional

Property type slug, for example house, apartment, unit or townhouse. Unknown values are ignored by Trade Me.

Example value example
region integer Optional

Region id from the localities endpoint, e.g. 15 for Wellington.

Example value US
district integer Optional

District id from the localities endpoint, e.g. 47 for Wellington city.

Example value 10
suburb string Optional

One or more suburb ids from the localities endpoint, separated by commas, e.g. 53,57.

Example value example
search_string string Optional

Free-text keyword search, up to 100 characters, e.g. beach.

Example value example
sort_order string Optional

Default, PriceAsc, PriceDesc, ExpiryDesc or EarliestOpenHome. Defaults to Default.

Example value example
pets_ok boolean Optional

Set to true to return only rentals that allow pets.

Example value true

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/trademe_property/search_rent?rows=2&page=1",
    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
<?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_rent?rows=2&page=1');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/trademe_property/search_rent?rows=2&page=1', 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));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/trademe_property/search_rent?rows=2&page=1',
    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);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/trademe_property/search_rent?rows=2&page=1")
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
Python
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_rent?rows=2&page=1", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/trademe_property/search_rent?rows=2&page=1', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
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_rent?rows=2&page=1")
        .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());
        }
    }
}
Go
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_rent?rows=2&page=1", 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))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/trademe_property/search_rent?rows=2&page=1"
C#
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_rent?rows=2&page=1"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/trademe_property/search_rent?rows=2&page=1',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
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_rent?rows=2&page=1")
        .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
JSON Response
200 OK
{
    "success": true,
    "data": {
        "total_count": 11881,
        "page": 1,
        "page_size": 2,
        "has_more": true,
        "listings": [
            {
                "id": 6176096818,
                "url": "https://www.trademe.co.nz/a/listing/6176096818",
                "title": "Milford, 4 bedrooms, $2500 pw",
                "category": "To Rent",
                "property_type": "House",
                "price_text": "$2,500 per week",
                "price_per_week": 2500,
                "currency": "NZD",
                "start_date": "2026-10-12T11:26:55Z",
                "end_date": "2026-11-02T11:26:55Z",
                "available_from": "2026-11-10",
                "region": "Auckland",
                "district": "North Shore City",
                "suburb": "Milford",
                "address": "43 East Coast Road",
                "location": {
                    "latitude": -36.76861,
                    "longitude": 174.7598075
                },
                "bedrooms": 4,
                "bathrooms": 3,
                "parking_spaces": 2,
                "image_url": "https://trademe.tmcdn.co.nz/photoserver/thumb/2334741472.jpg",
                "photo_urls": [
                    "https://trademe.tmcdn.co.nz/photoserver/thumb/2334741473.jpg",
                    "https://trademe.tmcdn.co.nz/photoserver/thumb/2334741474.jpg"
                ],
                "agency": "Harcourts Cooper & Co Property Management, (Licensed: REAA 2008)",
                "is_featured": true
            }
        ]
    },
    "meta": {
        "endpoint_family": "search_rent",
        "billable": true
    }
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

NOT_FOUND

HTTP NOT_FOUND

The listing was not found or has expired. Not billed.

UPSTREAM_UNAVAILABLE

HTTP UPSTREAM_UNAVAILABLE

Trade Me could not be reached. Not billed.

UPSTREAM_BLOCKED

HTTP UPSTREAM_BLOCKED

Trade Me rejected the request. Not billed.

upstream_unavailable

HTTP upstream_unavailable

The upstream service is temporarily unavailable. Please retry shortly.

PARSER_DRIFT

HTTP PARSER_DRIFT

Trade Me returned an unexpected payload shape. Not billed.

UPSTREAM_ERROR

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.