Skip to content
Scrappa Get API key
Leboncoin Immobilier API 1 credit/request

Leboncoin Immobilier Search

GET https://scrappa.co/api/leboncoin-immo/search?vertical=sale&price_min=200000&price_max=400000&limit=3

Search property listings across the French market. Every listing comes back with its full description, price, location, images, seller identity and structured property attributes such as surface, rooms and energy rating. Read-only public listing data; no Leboncoin account required.

Leboncoin Immobilier Search 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/leboncoin-immo/search?vertical=sale&price_min=200000&price_max=400000&limit=3
Auth header
x-api-key
Cost
1 credit/request
vertical = sale
Response preview
200 OK
{
    "success": true,
    "data": {
        "results": [
            {
                "list_id": 3282271360,
                "subject": "Maison 5 pieces",
                "body": "Full listing description as published.",
                "price": 305000,
                "price_cents": 30500000,
                "location": {
                    "city": "La Baule-Escoublac",
                    "zipcode": "44500",
                    "lat": 47.285,
...

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.

16 optional filters available.

vertical string Required

sale, rent, colocation, commercial, or all for every real-estate listing.

Example value sale
page integer Optional

1-based page number.

Example value 1
limit integer Optional

Listings per page, 1-100. Default 20.

Example value 3
price_min integer Optional

Minimum price in euros.

Example value 200000
price_max integer Optional

Maximum price in euros.

Example value 400000
surface_min integer Optional

Minimum surface in square metres.

Example value 10
surface_max integer Optional

Maximum surface in square metres.

Example value 10
property_type string Optional

1 house, 2 apartment, 3 land, 4 parking, 5 other.

Example value example
furnished string Optional

1 furnished, 2 unfurnished. Applies to rental verticals.

Example value example
rooms_min integer Optional

Minimum room count.

Example value 10
rooms_max integer Optional

Maximum room count.

Example value 10
query string Optional

Free-text search term.

Example value coffee shops
query_scope string Optional

subject to search titles only, or all to search the full listing text.

Example value example
location string Optional

Location label from the locations endpoint.

Example value Austin, Texas
seller string Optional

all, pro for agencies and professionals, or private.

Example value example
sort string Optional

relevance, time, price or proximity.

Example value relevance
order string Optional

asc or desc.

Example value example

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/leboncoin-immo/search?vertical=sale&price_min=200000&price_max=400000&limit=3",
    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/leboncoin-immo/search?vertical=sale&price_min=200000&price_max=400000&limit=3');

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/leboncoin-immo/search?vertical=sale&price_min=200000&price_max=400000&limit=3', 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/leboncoin-immo/search?vertical=sale&price_min=200000&price_max=400000&limit=3',
    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/leboncoin-immo/search?vertical=sale&price_min=200000&price_max=400000&limit=3")
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/leboncoin-immo/search?vertical=sale&price_min=200000&price_max=400000&limit=3", 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/leboncoin-immo/search?vertical=sale&price_min=200000&price_max=400000&limit=3', 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/leboncoin-immo/search?vertical=sale&price_min=200000&price_max=400000&limit=3")
        .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/leboncoin-immo/search?vertical=sale&price_min=200000&price_max=400000&limit=3", 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/leboncoin-immo/search?vertical=sale&price_min=200000&price_max=400000&limit=3"
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/leboncoin-immo/search?vertical=sale&price_min=200000&price_max=400000&limit=3"));
            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/leboncoin-immo/search?vertical=sale&price_min=200000&price_max=400000&limit=3',
            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/leboncoin-immo/search?vertical=sale&price_min=200000&price_max=400000&limit=3")
        .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
JSON Response
200 OK
{
    "success": true,
    "data": {
        "results": [
            {
                "list_id": 3282271360,
                "subject": "Maison 5 pieces",
                "body": "Full listing description as published.",
                "price": 305000,
                "price_cents": 30500000,
                "location": {
                    "city": "La Baule-Escoublac",
                    "zipcode": "44500",
                    "lat": 47.285,
                    "lng": -2.36543
                },
                "images": {
                    "nb_images": 8
                },
                "owner": {
                    "type": "pro",
                    "siren": "938018017"
                },
                "attributes": {
                    "square": {
                        "value": 95
                    }
                }
            }
        ],
        "total": 336403,
        "total_pro": 210000,
        "total_private": 126403,
        "max_pages": 1750
    },
    "meta": {
        "endpoint_family": "search",
        "billable": true
    }
}

Errors

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

Not Found

The requested property listing was not found. This response is not billable.

Validation Error

A public parameter is invalid. This response is not billable.

Service Unavailable

The service could not obtain a complete result. This response is not billable.

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.