Skip to content
Scrappa Get API key
realestate.co.nz API 1 credit/request

realestate.co.nz Property Search API Documentation

GET https://scrappa.co/api/realestate-co-nz/search?type=sale&region=35&bedrooms_min=3&sort=latest&rows=2
Get API key Open Playground

Search New Zealand residential property for sale or rent on realestate.co.nz. Filter by region, district, suburb, price, bedrooms, bathrooms, car parks, land and floor area, property type, keyword, open homes, new builds, pool and more. Sort the results and page through them with page and rows. Each listing returns id, url, price text and a price number when the text is one clear amount, address with coordinates, bedrooms, bathrooms, parking, land and floor area, open homes, features, description, photos, agents and office. The site returns at most 10000 results per search, so narrow the search by location or price to go deeper. Use the locations endpoint or autocomplete to find location ids. A valid search with no hits returns an empty listings list and is a successful, billable response.

realestate.co.nz Property Search API Documentation 1 credit/request
Get API key Open Playground

Endpoint

Request preview
GET
https://scrappa.co/api/realestate-co-nz/search?type=sale&region=35&bedrooms_min=3&sort=latest&rows=2
Auth header
x-api-key
Cost
1 credit/request
type = sale
Response preview
200 OK 
{
    "success": true,
    "data": {
        "total_count": 11779,
        "page": 1,
        "page_size": 2,
        "has_more": true,
        "max_results_per_query": 10000,
        "search_location": {
            "regions": [
                "Auckland"
            ]
        },
        "listings": [
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

31 optional filters available.

type
type string Required

sale or rent.

Example value sale
page integer Optional

Page number, 1-based. Defaults to 1. A search returns at most 10000 results, so page times rows must stay at or below 10000.

Example value 1
rows integer Optional

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

Example value 2
region string Optional

Region ids from the locations endpoint, separated by commas, e.g. 35 for Auckland.

Example value 35
district string Optional

District ids from the locations endpoint, separated by commas, e.g. 225.

Example value example
suburb string Optional

Suburb ids from the locations endpoint or autocomplete, separated by commas, e.g. 3236.

Example value example
include_nearby_suburbs boolean Optional

Set to true to include listings from suburbs next to the chosen suburbs.

Example value true
price_min integer Optional

Minimum price in NZD. For rent this is NZD per week.

Example value 10
price_max integer Optional

Maximum price in NZD. For rent this is NZD per week.

Example value 10
bedrooms_min integer Optional

Minimum number of bedrooms.

Example value 3
bedrooms_max integer Optional

Maximum number of bedrooms.

Example value 10
bathrooms_min integer Optional

Minimum number of bathrooms.

Example value 10
bathrooms_max integer Optional

Maximum number of bathrooms.

Example value 10
carparks integer Optional

Minimum number of car parks.

Example value 10
land_area_min integer Optional

Minimum land area in square metres.

Example value 10
land_area_max integer Optional

Maximum land area in square metres.

Example value 10
floor_area_min integer Optional

Minimum floor area in square metres.

Example value 10
floor_area_max integer Optional

Maximum floor area in square metres.

Example value 10
property_type string Optional

One or more types separated by commas. Sale: house, apartment, studio, townhouse, section, carpark. Rent: house, apartment, studio, townhouse, unit, carpark.

Example value example
keyword string Optional

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

Example value running shoes
open_home boolean Optional

Set to true to return only listings with an upcoming open home.

Example value true
new_construction boolean Optional

Set to true to return only new builds.

Example value true
mortgagee_sale boolean Optional

Set to true to return only mortgagee sales.

Example value true
swimming_pool boolean Optional

Set to true to return only listings with a swimming pool.

Example value true
coastal_waterfront boolean Optional

Set to true to return only coastal waterfront listings.

Example value true
pets_allowed boolean Optional

Rent only. Set to true to return only rentals that allow pets.

Example value true
floor_plans boolean Optional

Set to true to return only listings with floor plans.

Example value true
videos boolean Optional

Set to true to return only listings with a video.

Example value true
agent string Optional

Agent ids separated by commas. Returns that agent's listings.

Example value example
office string Optional

Office ids separated by commas. Returns that office's listings.

Example value example
school string Optional

School ids from autocomplete (type school, field value), separated by commas.

Example value example
sort string Optional

best-match, featured, latest, oldest, lowest-price, highest-price, lowest-land-area or highest-land-area. Defaults to the site order.

Example value latest

Request Examples

PHP 
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/realestate-co-nz/search?type=sale&region=35&bedrooms_min=3&sort=latest&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 
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/realestate-co-nz/search?type=sale&region=35&bedrooms_min=3&sort=latest&rows=2');

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/realestate-co-nz/search?type=sale&region=35&bedrooms_min=3&sort=latest&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));
JavaScript 
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/realestate-co-nz/search?type=sale&region=35&bedrooms_min=3&sort=latest&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);
}
Ruby 
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/realestate-co-nz/search?type=sale&region=35&bedrooms_min=3&sort=latest&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
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/realestate-co-nz/search?type=sale&region=35&bedrooms_min=3&sort=latest&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()
Python 
import requests

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

