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

Flatfox Search API Documentation

GET https://scrappa.co/api/immoscout24-ch/flatfox/search?north=47.45&south=47.32&east=8.62&west=8.45&offer_type=rent&object_category=apartment&max_count=100

Search public Flatfox listings inside a map bounding box. The result is a list of map pins: id, display price, latitude and longitude. The source returns no total and no offset, so narrow the box or the filters to see more. Pass the pin ids to the Flatfox listing endpoint for the full details.

Flatfox Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/immoscout24-ch/flatfox/search?north=47.45&south=47.32&east=8.62&west=8.45&offer_type=rent&object_category=apartment&max_count=100
Auth header
x-api-key
Cost
1 credit/request
north = 47.45 south = 47.32 east = 8.62
Response preview
200 OK
{
    "success": true,
    "data": {
        "search_metadata": {
            "offer_type": "rent",
            "object_category": "apartment",
            "bounds": {
                "north": 47.45,
                "south": 47.32,
                "east": 8.62,
                "west": 8.45
            },
            "max_count": 100,
            "returned": 1
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

4 required parameters needed before sending a request.

7 optional filters available.

north number Required

Northern edge of the box in degrees latitude. Example: 47.45.

Example value 47.45
south number Required

Southern edge of the box in degrees latitude. Example: 47.32.

Example value 47.32
east number Required

Eastern edge of the box in degrees longitude. Example: 8.62.

Example value 8.62
west number Required

Western edge of the box in degrees longitude. Example: 8.45.

Example value 8.45
offer_type string Optional

rent or buy. Defaults to rent.

Example value rent
object_category string Optional

apartment, house, shared, parking or industry.

Example value apartment
min_price integer Optional

Minimum price in CHF.

Example value 10
max_price integer Optional

Maximum price in CHF.

Example value 10
min_rooms number Optional

Minimum number of rooms.

Example value 10
organization integer Optional

Only pins of one agency, using the organization id.

Example value 10
max_count integer Optional

Maximum number of pins, 1 to 1000. Defaults to 100.

Example value 100

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/immoscout24-ch/flatfox/search?north=47.45&south=47.32&east=8.62&west=8.45&offer_type=rent&object_category=apartment&max_count=100",
    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/flatfox/search?north=47.45&south=47.32&east=8.62&west=8.45&offer_type=rent&object_category=apartment&max_count=100');

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/flatfox/search?north=47.45&south=47.32&east=8.62&west=8.45&offer_type=rent&object_category=apartment&max_count=100', 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/flatfox/search?north=47.45&south=47.32&east=8.62&west=8.45&offer_type=rent&object_category=apartment&max_count=100',
    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/flatfox/search?north=47.45&south=47.32&east=8.62&west=8.45&offer_type=rent&object_category=apartment&max_count=100")
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/flatfox/search?north=47.45&south=47.32&east=8.62&west=8.45&offer_type=rent&object_category=apartment&max_count=100", 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/flatfox/search?north=47.45&south=47.32&east=8.62&west=8.45&offer_type=rent&object_category=apartment&max_count=100', 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/flatfox/search?north=47.45&south=47.32&east=8.62&west=8.45&offer_type=rent&object_category=apartment&max_count=100")
        .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/flatfox/search?north=47.45&south=47.32&east=8.62&west=8.45&offer_type=rent&object_category=apartment&max_count=100", 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/flatfox/search?north=47.45&south=47.32&east=8.62&west=8.45&offer_type=rent&object_category=apartment&max_count=100"
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/flatfox/search?north=47.45&south=47.32&east=8.62&west=8.45&offer_type=rent&object_category=apartment&max_count=100"));
            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/flatfox/search?north=47.45&south=47.32&east=8.62&west=8.45&offer_type=rent&object_category=apartment&max_count=100',
            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/flatfox/search?north=47.45&south=47.32&east=8.62&west=8.45&offer_type=rent&object_category=apartment&max_count=100")
        .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",
            "object_category": "apartment",
            "bounds": {
                "north": 47.45,
                "south": 47.32,
                "east": 8.62,
                "west": 8.45
            },
            "max_count": 100,
            "returned": 1
        },
        "results": [
            {
                "id": "1234567",
                "price_display": 2150,
                "latitude": 47.3769,
                "longitude": 8.5417
            }
        ],
        "pagination": {
            "current_page": 1,
            "max_count": 100,
            "has_more": false
        }
    },
    "meta": {
        "endpoint_family": "flatfox-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": {
        "north": [
            "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": "flatfox-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.