Search homes for sale and rent on Supercasa, Portugal's national property portal, including new-build developments.
Run this endpoint
Endpoint
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.
17 optional filters available.
string
Optional
Place name to search, e.g. Lisboa, Porto or Caldas da Rainha.
Lisboa
string
Optional
How to interpret the location: state, town, neighborhood or zone. Sent only when you supply it — a level sent with an ambiguous name resolves to no match instead of the disambiguation options, so leaving it unset is what gets you those options and a selection token.
example
string
Optional
sale (default), rent or holiday_rent.
sale
string
Optional
Search profile. property (default) covers the full filter set, rooms adds room preferences, new_construction covers empreendimentos.
property
array
Optional
Specific category ids from the filters endpoint.
["example"]
number
Optional
Minimum asking price in EUR.
10
number
Optional
Maximum asking price in EUR.
350000
number
Optional
Minimum area in m².
10
number
Optional
Maximum area in m².
10
integer
Optional
Minimum bedroom count.
10
integer
Optional
Maximum bedroom count.
10
integer
Optional
Minimum bathroom count.
10
integer
Optional
Condition id from the filters endpoint.
10
array
Optional
Feature names from the filters endpoint, e.g. elevador.
["example"]
string
Optional
relevance (default), newest, price_asc or price_desc.
relevance
integer
Optional
Result page, 1 to 75. Each page holds 25 listings, so a single query tops out at 1,875 results.
1
string
Optional
Opaque token from the autocomplete endpoint. Pass it instead of location — never alongside it — to resume an unambiguous search. Either this or location is required.
example
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/supercasa/search?location=Lisboa&business=sale&category=property&max_price=350000&page=1",
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
use Illuminate\Support\Facades\Http;
$response = Http::timeout(30)
->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
->get('https://scrappa.co/api/supercasa/search?location=Lisboa&business=sale&category=property&max_price=350000&page=1');
if ($response->successful()) {
echo $response->body();
} else {
echo "Error: " . $response->status();
}
const options = {
method: 'GET',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE'
}
};
fetch('https://scrappa.co/api/supercasa/search?location=Lisboa&business=sale&category=property&max_price=350000&page=1', 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));
const axios = require('axios');
const options = {
method: 'GET',
url: 'https://scrappa.co/api/supercasa/search?location=Lisboa&business=sale&category=property&max_price=350000&page=1',
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);
}
require 'net/http'
require 'uri'
uri = URI.parse("https://scrappa.co/api/supercasa/search?location=Lisboa&business=sale&category=property&max_price=350000&page=1")
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
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/search?location=Lisboa&business=sale&category=property&max_price=350000&page=1", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
except Exception as e:
print(f"Error: {e}")
finally:
conn.close()
import requests
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
response = requests.get('https://scrappa.co/api/supercasa/search?location=Lisboa&business=sale&category=property&max_price=350000&page=1', headers=headers)
response.raise_for_status()
print(response.text)
except requests.exceptions.RequestException as e:
print(f"Error: {e}")
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/search?location=Lisboa&business=sale&category=property&max_price=350000&page=1")
.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());
}
}
}
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("GET", "https://scrappa.co/api/supercasa/search?location=Lisboa&business=sale&category=property&max_price=350000&page=1", 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))
}
#!/bin/bash
curl -X GET \
-H "x-api-key: YOUR_API_KEY_HERE" \
"https://scrappa.co/api/supercasa/search?location=Lisboa&business=sale&category=property&max_price=350000&page=1"
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/search?location=Lisboa&business=sale&category=property&max_price=350000&page=1"));
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
catch (Exception ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}
import axios from 'axios';
async function run(): Promise<void> {
try {
const response = await axios({
method: 'GET',
url: 'https://scrappa.co/api/supercasa/search?location=Lisboa&business=sale&category=property&max_price=350000&page=1',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE',
},
});
console.log(response.data);
} catch (error) {
console.error('Error:', error);
}
}
void run();
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/search?location=Lisboa&business=sale&category=property&max_price=350000&page=1")
.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
listingId
listingReference
title
propertyType
condition
business
price
+6 more
{
"success": true,
"listingId": 2165197,
"listingReference": "SuperCasa QRHR2395",
"title": "Apartamento T2 \u00e0 venda em Benfica",
"propertyType": "Apartamento",
"condition": "Renovado",
"business": "Comprar",
"price": 395000,
"location": "Benfica, Lisboa",
"bedrooms": 2,
"bathrooms": 2,
"grossAreaSqm": 120,
"firstPhoto": "https://images.egorealestate.com/Z720x540/S5/C10197/P29637360/Tphoto/IDf03ac401.jpg",
"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.