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

VivaReal Price Insights API Documentation

GET https://scrappa.co/api/vivareal/price-insights?portal=ZAP&city=S%C3%A3o+Paulo&state=S%C3%A3o+Paulo&neighborhood=Pinheiros&business_type=RENTAL&unit_type=APARTMENT&latitude=-23.563579&longitude=-46.691607&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros
Get API key Open Playground

Scrappa's GET /api/vivareal/price-insights returns market statistics for one location: main_location with the number of properties, average price, average area, average price per m2 and price brackets with counts, and top_locations with nearby areas.

City, state, business type, unit type, latitude, longitude and location id are all required. The portal answers an incomplete set with an empty body, which this API reports as 404 no_data and does not bill. Take the values from location-autocomplete and keep the accents: an unknown spelling answers 404 no_data. Leave neighborhood out for city-level insights. A valid answer is billed, including an empty page. Failures never consume credits.

VivaReal Price Insights API Documentation 1 credit/request
Get API key Open Playground

Endpoint

Request preview
GET
https://scrappa.co/api/vivareal/price-insights?portal=ZAP&city=S%C3%A3o+Paulo&state=S%C3%A3o+Paulo&neighborhood=Pinheiros&business_type=RENTAL&unit_type=APARTMENT&latitude=-23.563579&longitude=-46.691607&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros
Auth header
x-api-key
Cost
1 credit/request
city = São Paulo state = São Paulo business_type = RENTAL
Response preview
200 OK 
{
    "success": true,
    "main_location": {
        "location": {
            "name": "Pinheiros",
            "stats": {
                "total_properties": 4255,
                "avg_total_price": 5001,
                "avg_total_area": 50,
                "avg_sqm": 100
            },
            "price_ranges": [
                {
                    "key": "De R$ 1 mil a R$ 2,5 mil",
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

7 required parameters needed before sending a request.

2 optional filters available.

city state business_type unit_type latitude longitude location_id
city string Required

City, spelled with accents as location-autocomplete returns it, for example São Paulo.

Example value São Paulo
state string Required

State, spelled with accents as location-autocomplete returns it, for example São Paulo.

Example value São Paulo
business_type string Required

RENTAL or SALE.

Example value RENTAL
unit_type string Required

Unit type such as APARTMENT or HOME.

Example value APARTMENT
latitude number Required

Latitude of the location.

Example value -23.563579
longitude number Required

Longitude of the location.

Example value -46.691607
location_id string Required

Location id from location-autocomplete.

Example value BR>Sao Paulo>NULL>Sao Paulo>Zona Oeste>Pinheiros
portal string Optional

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

Example value ZAP
neighborhood string Optional

Neighbourhood, for example Pinheiros.

Example value Pinheiros

Request Examples

PHP 
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/vivareal/price-insights?portal=ZAP&city=S%C3%A3o+Paulo&state=S%C3%A3o+Paulo&neighborhood=Pinheiros&business_type=RENTAL&unit_type=APARTMENT&latitude=-23.563579&longitude=-46.691607&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros",
    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/price-insights?portal=ZAP&city=S%C3%A3o+Paulo&state=S%C3%A3o+Paulo&neighborhood=Pinheiros&business_type=RENTAL&unit_type=APARTMENT&latitude=-23.563579&longitude=-46.691607&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros');

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/price-insights?portal=ZAP&city=S%C3%A3o+Paulo&state=S%C3%A3o+Paulo&neighborhood=Pinheiros&business_type=RENTAL&unit_type=APARTMENT&latitude=-23.563579&longitude=-46.691607&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros', 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/price-insights?portal=ZAP&city=S%C3%A3o+Paulo&state=S%C3%A3o+Paulo&neighborhood=Pinheiros&business_type=RENTAL&unit_type=APARTMENT&latitude=-23.563579&longitude=-46.691607&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros',
    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/price-insights?portal=ZAP&city=S%C3%A3o+Paulo&state=S%C3%A3o+Paulo&neighborhood=Pinheiros&business_type=RENTAL&unit_type=APARTMENT&latitude=-23.563579&longitude=-46.691607&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros")
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/price-insights?portal=ZAP&city=S%C3%A3o+Paulo&state=S%C3%A3o+Paulo&neighborhood=Pinheiros&business_type=RENTAL&unit_type=APARTMENT&latitude=-23.563579&longitude=-46.691607&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros", 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/price-insights?portal=ZAP&city=S%C3%A3o+Paulo&state=S%C3%A3o+Paulo&neighborhood=Pinheiros&business_type=RENTAL&unit_type=APARTMENT&latitude=-23.563579&longitude=-46.691607&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros', 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/price-insights?portal=ZAP&city=S%C3%A3o+Paulo&state=S%C3%A3o+Paulo&neighborhood=Pinheiros&business_type=RENTAL&unit_type=APARTMENT&latitude=-23.563579&longitude=-46.691607&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros")
        .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/price-insights?portal=ZAP&city=S%C3%A3o+Paulo&state=S%C3%A3o+Paulo&neighborhood=Pinheiros&business_type=RENTAL&unit_type=APARTMENT&latitude=-23.563579&longitude=-46.691607&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros", 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/price-insights?portal=ZAP&city=S%C3%A3o+Paulo&state=S%C3%A3o+Paulo&neighborhood=Pinheiros&business_type=RENTAL&unit_type=APARTMENT&latitude=-23.563579&longitude=-46.691607&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros"
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/price-insights?portal=ZAP&city=S%C3%A3o+Paulo&state=S%C3%A3o+Paulo&neighborhood=Pinheiros&business_type=RENTAL&unit_type=APARTMENT&latitude=-23.563579&longitude=-46.691607&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros"));
            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/price-insights?portal=ZAP&city=S%C3%A3o+Paulo&state=S%C3%A3o+Paulo&neighborhood=Pinheiros&business_type=RENTAL&unit_type=APARTMENT&latitude=-23.563579&longitude=-46.691607&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros',
            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/price-insights?portal=ZAP&city=S%C3%A3o+Paulo&state=S%C3%A3o+Paulo&neighborhood=Pinheiros&business_type=RENTAL&unit_type=APARTMENT&latitude=-23.563579&longitude=-46.691607&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros")
        .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.

Open in Playground

Example response fields

Scan these fields before integrating.

success main_location top_locations meta
JSON Response
200 OK 
{
    "success": true,
    "main_location": {
        "location": {
            "name": "Pinheiros",
            "stats": {
                "total_properties": 4255,
                "avg_total_price": 5001,
                "avg_total_area": 50,
                "avg_sqm": 100
            },
            "price_ranges": [
                {
                    "key": "De R$ 1 mil a R$ 2,5 mil",
                    "doc_count": 160
                }
            ]
        }
    },
    "top_locations": [],
    "meta": {
        "billable": true,
        "endpoint_family": "price-insights",
        "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

GET Location Autocomplete

Find the location values

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.

Get API key Open Playground
Back to Home Full API reference