# MyHome.ie Agency Directory API Documentation

Scrappa's `GET /api/myhome-ie/agencies` pages through all MyHome.ie estate agencies.

## What you get

`agencies` has `id`, `name`, `address`, `phone`, `logo`, `sales_licence`, `rental_licence` and the public `url`. Use `name` to search by agency name and `region_id` to keep one region (ids from the locations endpoint). `total`, `page`, `page_size`, `total_pages` and `has_more` describe the paging. The `page` in the answer is the page that was served.

- **Documentation:** [https://scrappa.co/docs/myhome-ie-api/myhome_ie_agencies](https://scrappa.co/docs/myhome-ie-api/myhome_ie_agencies)
- **API group:** MyHome.ie API
- **Endpoint:** `GET https://scrappa.co/api/myhome-ie/agencies`

## 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 |
| --- | --- | --- | --- |
| `name` | string | No | Agency name to search for. |
| `region_id` | integer | No | Only agencies of this region id. |
| `page` | integer | No | Result page, 1-based. |
| `page_size` | integer | No | Agencies per page: 10, 20 (default) or 50. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/myhome-ie/agencies?name=DNG&region_id=1265"
```

## Example response

```json
{
    "success": true,
    "total": 21,
    "page": 1,
    "page_size": 20,
    "total_pages": 2,
    "has_more": true,
    "applied_filters": {
        "name": "DNG",
        "region_id": 1265
    },
    "agencies": [
        {
            "id": 5543,
            "name": "DNG Stillorgan",
            "address": "18 Lower Kilmacud Road, Stillorgan, Co. Dublin",
            "phone": "01 283 2700",
            "email": null,
            "logo": "https://photos-a.propertyimages.ie/groups/3/4/5/5543/logo.jpg",
            "sales_licence": "004017",
            "rental_licence": null,
            "url": "https://www.myhome.ie/estate-agents/dng-stillorgan-5543"
        }
    ],
    "meta": {
        "billable": true,
        "endpoint_family": "agencies",
        "attempts": 1
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A query parameter failed validation. Non-billable. |
| 503 | Upstream Unavailable | MyHome.ie could not be reached after retries, answered with a body this API cannot read, or did not apply the requested filters (public error code `upstream_unavailable`). Retryable and never billed. Clients are never rate limited. |

## 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)