Search apartments, houses, land, commercial premises, offices, warehouses and garages for sale or rent across Portugal. The request takes a transaction (comprar or arrendar), an estate type, an optional location slug-path from the locations endpoint, price and area filters, and page/limit. Each listing returns id, canonical url, title, estate, transaction, price with currency, price per square meter, area, rooms, floor, agency and location. The response also carries pagination and price stats. A valid empty result is a successful response.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
2 required parameters needed before sending a request.
7 optional filters available.
string
Required
comprar (buy) or arrendar (rent).
comprar
string
Required
Estate slug such as apartamento or moradia; comma combinations such as moradia,t3 are accepted.
apartamento
string
Optional
Location slug-path from the locations endpoint, e.g. lisboa/lisboa. Defaults to todo-o-pais (whole country).
lisboa/lisboa
integer
Optional
Page number, 1-based. Defaults to 1.
1
integer
Optional
Items per page: 24, 36, 48 or 72. Defaults to 36.
24
integer
Optional
Minimum price in EUR.
10
integer
Optional
Maximum price in EUR.
10
integer
Optional
Minimum area in square meters.
10
integer
Optional
Maximum area in square meters.
10
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/imovirtual/search?transaction=comprar&estate=apartamento&location=lisboa%2Flisboa&page=1&limit=24",
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/imovirtual/search?transaction=comprar&estate=apartamento&location=lisboa%2Flisboa&page=1&limit=24');
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/imovirtual/search?transaction=comprar&estate=apartamento&location=lisboa%2Flisboa&page=1&limit=24', 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/imovirtual/search?transaction=comprar&estate=apartamento&location=lisboa%2Flisboa&page=1&limit=24',
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/imovirtual/search?transaction=comprar&estate=apartamento&location=lisboa%2Flisboa&page=1&limit=24")
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/imovirtual/search?transaction=comprar&estate=apartamento&location=lisboa%2Flisboa&page=1&limit=24", 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/imovirtual/search?transaction=comprar&estate=apartamento&location=lisboa%2Flisboa&page=1&limit=24', 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/imovirtual/search?transaction=comprar&estate=apartamento&location=lisboa%2Flisboa&page=1&limit=24")
.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/imovirtual/search?transaction=comprar&estate=apartamento&location=lisboa%2Flisboa&page=1&limit=24", 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/imovirtual/search?transaction=comprar&estate=apartamento&location=lisboa%2Flisboa&page=1&limit=24"
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/imovirtual/search?transaction=comprar&estate=apartamento&location=lisboa%2Flisboa&page=1&limit=24"));
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/imovirtual/search?transaction=comprar&estate=apartamento&location=lisboa%2Flisboa&page=1&limit=24',
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/imovirtual/search?transaction=comprar&estate=apartamento&location=lisboa%2Flisboa&page=1&limit=24")
.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
{
"success": true,
"data": {
"items": [
{
"id": 19310188,
"url": "https://www.imovirtual.com/pt/anuncio/apartamento-t2-com-logradouro-ID1j1sE",
"title": "Apartamento T2 com logradouro",
"estate": "FLAT",
"transaction": "SELL",
"price": {
"value": 359900,
"currency": "EUR"
},
"areaInSquareMeters": 57,
"roomsNumber": 3,
"floorNumber": "ground_floor",
"isPrivateOwner": false,
"publishedAt": "2026-10-15T11:39:16Z"
}
],
"pagination": {
"page": 1,
"pageSize": 24,
"total": 7859,
"totalPages": 328,
"hasMore": true
},
"stats": [
{
"type": "PRICE",
"min": 13000,
"max": 19500000,
"mean": 925751.08
}
]
},
"meta": {
"endpoint_family": "search",
"billable": true
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
HTTP NOT_FOUND
The requested Imovirtual resource was not found. Not billed.
HTTP UPSTREAM_UNAVAILABLE
Imovirtual could not be reached. Not billed.
HTTP UPSTREAM_BLOCKED
Imovirtual rejected the request. Not billed.
HTTP upstream_unavailable
The upstream service is temporarily unavailable. Please retry shortly.
HTTP PARSER_DRIFT
Imovirtual returned an unexpected payload shape. Not billed.
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.