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

Immoweb Discovery API Documentation

GET https://scrappa.co/api/immoweb/discovery?module=newest&transactionTypes=FOR_SALE

Scrappa's GET /api/immoweb/discovery endpoint returns Immoweb's own discovery feeds: newest listings, popular listings and similar listings.

Modules

newest-classifieds-for-sale and popular-classifieds are the homepage modules and take no parameters. newest, popular and similar are search-derived feeds and require transactionTypes.

Each response includes a search_context block echoing the exact parameters the feed ran with, which is useful for reproducing a feed's result set as a normal search query.

Pagination caveat

These feeds are fixed-size by design. similar always returns a small fixed number of rows regardless of any page window, and emits no total count — so treat a discovery response as a feed to read, not a result set to page. Use Immoweb Search when you need pagination or a total.

Languages

Pass language as nl, fr or en. Bare two-letter codes only.

Immoweb Discovery API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/immoweb/discovery?module=newest&transactionTypes=FOR_SALE
Auth header
x-api-key
Cost
1 credit/request
module = newest
Response preview
200 OK
{
    "success": true,
    "module": "newest",
    "classifieds": [
        {
            "id": 21882350,
            "price": 449000
        }
    ],
    "search_context": null
}

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.

module string Required

guest, newest-classifieds-for-sale, newest-classifieds-for-rent, popular-classifieds, newest, popular or similar.

Example value newest
transactionTypes string Optional

FOR_SALE or FOR_RENT. Required for the newest, popular and similar modules.

Example value FOR_SALE
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/discovery?module=newest&transactionTypes=FOR_SALE",
    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/discovery?module=newest&transactionTypes=FOR_SALE');

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/discovery?module=newest&transactionTypes=FOR_SALE', 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/discovery?module=newest&transactionTypes=FOR_SALE',
    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/discovery?module=newest&transactionTypes=FOR_SALE")
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/discovery?module=newest&transactionTypes=FOR_SALE", 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/discovery?module=newest&transactionTypes=FOR_SALE', 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/discovery?module=newest&transactionTypes=FOR_SALE")
        .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/discovery?module=newest&transactionTypes=FOR_SALE", 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/discovery?module=newest&transactionTypes=FOR_SALE"
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/discovery?module=newest&transactionTypes=FOR_SALE"));
            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/discovery?module=newest&transactionTypes=FOR_SALE',
            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/discovery?module=newest&transactionTypes=FOR_SALE")
        .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 module classifieds search_context

Common classifieds fields

id price
JSON Response
200 OK
{
    "success": true,
    "module": "newest",
    "classifieds": [
        {
            "id": 21882350,
            "price": 449000
        }
    ],
    "search_context": null
}

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. transactionTypes is required for the newest, popular and similar modules.

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