Skip to content
Scrappa Get API key
ImmoScout24 CH API 1 credit/request

ImmoScout24 CH Search API Documentation

GET https://scrappa.co/api/immoscout24-ch/search?offer_type=rent&geo_tags=geo-city-zurich&min_rooms=2.5&max_price=3000&size=20

Search public ImmoScout24 Switzerland listings by offer type, location, price, rooms, living space and features. Each listing carries the id, price (CHF), rooms, living space, floor, features, address with coordinates, image urls, agency and the public listing url. Pages hold 5, 10, 20 or 50 rows; the first 1000 results of a search can be paged. Rent and room bounds are enforced on every row. A valid empty result is a successful response.

ImmoScout24 CH Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/immoscout24-ch/search?offer_type=rent&geo_tags=geo-city-zurich&min_rooms=2.5&max_price=3000&size=20
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "success": true,
    "data": {
        "search_metadata": {
            "offer_type": "rent",
            "geo_tags": [
                "geo-city-zurich"
            ],
            "page": 1,
            "size": 20,
            "language": "de",
            "sort_by": "date",
            "sort_direction": "desc",
            "total": 412,
...

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.

17 optional filters available.

offer_type string Optional

Rent or buy listings. Defaults to rent. Example: rent.

Example value rent
property_type string Optional

apartment_or_house, apartment or house. Defaults to apartment_or_house.

Example value example
geo_tags string Optional

Comma-separated geo tags from the locations endpoint, e.g. geo-city-zurich. Without a tag the search covers all of Switzerland. Example: geo-city-zurich.

Example value geo-city-zurich
min_price number Optional

Minimum gross monthly rent (rent) or purchase price (buy) in CHF. Example: 1500.

Example value 10
max_price number Optional

Maximum gross monthly rent (rent) or purchase price (buy) in CHF. Example: 3000.

Example value 3000
min_rooms number Optional

Minimum number of rooms. Example: 2.5.

Example value 2.5
max_rooms number Optional

Maximum number of rooms.

Example value 10
min_area integer Optional

Minimum living space in square metres.

Example value 10
balcony boolean Optional

Only listings with a balcony when true.

Example value true
elevator boolean Optional

Only listings with an elevator when true.

Example value true
lister_id string Optional

Only listings of one agency, using the lister id from a listing.

Example value 1234567890
semantic_query string Optional

Free text such as "8004 Zurich quiet". Used with sort_by=relevance.

Example value example
sort_by string Optional

date, price, rooms, place, completeness, listing_type, random, exclusive or relevance. Defaults to date.

Example value example
sort_direction string Optional

asc or desc. Defaults to desc.

Example value example
lang string Optional

Text language: de, fr, it or en. Defaults to de.

Example value example
page integer Optional

1-based page number. Defaults to 1.

Example value 1
size integer Optional

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

Example value 20

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/immoscout24-ch/search?offer_type=rent&geo_tags=geo-city-zurich&min_rooms=2.5&max_price=3000&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/immoscout24-ch/search?offer_type=rent&geo_tags=geo-city-zurich&min_rooms=2.5&max_price=3000&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/immoscout24-ch/search?offer_type=rent&geo_tags=geo-city-zurich&min_rooms=2.5&max_price=3000&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/immoscout24-ch/search?offer_type=rent&geo_tags=geo-city-zurich&min_rooms=2.5&max_price=3000&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/immoscout24-ch/search?offer_type=rent&geo_tags=geo-city-zurich&min_rooms=2.5&max_price=3000&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/immoscout24-ch/search?offer_type=rent&geo_tags=geo-city-zurich&min_rooms=2.5&max_price=3000&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/immoscout24-ch/search?offer_type=rent&geo_tags=geo-city-zurich&min_rooms=2.5&max_price=3000&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/immoscout24-ch/search?offer_type=rent&geo_tags=geo-city-zurich&min_rooms=2.5&max_price=3000&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/immoscout24-ch/search?offer_type=rent&geo_tags=geo-city-zurich&min_rooms=2.5&max_price=3000&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/immoscout24-ch/search?offer_type=rent&geo_tags=geo-city-zurich&min_rooms=2.5&max_price=3000&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/immoscout24-ch/search?offer_type=rent&geo_tags=geo-city-zurich&min_rooms=2.5&max_price=3000&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/immoscout24-ch/search?offer_type=rent&geo_tags=geo-city-zurich&min_rooms=2.5&max_price=3000&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/immoscout24-ch/search?offer_type=rent&geo_tags=geo-city-zurich&min_rooms=2.5&max_price=3000&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",
            "geo_tags": [
                "geo-city-zurich"
            ],
            "page": 1,
            "size": 20,
            "language": "de",
            "sort_by": "date",
            "sort_direction": "desc",
            "total": 412,
            "returned": 1
        },
        "results": [
            {
                "id": "4003373005",
                "offer_type": "rent",
                "categories": [
                    "APARTMENT",
                    "FLAT"
                ],
                "title": "Zentrale 3-Zimmer-Wohnung mit Balkon",
                "description": "Helle Wohnung in ruhiger Lage, nahe Tram und Einkauf.",
                "price": {
                    "currency": "CHF",
                    "gross": 2310,
                    "net": 2100,
                    "interval": "MONTH"
                },
                "rooms": 3,
                "living_space": 68,
                "floor": 3,
                "features": {
                    "has_balcony": true,
                    "has_elevator": true
                },
                "address": {
                    "street": "Brunnenstrasse 22",
                    "postal_code": "8610",
                    "locality": "Uster",
                    "region": "ZH",
                    "latitude": 47.3511,
                    "longitude": 8.7225
                },
                "images": [
                    "https://media2.homegate.ch/listings/v2/z927/4003373005/image/b002cd67dead2640a1d0f0b75f66055d.jpg"
                ],
                "lister": {
                    "id": "z927",
                    "name": "Example Immobilien AG"
                },
                "platforms": [
                    "immoscout24",
                    "homegate"
                ],
                "available_from": "2026-11-01",
                "url": "https://www.immoscout24.ch/rent/4003373005"
            }
        ],
        "pagination": {
            "current_page": 1,
            "total": 412,
            "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

A parameter is missing or invalid. This response is not billable.

{
    "errors": {
        "offer_type": [
            "The parameter is missing or invalid."
        ]
    },
    "message": "The request validation failed"
}
503

Source Unavailable

The source is temporarily unreachable or blocked the request. Retry later; this response is not billable.

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