Skip to content
Scrappa Get API key
Green-Acres API 1 credit/request

Green-Acres Agency Profile API Documentation

GET https://scrappa.co/api/green-acres/agency?agency_key=QFm252w5k7VL&slug=said-el-marrahi-barjac

Scrappa's GET /api/green-acres/agency returns the public profile of one Green-Acres agency and its latest listings.

What you get

name, city, languages, the parent company (name, type, address, agency_key, slug, logo) and latest_listings, up to 6 items in the same shape as the search items.

Latest 6 listings only

Green-Acres shows the latest 6 listings on the agency page. The full list is not available through this API. listings_limit_note repeats this in every response. To list more of an agency's property, search by location and filter the agency of the items.

How to find an agency

Use agency.agency_key and agency.slug of a listing result. The slug is optional.

Green-Acres Agency Profile API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/green-acres/agency?agency_key=QFm252w5k7VL&slug=said-el-marrahi-barjac
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "success": true,
    "data": {
        "agency_key": "QFm252w5k7VL",
        "slug": "said-el-marrahi-barjac",
        "name": "Said El marrahi",
        "city": "barjac",
        "languages": [
            "Fran\u00e7ais",
            "Anglais"
        ],
        "parent": {
            "name": "Renaissance Immobilier",
            "type": "Agence immobili\u00e8re",
...

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.

3 optional filters available.

agency_key string Optional

agency_key from a listing result, for example QFm252w5k7VL. Required unless url is given.

Example value QFm252w5k7VL
slug string Optional

Optional agency slug from a listing result, for example said-el-marrahi-barjac.

Example value said-el-marrahi-barjac
url string Optional
Open example

Agency address on green-acres.fr. Required unless agency_key is given.

Example value https://example.com/product

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/green-acres/agency?agency_key=QFm252w5k7VL&slug=said-el-marrahi-barjac",
    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/green-acres/agency?agency_key=QFm252w5k7VL&slug=said-el-marrahi-barjac');

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/green-acres/agency?agency_key=QFm252w5k7VL&slug=said-el-marrahi-barjac', 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/green-acres/agency?agency_key=QFm252w5k7VL&slug=said-el-marrahi-barjac',
    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/green-acres/agency?agency_key=QFm252w5k7VL&slug=said-el-marrahi-barjac")
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/green-acres/agency?agency_key=QFm252w5k7VL&slug=said-el-marrahi-barjac", 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/green-acres/agency?agency_key=QFm252w5k7VL&slug=said-el-marrahi-barjac', 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/green-acres/agency?agency_key=QFm252w5k7VL&slug=said-el-marrahi-barjac")
        .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/green-acres/agency?agency_key=QFm252w5k7VL&slug=said-el-marrahi-barjac", 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/green-acres/agency?agency_key=QFm252w5k7VL&slug=said-el-marrahi-barjac"
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/green-acres/agency?agency_key=QFm252w5k7VL&slug=said-el-marrahi-barjac"));
            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/green-acres/agency?agency_key=QFm252w5k7VL&slug=said-el-marrahi-barjac',
            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/green-acres/agency?agency_key=QFm252w5k7VL&slug=said-el-marrahi-barjac")
        .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": {
        "agency_key": "QFm252w5k7VL",
        "slug": "said-el-marrahi-barjac",
        "name": "Said El marrahi",
        "city": "barjac",
        "languages": [
            "Fran\u00e7ais",
            "Anglais"
        ],
        "parent": {
            "name": "Renaissance Immobilier",
            "type": "Agence immobili\u00e8re",
            "address": "AVENUE CHAILLOT, 30430 barjac",
            "agency_key": "59zEZGtck8Je",
            "slug": "renaissance-immobilier-barjac",
            "logo": "https://lb1.green-acres.com/ClientLogos/386262.png"
        },
        "listings_limit_note": "Green-Acres shows the latest 6 listings of an agency. The full list is not available.",
        "latest_listings": [
            {
                "listing_id": "A3nj6wezmd7cep29",
                "url": "https://www.green-acres.fr/fr/properties/immobilier/chassiers/A3nj6wezmd7cep29.htm",
                "title": "Sud Ardeche-Chassiers 07110",
                "price": 233000,
                "currency": "EUR",
                "price_on_request": false,
                "price_from": false,
                "price_per_m2": 3107,
                "price_drop_percent": null,
                "city": "Chassiers",
                "department": "Ard\u00e8che",
                "property_type": "Mas proven\u00e7al",
                "is_new_build": false,
                "is_exclusive": true,
                "rooms": 4,
                "rooms_max": null,
                "bedrooms": 2,
                "bedrooms_max": null,
                "living_area_m2": 75,
                "living_area_max_m2": null,
                "land_area_m2": 4160,
                "lots": null,
                "description_snippet": "Mas en pierre avec vue d\u00e9gag\u00e9e Chassiers (07110)...",
                "photo_count": 12,
                "thumbnails": [
                    "https://lb1.green-acres.com/1140632a/A3nj6wezmd7cep29/miniPhotos/A3nj6wezmd7cep29_1.jpg"
                ],
                "agency": {
                    "name": "Said El marrahi",
                    "parent": "Renaissance Immobilier",
                    "logo": "https://lb1.green-acres.com/ClientLogos/386262.png",
                    "account_id": "1140632a"
                }
            }
        ]
    },
    "meta": {
        "endpoint_family": "agency",
        "billable": true,
        "attempts": 1
    }
}

Errors

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

404

Not Found

No agency with that key exists on Green-Acres (`NOT_FOUND`). Non-billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "agency"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested resource was not found."
    },
    "success": false
}
422

Validation Error

A query parameter is missing, unknown or unusable. Unknown parameters and unknown values are rejected, never ignored. Non-billable.

{
    "errors": {
        "sort": [
            "The selected sort is invalid."
        ]
    },
    "message": "The selected sort is invalid."
}
503

Upstream Unavailable

Green-Acres could not be reached, refused the request or answered with a page this API could not read (`UPSTREAM_UNAVAILABLE`). Retryable and never billed. Clients are never rate limited.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "agency"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "Green-Acres could not be reached. Please retry shortly."
    },
    "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.