Scrappa's GET /api/vivareal/advertiser-listings returns the live listings of one advertiser in the same shape and with the same paging rules as the search endpoint (30 rows per page, 1500 row window). business is optional: without it the stock spans rent and sale. 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.
4 optional filters available.
string
Required
Advertiser uuid.
cef4b87e-6256-8bb2-b798-cf23e10cd883
string
Optional
ZAP (default) for ZAP Imoveis or VIVAREAL for VivaReal. Both use the same fields and filters.
ZAP
string
Optional
RENTAL or SALE. Optional.
example
integer
Optional
Listings per page, 1-30 (default 30).
5
integer
Optional
Result page, 1-based.
1
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/vivareal/advertiser-listings?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883&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/advertiser-listings?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883&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/advertiser-listings?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883&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/advertiser-listings?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883&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/advertiser-listings?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883&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/advertiser-listings?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883&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/advertiser-listings?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883&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/advertiser-listings?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883&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/advertiser-listings?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883&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/advertiser-listings?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883&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/advertiser-listings?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883&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/advertiser-listings?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883&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/advertiser-listings?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883&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": 912,
"total_is_approximate": true,
"page": 1,
"rows": 5,
"returned": 1,
"total_pages": 183,
"window_limit": 1500,
"applied_filters": {
"portal": "ZAP",
"listing_type": "USED",
"advertiser_id": "cef4b87e-6256-8bb2-b798-cf23e10cd883"
},
"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": "advertiser-listings",
"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
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.