Skip to content
Scrappa Get API key
Supercasa API 1 credit/request

Supercasa Agency Profile

GET https://scrappa.co/api/supercasa/agency?agency=blyss-real-estate-6957&business=comprar&location=lisboa

Fetch one Supercasa agency profile: name, logo, published licence, locality and the listings it currently publishes. Use the slug_id, business and locality values returned by the agencies endpoint. While this family is withdrawn the endpoint answers 410 Gone with no upstream request and no charge; search, property, filters and autocomplete keep serving.

Supercasa Agency Profile 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/supercasa/agency?agency=blyss-real-estate-6957&business=comprar&location=lisboa
Auth header
x-api-key
Cost
1 credit/request
agency = blyss-real-estate-6957 business = comprar location = lisboa
Response preview
200 OK
{
    "success": true,
    "slug_id": "blyss-real-estate-6957",
    "name": "Blyss Real Estate",
    "business": "comprar",
    "location": "lisboa",
    "ami_licence": "19794",
    "listings_count": 15,
    "listings": [
        {
            "listing_id": 2165197,
            "url": "https://supercasa.pt/venda-apartamento-t2-lisboa/i2165197"
        }
    ]
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

3 required parameters needed before sending a request.

agency string Required

Agency handle as returned by the agencies endpoint, e.g. blyss-real-estate-6957.

Example value blyss-real-estate-6957
business string Required

comprar or arrendar — the tail every Supercasa profile URL carries.

Example value comprar
location string Required

Locality slug, e.g. lisboa.

Example value lisboa

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/supercasa/agency?agency=blyss-real-estate-6957&business=comprar&location=lisboa",
    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/supercasa/agency?agency=blyss-real-estate-6957&business=comprar&location=lisboa');

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/supercasa/agency?agency=blyss-real-estate-6957&business=comprar&location=lisboa', 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/supercasa/agency?agency=blyss-real-estate-6957&business=comprar&location=lisboa',
    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/supercasa/agency?agency=blyss-real-estate-6957&business=comprar&location=lisboa")
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/supercasa/agency?agency=blyss-real-estate-6957&business=comprar&location=lisboa", 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/supercasa/agency?agency=blyss-real-estate-6957&business=comprar&location=lisboa', 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/supercasa/agency?agency=blyss-real-estate-6957&business=comprar&location=lisboa")
        .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/supercasa/agency?agency=blyss-real-estate-6957&business=comprar&location=lisboa", 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/supercasa/agency?agency=blyss-real-estate-6957&business=comprar&location=lisboa"
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/supercasa/agency?agency=blyss-real-estate-6957&business=comprar&location=lisboa"));
            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/supercasa/agency?agency=blyss-real-estate-6957&business=comprar&location=lisboa',
            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/supercasa/agency?agency=blyss-real-estate-6957&business=comprar&location=lisboa")
        .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 slug_id name business location ami_licence listings_count listings

Common listings fields

listing_id url
JSON Response
200 OK
{
    "success": true,
    "slug_id": "blyss-real-estate-6957",
    "name": "Blyss Real Estate",
    "business": "comprar",
    "location": "lisboa",
    "ami_licence": "19794",
    "listings_count": 15,
    "listings": [
        {
            "listing_id": 2165197,
            "url": "https://supercasa.pt/venda-apartamento-t2-lisboa/i2165197"
        }
    ]
}

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.