VivaReal (Brazil) API & Scraper
VivaReal (vivareal.com.br, Grupo OLX) is one of Brazil's largest property portals: 3,481,424 listings for sale on 2026-11-16.
🤖 Using an AI assistant? Copy this link into ChatGPT / Claude / Cursor — it reads every endpoint and parameter instantly and tells you if this API fits your use case.
This API reads it logged out, prices in Brazilian reais. `locations` turns a city, neighbourhood, zone or street name into the location id the site uses. `search` takes a state, city, neighbourhood, a point with a radius or a map box, for sale or for rent, with the site's own filters (price, condo fee, bedrooms, bathrooms, parking, usable area, property type, 210 amenities, the 'Ótimo preço' below-market badge, the running Festival da Mudança campaign, near metro or train, rent without guarantor, seasonal rent, reference code) plus total area, virtual tour, owner-only and keyword, and returns the site's own total with 30 listings per page. `developments` does the same for new developments (lançamentos) with their construction stage. `count` gives the total and how many matches have each amenity. `listing` returns one listing in full: sale price or rent, condo fee, IPTU, rent total, accepted rental guarantees, areas, rooms, suites, parking, floor, the whole description, every photo and video, the address and coordinates as published, nearby metro and train stations, and the advertiser with CRECI licence, phone numbers, WhatsApp and the site's 'verified' badge. `price_insights` returns the site's own average price, area and price per m² for a city or neighbourhood with nearby neighbourhoods compared. `agency`, `agency_listings`, `condominiums` and `condominium` cover real-estate agencies and condominium buildings, and `developers` and `developer` cover the site's directory of property developers (incorporadoras) with every development each one lists.
What a VivaReal field actually contains
Fields that read differently from how they look. Every row was measured against live vivareal.com.br data on 2026-11-16.
| Field | What it holds |
|---|---|
| prices.sale_price_brl, rent_price_brl | The sale price ('Venda') and the monthly rent ('Aluguel') the listing page prints. A listing offered both ways carries both. On 20 listings checked against their own page on 2026-11-16, 66 of 66 price, condo-fee and IPTU values matched. |
| prices.condo_fee_brl | The monthly condominium fee ('Condomínio') as printed. Null when the listing states none. |
| prices.iptu_brl, iptu_period | The IPTU property-tax figure the page prints under 'IPTU', with the period the advertiser declared in iptu_period. |
| prices.rent_total_brl | Rent plus condominium fee, as the site computes it for rentals (3,497 rent + 150 condo fee = 3,647). |
| prices.sale_price_max_brl | For a new development with several unit prices: the highest unit price, next to the lowest in sale_price_brl ('a partir de'). The search row of a development carries the lowest price only; listing carries every unit. |
| title, description (search rows) | The results list carries no title or description for ordinary listings: 49 of 299 rows across 10 searches had them, the paid 'SUPER PREMIUM' rows and owner listings. Every row has headline (the card heading, e.g. 'Apartamento com 3 Quartos à venda, 110m²'); listing returns the title and the full description. |
| promoted | true for the paid placements the site mixes into relevance-ordered pages (2 per 30-row page on most searches). Sorting by newest returns no promoted rows. |
| below_market | true when the site shows its 'Ótimo preço' badge (priced below the market); 2,788 of 23,141 sale listings in Pinheiros, São Paulo. |
| advertiser.verified | The site's 'Anunciante verificado' badge: true on 117 of 299 search rows. Null when the advertiser record does not say. |
| advertiser.license_number | The agency's CRECI licence as published (e.g. 19828-J-SP): 138 of 299 search rows. Private owners and development aggregators publish none. |
| property_type | What the listing record itself says. The site's type filter can return rows whose record only names the broader type: a studio search for rent in São Paulo gave 13 of 30 rows marked studio, 15 marked apartment, 2 kitnet. |
| developer.listings_total, own_account_listings_total | listings_total is what the developer's own page lists (Abyara: 73). Developments are often advertised through partner accounts, so own_account_listings_total (listings under the developer's own advertiser account) is often 0. |
Prices are in Brazilian reais (BRL) as the site prints them. Of 20 listing ids taken from searches, 19 came back with the same area and bedrooms; on the 20th the search row said 40 m² while the listing and its page said 45 m².
Real request and response JSON
Captured from the indexed primary action, search, on .
{
"method": "POST",
"url": "https://api.reefapi.com/vivareal/v1/search",
"headers": {
"x-api-key": "$REEF_KEY",
"content-type": "application/json"
},
"body": {
"location": "Pinheiros, São Paulo"
}
}{
"ok": true,
"meta": {
"api": "vivareal",
"endpoint": "search",
"mode": "live",
"latency_ms": 809.1,
"record_count": 30,
"bytes": 271936,
"cache_hit": false,
"upstream_requests": 1,
"promoted_rows": 7,
"paging_ceiling": 1500,
"charged_credits": 2,
"version": "1.0.0",
"request_id": "d75d29a86a8b4158",
"queue_ms": 2,
"fetched_at": "2026-11-16T21:05:26.467Z"
},
"data": {
"results": [
{
"id": "2869003993",
"url": "https://www.vivareal.com.br/imovel/apartamento-4-quartos-pinheiros-zona-oeste-sao-paulo-com-garagem-193m2-venda-RS3600000-id-2869003993/",
"title": "APARTAMENTO PINHEIROS 4 DORMITÓRIOS 2 VAGAS",
"headline": "Apartamento com 4 Quartos à venda, 193m²",
"business": [
"sale"
],
"listing_type": "used",
"property_type": "apartment",
"unit_types": [
"APARTMENT"
],
"unit_sub_types": [],
"usage": "residential",
"prices": {
"currency": "BRL",
"sale_price_brl": 3600000,
"sale_price_max_brl": null,
"rent_price_brl": null,
"rent_price_max_brl": null,
"rent_total_brl": null,
"condo_fee_brl": 2400,
"iptu_brl": 1682,
"iptu_period": "yearly",
"rental_period": null,
"rental_guarantees": []
},
"show_price": true,
"price_per_m2_brl": 18652.85,
"usable_area_m2": 193,
"usable_area_m2_max": null,
"total_area_m2": 313,
"total_area_m2_max": null,
"bedrooms": 4,
"bedrooms_max": null,
"bathrooms": 2,
"bathrooms_max": null,
"suites": 2,
"suites_max": null,
"parking_spaces": 2,
"parking_spaces_max": null,
"floor": null,
"building_floors": 27,
"units_per_floor": null,
"buildings": null,
"address": {
"street": "Rua Eugênio de Medeiros",
"number": "711",
"complement": null,
"neighborhood": "Pinheiros",
"zone": "Zona Oeste",
"city": "São Paulo",
"state": "São Paulo",
"state_code": "SP",
"zip_code": "05425001",
"country": "BR",
"location_id": "BR>Sao Paulo>NULL>Sao Paulo>Zona Oeste>Pinheiros",
"latitude": -23.565225,
"longitude": -46.700377,
"point_is_approximate": true,
"display_latitude": -23.565225,
"display_longitude": -46.700377,
"precision": "RANGE_INTERPOLATED",
"address_shown": "all"
},
"nearby_transit": {
"within_1km": [
"[trimmed-depth]",
"[trimmed-depth]",
"[trimmed-depth]"
],
"within_2km": [
"[trimmed-depth]",
"[trimmed-depth]",
"[trimmed-depth]"
],
"within_3km": [
"[trimmed-depth]",
"[trimmed-depth]",
"[trimmed-depth]"
]
},
"points_of_interest": [
{
"kind": "[trimmed-depth]",
"code": "[trimmed-depth]",
"name": "[trimmed-depth]"
},
{
"kind": "[trimmed-depth]",
"code": "[trimmed-depth]",
"name": "[trimmed-depth]"
},
{
"kind": "[trimmed-depth]",
"code": "[trimmed-depth]",
"name": "[trimmed-depth]"
}
],
"amenities": [
{
"code": "[trimmed-depth]",
"label": "[trimmed-depth]"
},
{
"code": "[trimmed-depth]",
"label": "[trimmed-depth]"
},
{
"code": "[trimmed-depth]",
"label": "[trimmed-depth]"
}
],
"amenities_detected": [
{
"code": "[trimmed-depth]",
"label": "[trimmed-depth]"
},
{
"code": "[trimmed-depth]",
"label": "[trimmed-depth]"
},
{
"code": "[trimmed-depth]",
"label": "[trimmed-depth]"
}
],
"description": "Apartamento de Alto Padrão à Venda em Pinheiros - 193 m² Privativos\n\nViva o melhor de Pinheiros em um apartamento único, resultado da integração de duas unidades, que oferece 193 m² de área privativa, 4 dormitórios, 2 suítes (sendo uma suíte master) e 2 vagas de garagem.\nUm imóvel exclusivo, com ambientes amplos, sofisticados e pensados para quem valoriza conforto, design e localização privilegiada.\n\nA área social encanta logo na chegada: living para 3 ambientes, totalmente integrado ao terraço com vista livre, criando um espaço perfeito para receber amigos e viver momentos especiais em famíli",
"photos": [
"https://resizedimgs.vivareal.com/img/vr-listing/1a81dc064380c310ab201c1bd95c53bb/imagem.webp?action=fit-in&dimension=1920x1080",
"https://resizedimgs.vivareal.com/img/vr-listing/9bee2dfcaea0fb66a737074a6964a5fa/imagem.webp?action=fit-in&dimension=1920x1080",
"https://resizedimgs.vivareal.com/img/vr-listing/67f4df021c7142861bcfd257e45a64ed/imagem.webp?action=fit-in&dimension=1920x1080"
],
"videos": [],
"floor_plans": [],
"virtual_tours": [],
"photo_count": 57,
"virtual_tour_url": null,
"publication_type": "SUPER_PREMIUM",
"promoted": true,
"promotion": "SUPER PREMIUM",
"stamps": [],
"below_market": false,
"advertiser_type": "real_estate_agency",
"external_id": "286405",
"condominium_name": null,
"construction_status": null,
"construction_timeline": [],
"delivered_at": "2019-10-30T05:22:51.452Z",
"property_developers": [],
"accepts_exchange": false,
"same_property_listings": null,
"portals": [
"OLX",
"VIVAREAL",
"ZAP"
],
"olx_listing_ids": {
"sale": "1475521545"
},
"quality_score": 93,
"status": "ACTIVE",
"created_at": "2026-02-05T22:26:15.343Z",
"updated_at": "2026-10-30T05:25:23.034Z",
"advertiser": {
"id": "d7bb8114-c1b3-f8a2-9f4c-75a2b3b80d68",
"name": "Zimmermann Imóveis",
"page_id": "7305",
"profile_url": "https://www.vivareal.com.br/imobiliaria/7305/",
"license_number": "15319-J-SP",
"phones": [
"[trimmed-depth]",
"[trimmed-depth]"
],
"phone_primary": "1155551000",
"phone_mobile": "11941934662",
"whatsapp": "[redacted-phone]",
"website": "http://www.zimoveis.com.br/ dev.zimoveis.com.br zimoveis.com.br",
"logo": "https://resizedimgs.vivareal.com/img/vr-listing/8b3e0a78aa9aaa81e510b5632a613082/imagem.webp?action=fit-in&dimension=400x400",
"tier": "diamond",
"created_at": "2018-03-27T14:34:17Z",
"chat_enabled": true,
"verified": null,
"super_advertiser": null,
"virtual_assistant": false,
"concierge": null,
"address_shown": true,
"address": {
"street": "[trimmed-depth]",
"number": "[trimmed-depth]",
"complement": "[trimmed-depth]",
"neighborhood": "[trimmed-depth]",
"city": "[trimmed-depth]",
"state": "[trimmed-depth]",
"zip_code": "[trimmed-depth]"
},
"legacy_zap_id": 5508,
"legacy_vivareal_id": 7305
},
"units": []
},
{
"id": "2914262397",
"url": "https://www.vivareal.com.br/imoveis-lancamentos/living-full-eldorado-fase-2-id-2914262397/",
"title": "LIVING FULL ELDORADO - FASE 2",
"headline": "LIVING FULL ELDORADO - FASE 2",
"business": [
"sale"
],
"listing_type": "new_development",
"property_type": "apartment",
"unit_types": [
"APARTMENT"
],
"unit_sub_types": [],
"usage": "residential",
"prices": {
"currency": "BRL",
"sale_price_brl": 457703,
"sale_price_max_brl": 667346,
"rent_price_brl": null,
"rent_price_max_brl": null,
"rent_total_brl": null,
"condo_fee_brl": null,
"iptu_brl": null,
"iptu_period": null,
"rental_period": null,
"rental_guarantees": []
},
"show_price": true,
"price_per_m2_brl": null,
"usable_area_m2": 25,
"usable_area_m2_max": 37,
"total_area_m2": 37,
"total_area_m2_max": 55,
"bedrooms": 1,
"bedrooms_max": 2,
"bathrooms": 1,
"bathrooms_max": null,
"suites": 0,
"suites_max": null,
"parking_spaces": 0,
"parking_spaces_max": null,
"floor": null,
"building_floors": null,
"units_per_floor": null,
"buildings": null,
"address": {
"street": "Rua Butantã",
"number": "153",
"complement": null,
"neighborhood": "Pinheiros",
"zone": "Zona Oeste",
"city": "São Paulo",
"state": "São Paulo",
"state_code": "SP",
"zip_code": "05424140",
"country": "BR",
"location_id": "BR>Sao Paulo>NULL>Sao Paulo>Zona Oeste>Pinheiros",
"latitude": -23.568924,
"longitude": -46.696988,
"point_is_approximate": null,
"display_latitude": -23.568924,
"display_longitude": -46.696988,
"precision": "ROOFTOP",
"address_shown": "all"
},
"nearby_transit": null,
"points_of_interest": [
{
"kind": "[trimmed-depth]",
"code": "[trimmed-depth]",
"name": "[trimmed-depth]"
},
{
"kind": "[trimmed-depth]",
"code": "[trimmed-depth]",
"name": "[trimmed-depth]"
},
{
"kind": "[trimmed-depth]",
"code": "[trimmed-depth]",
"name": "[trimmed-depth]"
}
],
"amenities": [
{
"code": "[trimmed-depth]",
"label": "[trimmed-depth]"
},
{
"code": "[trimmed-depth]",
"label": "[trimmed-depth]"
},
{
"code": "[trimmed-depth]",
"label": "[trimmed-depth]"
}
],
"amenities_detected": [
{
"code": "[trimmed-depth]",
"label": "[trimmed-depth]"
},
{
"code": "[trimmed-depth]",
"label": "[trimmed-depth]"
},
{
"code": "[trimmed-depth]",
"label": "[trimmed-depth]"
}
],
"description": "Oportunidade para morar ou investir em Pinheiros (Rua Butantã)! A apenas 400m da Estação Faria Lima e próximo ao Shopping Eldorado. Studios, 1 e 2 dorms (24m² a 37m²) com varanda integrada e acabamento acústico. Lazer focado em wellness com piscina, sauna infravermelha, beach arena, academia Matrix, coworking e lavanderia. Altíssima demanda de locação na região mais valorizada da Zona Oeste. Garanta sua unidade no lançamento!",
"photos": [
"https://resizedimgs.vivareal.com/img/vr-listing/2c3a2fff74bf5077d18536523dfb67c9/imagem.webp?action=fit-in&dimension=1920x1080",
"https://resizedimgs.vivareal.com/img/vr-listing/1e30df8fd200206dfab3e2ae0f560a4d/imagem.webp?action=fit-in&dimension=1920x1080",
"https://resizedimgs.vivareal.com/img/vr-listing/d5363d79a6db4bbec2897607c22dbb75/imagem.webp?action=fit-in&dimension=1920x1080"
],
"videos": [],
"floor_plans": [],
"virtual_tours": [],
"photo_count": 12,
"virtual_tour_url": null,
"publication_type": "STANDARD",
"promoted": true,
"promotion": "FIXED DEVELOPMENTS POSITIONS",
"stamps": [],
"below_market": false,
"advertiser_type": "property_developer",
"external_id": "30056526",
"condominium_name": "LIVING FULL ELDORADO - FASE 2",
"construction_status": "planned",
"construction_timeline": [
{
"date": "[trimmed-depth]",
"status": "[trimmed-depth]"
},
{
"date": "[trimmed-depth]",
"status": "[trimmed-depth]"
},
{
"date": "[trimmed-depth]",
"status": "[trimmed-depth]"
}
],
"delivered_at": null,
"property_developers": [
{
"name": "[trimmed-depth]",
"logo": "[trimmed-depth]"
}
],
"accepts_exchange": false,
"same_property_listings": null,
"portals": [
"OLX",
"VIVAREAL",
"ZAP"
],
"olx_listing_ids": {
"sale": "1538833934"
},
"quality_score": 77.8,
"status": "ACTIVE",
"created_at": "2026-09-25T17:06:05.326Z",
"updated_at": "2026-11-03T23:02:44.958Z",
"advertiser": {
"id": "a556450c-b93c-d68f-a849-09dabe9e1330",
"name": "Bom Negocio Atividades De Internet Ltda",
"page_id": "856599",
"profile_url": "https://www.vivareal.com.br/imobiliaria/856599/",
"license_number": null,
"phones": [
"[trimmed-depth]"
],
"phone_primary": "1122222222",
"phone_mobile": "1122222222",
"whatsapp": null,
"website": null,
"logo": null,
"tier": null,
"created_at": "2025-03-12T11:42:11Z",
"chat_enabled": null,
"verified": null,
"super_advertiser": null,
"virtual_assistant": null,
"concierge": null,
"address_shown": false,
"address": null,
"legacy_zap_id": 0,
"legacy_vivareal_id": 856599
},
"units": [
{
"id": "[trimmed-depth]",
"url": "[trimmed-depth]",
"title": "[trimmed-depth]",
"status": "[trimmed-depth]",
"usable_area_m2": "[trimmed-depth]",
"usable_area_m2_max": "[trimmed-depth]",
"total_area_m2": "[trimmed-depth]",
"total_area_m2_max": "[trimmed-depth]",
"bedrooms": "[trimmed-depth]",
"bedrooms_max": "[trimmed-depth]",
"bathrooms": "[trimmed-depth]",
"bathrooms_max": "[trimmed-depth]",
"suites": "[trimmed-depth]",
"suites_max": "[trimmed-depth]",
"parking_spaces": "[trimmed-depth]",
"parking_spaces_max": "[trimmed-depth]",
"prices": "[trimmed-depth]",
"property_type": "[trimmed-depth]"
},
{
"id": "[trimmed-depth]",
"url": "[trimmed-depth]",
"title": "[trimmed-depth]",
"status": "[trimmed-depth]",
"usable_area_m2": "[trimmed-depth]",
"usable_area_m2_max": "[trimmed-depth]",
"total_area_m2": "[trimmed-depth]",
"total_area_m2_max": "[trimmed-depth]",
"bedrooms": "[trimmed-depth]",
"bedrooms_max": "[trimmed-depth]",
"bathrooms": "[trimmed-depth]",
"bathrooms_max": "[trimmed-depth]",
"suites": "[trimmed-depth]",
"suites_max": "[trimmed-depth]",
"parking_spaces": "[trimmed-depth]",
"parking_spaces_max": "[trimmed-depth]",
"prices": "[trimmed-depth]",
"property_type": "[trimmed-depth]"
}
]
},
{
"id": "2612540897",
"url": "https://www.vivareal.com.br/imovel/cobertura-3-quartos-pinheiros-zona-oeste-sao-paulo-com-garagem-100m2-venda-RS1800000-id-2612540897/",
"title": "Apartamento para venda possui 100 metros quadrados com 2 quartos",
"headline": "Cobertura com 3 Quartos à venda, 100m²",
"business": [
"sale"
],
"listing_type": "used",
"property_type": "penthouse",
"unit_types": [
"APARTMENT"
],
"unit_sub_types": [
"PENTHOUSE",
"DUPLEX"
],
"usage": "residential",
"prices": {
"currency": "BRL",
"sale_price_brl": 1800000,
"sale_price_max_brl": null,
"rent_price_brl": null,
"rent_price_max_brl": null,
"rent_total_brl": null,
"condo_fee_brl": 1650,
"iptu_brl": 644,
"iptu_period": null,
"rental_period": null,
"rental_guarantees": []
},
"show_price": true,
"price_per_m2_brl": 18000,
"usable_area_m2": 100,
"usable_area_m2_max": null,
"total_area_m2": 100,
"total_area_m2_max": null,
"bedrooms": 3,
"bedrooms_max": null,
"bathrooms": 2,
"bathrooms_max": null,
"suites": 1,
"suites_max": null,
"parking_spaces": 1,
"__trimmed": "response capped for page display"
}
],
"__trimmed": "response capped for page display"
},
"__trimmed": "response capped for page display"
}What the VivaReal (Brazil) API does
| Action | Description | Concrete use case | Key params |
|---|---|---|---|
| locations | Look up Brazilian places by name and get the location ids the search actions accept: cities, neighbourhoods, zones (e.g. Zona Sul) and streets, with coordinates and the site's own sale / rent links. | Real-estate investors call locations to look up Brazilian places by name and get the location ids the search actions accept. | query, type, limit |
| search | Search VivaReal listings for sale or rent in a place (or around a point / inside a map box) with every filter and sort the site offers. 30 listings per page, pages 1-50 (the site's own ceiling of 1,500 results; `total` is the full count). Used (resale / rental) listings; new developments are the `developments` action. | Brokerage tools call search to search VivaReal listings for sale or rent in a place (or around a point / inside a map box) w…. | location, latitude, longitude, radius_km, north, ... |
| developments | New developments (lançamentos) for sale: projects with their price-from, unit sizes and bedroom ranges, construction stage and developer, in a place or around a point, with the site's filters. 30 per page, pages 1-50. | Property dashboards call developments to get new developments (lançamentos) for sale. | location, latitude, longitude, radius_km, north, ... |
| count | Count the listings that match a place and filters (without fetching them), with the number of matching listings per amenity (pool, gym, elevator, pets allowed…). | Lead-generation teams call count to get count the listings that match a place and filters (without fetching them), with the number of…. | location, latitude, longitude, radius_km, north, ... |
| listing | Everything VivaReal publishes about one listing: sale price / rent, condo fee, IPTU, rent total, accepted rental guarantees, usable and total area, bedrooms, suites, bathrooms, parking, floor, amenities, the full description, every photo, video and floor plan, the address and coordinates as published, nearby metro / train stations and points of interest, construction stage and timeline, the units of a development, and the advertiser (name, CRECI, phones, WhatsApp, website, profile). | Real-estate investors call listing to get everything VivaReal publishes about one listing. | listing |
| price_insights | The site's own price statistics for a city or neighbourhood: number of listings, average price, average area, average price per m², listings per price band, a short description of the area, and nearby neighbourhoods with their averages and % difference. | Brokerage tools call price_insights to get the site's own price statistics for a city or neighbourhood. | location, business, property_type |
| agency | A real-estate agency / advertiser profile: name, CRECI licence, phones, address, website, logo, tier, the rating and official-store text its VivaReal page carries, and how many listings it has for sale and for rent. | Property dashboards call agency to get a real-estate agency / advertiser profile. | agency |
| agency_listings | Every live listing of one agency / advertiser, for sale or for rent, with the same filters and sorts as `search`. 30 per page, pages 1-50. | Lead-generation teams call agency_listings to get every live listing of one agency / advertiser, for sale or for rent, with the same filters an…. | agency, business, listing_type, location, sort, ... |
| condominiums | Find condominium buildings (condomínios) by name and get the id the `condominium` action accepts. | Real-estate investors call condominiums to find condominium buildings (condomínios) by name and get the id the `condominium` action acce…. | query, limit |
| condominium | One condominium building as its VivaReal page shows it: address and coordinates, building amenities, area range, bedroom / bathroom / parking maxima, sale and rent price-from, and the listings inside it (5 per page, the page's own size) for sale or for rent. | Brokerage tools call condominium to get one condominium building as its VivaReal page shows it. | condominium, business, page |
| developers | VivaReal's directory of property developers (incorporadoras / construtoras) that advertise new developments on the site: name, office address, number of active listings, the year they started advertising, and the id the `developer` action accepts. 16 per page, in the directory's own (alphabetical) order; `total` is the directory's own count. | Property dashboards call developers to get vivaReal's directory of property developers (incorporadoras / construtoras) that advertise ne…. | page |
| developer | One property developer (incorporadora) as its VivaReal page shows it: name, office address, phone, logo, website and licence from its advertiser record, and every development the page lists (price-from and price-to, unit sizes, bedrooms, construction stage, address and coordinates, amenities, photos, description) — the page shows them all at once (no paging measured). | Lead-generation teams call developer to get one property developer (incorporadora) as its VivaReal page shows it. | developer |
Call search from your stack
curl -X POST https://api.reefapi.com/vivareal/v1/search \
-H "x-api-key: $REEF_KEY" \
-H "content-type: application/json" \
-d '{"location":"Pinheiros, São Paulo"}'import os
import requests
REEF_KEY = os.environ["REEF_KEY"]
r = requests.post(
"https://api.reefapi.com/vivareal/v1/search",
headers={"x-api-key": REEF_KEY},
json={
"location": "Pinheiros, São Paulo"
},
timeout=90,
)
print(r.json()["data"])const res = await fetch("https://api.reefapi.com/vivareal/v1/search", {
method: "POST",
headers: {
"x-api-key": process.env.REEF_KEY,
"content-type": "application/json",
},
body: JSON.stringify({
"location": "Pinheiros, São Paulo"
}),
});
const { ok, data, meta, error } = await res.json();Ask your MCP-connected assistant: call reefapi.vivareal.search with {"location":"Pinheiros, São Paulo"}.Who uses this API and why
- Track asking prices, rents, condo fees and IPTU per neighbourhood in Brazilian cities.
- Build a lead list of real-estate agencies with CRECI, phones, WhatsApp and live listing counts.
- Monitor new listings in a search with sort=newest and alert on matches.
- Map every development of a property developer, with prices, unit sizes and construction stage.
- Compare a neighbourhood's average price per m² with the ones around it.
Questions developers ask before integrating
Do I need a VivaReal account?
No. Everything is read logged out.
Which filters can I use?
Price (or rent; for rentals optionally rent + condo fee), condo fee, bedrooms, bathrooms and parking spaces (exact counts or a minimum, 4 meaning 4 or more), usable and total area, 24 property types, 210 amenities, the 'Ótimo preço' badge, the running seasonal campaign, virtual tour, near metro or train, rent without guarantor, seasonal rent, owner-only, keyword and the advertiser's reference code. In Pinheiros, São Paulo, 23,141 listings were for sale on 2026-11-16: apartments 15,898, at least 3 bedrooms 6,003, up to R$ 800,000 6,858, with a pool 10,096, 'Ótimo preço' 2,788, in the Festival da Mudança campaign 989, by owner 46.
Can I search a whole state, or a map area?
Yes. A state name or code searches the whole state (Minas Gerais: 7,655 farms for sale; SP: 31,365 warehouses). A point with radius_km (2 km around Pinheiros: 34,703 for sale) or a box with north, south, east and west (17,049) works too, and several places can be searched together: 'Pinheiros, São Paulo | Perdizes, São Paulo' gave 41,816.
Can I paste a VivaReal search link?
Yes. The place, sale or rent and property type come from the link's path and the other filters from its query (quartos, precoMaximo, amenities, ordem…). The Copacabana 2-bedroom rental apartments link counted 139, the same number its page printed.
How deep can I page?
30 listings per page, pages 1 to 50: the site serves the first 1,500 results of any search, and asking for page 51 is refused by the site itself. total always carries the full count (757,627 listings for sale in São Paulo city), so narrow the filters or the place to reach the rest. Paging with sort=newest gave 90 different listings on pages 1 to 3.
Do I get the agent's phone number and CRECI?
Yes, as the advertiser publishes them: phone numbers on 299 of 299 search rows, WhatsApp on 230, the CRECI licence on 138 and the verified badge on 117. agency adds the agency's address, website, rating and how many listings it has for sale and for rent.
Does it cover new developments and the developers behind them?
Yes. developments returns them with construction stage (planned, under construction, ready), the developer, price-from and area and bedroom ranges; São Paulo had 973 on 2026-11-16 (77 planned, 521 under construction, 374 ready). developers lists the site's directory of 133 property developers, and developer returns one developer's profile with every development its page lists, all at once (Abyara 73).
Is there price history?
No. VivaReal does not publish a listing's past prices to logged-out visitors, so the API does not return any. price_insights returns the site's current averages per city or neighbourhood instead.
What is the VivaReal (Brazil) API?
VivaReal (Brazil) API is a ReefAPI endpoint group for brazilian homes for sale and rent on vivareal.com.br: every site filter, full listings with condo fee and iptu, the agent's creci and phones, price statistics, condominiums and property developers. It returns live JSON through POST requests under /vivareal/v1.
Is the VivaReal (Brazil) API free to try?
Yes. ReefAPI starts with 1,000 free credits, no card required. VivaReal (Brazil) calls use the same shared credit balance as every other ReefAPI engine.
Do I need a VivaReal (Brazil) login or account?
No login to VivaReal (Brazil) is needed for the API response. You call ReefAPI with your x-api-key header, and the playground can run live examples before you create a production key.
How fresh is the VivaReal (Brazil) data?
The page example is captured from a live locations call, and production requests fetch live data through ReefAPI rather than a static sample.
How many credits does the VivaReal (Brazil) API use?
VivaReal (Brazil) actions currently cost 1-2 credits per successful call. Failed or blocked calls are free. All APIs draw from one credit pool.
Can I call VivaReal (Brazil) from an AI assistant or MCP client?
Yes. Connect ReefAPI once through MCP and your assistant can call vivareal actions with the same key, credit pool and JSON envelope used by normal REST requests.