try:
    response = requests.get('https://scrappa.co/api/realestate-co-nz/search?type=sale&region=35&bedrooms_min=3&sort=latest&rows=2', 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/realestate-co-nz/search?type=sale&region=35&bedrooms_min=3&sort=latest&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());
        }
    }
}
Go 
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/realestate-co-nz/search?type=sale&region=35&bedrooms_min=3&sort=latest&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))
}
Terminal 
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/realestate-co-nz/search?type=sale&region=35&bedrooms_min=3&sort=latest&rows=2"
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/realestate-co-nz/search?type=sale&region=35&bedrooms_min=3&sort=latest&rows=2"));
            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/realestate-co-nz/search?type=sale&region=35&bedrooms_min=3&sort=latest&rows=2',
            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/realestate-co-nz/search?type=sale&region=35&bedrooms_min=3&sort=latest&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.

Open in Playground

Example response fields

Scan these fields before integrating.

success data meta
JSON Response
200 OK 
{
    "success": true,
    "data": {
        "total_count": 11779,
        "page": 1,
        "page_size": 2,
        "has_more": true,
        "max_results_per_query": 10000,
        "search_location": {
            "regions": [
                "Auckland"
            ]
        },
        "listings": [
            {
                "id": 43156911,
                "listing_no": "1973289",
                "url": "https://www.realestate.co.nz/43156911/residential/sale/67-lough-bourne-drive-pukekohe",
                "title": "Where design meets tranquillity",
                "status": "active",
                "category": "res_sale",
                "property_type": "House",
                "price_text": "Auction",
                "currency": "NZD",
                "price_code": 5,
                "auction_at": "2026-11-24T02:00:00Z",
                "auction_location": "8 Massey Avenue, Pukekohe",
                "address": {
                    "full": "67 Lough Bourne Drive, Pukekohe, Franklin, Auckland",
                    "display": "67 Lough Bourne Drive, Pukekohe",
                    "street_number": "67",
                    "street": "Lough Bourne Drive",
                    "suburb": "Pukekohe",
                    "district": "Franklin",
                    "region": "Auckland",
                    "postcode": "2120",
                    "suburb_slug": "auckland_franklin_pukekohe_pukekohe",
                    "district_slug": "auckland_franklin",
                    "region_slug": "auckland",
                    "latitude": -37.1880619,
                    "longitude": 174.8975293
                },
                "bedrooms": 4,
                "bathrooms": 2,
                "parking": {
                    "garage": 3,
                    "carport": 0,
                    "off_street": 0
                },
                "land_area": 1024,
                "land_area_unit": "sqm",
                "land_area_sqm": 1024,
                "floor_area": 237,
                "floor_area_unit": "sqm",
                "floor_area_sqm": 237,
                "published_at": "2026-10-25T02:57:04Z",
                "created_at": "2026-10-25T02:57:04Z",
                "open_homes": [
                    {
                        "start": "2026-10-31T00:15:00Z",
                        "end": "2026-10-31T00:45:00Z"
                    },
                    {
                        "start": "2026-11-01T00:15:00Z",
                        "end": "2026-11-01T00:45:00Z"
                    }
                ],
                "is_new_construction": false,
                "is_mortgagee_sale": false,
                "is_coastal_waterfront": false,
                "has_swimming_pool": false,
                "is_featured": true,
                "features": [],
                "description": "Positioned in a peaceful cul-de-sac and backing directly onto a tranquil bush setting, this striking Jennian-built residence offers a level of design distinctio\u2026",
                "photo_count": 24,
                "photos": [
                    {
                        "url": "https://mediaserver.realestate.co.nz/listings/43156911/a876efeb05261acef191a50300b13ddd.jpg",
                        "thumbnail_url": "https://mediaserver.realestate.co.nz/listings/43156911/a876efeb05261acef191a50300b13ddd.crop.31x40.jpg",
                        "medium_url": "https://mediaserver.realestate.co.nz/listings/43156911/a876efeb05261acef191a50300b13ddd.crop.105x134.jpg",
                        "large_url": "https://mediaserver.realestate.co.nz/listings/43156911/a876efeb05261acef191a50300b13ddd.crop.140x178.jpg"
                    },
                    {
                        "url": "https://mediaserver.realestate.co.nz/listings/43156911/a53dd85cc85c47ee7a6d723eb391452b.jpg",
                        "thumbnail_url": "https://mediaserver.realestate.co.nz/listings/43156911/a53dd85cc85c47ee7a6d723eb391452b.crop.31x40.jpg",
                        "medium_url": "https://mediaserver.realestate.co.nz/listings/43156911/a53dd85cc85c47ee7a6d723eb391452b.crop.105x134.jpg",
                        "large_url": "https://mediaserver.realestate.co.nz/listings/43156911/a53dd85cc85c47ee7a6d723eb391452b.crop.140x178.jpg"
                    }
                ],
                "agents": [
                    {
                        "id": 564606,
                        "name": "Mike Murphy",
                        "first_name": "Mike",
                        "last_name": "Murphy",
                        "slug": "mike-murphy",
                        "phone": "021 000 000",
                        "email": "agent@example.co.nz",
                        "website_url": "https://www.bayleys.co.nz/mike-murphy",
                        "image": {
                            "url": "https://mediaserver.realestate.co.nz/per_orgs/564606/4d7c20ec2f11518976580b049896b4da.jpg"
                        },
                        "office_name": "Bayleys Real Estate Ltd (Licensed: REAA 2008) - Pukekohe",
                        "listing_count": 26
                    },
                    {
                        "id": 945281,
                        "name": "Patrick Murphy",
                        "first_name": "Patrick",
                        "last_name": "Murphy",
                        "slug": "patrick-murphy",
                        "phone": "021 000 000",
                        "email": "agent@example.co.nz",
                        "website_url": "https://www.bayleys.co.nz/patrick-murphy",
                        "image": {
                            "url": "https://mediaserver.realestate.co.nz/per_orgs/945281/c4478c9aec106daf8f7dfd60e64550f8.jpg"
                        },
                        "office_name": "Bayleys Real Estate Ltd (Licensed: REAA 2008) - Pukekohe",
                        "listing_count": 14
                    }
                ],
                "office": {
                    "id": 231240,
                    "name": "Bayleys Real Estate Ltd (Licensed: REAA 2008) - Pukekohe",
                    "colloquial_name": "Bayleys - Pukekohe",
                    "slug": "bayleys-real-estate-ltd-licensed-reaa-2008-pukekohe",
                    "phone": "021 000 000",
                    "email": "agent@example.co.nz",
                    "logo_url": "https://mediaserver.realestate.co.nz/per_orgs/231240/317fb1fad9daaf5bd0f93986120e4ebe.jpg",
                    "brand_colour": "#00263A"
                }
            },
            {
                "id": 43156900,
                "listing_no": "RMU46266",
                "url": "https://www.realestate.co.nz/43156900/residential/sale/62-barrack-road-mount-wellington",
                "title": "1950s Charm, Built to Last, Brilliant Location",
                "status": "active",
                "category": "res_sale",
                "property_type": "House",
                "price_text": "Deadline Sale",
                "currency": "NZD",
                "price_code": 7,
                "address": {
                    "full": "62 Barrack Road, Mount Wellington, Auckland City, Auckland",
                    "display": "62 Barrack Road, Mount Wellington",
                    "street_number": "62",
                    "street": "Barrack Road",
                    "suburb": "Mount Wellington",
                    "district": "Auckland City",
                    "region": "Auckland",
                    "postcode": "1051",
                    "suburb_slug": "auckland_auckland-city_mount-wellington_mount-wellington",
                    "district_slug": "auckland_auckland-city",
                    "region_slug": "auckland",
                    "latitude": -36.9000084,
                    "longitude": 174.8390455
                },
                "bedrooms": 4,
                "bathrooms": 2,
                "parking": {
                    "garage": 1,
                    "carport": 0,
                    "off_street": 1
                },
                "published_at": "2026-10-25T00:38:21Z",
                "created_at": "2026-10-25T00:38:21Z",
                "open_homes": [
                    {
                        "start": "2026-10-28T04:00:00Z",
                        "end": "2026-10-28T04:30:00Z"
                    },
                    {
                        "start": "2026-10-30T22:00:00Z",
                        "end": "2026-10-30T22:30:00Z"
                    }
                ],
                "is_new_construction": false,
                "is_mortgagee_sale": false,
                "is_coastal_waterfront": false,
                "has_swimming_pool": true,
                "is_featured": false,
                "features": [],
                "description": "Full of charm and offering plenty of space for family living, this appealing 1950s stucco home is one to put on your must-view list. With four double bedrooms, \u2026",
                "photo_count": 14,
                "photos": [
                    {
                        "url": "https://mediaserver.realestate.co.nz/listings/43156900/2eb5a662426529e2b663cbadf97456a8.jpg",
                        "thumbnail_url": "https://mediaserver.realestate.co.nz/listings/43156900/2eb5a662426529e2b663cbadf97456a8.crop.31x40.jpg",
                        "medium_url": "https://mediaserver.realestate.co.nz/listings/43156900/2eb5a662426529e2b663cbadf97456a8.crop.105x134.jpg",
                        "large_url": "https://mediaserver.realestate.co.nz/listings/43156900/2eb5a662426529e2b663cbadf97456a8.crop.140x178.jpg"
                    },
                    {
                        "url": "https://mediaserver.realestate.co.nz/listings/43156900/293ad86d346d45c896ffd0473c96d489.jpg",
                        "thumbnail_url": "https://mediaserver.realestate.co.nz/listings/43156900/293ad86d346d45c896ffd0473c96d489.crop.31x40.jpg",
                        "medium_url": "https://mediaserver.realestate.co.nz/listings/43156900/293ad86d346d45c896ffd0473c96d489.crop.105x134.jpg",
                        "large_url": "https://mediaserver.realestate.co.nz/listings/43156900/293ad86d346d45c896ffd0473c96d489.crop.140x178.jpg"
                    }
                ],
                "agents": [
                    {
                        "id": 767852,
                        "name": "Marama Curness",
                        "first_name": "Marama",
                        "last_name": "Curness",
                        "slug": "marama-curness",
                        "phone": "021 000 000",
                        "email": "agent@example.co.nz",
                        "image": {
                            "url": "https://mediaserver.realestate.co.nz/per_orgs/767852/2a3cf8a36bd4b7855b5887900057dcd8.jpg"
                        },
                        "office_name": "Megan Jaffe Real Estate Ltd (Licensed: REAA 2008) - Ray White, Remuera",
                        "listing_count": 2
                    },
                    {
                        "id": 29337,
                        "name": "Glenn Curness",
                        "first_name": "Glenn",
                        "last_name": "Curness",
                        "slug": "glenn-curness",
                        "phone": "021 000 000",
                        "email": "agent@example.co.nz",
                        "website_url": "https://rwremuera.co.nz/team/agents/glenn-curness/",
                        "image": {
                            "url": "https://mediaserver.realestate.co.nz/per_orgs/29337/93fdadbe95f7c969ab0dbc05bc8f515a.jpg"
                        },
                        "office_name": "Megan Jaffe Real Estate Ltd (Licensed: REAA 2008) - Ray White, Remuera",
                        "listing_count": 2
                    }
                ],
                "office": {
                    "id": 22063,
                    "name": "Megan Jaffe Real Estate Ltd (Licensed: REAA 2008) - Ray White, Remuera",
                    "colloquial_name": "Ray White - Remuera",
                    "slug": "megan-jaffe-real-estate-ltd-licensed-reaa-2008-ray-white-remuera",
                    "phone": "021 000 000",
                    "email": "agent@example.co.nz",
                    "logo_url": "https://mediaserver.realestate.co.nz/per_orgs/22063/bcf30b21eb0a703a94ac421a4a4520e4.jpg",
                    "brand_colour": "#FFE512"
                }
            }
        ]
    },
    "meta": {
        "endpoint_family": "search",
        "billable": true
    }
}

Errors

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

RESULT_WINDOW_EXCEEDED

HTTP RESULT_WINDOW_EXCEEDED

page times rows is above 10000. Narrow the search. Not billed.

NOT_FOUND

HTTP NOT_FOUND

The listing, agent or office does not exist. Not billed.

UPSTREAM_UNAVAILABLE

HTTP UPSTREAM_UNAVAILABLE

realestate.co.nz could not be reached. Not billed.

UPSTREAM_BLOCKED

HTTP UPSTREAM_BLOCKED

realestate.co.nz refused the request. Not billed.

upstream_unavailable

HTTP upstream_unavailable

The upstream service is temporarily unavailable. Please retry shortly.

PARSER_DRIFT

HTTP PARSER_DRIFT

realestate.co.nz returned an unexpected payload shape. Not billed.

UPSTREAM_ERROR

HTTP UPSTREAM_ERROR

realestate.co.nz 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.

Get API key Open Playground
Back to Home Full API reference