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

SeLoger Property Search

GET https://scrappa.co/api/seloger/search?place_id=AD08FR31096&distribution=buy&estate_types%5B0%5D=Apartment&price_max=500000
Get API key Open Playground

Search apartments, houses and other property types for sale or rent on SeLoger, France's largest property portal. A SeLoger place id such as "AD08FR31096" for Paris is externally sourced: read it from the locations= query parameter of any seloger.com search URL. Location Autocomplete returns departments, city groups and postal codes for building a location picker, not place ids. Omit place_id to search the whole of France. Billing is per upstream read. A national search costs 1 credit. A search with place_id also reads the matching listing cards, at 1 credit per card read: a page of 50 twelve-character ids is one read, and a page that does not fit one read costs one credit per further read. A failed request costs nothing.

SeLoger Property Search 1 credit/request
Get API key Open Playground

Endpoint

Request preview
GET
https://scrappa.co/api/seloger/search?place_id=AD08FR31096&distribution=buy&estate_types%5B0%5D=Apartment&price_max=500000
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK 
{
    "success": true,
    "results": [],
    "total_results": 0,
    "page": 1,
    "per_page": 30,
    "total_pages": 0
}

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.

15 optional filters available.

place_id string Optional

SeLoger place id, e.g. "AD08FR31096" for Paris, obtainable from the locations= query parameter of any seloger.com search URL. Omit for a national search.

Example value AD08FR31096
distribution string Optional

buy or rent

Example value buy
estate_types[] array Optional

Property types: Apartment, House, Office, Trading, Parking, Building, Plot, Miscellaneous, Storage_Production, Gastronomy_Hotel, Agriculture_Forestry, Project, Senior

Example value ["example"]
new_build boolean Optional

Restrict to new-build (neuf) listings. Requires distribution=buy; SeLoger has no new-build partition for rent.

Example value true
price_min integer Optional

Minimum price in EUR

Example value 10
price_max integer Optional

Maximum price in EUR

Example value 500000
rooms_min number Optional

Minimum number of rooms

Example value 10
rooms_max number Optional

Maximum number of rooms

Example value 10
size_min integer Optional

Minimum floor area in m²

Example value 10
year_built_min integer Optional

Earliest construction year

Example value 10
available_from_max string Optional

Latest availability date, YYYY-MM-DD. Requires place_id; the national search route cannot express it.

Example value example
keywords string Optional

Free-text search term

Example value running shoes
order string Optional

Sort order, e.g. Default, PriceAsc, PriceDesc, DateDesc. Requires place_id; a national search refuses a non-default order.

Example value example
page integer Optional

Page number (default: 1)

Example value 1
per_page integer Optional

Results per page (default: 30, max: 50). A national search returns the grid page size instead and reports total_pages as null, because the upstream grid fixes its own page size.

Example value 10

Request Examples

PHP 
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/seloger/search?place_id=AD08FR31096&distribution=buy&estate_types%5B0%5D=Apartment&price_max=500000",
    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/seloger/search?place_id=AD08FR31096&distribution=buy&estate_types%5B0%5D=Apartment&price_max=500000');

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/seloger/search?place_id=AD08FR31096&distribution=buy&estate_types%5B0%5D=Apartment&price_max=500000', 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/seloger/search?place_id=AD08FR31096&distribution=buy&estate_types%5B0%5D=Apartment&price_max=500000',
    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/seloger/search?place_id=AD08FR31096&distribution=buy&estate_types%5B0%5D=Apartment&price_max=500000")
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/seloger/search?place_id=AD08FR31096&distribution=buy&estate_types%5B0%5D=Apartment&price_max=500000", 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/seloger/search?place_id=AD08FR31096&distribution=buy&estate_types%5B0%5D=Apartment&price_max=500000', 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/seloger/search?place_id=AD08FR31096&distribution=buy&estate_types%5B0%5D=Apartment&price_max=500000")
        .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/seloger/search?place_id=AD08FR31096&distribution=buy&estate_types%5B0%5D=Apartment&price_max=500000", 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/seloger/search?place_id=AD08FR31096&distribution=buy&estate_types%5B0%5D=Apartment&price_max=500000"
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/seloger/search?place_id=AD08FR31096&distribution=buy&estate_types%5B0%5D=Apartment&price_max=500000"));
            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/seloger/search?place_id=AD08FR31096&distribution=buy&estate_types%5B0%5D=Apartment&price_max=500000',
            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/seloger/search?place_id=AD08FR31096&distribution=buy&estate_types%5B0%5D=Apartment&price_max=500000")
        .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.

Open in Playground

Example response fields

Scan these fields before integrating.

success results total_results page per_page total_pages
JSON Response
200 OK 
{
    "success": true,
    "results": [],
    "total_results": 0,
    "page": 1,
    "per_page": 30,
    "total_pages": 0
}

Errors

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

422

Validation Error

One or more query parameters failed validation.

{
    "errors": {
        "place_id": [
            "The place id format is invalid."
        ]
    },
    "message": "The request validation failed."
}
400

Invalid Request

The request is well formed but cannot be expressed as a SeLoger query. `INVALID_PLACE_ID` means the `place_id` you supplied is not a SeLoger place id (`AD08FR…`); omit it to query the whole of France instead. `INVALID_DISTRIBUTION`, `INVALID_ESTATE_TYPES` and `INVALID_ENERGY_CERTIFICATE_CLASS` name the offending parameter. `INVALID_UPSTREAM_REQUEST` means a combination SeLoger cannot answer honestly, such as `new_build` without `distribution=buy`; the message names it. These failures are not billed.

{
    "error": {
        "code": "INVALID_PLACE_ID",
        "message": "place_id must be a SeLoger place id such as AD08FR31096."
    },
    "success": false
}
404

Not Found

The requested resource does not exist upstream: the listing is gone, was never live, or is not reachable through the search it would belong to. This is not billed.

{
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested SeLoger listing was not found."
    },
    "success": false
}
503

Upstream Unavailable

SeLoger did not return a usable response through any available request path, or refused the request this integration sent it. This failure is not billed and is retryable.

{
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "SeLoger is temporarily unavailable. Please retry."
    },
    "success": false
}
503

Service Disabled

The SeLoger integration is switched off. Reads as a clean 503 so a rollback needs no deploy.

{
    "error": {
        "code": "SELOGER_DISABLED",
        "message": "The SeLoger API 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.

Get API key Open Playground
Back to Home Full API reference