# Viva Real Property ## Overview | Property | Value | |----------|-------| | **Status** | active | | **Method** | `GET` | | **Endpoint** | `/v2/vivareal/property` | | **Base URL** | `https://api.piloterr.com` | | **Credit Cost** | 1 credit per call | | **Documentation** | https://www.piloterr.com/library/vivareal-property | ## Description Read one Viva Real property from its URL. The price follows the operation of that URL, so a sale link stays a sale price. ## 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/vivareal/property' \ --header 'Content-Type: application/json' \ --header 'x-api-key: YOUR_API_KEY' ``` ## Example Response ### Brooklin sale 2776423622, rent also shown on the page ```json { "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" } ``` ## Documentation ## 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`. ## 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 ``` ## 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 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 cases - Open the building behind a search card - Store address, area, and bedrooms - Keep sale and rent from being mixed ## 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 | ## Related endpoints [Viva Real Search](https://www.piloterr.com/library/vivareal-search)