Scrappa's GET /api/immoweb/search endpoint is the Immoweb Search API documentation page for developers who need Belgian property listings as structured JSON instead of building their own scraper.
Endpoint reference for Immoweb.be listing search
Use this endpoint to search houses, apartments, land and commercial property for sale or rent across Belgium, including new-build homes. The request supports transaction type, property type, postal codes, provinces, districts, price bounds, surface bounds, room counts and amenity booleans.
What the Immoweb search response returns
Each listing carries its identifier, price, address with coordinates, surface and room counts, media references, publication timestamps and the agency record it belongs to. Belgian-specific data is included: notary public-sale flags, life-annuity sale flags, energy label information and construction-permit fields.
Every search response also returns x_count and x_count_with_geopoint — the number of matching listings in total, and the number of those that have coordinates. Comparing the two tells you how many listings are mappable, which is not always all of them.
Pagination
Use range to page through results. It is zero-based and inclusive at both ends, so range=0-199 returns 200 listings and range=200-399 returns the next 200. Results are ordered deterministically; no sort-direction parameter is offered because the underlying data source has a fixed order per sort criterion.
What this endpoint does not return
Three capabilities are worth stating plainly rather than discovering later. Immoweb exposes a price-changed boolean and modification timestamps, but not a price history series. User reviews and ratings do not exist on Immoweb. No new-build project entity is published — new build surfaces as listings and as developers in the agency directory.
When to pair this endpoint with the other Immoweb docs
Use Location Autocomplete to turn a place name into ready-made search filters before searching. Use Search Count to size a market before paginating. Use Listing Detail for a single full record. See the Immoweb API overview for the full endpoint list.
Run this endpoint
Endpoint
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.
13 optional filters available.
string
Required
FOR_SALE or FOR_RENT. Required.
FOR_SALE
string
Optional
Property type, for example HOUSE, APARTMENT, LAND or HOMES_TO_BUILD for new build.
HOUSE
string
Optional
Construction type, for example VILLA, HOUSE, BUNGALOW, BEL_ETAGE, APARTMENT_BUILDING, ALL_KIND or ANY. This vocabulary is not yet confirmed against the live API. An unrecognised value is rejected with HTTP 422. If a recognised value turns out not to be a query value the tier accepts, it returns zero results rather than the full inventory.
example
string
Optional
Comma-separated Belgian postal codes. Both 9000 and BE-9000 are accepted.
BE-9000
string
Optional
Unprefixed province codes, for example ANTWERP or EAST_FLANDERS.
example
string
Optional
Unprefixed district codes, for example GENT.
example
string
Optional
PRICE, MONTHLY_RENTAL_PRICE, YEARLY_RENTAL_PRICE, PRICE_PER_SQM or YEARLY_RENTAL_PRICE_PER_SQM.
example
integer
Optional
Minimum price.
10
integer
Optional
Maximum price.
10
string
Optional
PRICE, AD_QUALITY, POSTAL_CODE or PUBLICATION_DATE. Each criterion has one fixed direction.
relevance
string
Optional
Zero-based inclusive page window, for example 0-199 for 200 listings. Defaults to 0-199.
0-9
string
Optional
nl, fr or en. Bare two-letter codes only; defaults to nl.
en
boolean
Optional
Restrict to notary public sales (veiling).
true
boolean
Optional
Restrict to listings with a garden.
true
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/immoweb/search?transactionTypes=FOR_SALE&propertyTypes=HOUSE&postalCodes=BE-9000&range=0-9",
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/immoweb/search?transactionTypes=FOR_SALE&propertyTypes=HOUSE&postalCodes=BE-9000&range=0-9');
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/immoweb/search?transactionTypes=FOR_SALE&propertyTypes=HOUSE&postalCodes=BE-9000&range=0-9', 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/immoweb/search?transactionTypes=FOR_SALE&propertyTypes=HOUSE&postalCodes=BE-9000&range=0-9',
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/immoweb/search?transactionTypes=FOR_SALE&propertyTypes=HOUSE&postalCodes=BE-9000&range=0-9")
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/immoweb/search?transactionTypes=FOR_SALE&propertyTypes=HOUSE&postalCodes=BE-9000&range=0-9", 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/immoweb/search?transactionTypes=FOR_SALE&propertyTypes=HOUSE&postalCodes=BE-9000&range=0-9', 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/immoweb/search?transactionTypes=FOR_SALE&propertyTypes=HOUSE&postalCodes=BE-9000&range=0-9")
.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/immoweb/search?transactionTypes=FOR_SALE&propertyTypes=HOUSE&postalCodes=BE-9000&range=0-9", 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/immoweb/search?transactionTypes=FOR_SALE&propertyTypes=HOUSE&postalCodes=BE-9000&range=0-9"
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/immoweb/search?transactionTypes=FOR_SALE&propertyTypes=HOUSE&postalCodes=BE-9000&range=0-9"));
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/immoweb/search?transactionTypes=FOR_SALE&propertyTypes=HOUSE&postalCodes=BE-9000&range=0-9',
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/immoweb/search?transactionTypes=FOR_SALE&propertyTypes=HOUSE&postalCodes=BE-9000&range=0-9")
.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
x_count
x_count_with_geopoint
range
results
Common results fields
id
price
isAPublicSale
isALifeAnnuitySale
{
"success": true,
"x_count": 3812,
"x_count_with_geopoint": 3627,
"range": {
"first": 0,
"last": 9
},
"results": [
{
"id": 21882350,
"price": 449000,
"isAPublicSale": false,
"isALifeAnnuitySale": false,
"lastModificationDate": "2026-10-04T14:01:02.451Z",
"property": {
"title": "Te koop - huis",
"alternativeTitles": {
"fr": "\u00c0 vendre - maison",
"nl": "Te koop - huis"
},
"numberOfBedrooms": 3,
"surface": 180,
"constructionPermit": {
"isObtained": true,
"floodZoneType": null
},
"location": {
"address": {
"postalCode": "9000",
"locality": "Gent",
"country": "Belgi\u00eb"
},
"geoPoint": {
"latitude": 51.05,
"longitude": 3.72
}
}
},
"media": {
"pictures": {
"baseUrl": "https://media-resize.immowebstatic.be",
"items": []
}
},
"customers": [
{
"id": 90001334,
"type": "AGENCY",
"publicInfo": {
"name": "Example Agency",
"ipiNo": "BE-000000"
}
}
]
}
]
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
One or more query parameters failed validation. No credits are charged.
{
"errors": {
"field": [
"The field is invalid."
]
},
"message": "The given data was invalid."
}Upstream Unavailable
One upstream lookup per request. A failed lookup is never billed. Upstream rejections (HTTP 403) surface as a 503 with the failure code; filter values outside the documented vocabulary are rejected with 422 before any upstream call.
{
"error": {
"code": "upstream_unavailable",
"message": "The upstream service 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.