# Viva Real Search

## Overview

| Property | Value |
|----------|-------|
| **Status** | private |
| **Method** | `GET` |
| **Endpoint** | `/v2/viva-real/search` |
| **Base URL** | `https://api.piloterr.com` |
| **Credit Cost** | 1 credit per call |
| **Documentation** | https://www.piloterr.com/library/viva-real-search |

## Description

Search Viva Real Brazilian property listings for sale or rent by location and get price, area, rooms, condo fee, and agent details as structured JSON in real time.

## Authentication

- **Key Name:** `x-api-key`
- **Location:** HTTP Header
- **Get an API key:** https://app.piloterr.com/register

## Example Request

```bash
curl --location --request GET 'https://api.piloterr.com/v2/viva-real/search' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Example Response

### Search in Moema, São Paulo

```json
{
  "page": 1,
  "results": [
    {
      "id": "2948312784",
      "url": "https://www.vivareal.com.br/imovel/apartamento-2-quartos-moema-bairros-sao-paulo-sp-70m2-venda-id-2948312784/",
      "iptu": 182,
      "price": 895000,
      "title": "Apartamento para comprar com 70 m², 2 quartos, 2 banheiros, 1 vaga em Moema, São Paulo",
      "address": {
        "lat": -23.6012,
        "lon": -46.6644,
        "city": "São Paulo",
        "state": "SP",
        "neighborhood": "Moema"
      },
      "bedrooms": 2,
      "bathrooms": 2,
      "condo_fee": 1680,
      "thumbnail": "https://resizedimgs.vivareal.com/fit-in/760x420/vr.images.sp/2948312784_primary.jpg",
      "agent_name": "Imobiliária Lello",
      "area_total": 70,
      "published_at": "2026-04-10T11:00:00Z",
      "price_per_sqm": 12786,
      "property_type": "Apartamento",
      "parking_spaces": 1,
      "transaction_type": "venda"
    }
  ],
  "total_pages": 1921,
  "total_results": 38420
}
```

## Documentation

## Overview

Viva Real is one of Brazil's largest real estate portals, part of Grupo OLX, covering both sale and rental markets. The platform uses Cloudflare to block automated access. Piloterr handles the bypass transparently. One GET request returns paginated property listings as structured JSON.

## Quickstart

```
GET https://api.piloterr.com/v2/viva-real/search?query=Moema
```

## Main use cases

- Track rental prices by neighborhood to map average monthly rent per m² in real time
- Compare buy vs rent cost ratios for investment yield analysis
- Alert buyers when new listings matching their criteria appear in a target area
- Combine Viva Real and ZAP Imóveis data for full Brazilian market coverage
- Feed ML models with property attributes and prices for automated valuation