Scrappa's GET /api/vivareal/advertiser returns the business identity of one advertiser: name, logo_url, license_number (CRECI), tier, trust_score, created_at, minisite and listings_total, the approximate number of live listings.
Take advertiser_id from advertiser.id in a listing. legacy_id is the id used by the portal's public advertiser page. Broker phone numbers are never returned.
An advertiser without a live listing returns 404 not_found. 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.
1 optional filter 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
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/vivareal/advertiser?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883",
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?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883');
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?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883', 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?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883',
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?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883")
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?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883", 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?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883', 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?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883")
.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?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883", 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?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883"
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?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883"));
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?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883',
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?portal=ZAP&advertiser_id=cef4b87e-6256-8bb2-b798-cf23e10cd883")
.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
advertiser
total_is_approximate
meta
{
"success": true,
"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,
"listings_total": 912
},
"total_is_approximate": true,
"meta": {
"billable": true,
"endpoint_family": "advertiser",
"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.