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

realestate.co.nz Agent Profile API Documentation

GET https://scrappa.co/api/realestate-co-nz/agent?id=564606

Retrieve a public agent profile by agent id: name, slug, public listing phone and email, website, profile and awards, image, office, listing counts, categories and areas. Set include_listings=true to add the agent's current listings with the same page, rows and type parameters as search. Agent ids come from the agents field of a listing. Lookup by name is not available.

realestate.co.nz Agent Profile API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/realestate-co-nz/agent?id=564606
Auth header
x-api-key
Cost
1 credit/request
id = 564606
Response preview
200 OK
{
    "success": true,
    "data": {
        "agent": {
            "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",
...

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.

4 optional filters available.

id integer Required

Numeric agent id from a listing, e.g. 564606.

Example value 564606
include_listings boolean Optional

Set to true to add the agent's listings. Uses one extra request.

Example value true
type string Optional

sale or rent. Listings category when include_listings is true. Defaults to sale.

Example value example
page integer Optional

Listings page, 1-based. Defaults to 1.

Example value 1
rows integer Optional

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

Example value 10

Request Examples

PHP
<?php

$curl = curl_init();

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

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/agent?id=564606', 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/agent?id=564606',
    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/agent?id=564606")
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/agent?id=564606", 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/agent?id=564606', 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/agent?id=564606")
        .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/agent?id=564606", 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/agent?id=564606"
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/agent?id=564606"));
            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/agent?id=564606',
            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/agent?id=564606")
        .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": {
        "agent": {
            "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",
                "thumbnail_url": "https://mediaserver.realestate.co.nz/per_orgs/564606/4d7c20ec2f11518976580b049896b4da.crop.31x40.jpg",
                "medium_url": "https://mediaserver.realestate.co.nz/per_orgs/564606/4d7c20ec2f11518976580b049896b4da.crop.105x134.jpg",
                "large_url": "https://mediaserver.realestate.co.nz/per_orgs/564606/4d7c20ec2f11518976580b049896b4da.crop.140x178.jpg"
            },
            "office_name": "Bayleys Real Estate Ltd (Licensed: REAA 2008) - Pukekohe",
            "listing_count": 26,
            "office_id": 231240,
            "office_logo_url": "https://mediaserver.realestate.co.nz/per_orgs/231240/317fb1fad9daaf5bd0f93986120e4ebe.jpg",
            "office_brand_colour": "#00263A",
            "private_url": "https://www.mikemurphyrealestate.co.nz",
            "facebook_url": "https://www.facebook.com/mikemurphypukekoherealestate/",
            "linkedin_url": "https://www.linkedin.com/feed/?trk=onboarding-landing",
            "listing_total_count": 425,
            "listing_recent_count": 83,
            "active_listings_by_category": {
                "res_sale": 21,
                "rural_sale": 5
            },
            "categories": [
                "rural_sale",
                "res_sale"
            ],
            "suburbs": [
                "Tuakau",
                "Pukekohe"
            ],
            "profile_html": "<p>Mike Murphy comes from a legacy of real estate success, and has since built his own outstanding pattern of high performance.</p><p>Mike brings with him a net\u2026",
            "awards_html": "<ul><li>National EBU of the Year 2024/2025</li><li>Top 5% Bayleys Agents Nationwide</li><li>Bayleys $300 Million Dollar Club 2025/2026</li><li>Bayleys Pukekohe \u2026",
            "excellence_rank": 23,
            "is_feature_agent": false,
            "modified_at": "2026-10-24T13:03:37Z"
        }
    },
    "meta": {
        "endpoint_family": "agent",
        "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.