Fetch public Flatfox listings by id, up to 50 in one request, or one page of the listings of an agency. Each listing carries the price, rooms, living space, floor, year built, features, address with coordinates, images, documents, the agency, the moving date, publication dates, viewing and tour links and the public url. Ids that Flatfox does not know are listed in missing_pks; if none is found the request answers a non-billable 404.
Run this endpoint
Endpoint
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.
4 optional filters available.
string
Optional
One listing id, a comma-separated list, or pk[]=1&pk[]=2 (up to 50). Example: 1234567.
1234567
integer
Optional
Agency id. Returns a page of that agency's listings instead.
10
integer
Optional
Page size for organization lookups, 1 to 50. Defaults to 20.
10
integer
Optional
Offset for organization lookups. Defaults to 0.
10
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/immoscout24-ch/flatfox/listing?pk=1234567",
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
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/listing?pk=1234567');
if ($response->successful()) {
echo $response->body();
} else {
echo "Error: " . $response->status();
}
const options = {
method: 'GET',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE'
}
};
fetch('https://scrappa.co/api/immoscout24-ch/flatfox/listing?pk=1234567', 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));
const axios = require('axios');
const options = {
method: 'GET',
url: 'https://scrappa.co/api/immoscout24-ch/flatfox/listing?pk=1234567',
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);
}
require 'net/http'
require 'uri'
uri = URI.parse("https://scrappa.co/api/immoscout24-ch/flatfox/listing?pk=1234567")
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
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/listing?pk=1234567", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
except Exception as e:
print(f"Error: {e}")
finally:
conn.close()
import requests
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
response = requests.get('https://scrappa.co/api/immoscout24-ch/flatfox/listing?pk=1234567', headers=headers)
response.raise_for_status()
print(response.text)
except requests.exceptions.RequestException as e:
print(f"Error: {e}")
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/listing?pk=1234567")
.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());
}
}
}
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/listing?pk=1234567", 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))
}
#!/bin/bash
curl -X GET \
-H "x-api-key: YOUR_API_KEY_HERE" \
"https://scrappa.co/api/immoscout24-ch/flatfox/listing?pk=1234567"
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/listing?pk=1234567"));
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
catch (Exception ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}
import axios from 'axios';
async function run(): Promise<void> {
try {
const response = await axios({
method: 'GET',
url: 'https://scrappa.co/api/immoscout24-ch/flatfox/listing?pk=1234567',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE',
},
});
console.log(response.data);
} catch (error) {
console.error('Error:', error);
}
}
void run();
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/listing?pk=1234567")
.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
{
"success": true,
"data": {
"query": {
"pk": [
1234567
]
},
"results": [
{
"id": "1234567",
"offer_type": "rent",
"object_category": "APARTMENT",
"title": "Helle 2.5-Zimmer-Wohnung in Z\u00fcrich",
"price": {
"currency": "CHF",
"display": 2150,
"net": 1900,
"charges": 250,
"gross": 2150
},
"rooms": 2.5,
"living_space": 62,
"floor": 2,
"features": {
"attributes": [
"balcony",
"lift"
]
},
"address": {
"street": "Beispielstrasse 1",
"postal_code": "8004",
"locality": "Z\u00fcrich",
"latitude": 47.3769,
"longitude": 8.5417
},
"images": [
"https://flatfox.ch/media/example/1.jpg"
],
"lister": {
"name": "Beispiel Verwaltung AG",
"locality": "Z\u00fcrich",
"country": "CH"
},
"moving_date": "2026-12-01",
"created_at": "2026-10-01T08:00:00Z",
"url": "https://flatfox.ch/en/flat/example/1234567/"
}
]
},
"meta": {
"endpoint_family": "flatfox-listing",
"billable": true
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A parameter is missing or invalid. This response is not billable.
{
"errors": {
"pk": [
"The parameter is missing or invalid."
]
},
"message": "The request validation failed"
}Listing Not Found
The source has no matching resource. This response is not billable.
{
"meta": {
"billable": false,
"retryable": false,
"endpoint_family": "flatfox-listing"
},
"error": {
"code": "NOT_FOUND",
"message": "The requested resource was not found."
},
"success": false
}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-listing"
},
"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.