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

Ouest-France Immo Agencies API Documentation

GET https://scrappa.co/api/ouestfrance-immo/agencies?place_id=15818&limit=5

Find agencies in a place (place_id from /autocomplete) or by name (query). Each agency carries its id, name, address, coordinates, phone, website, logo, opening hours, rating when present and listing counts. Pass the id to /agency or /agency-listings. A page past the last one is an empty list that keeps the requested page number.

Ouest-France Immo Agencies API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/ouestfrance-immo/agencies?place_id=15818&limit=5
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "success": true,
    "data": {
        "items": [
            {
                "id": 8765,
                "name": "CENTURY 21 RENNES",
                "legal_name": "EXAMPLE IMMOBILIER",
                "siret": "00000000000000",
                "slug": "century-21",
                "address": "27 Boulevard Ren\u00e9 Laennec",
                "postal_code": "35000",
                "city": "Rennes",
                "place_id": 15818,
...

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.

4 optional filters available.

place_id string Optional

Place id from /autocomplete. Required unless query is set.

Example value 15818
query string Optional

Agency name, 2 to 80 characters. Required unless place_id is set.

Example value coffee shops
page integer Optional

One-based page number. Defaults to 1.

Example value 1
limit integer Optional

Agencies per page, 1 to 50. Defaults to 10.

Example value 5

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/ouestfrance-immo/agencies?place_id=15818&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/agencies?place_id=15818&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/agencies?place_id=15818&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/agencies?place_id=15818&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/agencies?place_id=15818&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/agencies?place_id=15818&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/agencies?place_id=15818&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/agencies?place_id=15818&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/agencies?place_id=15818&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/agencies?place_id=15818&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/agencies?place_id=15818&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/agencies?place_id=15818&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/agencies?place_id=15818&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": 8765,
                "name": "CENTURY 21 RENNES",
                "legal_name": "EXAMPLE IMMOBILIER",
                "siret": "00000000000000",
                "slug": "century-21",
                "address": "27 Boulevard Ren\u00e9 Laennec",
                "postal_code": "35000",
                "city": "Rennes",
                "place_id": 15818,
                "latitude": 48.105855,
                "longitude": -1.665844,
                "phone": "0200000000",
                "website": "https://www.century21-reine-rennes.com/agence/",
                "logo_url": "https://www.ouestfrance-immo.com/photo-century-21/logo.png",
                "opening_hours": {
                    "monday": [
                        {
                            "open": "09:00",
                            "close": "12:00"
                        },
                        {
                            "open": "14:00",
                            "close": "19:00"
                        }
                    ]
                },
                "rating": null,
                "listing_counts": {
                    "sale": 46,
                    "rent": 9,
                    "sold": 0,
                    "exclusive": 25
                },
                "attributes": {
                    "tag": "example"
                }
            }
        ],
        "pagination": {
            "page": 1,
            "limit": 5,
            "total_results": 327,
            "total_pages": 66,
            "has_next": true
        }
    },
    "meta": {
        "endpoint_family": "agencies",
        "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": {
        "place_id": [
            "The place id 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": "agencies"
    },
    "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": "agencies"
    },
    "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.