Skip to content
Scrappa Get API key
Bien'ici API 1 credit/request

Bien'ici Agency Listings

GET https://scrappa.co/api/bienici/agency-listings?import_account_id=558bbfd06fbf04e50075bbce&transaction_type=rent&page=2&size=5

Returns the ads published by one agency, keyed on its Bien'ici account id. Only ads whose agency identifier matches the requested account are returned, because an unrecognized account key yields a full unfiltered national page rather than an error. The structured agent contact block is removed and never returned. Each ad's description is the seller's own text passed through unchanged, so on this route it is also how the rent is read, and it may contain a phone number or email address the seller wrote there. The price field on this route is not a monetary quantity and is published with unit "unreadable" and no figure: the captured agency ads carry price 0, 1, 1, 5 and 6, matching neither a plausible total nor the rate their own text quotes. The other raw fields are left on each ad — agencyRentalFee, surfaceArea and the seller's own description — so you can read the rent yourself rather than being given a confident wrong number. The upstream total is not published either: it is a global counter, not this agency's listing count, so returnedCount is the number of ads in the response.

Bien'ici Agency Listings 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/bienici/agency-listings?import_account_id=558bbfd06fbf04e50075bbce&transaction_type=rent&page=2&size=5
Auth header
x-api-key
Cost
1 credit/request
import_account_id = 558bbfd06fbf04e50075bbce
Response preview
200 OK
{
    "success": true,
    "data": {
        "realEstateAds": [
            {
                "id": "ag110162-46244965",
                "transactionType": "rent",
                "propertyType": "office",
                "price": {
                    "min": null,
                    "max": null,
                    "currency": null,
                    "disclosed": false,
                    "unit": "unreadable"
...

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.

3 optional filters available.

import_account_id string Required

The agency's Bien'ici account id, as found in an ad's agency identifier.

Example value 558bbfd06fbf04e50075bbce
transaction_type string Optional

buy, rent, or new_build. Defaults to buy, which returns only the buy half of the agency's inventory — pass rent to see its rental ads.

Example value rent
page integer Optional

1-based page.

Example value 2
size integer Optional

Ads per page, 1 to 500.

Example value 5

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/bienici/agency-listings?import_account_id=558bbfd06fbf04e50075bbce&transaction_type=rent&page=2&size=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/bienici/agency-listings?import_account_id=558bbfd06fbf04e50075bbce&transaction_type=rent&page=2&size=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/bienici/agency-listings?import_account_id=558bbfd06fbf04e50075bbce&transaction_type=rent&page=2&size=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/bienici/agency-listings?import_account_id=558bbfd06fbf04e50075bbce&transaction_type=rent&page=2&size=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/bienici/agency-listings?import_account_id=558bbfd06fbf04e50075bbce&transaction_type=rent&page=2&size=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/bienici/agency-listings?import_account_id=558bbfd06fbf04e50075bbce&transaction_type=rent&page=2&size=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/bienici/agency-listings?import_account_id=558bbfd06fbf04e50075bbce&transaction_type=rent&page=2&size=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/bienici/agency-listings?import_account_id=558bbfd06fbf04e50075bbce&transaction_type=rent&page=2&size=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/bienici/agency-listings?import_account_id=558bbfd06fbf04e50075bbce&transaction_type=rent&page=2&size=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/bienici/agency-listings?import_account_id=558bbfd06fbf04e50075bbce&transaction_type=rent&page=2&size=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/bienici/agency-listings?import_account_id=558bbfd06fbf04e50075bbce&transaction_type=rent&page=2&size=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/bienici/agency-listings?import_account_id=558bbfd06fbf04e50075bbce&transaction_type=rent&page=2&size=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/bienici/agency-listings?import_account_id=558bbfd06fbf04e50075bbce&transaction_type=rent&page=2&size=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": {
        "realEstateAds": [
            {
                "id": "ag110162-46244965",
                "transactionType": "rent",
                "propertyType": "office",
                "price": {
                    "min": null,
                    "max": null,
                    "currency": null,
                    "disclosed": false,
                    "unit": "unreadable"
                },
                "agencyRentalFee": 0,
                "city": "Carcassonne",
                "postalCode": "11000"
            },
            {
                "id": "ag692351-57141273",
                "transactionType": "rent",
                "propertyType": "house",
                "price": {
                    "min": null,
                    "max": null,
                    "currency": null,
                    "disclosed": false,
                    "unit": "unreadable"
                },
                "agencyRentalFee": 1550,
                "city": "Charbonni\u00e8res-les-Bains",
                "postalCode": "69260"
            },
            {
                "id": "ag190113-57633015",
                "transactionType": "rent",
                "propertyType": "shop",
                "price": {
                    "min": null,
                    "max": null,
                    "currency": null,
                    "disclosed": false,
                    "unit": "unreadable"
                },
                "agencyRentalFee": 0,
                "city": "Malemort-sur-Corr\u00e8ze",
                "postalCode": "19100"
            },
            {
                "id": "ag131474-55672491",
                "transactionType": "rent",
                "propertyType": "parking",
                "price": {
                    "min": null,
                    "max": null,
                    "currency": null,
                    "disclosed": false,
                    "unit": "unreadable"
                },
                "agencyRentalFee": 350,
                "city": "La Barben",
                "postalCode": "13330"
            },
            {
                "id": "ag260625-267764960",
                "transactionType": "rent",
                "propertyType": "premises",
                "price": {
                    "min": null,
                    "max": null,
                    "currency": null,
                    "disclosed": false,
                    "unit": "unreadable"
                },
                "agencyRentalFee": 9,
                "city": "Orange",
                "postalCode": "84100"
            }
        ],
        "returnedCount": 5,
        "from": 5,
        "perPage": 5,
        "agency": {
            "importAccountId": "558bbfd06fbf04e50075bbce"
        }
    },
    "meta": {
        "endpoint_family": "agency_listings"
    }
}

Errors

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

Not Found

The requested house 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.