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

Homegate Listing Detail API Documentation

GET https://scrappa.co/api/homegate/listing?id=4003373005

Fetch one public Homegate listing by id: categories, price (CHF), rooms, living space, floor, address with coordinates, image urls, the lister (agency) with its legal name and website, availability date, title and description as plain text, created/updated timestamps and the public listing url. An unknown id answers a non-billable 404.

Homegate Listing Detail API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/homegate/listing?id=4003373005
Auth header
x-api-key
Cost
1 credit/request
id = 4003373005
Response preview
200 OK
{
    "success": true,
    "data": {
        "id": "4003373005",
        "offer_type": "rent",
        "categories": [
            "APARTMENT",
            "FLAT"
        ],
        "title": "Zentrale 2-Zimmer-Wohnung in Uster (Befristung bis 30.09.2027)",
        "description": "Diese gem\u00fctliche 2-Zimmer-Wohnung mit ca. 43 m\u00b2 Wohnfl\u00e4che befindet sich in einem Mehrfamilienhaus an der Brunnenstrasse 22 in 8610 Uster.",
        "price": {
            "currency": "CHF",
            "gross": 2310,
...

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

Homegate numeric listing id, e.g. 4003373005. Example: 4003373005.

Example value 4003373005

Request Examples

PHP
<?php

$curl = curl_init();

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

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/listing?id=4003373005', 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/listing?id=4003373005',
    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/listing?id=4003373005")
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/listing?id=4003373005", 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/listing?id=4003373005', 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/listing?id=4003373005")
        .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/listing?id=4003373005", 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/listing?id=4003373005"
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/listing?id=4003373005"));
            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/listing?id=4003373005',
            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/listing?id=4003373005")
        .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": {
        "id": "4003373005",
        "offer_type": "rent",
        "categories": [
            "APARTMENT",
            "FLAT"
        ],
        "title": "Zentrale 2-Zimmer-Wohnung in Uster (Befristung bis 30.09.2027)",
        "description": "Diese gem\u00fctliche 2-Zimmer-Wohnung mit ca. 43 m\u00b2 Wohnfl\u00e4che befindet sich in einem Mehrfamilienhaus an der Brunnenstrasse 22 in 8610 Uster.",
        "price": {
            "currency": "CHF",
            "gross": 2310,
            "interval": "MONTH"
        },
        "rooms": 2,
        "living_space": 43,
        "floor": 3,
        "address": {
            "street": "Brunnenstrasse 22",
            "postal_code": "8610",
            "locality": "Uster",
            "region": "ZH",
            "country": "CH",
            "geoTags": [
                "geo-canton-zurich",
                "geo-city-uster",
                "geo-zipcode-8610"
            ],
            "latitude": 47.351159941534,
            "longitude": 8.722516604289
        },
        "images": [
            "https://media2.homegate.ch/listings/v2/z927/4003373005/image/b002cd67dead2640a1d0f0b75f66055d.jpg"
        ],
        "lister": {
            "id": "z927",
            "name": "NOVAC-SOLUTIONS AG (Wohnung)",
            "logo_url": "https://media2.homegate.ch/t_customer_logo/logos/l_z927_v1.png",
            "website": "https://www.novac-solutions.com/",
            "subscription_type": "Bronze"
        },
        "available_from": "2026-09-30",
        "created_at": "2026-08-10T11:04:34Z",
        "updated_at": "2026-10-12T17:42:40Z",
        "url": "https://www.homegate.ch/rent/4003373005"
    },
    "meta": {
        "endpoint_family": "listing",
        "billable": true
    }
}

Errors

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

422

Validation Error

The id parameter is missing or not a Homegate numeric id. This response is not billable.

{
    "errors": {
        "id": [
            "A listing id is required, e.g. 4003373005."
        ]
    },
    "message": "The request validation failed"
}
404

Listing Not Found

No listing exists for the supplied id. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "listing"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested Homegate resource was not found."
    },
    "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": "listing"
    },
    "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.