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

VivaReal Parse Filters API Documentation

GET https://scrappa.co/api/vivareal/parse-filters?portal=ZAP&q=apartamento+em+Pinheiros%2C+Sao+Paulo

Scrappa's GET /api/vivareal/parse-filters turns free text such as "apartamento em Pinheiros, Sao Paulo" into a resolved location (location_id, coordinates, address parts), listing_type and unit_types. Use the result as the filters of a search request. A valid answer is billed, including an empty page. Failures never consume credits.

VivaReal Parse Filters API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/vivareal/parse-filters?portal=ZAP&q=apartamento+em+Pinheiros%2C+Sao+Paulo
Auth header
x-api-key
Cost
1 credit/request
q = apartamento em Pinheiros, Sao Paulo
Response preview
200 OK
{
    "success": true,
    "query": "apartamento em Pinheiros, Sao Paulo",
    "filters": {
        "addresses": [
            {
                "location_id": "BR>Sao Paulo>NULL>Sao Paulo>Zona Oeste>Pinheiros",
                "street": null,
                "neighborhood": "Pinheiros",
                "zone": "Zona Oeste",
                "city": "Sao Paulo",
                "state": "Sao Paulo",
                "state_code": null,
                "lat": -23.563579,
...

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.

q string Required

Free text to parse.

Example value apartamento em Pinheiros, Sao Paulo
portal string Optional

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

Example value ZAP

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/vivareal/parse-filters?portal=ZAP&q=apartamento+em+Pinheiros%2C+Sao+Paulo",
    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/parse-filters?portal=ZAP&q=apartamento+em+Pinheiros%2C+Sao+Paulo');

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/parse-filters?portal=ZAP&q=apartamento+em+Pinheiros%2C+Sao+Paulo', 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/parse-filters?portal=ZAP&q=apartamento+em+Pinheiros%2C+Sao+Paulo',
    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/parse-filters?portal=ZAP&q=apartamento+em+Pinheiros%2C+Sao+Paulo")
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/parse-filters?portal=ZAP&q=apartamento+em+Pinheiros%2C+Sao+Paulo", 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/parse-filters?portal=ZAP&q=apartamento+em+Pinheiros%2C+Sao+Paulo', 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/parse-filters?portal=ZAP&q=apartamento+em+Pinheiros%2C+Sao+Paulo")
        .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/parse-filters?portal=ZAP&q=apartamento+em+Pinheiros%2C+Sao+Paulo", 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/parse-filters?portal=ZAP&q=apartamento+em+Pinheiros%2C+Sao+Paulo"
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/parse-filters?portal=ZAP&q=apartamento+em+Pinheiros%2C+Sao+Paulo"));
            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/parse-filters?portal=ZAP&q=apartamento+em+Pinheiros%2C+Sao+Paulo',
            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/parse-filters?portal=ZAP&q=apartamento+em+Pinheiros%2C+Sao+Paulo")
        .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 query filters meta
JSON Response
200 OK
{
    "success": true,
    "query": "apartamento em Pinheiros, Sao Paulo",
    "filters": {
        "addresses": [
            {
                "location_id": "BR>Sao Paulo>NULL>Sao Paulo>Zona Oeste>Pinheiros",
                "street": null,
                "neighborhood": "Pinheiros",
                "zone": "Zona Oeste",
                "city": "Sao Paulo",
                "state": "Sao Paulo",
                "state_code": null,
                "lat": -23.563579,
                "lon": -46.691607
            }
        ],
        "listing_type": "USED",
        "unit_types": [
            "APARTMENT"
        ],
        "unit_sub_types": [
            "PENTHOUSE",
            "FLAT",
            "LOFT",
            "STUDIO",
            "KITNET"
        ]
    },
    "meta": {
        "billable": true,
        "endpoint_family": "parse-filters",
        "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.