Skip to main content
Piloterr
Back to library

Viva Real Property API

Read one Viva Real property from its URL. The price follows the operation of that URL, so a sale link stays a sale price.

Active1 credit = 1 requestGET/v2/vivareal/property

Endpoint Overview

Detailed documentation, pricing, and usage examples.

OverviewLink to Overview

One Viva Real listing from an /imovel/ URL.

query placeholder is a listing URL. price is the asking price for the transaction in that URL. On a sale URL, price stays the sale price when the page also shows rent. price_display is that text. currency is BRL. The response has no struck previous price.

The Brooklin sale page prints sale R$ 3.710.000 and rent R$ 21.133/mês. price is 3710000.

QuickstartLink to Quickstart

GET https://api.piloterr.com/v2/vivareal/property?query=https://www.vivareal.com.br/imovel/apartamento-3-quartos-brooklin-zona-sul-sao-paulo-com-garagem-186m2-venda-RS3710000-id-2776423622/

São Paulo search that leads to listings like this one:

GET https://api.piloterr.com/v2/vivareal/search?query=S%C3%A3o%20Paulo&operation=sale

ParametersLink to Parameters

Parameter Type Required Placeholder Example
query string yes https://www.vivareal.com.br/imovel/apartamento-3-quartos-brooklin-zona-sul-sao-paulo-com-garagem-186m2-venda-RS3710000-id-2776423622/ same URL

A search URL returns 400. A page with no asking price returns 404.

Response fieldsLink to Response fields

Field Type Description
id string Viva Real listing id
url string Listing URL
title string Page title
description string or null Listing text
price integer Sale price on a sale URL, rent on a rent URL
price_display string Price as shown
currency string BRL
address string Street, number, neighborhood, and city
neighborhood string or null Neighborhood
city string or null City
state_code string or null State code
area integer or null Area in m²
bedrooms integer or null Bedroom count. Null when the listing has no bedrooms
bathrooms integer or null Bathroom count
parking_spaces integer or null Garage spaces
suites integer or null Suite count
floor integer or null Floor. Null when the page does not print an andar
property_type string or null apartment, house, commercial, and similar
operation string sale or rent
condominium integer or null Condo fee. 0 when the page says isento
condominium_display string or null Fee as shown
iptu integer or null IPTU amount
iptu_display string or null IPTU as shown
amenities array Features printed on the page
image_url string or null First photo
images array Photo gallery
publisher_name string or null Advertiser
publisher_license string or null CRECI
reference string or null Advertiser code
published_at string or null Created date, YYYY-MM-DD

Main use casesLink to Main use cases

  • Open the building behind a search card
  • Store address, area, and bedrooms
  • Keep sale and rent from being mixed

Error codesLink to Error codes

Code Meaning
400 Missing URL, bad domain, or a search URL
401 Missing API key
404 No asking price
500 Fetch or parse failure

Viva Real Search

Related APIs

Expand your data capabilities with these complementary tools.

Ready to get started?

Your web scraping API is one click away. Start with +500 credits, no infrastructure to set up, no proxies to manage, and no credit card required.

  • +500 credits
  • No credit card required
  • All endpoints included