Skip to content
Scrappa Get API key
VivaReal & ZAP Imoveis API 1 credit/request

VivaReal Count API Documentation

GET https://scrappa.co/api/vivareal/count?portal=VIVAREAL&business=SALE

Scrappa's GET /api/vivareal/count returns the approximate number of listings for a filter set and the amenity facet counts for it, without listing rows. It accepts the same filters as the search endpoint.

What you get

total is the approximate match count (it drifts while you page). facets.amenities maps each amenity code, such as POOL or ELEVATOR, to the number of matching listings. Use the codes in the amenities filter of the search endpoint. A valid answer is billed, including an empty page. Failures never consume credits.

VivaReal Count API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/vivareal/count?portal=VIVAREAL&business=SALE
Auth header
x-api-key
Cost
1 credit/request
business = SALE
Response preview
200 OK
{
    "success": true,
    "total": 995325,
    "total_is_approximate": true,
    "applied_filters": {
        "portal": "VIVAREAL",
        "business": "SALE",
        "listing_type": "USED"
    },
    "facets": {
        "amenities": {
            "KITCHEN": 350823,
            "AIR_CONDITIONING": 251807,
            "ELEVATOR": 243047,
...

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.

business string Required

RENTAL (aluguel) or SALE (venda).

Example value SALE
portal string Optional

ZAP (default) for ZAP Imoveis or VIVAREAL for VivaReal. Both use the same fields and filters.

Example value VIVAREAL
location_id string Optional

Location id from location-autocomplete, for example BR>Sao Paulo>NULL>Sao Paulo>Zona Oeste>Pinheiros. The only working location filter.

Example value 1234567890
price_max integer Optional

Maximum advertised price in BRL.

Example value 10
bedrooms string Optional

Bedroom counts, comma-separated.

Example value example

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/vivareal/count?portal=VIVAREAL&business=SALE",
    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
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/vivareal/count?portal=VIVAREAL&business=SALE');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/vivareal/count?portal=VIVAREAL&business=SALE', 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));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/vivareal/count?portal=VIVAREAL&business=SALE',
    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);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/vivareal/count?portal=VIVAREAL&business=SALE")
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
Python
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/count?portal=VIVAREAL&business=SALE", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/vivareal/count?portal=VIVAREAL&business=SALE', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
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/count?portal=VIVAREAL&business=SALE")
        .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());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/vivareal/count?portal=VIVAREAL&business=SALE", 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))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/vivareal/count?portal=VIVAREAL&business=SALE"
C#
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/count?portal=VIVAREAL&business=SALE"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/vivareal/count?portal=VIVAREAL&business=SALE',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
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/count?portal=VIVAREAL&business=SALE")
        .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 applied_filters facets meta
JSON Response
200 OK
{
    "success": true,
    "total": 995325,
    "total_is_approximate": true,
    "applied_filters": {
        "portal": "VIVAREAL",
        "business": "SALE",
        "listing_type": "USED"
    },
    "facets": {
        "amenities": {
            "KITCHEN": 350823,
            "AIR_CONDITIONING": 251807,
            "ELEVATOR": 243047,
            "POOL": 234255
        }
    },
    "meta": {
        "billable": true,
        "endpoint_family": "count",
        "portal": "VIVAREAL",
        "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.