Skip to content
Scrappa Get API key
Homegate API 1 credit/request

Homegate Search API Documentation

GET https://scrappa.co/api/homegate/search?offer_type=rent&location=city-zurich&size=20

Search public Homegate listings by offer type and location: for each listing the id, price (CHF), rooms, living space, address, image urls, agency branding and the public listing url, plus search metadata and a has_more pagination flag. A valid empty result is a successful response. Unknown locations answer a non-billable 422.

Homegate Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/homegate/search?offer_type=rent&location=city-zurich&size=20
Auth header
x-api-key
Cost
1 credit/request
location = city-zurich
Response preview
200 OK
{
    "success": true,
    "data": {
        "search_metadata": {
            "offer_type": "rent",
            "location": "city-zurich",
            "page": 1,
            "size": 20,
            "total": 1000,
            "max_from": 980,
            "sort_by": "listingType",
            "sort_direction": "desc"
        },
        "results": [
...

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.

3 optional filters available.

location string Required

Homegate English location url name from the locations endpoint, e.g. city-zurich. Example: city-zurich.

Example value city-zurich
offer_type string Optional

Rent or buy listings. Example: rent.

Example value rent
page integer Optional

1-based page number, 20 listings per page by default. Defaults to 1.

Example value 1
size integer Optional

Listings per page: 10, 20, 50 or 100. Defaults to 20.

Example value 20

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/homegate/search?offer_type=rent&location=city-zurich&size=20",
    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/homegate/search?offer_type=rent&location=city-zurich&size=20');

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/homegate/search?offer_type=rent&location=city-zurich&size=20', 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/homegate/search?offer_type=rent&location=city-zurich&size=20',
    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/homegate/search?offer_type=rent&location=city-zurich&size=20")
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/homegate/search?offer_type=rent&location=city-zurich&size=20", 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/homegate/search?offer_type=rent&location=city-zurich&size=20', 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/homegate/search?offer_type=rent&location=city-zurich&size=20")
        .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/homegate/search?offer_type=rent&location=city-zurich&size=20", 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/homegate/search?offer_type=rent&location=city-zurich&size=20"
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/homegate/search?offer_type=rent&location=city-zurich&size=20"));
            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/homegate/search?offer_type=rent&location=city-zurich&size=20',
            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/homegate/search?offer_type=rent&location=city-zurich&size=20")
        .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 data meta
JSON Response
200 OK
{
    "success": true,
    "data": {
        "search_metadata": {
            "offer_type": "rent",
            "location": "city-zurich",
            "page": 1,
            "size": 20,
            "total": 1000,
            "max_from": 980,
            "sort_by": "listingType",
            "sort_direction": "desc"
        },
        "results": [
            {
                "id": "4002086198",
                "offer_type": "rent",
                "title": "City Pop - Cosy Studio Apartments just next to HB Z\u00fcrich",
                "description": "Wir bieten zentral gelegene Apartments im Geb\u00e4ude City Pop Zurich City an der Militarstrasse 106, 8004 Z\u00fcrich an.",
                "price": {
                    "currency": "CHF",
                    "gross": 2257,
                    "interval": "MONTH"
                },
                "rooms": 1.5,
                "living_space": 24,
                "address": {
                    "street": "Milit\u00e4rstrasse 106",
                    "postal_code": "8004",
                    "locality": "Z\u00fcrich",
                    "region": "ZH",
                    "geoTags": [
                        "geo-city-zurich"
                    ],
                    "latitude": 47.375900941538,
                    "longitude": 8.518080868209
                },
                "images": [
                    "https://media2.homegate.ch/listings/v2/e335city/4002086198/image/92c334cb2a581eeda57f107e6b2d3fd3.jpg"
                ],
                "lister": {
                    "logo_url": "https://media2.homegate.ch/t_customer_logo/logos/l_e335city_v2.png",
                    "subscription_type": "Gold"
                },
                "url": "https://www.homegate.ch/rent/4002086198"
            }
        ],
        "pagination": {
            "current_page": 1,
            "total": 1000,
            "max_from": 980,
            "has_more": true
        }
    },
    "meta": {
        "endpoint_family": "search",
        "billable": true
    }
}

Errors

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

422

Validation Error

The location parameter is missing or not a Homegate url name. This response is not billable.

{
    "errors": {
        "location": [
            "A location url name is required, e.g. city-zurich."
        ]
    },
    "message": "The request validation failed"
}
422

Unknown Location

Homegate could not resolve the location url name. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "search"
    },
    "error": {
        "code": "INVALID_PARAMETER",
        "message": "Homegate rejected the request parameters."
    },
    "success": false
}
503

Upstream Unavailable

Homegate is temporarily unreachable, blocked the request, or answered a shape we could not parse. Retry later; this response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Homegate 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.