Get the total number of SeLoger listings matching a set of filters. Use it to size a market before paginating a search. Passing energy_certificate_class[] additionally returns a breakdown by energy certificate class (DPE A through G); upstream withholds the total in that mode, so total_results is null and aggregation_only is true. The facet counts only listings that carry a DPE value and is computed over the criteria with its own dimension removed, so the classes do not sum to total_results. It reads a single count route, so this endpoint costs 1 credit. A failed request costs nothing.
Run this endpoint
Endpoint
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.
9 optional filters available.
string
Optional
Optional. A SeLoger place id, e.g. "AD08FR31096", obtainable from the locations= query parameter of any seloger.com search URL. Omit it to count the whole of France; a malformed value is rejected with 400 INVALID_PLACE_ID.
1234567890
string
Optional
buy or rent
buy
array
Optional
Property types to count
["example"]
integer
Optional
Minimum price in EUR
10
integer
Optional
Maximum price in EUR
10
integer
Optional
Earliest construction year
10
integer
Optional
Minimum floor area in m²
10
string
Optional
Latest availability date, YYYY-MM-DD
example
array
Optional
DPE classes to count: A, B, C, D, E, F, G. Requesting this switches the response to aggregation-only mode, where total_results is null.
["example"]
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/seloger/count?distribution=buy",
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
use Illuminate\Support\Facades\Http;
$response = Http::timeout(30)
->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
->get('https://scrappa.co/api/seloger/count?distribution=buy');
if ($response->successful()) {
echo $response->body();
} else {
echo "Error: " . $response->status();
}
const options = {
method: 'GET',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE'
}
};
fetch('https://scrappa.co/api/seloger/count?distribution=buy', 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));
const axios = require('axios');
const options = {
method: 'GET',
url: 'https://scrappa.co/api/seloger/count?distribution=buy',
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);
}
require 'net/http'
require 'uri'
uri = URI.parse("https://scrappa.co/api/seloger/count?distribution=buy")
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
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/count?distribution=buy", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
except Exception as e:
print(f"Error: {e}")
finally:
conn.close()
import requests
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
response = requests.get('https://scrappa.co/api/seloger/count?distribution=buy', headers=headers)
response.raise_for_status()
print(response.text)
except requests.exceptions.RequestException as e:
print(f"Error: {e}")
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/count?distribution=buy")
.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());
}
}
}
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("GET", "https://scrappa.co/api/seloger/count?distribution=buy", 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))
}
#!/bin/bash
curl -X GET \
-H "x-api-key: YOUR_API_KEY_HERE" \
"https://scrappa.co/api/seloger/count?distribution=buy"
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/count?distribution=buy"));
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
catch (Exception ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}
import axios from 'axios';
async function run(): Promise<void> {
try {
const response = await axios({
method: 'GET',
url: 'https://scrappa.co/api/seloger/count?distribution=buy',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE',
},
});
console.log(response.data);
} catch (error) {
console.error('Error:', error);
}
}
void run();
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/count?distribution=buy")
.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
total_results
energy_certificate_counts
aggregation_only
{
"success": true,
"total_results": 24816,
"energy_certificate_counts": [],
"aggregation_only": false
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
One or more query parameters failed validation.
{
"errors": {
"place_id": [
"The place id format is invalid."
]
},
"message": "The request validation failed."
}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
}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
}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
}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.