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

Immoweb Location Autocomplete API Documentation

GET https://scrappa.co/api/immoweb/locations?input=Gent&language=nl

Scrappa's GET /api/immoweb/locations endpoint resolves Belgian place names into the exact filters the search endpoint accepts.

Filter bootstrap, not just typeahead

This is more than a name lookup. Every hit carries a query object naming the filter parameter and a ready value. Typing a locality name returns hits whose query.param is postalCodes with a full comma-separated list; typing a district name returns hits whose query.param is districts. You can feed either value straight into Immoweb Search.

Languages

Pass language as nl, fr or en. Bare two-letter codes only — regional variants fall back to English silently upstream, so they are rejected here. Belgian coverage means French queries work: Gand resolves in French, Gent in Dutch and Ghent in English.

Scope

Belgium only, which matches how the underlying data source scopes itself.

Related endpoints

Use Immoweb Geo to enumerate provinces and districts with their boundaries.

Immoweb Location Autocomplete API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/immoweb/locations?input=Gent&language=nl
Auth header
x-api-key
Cost
1 credit/request
input = Gent
Response preview
200 OK
{
    "success": true,
    "results": [
        {
            "type": "DISTRICT",
            "results": [
                {
                    "districtName": "Gent",
                    "query": {
                        "param": "districts",
                        "value": "GENT"
                    }
                }
            ]
...

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.

2 optional filters available.

input string Required

Place name fragment to resolve, for example Gent, Gand or Ghent.

Example value Gent
language string Optional

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

Example value nl
maxResults integer Optional

Maximum results per group, 1 to 50.

Example value 10

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/immoweb/locations?input=Gent&language=nl",
    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/locations?input=Gent&language=nl');

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/locations?input=Gent&language=nl', 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/locations?input=Gent&language=nl',
    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/locations?input=Gent&language=nl")
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/locations?input=Gent&language=nl", 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/locations?input=Gent&language=nl', 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/locations?input=Gent&language=nl")
        .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/locations?input=Gent&language=nl", 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/locations?input=Gent&language=nl"
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/locations?input=Gent&language=nl"));
            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/locations?input=Gent&language=nl',
            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/locations?input=Gent&language=nl")
        .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 results

Common results fields

type results
JSON Response
200 OK
{
    "success": true,
    "results": [
        {
            "type": "DISTRICT",
            "results": [
                {
                    "districtName": "Gent",
                    "query": {
                        "param": "districts",
                        "value": "GENT"
                    }
                }
            ]
        },
        {
            "type": "LOCALITY_NAME",
            "results": [
                {
                    "localityName": "Gent",
                    "countryCode": "BE",
                    "query": {
                        "param": "postalCodes",
                        "value": "BE-9000,BE-9030,BE-9050"
                    }
                }
            ]
        }
    ]
}

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.