# Homes.co.nz Agency API Documentation

<p><strong>Homes.co.nz Agency API</strong> returns the public profile of one agency branch: brand, branch name, logo, phone, email, website, address, coordinates and description. Get the agency <code>id</code> (UUID) from the <code>agency</code> of a search item or listing. An unknown agency is a 404. Failed requests are not billable.</p>

- **Documentation:** [https://scrappa.co/docs/homes-co-nz-api/homes_co_nz_agency](https://scrappa.co/docs/homes-co-nz-api/homes_co_nz_agency)
- **API group:** Homes.co.nz API
- **Endpoint:** `GET https://scrappa.co/api/homes-co-nz/agency`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | Required. Agency id (UUID) from a search item or listing. |

## Example response

```json
{
    "data": {
        "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",
        "about": "The Barfoot & Thompson City Branch is located in a historic building on the corner of Fort and Commerce Streets and behind the Vero building, which serves as a prominent land mark. The office is conveniently located f...",
        "brand": "Barfoot & Thompson",
        "email": "gsmith@barfoot.co.nz",
        "phone": "+64-9-3076340",
        "stats": null,
        "banner": "https://trademe.tmcdn.co.nz/tm/property/agent_logos/office_branding/2436274-office_branding-1.jpg",
        "address": "18 Commerce St\nCity Centre",
        "website": "https://www.barfoot.co.nz/branches/city",
        "latitude": -36.845954,
        "longitude": 174.767671,
        "legal_name": null
    },
    "meta": {
        "billable": true,
        "endpoint_family": "agency"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A parameter is missing or invalid. This response is not billable. |
| 404 | Not Found | The agency does not exist. This response is not billable. |
| 503 | Upstream Unavailable | Homes.co.nz could not be reached. This response is not billable and is retryable. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)