Skip to content
Scrappa Get API key
Ouest-France Immo API 1 credit/request

Ouest-France Immo Property Search API Documentation

GET https://scrappa.co/api/ouestfrance-immo/search?listing_type=sale&property_type=apartment&place_id=15818&max_price=300000&min_bedrooms=2&limit=5

Search Ouest-France Immo property listings in France for sale or rent. Filter by property type, place (ids from /autocomplete), price in EUR, living area in square metres, minimum bedrooms and minimum rooms, then sort and page. Each item carries the price (price_kind says sale_price or monthly_rent), agency fees, charges, rent excluding charges, price drops, area, rooms, bedrooms, floor, features, energy class (DPE and GES), coordinates, place, full description, dates, photos, virtual tour, video, flags and the agency id and phone. Every other filled field of the source ad is returned under attributes. Filtering by bathrooms is not offered: the source has no bathroom filter, so the bathrooms, min_bathrooms and max_bathrooms parameters are rejected with a 422 instead of being ignored. The bathrooms field of an item is only filled when the ad states it. Land and exceptional properties exist for sale only. A page past the last one is a valid empty page that keeps the requested page number and the true totals.

Ouest-France Immo Property Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/ouestfrance-immo/search?listing_type=sale&property_type=apartment&place_id=15818&max_price=300000&min_bedrooms=2&limit=5
Auth header
x-api-key
Cost
1 credit/request
listing_type = sale
Response preview
200 OK
{
    "success": true,
    "data": {
        "items": [
            {
                "id": 20677139,
                "reference": "JN0785-NP2",
                "url": "https://www.ouestfrance-immo.com/immobilier/vente/appartement/rennes-35-35238/3-pieces-20677139.htm",
                "listing_type": "sale",
                "property_type": {
                    "id": 201,
                    "label": "Vente appartement",
                    "slug": "appartement",
                    "category_id": 6202,
...

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.

10 optional filters available.

listing_type string Required

sale or rent.

Example value sale
property_type string Optional

Sale: apartment, house, land, parking, exceptional or other. Rent: apartment, house, parking or other. Without it all types match.

Example value apartment
place_id string Optional

One or more place ids from /autocomplete, separated by commas (at most 10). Example: 15818 for Rennes. Without a place the search covers all of France.

Example value 15818
min_price integer Optional

Minimum price in EUR (sale price or monthly rent).

Example value 10
max_price integer Optional

Maximum price in EUR.

Example value 300000
min_area integer Optional

Minimum living area in square metres.

Example value 10
min_bedrooms integer Optional

Minimum number of bedrooms.

Example value 2
min_rooms integer Optional

Minimum number of rooms (pièces).

Example value 10
sort string Optional

price_asc, price_desc or date_desc. Without it the order is the Ouest-France Immo default.

Example value relevance
page integer Optional

One-based page number. Defaults to 1.

Example value 1
limit integer Optional

Listings per page, 1 to 50. Defaults to 24.

Example value 5

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/ouestfrance-immo/search?listing_type=sale&property_type=apartment&place_id=15818&max_price=300000&min_bedrooms=2&limit=5",
    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/ouestfrance-immo/search?listing_type=sale&property_type=apartment&place_id=15818&max_price=300000&min_bedrooms=2&limit=5');

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/ouestfrance-immo/search?listing_type=sale&property_type=apartment&place_id=15818&max_price=300000&min_bedrooms=2&limit=5', 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/ouestfrance-immo/search?listing_type=sale&property_type=apartment&place_id=15818&max_price=300000&min_bedrooms=2&limit=5',
    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/ouestfrance-immo/search?listing_type=sale&property_type=apartment&place_id=15818&max_price=300000&min_bedrooms=2&limit=5")
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/ouestfrance-immo/search?listing_type=sale&property_type=apartment&place_id=15818&max_price=300000&min_bedrooms=2&limit=5", 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/ouestfrance-immo/search?listing_type=sale&property_type=apartment&place_id=15818&max_price=300000&min_bedrooms=2&limit=5', 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/ouestfrance-immo/search?listing_type=sale&property_type=apartment&place_id=15818&max_price=300000&min_bedrooms=2&limit=5")
        .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/ouestfrance-immo/search?listing_type=sale&property_type=apartment&place_id=15818&max_price=300000&min_bedrooms=2&limit=5", 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/ouestfrance-immo/search?listing_type=sale&property_type=apartment&place_id=15818&max_price=300000&min_bedrooms=2&limit=5"
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/ouestfrance-immo/search?listing_type=sale&property_type=apartment&place_id=15818&max_price=300000&min_bedrooms=2&limit=5"));
            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/ouestfrance-immo/search?listing_type=sale&property_type=apartment&place_id=15818&max_price=300000&min_bedrooms=2&limit=5',
            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/ouestfrance-immo/search?listing_type=sale&property_type=apartment&place_id=15818&max_price=300000&min_bedrooms=2&limit=5")
        .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": {
        "items": [
            {
                "id": 20677139,
                "reference": "JN0785-NP2",
                "url": "https://www.ouestfrance-immo.com/immobilier/vente/appartement/rennes-35-35238/3-pieces-20677139.htm",
                "listing_type": "sale",
                "property_type": {
                    "id": 201,
                    "label": "Vente appartement",
                    "slug": "appartement",
                    "category_id": 6202,
                    "category_label": "3 pi\u00e8ces",
                    "category_slug": "3-pieces"
                },
                "price": 104500,
                "price_kind": "sale_price",
                "currency": "EUR",
                "pricing": {
                    "agency_fee": 4500,
                    "agency_fee_percent": 4.5,
                    "charges": null,
                    "rent_excluding_charges": null,
                    "deposit": null,
                    "price_drop_amount": null,
                    "price_drop_percent": null,
                    "coownership_lots": 140,
                    "coownership_annual_charges": 2127
                },
                "area_sqm": 64,
                "land_area_sqm": null,
                "rooms": 3,
                "bedrooms": 3,
                "bathrooms": null,
                "shower_rooms": 1,
                "floor": "3",
                "floors_in_building": 8,
                "features": {
                    "balcony": true,
                    "terrace": false,
                    "garden": false,
                    "cellar": true,
                    "elevator": true,
                    "swimming_pool": false,
                    "furnished": false,
                    "heating_type": "autre",
                    "heating_mode": "collectif",
                    "exposure": "Sud"
                },
                "energy": {
                    "dpe_class": "D",
                    "dpe_value": 176,
                    "ges_class": "C",
                    "ges_value": 25
                },
                "location": {
                    "latitude": 48.123177,
                    "longitude": -1.708372,
                    "place_id": 100024,
                    "place_name": "Rennes Villejean",
                    "city": {
                        "id": 15818,
                        "name": "Rennes",
                        "type": "Villes",
                        "postal_code": "35000",
                        "insee_code": "35238"
                    },
                    "district": {
                        "id": 100024,
                        "name": "Rennes Villejean",
                        "type": "Quartiers"
                    }
                },
                "description": "Au 3\u00e8me \u00e9tage avec ascenseur, appartement T3 de 64 m2 \u00e0 r\u00e9nover.",
                "tags": "A r\u00e9nover",
                "dates": {
                    "created_at": "2026-09-17 16:04:23",
                    "published_at": "2026-10-23 00:00:00"
                },
                "photo_count": 7,
                "photos": [
                    "https://www.ouestfrance-immo.com/photo-vente-appartement-rennes-villejean-35/201/appartement-a-vendre-rennes-villejean-20677139_1.jpg"
                ],
                "virtual_tour_url": "https://my.matterport.com/show/?m=mebv5ECRRGi",
                "flags": {
                    "exclusive": false,
                    "professional": true,
                    "sold": false,
                    "new_build_programme": false
                },
                "agency": {
                    "id": 15197,
                    "phone": "0200000000",
                    "profile": null
                },
                "attributes": {
                    "transac_lib": "Vente",
                    "lieu_lib": "Rennes Villejean"
                }
            }
        ],
        "pagination": {
            "page": 1,
            "limit": 5,
            "total_results": 1042,
            "total_pages": 209,
            "has_next": true
        }
    },
    "meta": {
        "endpoint_family": "search",
        "billable": true
    }
}

Errors

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

422

Validation Error

A public parameter is missing or invalid. No upstream call is made and the response is not billable.

{
    "errors": {
        "listing_type": [
            "The listing type field is required."
        ]
    },
    "message": "The request validation failed"
}
502

Unexpected Upstream Response

Ouest-France Immo answered with a body that is not the documented shape. The response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "error": {
        "code": "UPSTREAM_ERROR",
        "message": "Ouest-France Immo returned an unexpected response."
    },
    "success": false
}
503

Upstream Unavailable

Ouest-France Immo was temporarily unavailable or blocked the request. The response is not billable and the request never answers 429.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Ouest-France Immo 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.