VivaReal API

Search VivaReal and pull Brazilian property listings, prices and advertisers as clean JSON.

The API.SH VivaReal API turns public pages on one of Brazil's major property portals into structured JSON. Find a city, neighbourhood or street, search homes and commercial property for sale (venda) or rent (aluguel) with price, area, bedroom, suite and parking filters, and open a listing for its condo fee, IPTU, full address with coordinates, the site's price estimate and the agency with its CRECI licence.

Get a free API key Try it in the playground

3 endpoints
from $1 / 1,000 calls
1,000 free credits / month
failed calls free

VivaReal property search

GET https://api.api.sh/vivareal/v1/search

{ "success": true }

1 credit · $1 per 1,000 calls

What you can build with the VivaReal API

Brazilian real estate market research

Search a city or neighbourhood for sale or rental listings and compare prices, condo fees and IPTU by area.

/search /places

Pricing and valuation models

Open listings for usable area, rooms, amenities and the site's price estimate per m² to build comparables.

/listing

Location lookup for apps

Turn a typed place name into VivaReal's cities, neighbourhoods and streets with coordinates and location ids.

/places

Agency and broker research

Read the advertiser on each listing, with agency name, CRECI licence, phones and listing counts by city and neighbourhood.

/listing /search

New listing alerts

Open the newest listing for your search filters with latest=true and send it to your team.

/listing

VivaReal data you get

Field names from real responses. Numbers come parsed, URLs absolute, dates in ISO 8601.

VivaReal API endpoints and prices

Every VivaReal endpoint costs 1 credit per call: credits are $1 per 1,000 on a monthly plan, $2 pay-as-you-go. Pricing

Search and discovery2

VivaReal place suggestions /vivareal/v1/places	$1 · $2 PAYG 1 credit
VivaReal property search /vivareal/v1/search	$1 · $2 PAYG 1 credit

Products, listings and places1

VivaReal listing

/vivareal/v1/listing

$1 · $2 PAYG

1 credit

Call the VivaReal API

VivaReal property search: GET https://api.api.sh/vivareal/v1/search

curl "https://api.api.sh/vivareal/v1/search?location=Curitiba" \
  -H "x-api-key: $APISH_KEY"

import os, requests

res = requests.get(
    "https://api.api.sh/vivareal/v1/search",
    params={"location": "Curitiba"},
    headers={"x-api-key": os.environ["APISH_KEY"]},
    timeout=120,
)
res.raise_for_status()
data = res.json()

const url = new URL("https://api.api.sh/vivareal/v1/search");
url.searchParams.set("location", "Curitiba");

const res = await fetch(url, { headers: { "x-api-key": process.env.APISH_KEY } });
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const data = await res.json();

# Google Sheets (API.SH add-on)
=APISH("/vivareal/v1/search", "location", "Curitiba")

# Zapier, Make, n8n (verified node): pick the API.SH app,
# choose "VivaReal" and "VivaReal property search".

# AI agents (Claude, ChatGPT, Cursor): add the
# API.SH MCP server https://api.sh/mcp

Create a free accountConfirm your email and get 1,000 free credits every month. No card needed.
Create an API keyOne key works for all 482 platforms.
Send the requestJSON back in one call. Add output=csv or output=ndjson for files.

Why API.SH for VivaReal data

Public data only: no VivaReal login, cookies or account needed
One key and one response shape for VivaReal and 481 other platforms
Built and maintained by API.SH, not third-party publishers
Pay per call; errors on our side cost nothing
Live status for every endpoint

API.SH vs the official VivaReal API

VivaReal belongs to Grupo OLX, alongside ZAP Imóveis and OLX. Its official integration portal is for agencies and CRMs sending listings by XML feed and receiving leads through webhooks; it does not offer a public API for searching listings. API.SH reads the public search and listing pages and returns them as JSON.

Apify actors and scraping libraries cover VivaReal; API.SH gives you maintained places, search and listing routes with one key, a fixed price per call and the same JSON shape as its ZAP Imóveis routes.

VivaReal API questions

What VivaReal data can I get?+

Place suggestions with coordinates and location ids (/vivareal/v1/places), property search results with prices, condo fee, IPTU, rooms, area, address and advertiser (/vivareal/v1/search), and one listing with amenities, photos, the site's price estimate and the agency (/vivareal/v1/listing).

How much does the VivaReal API cost?+

Every VivaReal endpoint costs 1 credit per call. On a monthly plan 1,000 credits cost $1 (Starter is $50/month for 50,000 credits). Pay-as-you-go is $2 per 1,000 credits, with top-ups from $15 that never expire.

Is there a free trial?+

Yes. Every account gets 1,000 free credits every month. That is 1,000 calls to /vivareal/v1/listing at 1 credit each.

Is there an official VivaReal API?+

Only for advertisers. The Grupo OLX integration portal lets agencies push listings by XML feed and get leads by webhook. There is no public API for reading VivaReal listings, which is what API.SH provides.

Do I need a VivaReal account or login?+

No. API.SH reads public VivaReal pages only. A private owner's phones and address are left out.

Does it cover rentals (aluguel) as well as sales (venda)?+

Yes. Set business on /vivareal/v1/search for sale or rent; rental results include the rent, condo fee and IPTU.

Is it the same data as ZAP Imóveis?+

Both portals belong to Grupo OLX and many agencies list on both. API.SH has separate VivaReal and ZAP Imóveis routes with the same parameters and response shape, so you can query either or both.

How do I get started?+

1. Sign up at api.sh. 2. Copy your API key. 3. Call /vivareal/v1/search with a location and business. Request examples and every parameter are in the docs at https://api.sh/docs. You can also use the JS or Python SDK, Google Sheets, Zapier, Make, n8n or the MCP server at https://api.sh/mcp.