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

MyHome.ie Agency Profile API Documentation

GET https://scrappa.co/api/myhome-ie/agency?id=5543

Scrappa's GET /api/myhome-ie/agency returns the public profile of one MyHome.ie estate agency by id.

What you get

agency has id, name, address, phone, email, website, fax, logo, sales_licence, rental_licence, latitude, longitude, description, services (which listing types the agency offers), parent_agency, child_agencies and negotiators (name, job title, photo). The contact data is the business data the agency shows on its public page. Negotiator e-mail addresses are not published.

Finding the id

Take agency.id from any search or listing result, or from the agency directory. An id that is not an agency returns a non-billable 404.

MyHome.ie Agency Profile API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/myhome-ie/agency?id=5543
Auth header
x-api-key
Cost
1 credit/request
id = 5543
Response preview
200 OK
{
    "success": true,
    "agency": {
        "id": 5543,
        "name": "DNG Stillorgan",
        "address": "18 Lower Kilmacud Road, Stillorgan, Co. Dublin",
        "phone": "01 283 2700",
        "email": "stillorgan@dng.ie",
        "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",
        "website": "http://www.dng.ie",
        "latitude": 53.288077,
...

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

Numeric agency id from a listing.

Example value 5543

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/myhome-ie/agency?id=5543",
    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/agency?id=5543');

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/agency?id=5543', 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/agency?id=5543',
    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/agency?id=5543")
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/agency?id=5543", 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/agency?id=5543', 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/agency?id=5543")
        .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/agency?id=5543", 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/agency?id=5543"
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/agency?id=5543"));
            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/agency?id=5543',
            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/agency?id=5543")
        .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 agency meta
JSON Response
200 OK
{
    "success": true,
    "agency": {
        "id": 5543,
        "name": "DNG Stillorgan",
        "address": "18 Lower Kilmacud Road, Stillorgan, Co. Dublin",
        "phone": "01 283 2700",
        "email": "stillorgan@dng.ie",
        "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",
        "website": "http://www.dng.ie",
        "latitude": 53.288077,
        "longitude": -6.200323,
        "services": {
            "residential_for_sale": true,
            "new_homes": false,
            "lettings_to_rent": false
        },
        "parent_agency": {
            "id": 269349,
            "name": "DNG Head Office"
        },
        "child_agencies": [],
        "negotiators": [
            {
                "id": 171386,
                "name": "Brian Dempsey",
                "job_title": "Partner",
                "image": "https://photos-a.propertyimages.ie/users/6/8/3/171386/profile.jpg"
            }
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "agency",
        "attempts": 1
    }
}

Errors

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

404

Not Found

Nothing exists with that id, or the listing is no longer online (`not_found`). Non-billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "agency"
    },
    "error": {
        "code": "not_found",
        "message": "No record exists with that id."
    },
    "success": false
}
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": "agency"
    },
    "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.