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

MyHome.ie Locations API Documentation

GET https://scrappa.co/api/myhome-ie/locations?q=Adamstown

Scrappa's GET /api/myhome-ie/locations lists the Irish regions (counties and Dublin postal areas) and their localities with the ids and slugs the search endpoint takes.

How to use it

Call it without parameters to list every region with id, name and slug. Pass the slug as location to search. Pass region_id to list that region's localities with id, name, slug, property_count and url, then pass the ids as locality_ids.

Text matching

q matches names ignoring case and accents. The platform has no autocomplete call, so matching runs on a daily cached list. Without region_id, q matches region names and Dublin localities. localities_region_id in the answer says which region was searched.

MyHome.ie Locations API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/myhome-ie/locations?q=Adamstown
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "success": true,
    "query": "Adamstown",
    "region_id": null,
    "localities_region_id": 1265,
    "total_regions": 0,
    "total_localities": 1,
    "regions": [],
    "localities": [
        {
            "id": 1419,
            "name": "Adamstown",
            "slug": "adamstown",
            "property_count": 27,
...

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.

2 optional filters available.

region_id integer Optional

Region id. Returns that region's localities.

Example value 1234567890
q string Optional

Text to match in names, ignoring case and accents.

Example value Adamstown

Request Examples

PHP
<?php

$curl = curl_init();

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

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/locations?q=Adamstown', 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/locations?q=Adamstown',
    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/locations?q=Adamstown")
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/locations?q=Adamstown", 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/locations?q=Adamstown', 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/locations?q=Adamstown")
        .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/locations?q=Adamstown", 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/locations?q=Adamstown"
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/locations?q=Adamstown"));
            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/locations?q=Adamstown',
            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/locations?q=Adamstown")
        .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 query region_id localities_region_id total_regions total_localities regions localities +1 more

Common localities fields

id name slug property_count
JSON Response
200 OK
{
    "success": true,
    "query": "Adamstown",
    "region_id": null,
    "localities_region_id": 1265,
    "total_regions": 0,
    "total_localities": 1,
    "regions": [],
    "localities": [
        {
            "id": 1419,
            "name": "Adamstown",
            "slug": "adamstown",
            "property_count": 27,
            "url": "https://www.myhome.ie/residential/dublin-west/property-for-sale-in-adamstown"
        }
    ],
    "meta": {
        "billable": true,
        "endpoint_family": "locations"
    }
}

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": "locations"
    },
    "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": "locations"
    },
    "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.