# ImmoScout24 Switzerland Search ## Overview | Property | Value | |----------|-------| | **Status** | active | | **Method** | `GET` | | **Endpoint** | `/v2/immoscout24ch/search` | | **Base URL** | `https://api.piloterr.com` | | **Credit Cost** | 2 credits per call | | **Documentation** | https://www.piloterr.com/library/immoscout24ch-search | ## Description Search ImmoScout24.ch listings by city or search URL and retrieve the CHF price, rooms, living area, and address. Property pages are not available. ## Authentication - **Key Name:** `x-api-key` - **Location:** HTTP Header - **Get an API key:** https://app.piloterr.com/register ## Example Request ```bash curl --location --request GET 'https://api.piloterr.com/v2/immoscout24ch/search' \ --header 'Content-Type: application/json' \ --header 'x-api-key: YOUR_API_KEY' ``` ## Example Response ### Apartments for rent in Zurich ```json { "results": [ { "id": "4002086198", "url": "https://www.immoscout24.ch/mieten/4002086198", "floor": null, "price": 2257, "rooms": 1.5, "title": "City Pop - Cosy Studio Apartments just next to HB Zürich", "canton": "ZH", "street": "Militärstrasse 106", "currency": "CHF", "features": [ "has_cable_tv", "has_dishwasher", "has_elevator", "has_garage", "has_nice_view", "has_parking", "is_ground_floor_raised", "is_quiet" ], "latitude": 47.375904371673, "locality": "Zürich", "bathrooms": 1, "image_url": "https://cdn.immoscout24.ch/listings/v2/e335city/4002086198/image/92c334cb2a581eeda57f107e6b2d3fd3.jpg", "longitude": 8.518085354726, "price_net": null, "categories": [ "apartment", "flat" ], "created_at": "2025-04-07T14:53:38.768Z", "offer_type": "rent", "year_built": 2025, "description": "Wir bieten zentral gelegene Apartments im Gebäude City Pop Zurich City an der Militarstrasse 106, 8004 Zürich an, die zwischen 19 und 46 Quadratmeter gross sind.", "extra_costs": null, "postal_code": "8004", "living_space": 24, "price_display": "CHF 2'257", "ceiling_height": null, "price_interval": "month", "year_renovated": 2025 } ], "pagination": { "next": "https://www.immoscout24.ch/de/wohnung/mieten/ort-zuerich?pn=2", "page": 1, "per_page": 20, "total_pages": 50, "total_results": 1222 } } ``` ## Documentation ## Overview Search rental and for-sale listings on ImmoScout24 Switzerland. Pass a city name or a full search URL from immoscout24.ch. Each listing includes the price in CHF, rooms, living area, and address. Property pages are not available. A listing URL such as `https://www.immoscout24.ch/mieten/4002086198` returns 400. This endpoint is Switzerland only. ## Quickstart Apartments for rent in Zurich. A city defaults to `offer_type=rent` and `property_type=apartment`. ``` GET https://api.piloterr.com/v2/immoscout24ch/search?query=zurich&offer_type=rent ``` The same search as a saved URL. Filters already on the URL, such as `nrf` and `nrt`, are kept. ``` GET https://api.piloterr.com/v2/immoscout24ch/search?query=https://www.immoscout24.ch/de/wohnung/mieten/ort-zuerich ``` Houses for sale in Geneva. `offer_type=buy` sets `results[].offer_type` to `buy`. ``` GET https://api.piloterr.com/v2/immoscout24ch/search?query=geneve&offer_type=buy&property_type=house ``` Page 2. ImmoScout24 receives `pn=2`. ``` GET https://api.piloterr.com/v2/immoscout24ch/search?query=zurich&page=2 ``` ## Parameters ### query Required string. - A city: `zurich`, `zuerich`, `geneve`, `geneva`, `bern`, `berne`, `basel`, `luzern`, or `lucerne`. The city is sent as `ort-{slug}`. - Default for a city: apartments for rent. `results[].offer_type` is `rent` and `results[].price` is the monthly gross rent in CHF. - A full immoscout24.ch search URL keeps its path and query filters unless `offer_type` or `property_type` is also set. - A listing URL returns 400. - A numeric id returns 400. - There is no default. ### offer_type Optional string. Default `rent` when `query` is a city. When omitted on a search URL, the URL path is kept. - `rent` (alias `mieten`): `results[].offer_type` is `rent`. `price` is the monthly gross rent. `price_interval` is `month` when the listing says so. - `buy` (aliases `kaufen`, `sale`): `results[].offer_type` is `buy`. `price` is the sale price. - Any other value returns 400. ### property_type Optional string. Default `apartment` when `query` is a city. When omitted on a search URL, the URL category is kept. - `apartment` (aliases `flat`, `wohnung`): flats. The path uses `wohnung`. - `house` (alias `haus`): houses. The path uses `haus`. - `all` (alias `immobilien`): every residential type. - `results[].categories` lists the categories on the card. - Any other value returns 400. ### page Optional integer. Default `1`. - Page 1 omits `pn`. Page 2 sends `pn=2`. - `pagination.page` is the page you asked for. - `pagination.next` is the next search URL, or null on the last page. - A value below 1 returns 400. ### return_page_source Optional boolean. Default `false`. `true` returns `{ "result": "" }` instead of `results` and `pagination`. ## Response fields | Field | Type | Description | |---|---|---| | `results[].id` | string | Listing id | | `results[].url` | string | Listing URL. Not a callable property endpoint | | `results[].title` | string or null | Listing title | | `results[].offer_type` | string or null | `rent` or `buy` | | `results[].categories` | array | Categories such as `apartment` and `flat` | | `results[].price` | number or null | CHF amount. Gross monthly rent, or the sale price | | `results[].price_display` | string or null | Same amount rebuilt as `CHF 2'257` | | `results[].currency` | string or null | `CHF` | | `results[].price_interval` | string or null | `month` for a rental | | `results[].rooms` | number or null | Room count | | `results[].living_space` | number or null | Living area in m² | | `results[].bathrooms` | number or null | Bathrooms | | `results[].floor` | number or null | Floor | | `results[].street` | string or null | Street | | `results[].locality` | string or null | City | | `results[].postal_code` | string or null | Postal code | | `results[].canton` | string or null | Canton code | | `results[].latitude` | number or null | Latitude | | `results[].longitude` | number or null | Longitude | | `results[].image_url` | string or null | First photo | | `results[].features` | array | Feature keys | | `results[].description` | string or null | Short description | | `pagination.page` | integer | Current page | | `pagination.per_page` | integer | Page size | | `pagination.total_results` | integer or null | Matching listings | | `pagination.total_pages` | integer or null | Page count | | `pagination.next` | string or null | Next search URL, or null | ## Notes `price_display` is rebuilt from `price` with an apostrophe as the thousands separator, and without a trailing dash. When `price` is present, that number is the amount in `price_display`. ## Use cases - Track asking rents in Zurich, Geneva, and other Swiss cities - Compare apartments and houses for sale from a saved search URL - Page through a city search with `page` ## Error codes | Code | Meaning | |---|---| | 400 | Missing query, unknown offer or property type, unknown domain, or a listing URL | | 401 | Missing API key | | 404 | The search page had no listings | | 500 | The page could not be rendered |