realestate.co.nz Listing Detail API Documentation

GET https://scrappa.co/api/realestate-co-nz/listing?id=43156911

Retrieve one realestate.co.nz listing (sale or rent) by id: price text and number, price history, address with coordinates, bedrooms, bathrooms, parking, land and floor area, auction details, open homes, features, plain-text and HTML description, all photos with sizes, videos, floor plans, virtual tours, nearby schools and child care, and the listing agents and office. An unknown or removed listing id returns a non-billable 404.

Run this endpoint

realestate.co.nz Listing Detail API Documentation 1 credit/request

Get API key Open Playground

Request preview

GET

https://scrappa.co/api/realestate-co-nz/listing?id=43156911

Auth header: x-api-key
Cost: 1 credit/request

id = 43156911

Response preview

200 OK

{
    "success": true,
    "data": {
        "listing": {
            "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,
...

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.

id


                                        integer

Required

Numeric listing id from a search result or autocomplete, e.g. 43156911.

Example value

43156911

Request Examples

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/realestate-co-nz/listing?id=43156911",
    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/listing?id=43156911');

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/listing?id=43156911', 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/listing?id=43156911',
    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/listing?id=43156911")
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/listing?id=43156911", 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/listing?id=43156911', 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/listing?id=43156911")
        .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/realestate-co-nz/listing?id=43156911", 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/listing?id=43156911"

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/listing?id=43156911"));
            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/listing?id=43156911',
            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/listing?id=43156911")
        .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": {
        "listing": {
            "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"
            },
            "description_html": "<p>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 distinc\u2026",
            "price_history": [],
            "videos": [],
            "virtual_tours": [],
            "floor_plans": [
                {
                    "url": "https://mediaserver.realestate.co.nz/listings/43156911/271231488399ba7219e41fc896e7f0b0.jpg"
                }
            ],
            "additional_websites": [
                {
                    "url": "https://www.bayleys.co.nz/1973289?ps-preview=true",
                    "title": "here"
                }
            ],
            "schools": [
                {
                    "name": "Pukekohe North School",
                    "slug": "pukekohe-north-school",
                    "in_zone": true,
                    "distance": "0.87km",
                    "longitude": 174.895974,
                    "latitude": -37.195792
                },
                {
                    "name": "Pukekohe High School",
                    "slug": "pukekohe-high-school",
                    "in_zone": true,
                    "distance": "1.98km",
                    "longitude": 174.905826,
                    "latitude": -37.204552
                }
            ],
            "child_cares": [
                {
                    "name": "Lambs Preschool Pukekohe",
                    "slug": "lambs-preschool-pukekohe",
                    "in_zone": false,
                    "distance": "1.52km",
                    "longitude": 174.8941803,
                    "latitude": -37.20146942
                },
                {
                    "name": "Wild and Love Early Learning Village",
                    "slug": "wild-and-love-early-learning-village",
                    "in_zone": false,
                    "distance": "3.08km",
                    "longitude": 174.886747,
                    "latitude": -37.2143534
                }
            ],
            "broadbands": []
        }
    },
    "meta": {
        "endpoint_family": "listing",
        "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.