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

Homes.co.nz Agent API Documentation

GET https://scrappa.co/api/homes-co-nz/agent

Homes.co.nz Agent API returns the public profile of one real estate agent: name, photo, business phone numbers, email, website, social links, biography, licence number, agency and recent sales with price text and sale date. Get the agent id (UUID) from the agents of a search item or listing. An unknown agent is a 404. Failed requests are not billable.

Homes.co.nz Agent API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/homes-co-nz/agent
Auth header
x-api-key
Cost
1 credit/request
id = 1234567890
Response preview
200 OK
{
    "data": {
        "id": "a77e78d2-fc9a-4c56-8857-85439405b744",
        "url": "https://homes.co.nz/agent/a77e78d2-fc9a-4c56-8857-85439405b744",
        "name": "Livia Li",
        "about": "Livia has a proven track record in selling real estate & for over 20 years. She has consistently been amongst the top sellers in Barfoot & Thompson. Her educational degrees in architecture and marketing enable her to ...",
        "email": "l.li@barfoot.co.nz",
        "photo": "https://trademe.tmcdn.co.nz/tm/property/agent_individual_profile/agent_individual_profile7183277v1.jpg",
        "video": null,
        "agency": {
            "id": "645814a2-983b-49ae-9372-7f58729a7dce",
            "url": "https://homes.co.nz/branch/645814a2-983b-49ae-9372-7f58729a7dce",
            "logo": "https://trademe.tmcdn.co.nz/tm/property/agent_logos/2436274-8.jpg",
            "name": "City",
...

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 string Required

Required. Agent id (UUID) from a search item or listing.

Example value 1234567890

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "id": "a77e78d2-fc9a-4c56-8857-85439405b744",
        "url": "https://homes.co.nz/agent/a77e78d2-fc9a-4c56-8857-85439405b744",
        "name": "Livia Li",
        "about": "Livia has a proven track record in selling real estate & for over 20 years. She has consistently been amongst the top sellers in Barfoot & Thompson. Her educational degrees in architecture and marketing enable her to ...",
        "email": "l.li@barfoot.co.nz",
        "photo": "https://trademe.tmcdn.co.nz/tm/property/agent_individual_profile/agent_individual_profile7183277v1.jpg",
        "video": null,
        "agency": {
            "id": "645814a2-983b-49ae-9372-7f58729a7dce",
            "url": "https://homes.co.nz/branch/645814a2-983b-49ae-9372-7f58729a7dce",
            "logo": "https://trademe.tmcdn.co.nz/tm/property/agent_logos/2436274-8.jpg",
            "name": "City",
            "brand": "Barfoot & Thompson",
            "phone": "+64-9-3076340",
            "banner": null
        },
        "is_team": false,
        "website": "https://www.barfoot.co.nz/l.li",
        "facebook": "https://www.facebook.com/Liviacity/",
        "linkedin": "https://www.linkedin.com/in/livia-li-a1324329/",
        "agency_id": "645814a2-983b-49ae-9372-7f58729a7dce",
        "mobile_phone": "027 560 9668",
        "office_phone": "09 377 8810",
        "recent_sales": [
            {
                "price": null,
                "address": "10L/16 Gore Street, Auckland Central, Auckland",
                "sold_at": "2026-10-07",
                "latitude": -36.845943450927734,
                "longitude": 174.7689208984375,
                "price_text": "$TBC",
                "property_id": "6e7f9adc-859f-4a67-a614-eb9b550c8feb"
            },
            {
                "price": null,
                "address": "1/16 Bond Crescent, Forrest Hill, Auckland",
                "sold_at": "2026-09-27",
                "latitude": -36.77176284790039,
                "longitude": 174.74859619140625,
                "price_text": "$TBC",
                "property_id": "6550c637-8bb9-4656-9c72-ac1411c45df2"
            },
            {
                "price": null,
                "address": "15M/16 Gore Street, Auckland Central, Auckland",
                "sold_at": "2026-09-16",
                "latitude": -36.846038818359375,
                "longitude": 174.76889038085938,
                "price_text": "$TBC",
                "property_id": "6efe07fa-1d76-480b-9ffc-446ce9a15c43"
            }
        ],
        "licence_number": "10000053",
        "with_agency_since": null
    },
    "meta": {
        "billable": true,
        "endpoint_family": "agent"
    },
    "success": true
}

Errors

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

422

Validation Error

A parameter is missing or invalid. This response is not billable.

{
    "errors": {
        "id": [
            "The id field is required."
        ]
    },
    "message": "The request validation failed"
}
404

Not Found

The agent does not exist. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "agent"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested record was not found."
    },
    "success": false
}
503

Upstream Unavailable

Homes.co.nz could not be reached. This response is not billable and is retryable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "agent"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Homes.co.nz could not be reached. Please retry shortly."
    },
    "success": false
}

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.