Scrappa's GET /api/vivareal/search returns Brazilian property listings for rent (business=RENTAL) or sale (business=SALE) from ZAP Imoveis or VivaReal as structured JSON.
What you get
One request returns up to 30 listings plus total. Each listing has prices (price, condo fee, IPTU, total monthly rent), usable_area_m2, rooms, a full address with coordinates, H3 cells and nearby points of interest, amenities, images (1024x768) and the advertiser identity. Areas and room counts the portal does not publish are null, never 0.
Location
Use location_id from the location-autocomplete endpoint. The portal ignores city names, so there is no city filter.
Paging and the 1500 row window
Each query reaches at most 1500 rows (rows x page). A request past that returns a 422 window_limit before any upstream call, and nothing is charged. To reach more listings, split the query by location, price band or area band and de-duplicate by id.
Totals and sorting
total is approximate and drifts while you page (total_is_approximate is always true). Do not use it as a cursor. BIGGEST_PRICE and BIGGEST_AREA page stably. LOWEST_PRICE and MOST_RELEVANT pages can overlap, so de-duplicate by id.
Filters that are rejected
Names the portal silently ignores (addressCity, bedroomsMin, usableAreaMin) and unknown names return 422 blocked_filter instead of a quiet wrong answer. Unit types, usage types and sort values are checked before the call. Lists are comma-separated, for example bedrooms=2,3.
What is not returned
Broker phone numbers and WhatsApp numbers are never returned. A valid answer is billed, including an empty page. Failures never consume credits.
Run this endpoint
Endpoint
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.
24 optional filters available.
string
Required
RENTAL (aluguel) or SALE (venda).
RENTAL
string
Optional
ZAP (default) for ZAP Imoveis or VIVAREAL for VivaReal. Both use the same fields and filters.
ZAP
string
Optional
Location id from location-autocomplete, for example BR>Sao Paulo>NULL>Sao Paulo>Zona Oeste>Pinheiros. The only working location filter.
BR>Sao Paulo>NULL>Sao Paulo>Zona Oeste>Pinheiros
string
Optional
USED (default), DEVELOPMENT or USED,DEVELOPMENT.
example
string
Optional
Free text filter.
coffee shops
integer
Optional
Minimum advertised price in BRL.
10
integer
Optional
Maximum advertised price in BRL.
10
integer
Optional
Minimum monthly rent including condo fee and IPTU.
10
integer
Optional
Maximum monthly rent including condo fee and IPTU.
10
integer
Optional
Minimum monthly condo fee in BRL.
10
integer
Optional
Maximum monthly condo fee in BRL.
10
string
Optional
Bedroom counts, comma-separated, for example 2,3.
2
string
Optional
Bathroom counts, comma-separated.
example
string
Optional
Suite counts, comma-separated.
example
string
Optional
Parking space counts, comma-separated.
example
integer
Optional
Minimum usable area in square metres.
10
integer
Optional
Maximum usable area in square metres.
10
string
Optional
Comma-separated: APARTMENT, HOME, CONDOMINIUM, COMMERCIAL_PROPERTY, PARKING_SPACE, BUILDING, RESIDENTIAL_ALLOTMENT_LAND, FARM, PENTHOUSE, FLAT, KITNET, TWO_STORY_HOUSE, COMMERCIAL_BUILDING, OFFICE, BUSINESS.
example
string
Optional
Comma-separated: PENTHOUSE, FLAT, LOFT, STUDIO, KITNET, DUPLEX, TRIPLEX, TWO_STORY_HOUSE, SINGLE_STOREY_HOUSE.
example
string
Optional
RESIDENTIAL or COMMERCIAL, comma-separated.
example
string
Optional
Comma-separated amenity codes such as POOL, GYM, ELEVATOR. The count endpoint lists the codes with counts.
example
string
Optional
Restrict to one advertiser uuid.
1234567890
string
Optional
MOST_RELEVANT (default), BIGGEST_PRICE, BIGGEST_AREA or LOWEST_PRICE.
BIGGEST_PRICE
integer
Optional
Listings per page, 1-30 (default 30).
5
integer
Optional
Result page, 1-based. rows x page may not pass 1500.
1
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/vivareal/search?portal=ZAP&business=RENTAL&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros&bedrooms=2&sort=BIGGEST_PRICE&rows=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
use Illuminate\Support\Facades\Http;
$response = Http::timeout(30)
->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
->get('https://scrappa.co/api/vivareal/search?portal=ZAP&business=RENTAL&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros&bedrooms=2&sort=BIGGEST_PRICE&rows=5');
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/vivareal/search?portal=ZAP&business=RENTAL&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros&bedrooms=2&sort=BIGGEST_PRICE&rows=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));
const axios = require('axios');
const options = {
method: 'GET',
url: 'https://scrappa.co/api/vivareal/search?portal=ZAP&business=RENTAL&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros&bedrooms=2&sort=BIGGEST_PRICE&rows=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);
}
require 'net/http'
require 'uri'
uri = URI.parse("https://scrappa.co/api/vivareal/search?portal=ZAP&business=RENTAL&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros&bedrooms=2&sort=BIGGEST_PRICE&rows=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
import http.client
import json
conn = http.client.HTTPSConnection("scrappa.co")
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
conn.request("GET", "/api/vivareal/search?portal=ZAP&business=RENTAL&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros&bedrooms=2&sort=BIGGEST_PRICE&rows=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()
import requests
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
response = requests.get('https://scrappa.co/api/vivareal/search?portal=ZAP&business=RENTAL&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros&bedrooms=2&sort=BIGGEST_PRICE&rows=5', 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/vivareal/search?portal=ZAP&business=RENTAL&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros&bedrooms=2&sort=BIGGEST_PRICE&rows=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());
}
}
}
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("GET", "https://scrappa.co/api/vivareal/search?portal=ZAP&business=RENTAL&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros&bedrooms=2&sort=BIGGEST_PRICE&rows=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))
}
#!/bin/bash
curl -X GET \
-H "x-api-key: YOUR_API_KEY_HERE" \
"https://scrappa.co/api/vivareal/search?portal=ZAP&business=RENTAL&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros&bedrooms=2&sort=BIGGEST_PRICE&rows=5"
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/vivareal/search?portal=ZAP&business=RENTAL&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros&bedrooms=2&sort=BIGGEST_PRICE&rows=5"));
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/vivareal/search?portal=ZAP&business=RENTAL&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros&bedrooms=2&sort=BIGGEST_PRICE&rows=5',
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/vivareal/search?portal=ZAP&business=RENTAL&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros&bedrooms=2&sort=BIGGEST_PRICE&rows=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
total
total_is_approximate
page
rows
returned
total_pages
window_limit
+3 more
Common listings fields
id
external_id
title
description
{
"success": true,
"total": 4255,
"total_is_approximate": true,
"page": 1,
"rows": 5,
"returned": 1,
"total_pages": 300,
"window_limit": 1500,
"applied_filters": {
"portal": "ZAP",
"business": "RENTAL",
"listing_type": "USED",
"sort": "BIGGEST_PRICE",
"location_id": "BR>Sao Paulo>NULL>Sao Paulo>Zona Oeste>Pinheiros",
"bedrooms": [
2
]
},
"listings": [
{
"id": "2814207417",
"external_id": "9015A005WH",
"title": "Apartamento com 2 quartos a venda e para alugar em Pinheiros, Sao Paulo",
"description": "Unidade disponivel em um dos empreendimentos mais sofisticados de Sao Paulo.",
"listing_type": "USED",
"property_type": "UNIT",
"unit_types": [
"APARTMENT"
],
"unit_sub_types": [],
"usage_types": [
"RESIDENTIAL"
],
"construction_status": null,
"publication_type": "STANDARD",
"show_price": true,
"accepts_exchange": false,
"prices": [
{
"business": "RENTAL",
"price": 12800,
"condo_fee": 2060,
"iptu": null,
"iptu_period": "YEARLY",
"rent_total": 14860,
"rent_period": "MONTHLY"
},
{
"business": "SALE",
"price": 2650000,
"condo_fee": 2060,
"iptu": null,
"iptu_period": "YEARLY",
"rent_total": null,
"rent_period": null
}
],
"usable_area_m2": 85,
"total_area_m2": 85,
"bedrooms": 2,
"bathrooms": 2,
"suites": 2,
"parking_spaces": 2,
"floors": [],
"unit_floor": null,
"address": {
"street": null,
"street_number": null,
"neighborhood": "Pinheiros",
"zone": "Zona Oeste",
"city": "Sao Paulo",
"state": "Sao Paulo",
"state_code": "SP",
"zip_code": "05414020",
"full_address": "Rua Francisco Leitao Pinheiros Sao Paulo SP",
"location_id": "BR>Sao Paulo>NULL>Sao Paulo>Zona Oeste>Pinheiros",
"lat": -23.561,
"lon": -46.681,
"approximate": true,
"radius_m": 250,
"precision": "GEOMETRIC_CENTER",
"h3": [
{
"index": "89a8100eab3ffff",
"resolution": 9
}
],
"pois": [
"BS:Rua Henrique Schaumann, 462"
]
},
"amenities": [],
"images": [
{
"id": "439a18da4c6f6047a797e444ec0520c0",
"type": "IMAGE",
"url": "https://resizedimgs.zapimoveis.com.br/img/vr-listing/439a18da4c6f6047a797e444ec0520c0/photo.jpg?action=fit-in&dimension=1024x768",
"width": 1024,
"height": 768
}
],
"advertiser": {
"id": "cef4b87e-6256-8bb2-b798-cf23e10cd883",
"legacy_id": 810901,
"legacy_zap_id": null,
"name": "Example Imoveis Ltda",
"logo_url": "https://resizedimgs.zapimoveis.com.br/img/vr-listing/718513a5c1a190eb20c1107deb8b40dd/logo.jpg?action=fit-in&dimension=200x200",
"license_number": null,
"tier": "diamond",
"trust_score": null,
"created_at": "2023-07-26T21:29:17Z",
"show_address": false,
"minisite": null
},
"url": null,
"created_at": "2025-06-14T19:02:35.799Z",
"updated_at": "2026-09-24T06:27:41.926Z",
"stamps": [],
"status": "ACTIVE"
}
],
"meta": {
"billable": true,
"endpoint_family": "search",
"portal": "ZAP",
"attempts": 1
}
}
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.
Related Endpoints
VivaReal & ZAP Imoveis API FAQ
Why can I only reach 1500 listings per query?
The portal serves a window of 1500 rows per query. Split the query by location, price band or area band and de-duplicate by listing id.
Is the total exact?
No. The portal total is a live figure that drifts while you page. Treat it as approximate.
Is this the official VivaReal or ZAP API?
No. Scrappa is an independent service and is not affiliated with VivaReal, ZAP Imoveis or their owners. Neither portal publishes a developer API.
Are failed requests charged?
A valid answer is billed, including an empty page. Failures never consume credits.
Try It Live
Test this endpoint in our interactive playground with real data.