Piloterr

Viva Real Property

GET
/v2/vivareal/property

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

Credit cost: 1 credit per call

Authorization

ApiKeyAuth
headerx-api-key<token>

Your API key. Include it in the x-api-key header for every request.

Query Parameters

query*string

Viva Real listing URL under /imovel/ with an id- number.

Example:

https://www.vivareal.com.br/imovel/apartamento-3-quartos-brooklin-zona-sul-sao-paulo-com-garagem-186m2-venda-RS3710000-id-2776423622/

A search URL returns 400. On a sale URL, price stays the sale price when the page also shows rent.

fields?string

Comma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).

is_async?boolean

Run the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.

Defaultfalse
soft_fail?boolean

Return HTTP 200 even when the request fails; the error is in the error field of the body.

Defaultfalse

Response Body

Successful response

application/json
  1. response
id?string
url?string
area?integer
city?string
iptu?integer
floor?unknown
price?integer
title?string
images?array<string>
suites?integer
address?string
bedrooms?integer
currency?string
amenities?array<string>
bathrooms?integer
image_url?string
operation?string
reference?string
state_code?string
condominium?integer
description?string
iptu_display?string
neighborhood?string
published_at?string
price_display?string
property_type?string
parking_spaces?integer
publisher_name?string
publisher_license?string
condominium_display?string
Example Request
curl -X GET 'https://api.piloterr.com/v2/vivareal/property?query=string'
Example Response
{  "id": "2776423622",  "url": "https://www.vivareal.com.br/imovel/apartamento-3-quartos-brooklin-zona-sul-sao-paulo-com-garagem-186m2-venda-RS3710000-id-2776423622/",  "area": 186,  "city": "São Paulo",  "iptu": 917,  "floor": null,  "price": 3710000,  "title": "Apartamento com 3 Quartos à venda, 186m² - Brooklin",  "images": [    "https://resizedimgs.vivareal.com/img/vr-listing/c16fea316fbef741a3dacf22121412b1/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297",    "https://resizedimgs.vivareal.com/img/vr-listing/3b1700b6695469ff6130dfa4dd7bd29a/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false",    "https://resizedimgs.vivareal.com/img/vr-listing/772a845f1483ec587b420c75499aa818/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false",    "https://resizedimgs.vivareal.com/img/vr-listing/06b6bbfa2c04d465eb4a54cdbcfee39c/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false",    "https://resizedimgs.vivareal.com/img/vr-listing/e506f5b4a8978baace21c4bb4f23dc68/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false",    "https://resizedimgs.vivareal.com/img/vr-listing/e24557ae970e7c88d63c02b8b93bb285/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false",    "https://resizedimgs.vivareal.com/img/vr-listing/63b359900c7910916c576ed5f4be5db5/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false",    "https://resizedimgs.vivareal.com/img/vr-listing/6c0a7e3a7a3379307b2ea8fb4b6097aa/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false",    "https://resizedimgs.vivareal.com/img/vr-listing/744030c65a06d4a9388c84533e965add/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false",    "https://resizedimgs.vivareal.com/img/vr-listing/c32fdef988ec9e7d0ed932587c27926f/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false",    "https://resizedimgs.vivareal.com/img/vr-listing/2bd6ca3a8550827912e07bda6ae41173/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false",    "https://resizedimgs.vivareal.com/img/vr-listing/7d20899930ba3d5328037e10548f45df/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false",    "https://resizedimgs.vivareal.com/img/vr-listing/86f08323d734c678a620939684eb2f40/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false",    "https://resizedimgs.vivareal.com/img/vr-listing/b97f0b7f824e07809dc72d42aba01f0a/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false",    "https://resizedimgs.vivareal.com/img/vr-listing/ee74d88e5f474ef6e5feed81a1ba3f57/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false",    "https://resizedimgs.vivareal.com/img/vr-listing/4ac4e946324633e889cd85de017ef491/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false",    "https://resizedimgs.vivareal.com/img/vr-listing/331c07bf790f8ce37a0f16b5b58a7fa6/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false",    "https://resizedimgs.vivareal.com/img/vr-listing/f225ff8f910eb7d2b5867719134ae405/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297&seo=false"  ],  "suites": 2,  "address": "Rua Nova York, 161 - Brooklin, São Paulo - SP",  "bedrooms": 3,  "currency": "BRL",  "amenities": [    "Mobiliado",    "Aceita animais",    "Cozinha",    "Freezer",    "Escritório",    "Armário embutido"  ],  "bathrooms": 3,  "image_url": "https://resizedimgs.vivareal.com/img/vr-listing/c16fea316fbef741a3dacf22121412b1/apartamento-com-3-quartos-a-venda-186m-no-brooklin-sao-paulo.webp?action=fit-in&dimension=614x297",  "operation": "sale",  "reference": "LR4127",  "state_code": "SP",  "condominium": 2500,  "description": "Apartamento alto padrão de 3 dormitórios sendo 1 suíte master com closet, home theater integrado, sala com living para 2 ambientes, cozinha totalmente planejada, sacada com vista livre e lazer completo no condominio. A permanência de animais de estimação no imóvel dependerá de avaliação e autorização expressa do proprietário. Conheça o Condomínio Nova York Penthouses, uma morada que reflete o espírito vibrante de São Paulo. Localizado na Rua Nova York, disponibiliza vários recursos para trazer comodidade e aconchego ao dia a dia dos moradores. Contando com portaria 24 horas, academia, piscina, quadra esportiva, salão de festas, gás encanado, playground, sauna, salão de jogos, brinquedoteca e espaço gourmet na área comum, o Condomínio Nova York Penthouses é preparado para atender às necessidades dos moradores que buscam lazer e conforto em um só lugar. A proximidade com DeRose Method Brooklin, Estação Campo Belo, Diko Pataca, Escola M. Dias, Beatíssima Virgem Maria e Escolinha das Acácias acrescenta praticidade e comodidade na rotina dos que residem no local. Atenção: Unidade sujeita a confirmação de valores e disponibilidade, sem aviso prévio.",  "iptu_display": "R$ 917",  "neighborhood": "Brooklin",  "published_at": "2025-02-03",  "price_display": "R$ 3.710.000",  "property_type": "apartment",  "parking_spaces": 3,  "publisher_name": "Lr Flats Imobiliária",  "publisher_license": "46905-J",  "condominium_display": "R$ 2.500/mês"}