Skip to content
Scrappa Get API key
Immoweb API 1 credit/request

Immoweb Agency API Documentation

GET https://scrappa.co/api/immoweb/agencies?byGroup=false

Scrappa's GET /api/immoweb/agencies endpoint lists Belgian estate agencies, and the developers behind new-build projects.

What a record contains

Each agency carries its name, description, logo, Belgian IPI registration number, location with coordinates, and a weekly opening-hours timetable with appointment requirements. Agency type distinguishes agencies, real estate agencies, companies and property developers — the last being how new-build developers surface, since no separate project entity is published.

Two shapes from one endpoint

By default the response lists agency networks and groups — records carrying groupInfo with the network name, logo and live active-listing counts broken down by sale and rent. Pass byGroup=false to get individual agency records instead, which carry publicInfo, timetable and location at the top level. The two shapes differ, so read the record type you asked for.

This endpoint has no paging parameter and returns at most 100 records per call, so returned is the number of rows in this response — not the size of the directory. Belgian directories exceed that; narrow by agency type or language rather than assuming the list is complete.

Finding an agency's listings

Every agency record carries the identifier you pass as customerIds to Immoweb Search, which returns that agency's listings directly. No join endpoint is needed.

Contact details are removed

Business email addresses and telephone numbers present in the upstream directory are stripped before the response is returned. Agency name, logo, IPI number, location and opening hours are all retained.

Languages

Pass language as nl, fr or en. Bare two-letter codes only. Human French and Dutch descriptions are published alongside the default description.

Immoweb Agency API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/immoweb/agencies?byGroup=false
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "success": true,
    "returned": 1,
    "page_limit": 100,
    "by_group": false,
    "agencies": [
        {
            "id": 90001334,
            "type": "AGENCY",
            "location": {
                "geoPoint": {
                    "latitude": 51.05,
                    "longitude": 3.72
                },
...

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.

2 optional filters available.

byGroup boolean Optional

Return agency networks and groups (default) or individual agencies when false.

Example value false
language string Optional

nl, fr or en. Bare two-letter codes only; defaults to nl.

Example value en

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/immoweb/agencies?byGroup=false",
    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/immoweb/agencies?byGroup=false');

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/immoweb/agencies?byGroup=false', 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/immoweb/agencies?byGroup=false',
    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/immoweb/agencies?byGroup=false")
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/immoweb/agencies?byGroup=false", 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/immoweb/agencies?byGroup=false', 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/immoweb/agencies?byGroup=false")
        .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/immoweb/agencies?byGroup=false", 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/immoweb/agencies?byGroup=false"
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/immoweb/agencies?byGroup=false"));
            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/immoweb/agencies?byGroup=false',
            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/immoweb/agencies?byGroup=false")
        .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 returned page_limit by_group agencies

Common agencies fields

id type location publicInfo
JSON Response
200 OK
{
    "success": true,
    "returned": 1,
    "page_limit": 100,
    "by_group": false,
    "agencies": [
        {
            "id": 90001334,
            "type": "AGENCY",
            "location": {
                "geoPoint": {
                    "latitude": 51.05,
                    "longitude": 3.72
                },
                "address": {
                    "postalCode": "9000",
                    "locality": "Gent"
                }
            },
            "publicInfo": {
                "name": "Example Agency",
                "description": "Vastgoedagentsuur",
                "alternativeDescriptions": {
                    "fr": "Agence immobili\u00e8re",
                    "nl": "Vastgoedagentsuur"
                },
                "ipiNo": "BE-000000"
            },
            "timetable": [
                {
                    "dayOfTheWeek": "MONDAY",
                    "openingHours": [
                        {
                            "from": "09:00",
                            "to": "17:00",
                            "appointmentRequired": false
                        }
                    ]
                }
            ]
        }
    ]
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

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."
}
503

Upstream Unavailable

One upstream lookup per request. A failed lookup is never billed.

{
    "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.