Skip to content
Scrappa Get API key
MyHome.ie API 1 credit/request

MyHome.ie Agency Directory API Documentation

GET https://scrappa.co/api/myhome-ie/agencies?name=DNG&region_id=1265

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.

MyHome.ie Agency Directory API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/myhome-ie/agencies?name=DNG&region_id=1265
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "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,
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

This endpoint has no required query parameters.

4 optional filters available.

name string Optional

Agency name to search for.

Example value DNG
region_id integer Optional

Only agencies of this region id.

Example value 1265
page integer Optional

Result page, 1-based.

Example value 1
page_size integer Optional

Agencies per page: 10, 20 (default) or 50.

Example value 10

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/myhome-ie/agencies?name=DNG&region_id=1265",
    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/myhome-ie/agencies?name=DNG&region_id=1265');

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/myhome-ie/agencies?name=DNG&region_id=1265', 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/myhome-ie/agencies?name=DNG&region_id=1265',
    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/myhome-ie/agencies?name=DNG&region_id=1265")
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/myhome-ie/agencies?name=DNG&region_id=1265", 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/myhome-ie/agencies?name=DNG&region_id=1265', 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/myhome-ie/agencies?name=DNG&region_id=1265")
        .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/myhome-ie/agencies?name=DNG&region_id=1265", 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/myhome-ie/agencies?name=DNG&region_id=1265"
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/myhome-ie/agencies?name=DNG&region_id=1265"));
            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/myhome-ie/agencies?name=DNG&region_id=1265',
            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/myhome-ie/agencies?name=DNG&region_id=1265")
        .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 total page page_size total_pages has_more applied_filters agencies +1 more

Common agencies fields

id name address phone
JSON Response
200 OK
{
    "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

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

422

Validation Error

A query parameter failed validation. Non-billable.

{
    "errors": {
        "page_size": [
            "The selected page size is invalid."
        ]
    },
    "message": "The page size field must be 10, 20 or 50."
}
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.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "agencies"
    },
    "error": {
        "code": "upstream_unavailable",
        "message": "MyHome.ie is temporarily unavailable. Please retry."
    },
    "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.