Skip to content

// docs

VivaReal: Search listings

Extracts search results from VivaReal for sales, rentals and launches, with pagination, real estate filters, advertiser, prices, media and standardized attributes.

vivareal.com.br:plp · 1 credit per request

Standard credit cost. Your account pricing is shown in the sandbox.

Try this operation in the sandbox

HTTP request

cURL
curl -X POST https://api.geckoapi.com.br/v1/extract \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "target": "vivareal.com.br",
  "type": "plp",
  "businessType": "sale",
  "state": "SP",
  "city": "São Paulo",
  "neighborhood": "Vila Mariana",
  "propertyTypes": [
    "apartment",
    "penthouse"
  ],
  "amenities": [
    "pool",
    "balcony"
  ],
  "bedrooms": [
    2,
    3
  ],
  "bathrooms": [
    2
  ],
  "parkingSpots": [
    1,
    2
  ],
  "priceMin": 500000,
  "priceMax": 1200000,
  "areaMin": 70,
  "areaMax": 180,
  "sort": "biggest_area",
  "page": 1
}'

Keep your API key on your server. See the quickstart for authentication and response handling.

MCP request

The hosted MCP tool fixes target and type for this operation. Its remaining arguments use the same input rules as Extract.

POST /v1/mcp · Bearer or X-API-Key authentication

vivareal_com_br_plp · tools/call
{
  "jsonrpc": "2.0",
  "id": 3,
  "method": "tools/call",
  "params": {
    "name": "vivareal_com_br_plp",
    "arguments": {
      "businessType": "sale",
      "state": "SP",
      "city": "São Paulo",
      "neighborhood": "Vila Mariana",
      "propertyTypes": [
        "apartment",
        "penthouse"
      ],
      "amenities": [
        "pool",
        "balcony"
      ],
      "bedrooms": [
        2,
        3
      ],
      "bathrooms": [
        2
      ],
      "parkingSpots": [
        1,
        2
      ],
      "priceMin": 500000,
      "priceMax": 1200000,
      "areaMin": 70,
      "areaMax": 180,
      "sort": "biggest_area",
      "page": 1,
      "executionId": "exec_example_123"
    }
  }
}

Supported inputs

Conditional fields depend on the alternatives and constraints in the rule column. Fields marked unsupported are omitted.

FieldTypeRequirementRuleDefaultExample
url
URL extraction target. For some PLPs it can be omitted when API assembles URL from other fields.
string (URL) Conditional Submit a public URL of results from the domain vivareal.com.br or use businessType for structured search. In URL mode, all parameters are preserved, including precoMinimoCondo/precoMaximoCondo, proximoMetro, stamps=Datazap and construction filters such as type=In plan. - https://www.vivareal.com.br/venda/sp/sao-paulo/casa_residencial/?precoMaximo=1200000&proximoMetro=true&stamps=Datazap
latitude
Latitude of the search area. It must be sent together with longitude. Supported in Airbnb PLP, Zap Imóveis PLP, VivaReal PLP, Chaves na Mão PLP and Webmotors PLP.
number Optional Optional coordinate of the structured search. It must be sent together with longitude. - -25.4284
longitude
Longitude of the search area. It must be sent together with latitude. Supported in Airbnb PLP, Zap Imóveis PLP, VivaReal PLP, Chaves na Mão PLP and Webmotors PLP.
number Optional Optional coordinate of the structured search. It must be sent together with latitude. - -49.2733
city
City used in structured searches for properties and vehicles and optionally in Catho PLP. In VivaReal, it requires state.
string Optional Structured search city. When submitted, state is also required. - São Paulo
neighborhood
Neighborhood used in ZAP Properties PLP, Chaves na Mão PLP and VivaReal PLP. Requires city + state when shipped.
string Optional Structured search neighborhood. Requires city and state. - Vila Mariana
state
UF used in structured searches for properties and vehicles and optionally in Catho PLP.
string (UF 2 letters) Optional UF with 2 letters. Mandatory when city is sent. - SP
businessType
Business type used in Zapimoveis, VivaReal and Chaves na Mão PLP to choose between sale and rent.
"sale" | "rent" Conditional Required when url is not sent. Accepts sale/rent and sale/rent aliases. - sale
bedrooms
Room filter in real estate searches PLP. Accepts list of integers (ex: [2,3,4]).
integer[] Optional List of room quantities, with integers from 0 to 20. - [2,3]
bathrooms
Bathroom filter in real estate searches PLP. Accepts list of integers (ex: [2,3,4]).
integer[] Optional List of bathroom quantities, with integers from 0 to 20. - [2]
parkingSpots
Job filter in real estate searches PLP. Accepts list of integers (ex: [2,3,4]).
integer[] Optional List of vacancy quantities, with integers from 0 to 20. - [1,2]
propertyTypes
Property types for ZAP Properties, Chaves na Mão and VivaReal PLP. Accepted values depend on API; see specific rules below.
array<string | integer> Optional Structured search property types. Supported aliases include apartment, house, two_story_house, condominium, penthouse, kitnet, flat, land, farm, warehouse, commercial_point, and commercial_room. - ["apartment","penthouse"]
amenities
Amenities for Chaves na Mão and VivaReal PLP. Common aliases: pool, balcony, garden, furnished and backyard.
array<string | integer> Optional Structured search amenities. Accepts names such as pool, balcony, furnished and pets_allowed, normalized for upstream. - ["pool","balcony"]
directOwner
Direct/private advertiser filter on Chaves na Mão and VivaReal PLP.
boolean Optional When true, limits the structured search to ads with contractType OWNER. false false
condominium
Filter for condominium properties in Chaves na Mão and VivaReal PLP.
boolean Optional When true, includes the condominium unit type in the structured search. false false
includeLaunches
Controls the inclusion of entries in real estate searches PLP. In VivaReal, combines used listings and developments when true.
boolean Optional When false, the structured search restricts listingType to USED; when true, it also allows launches and ventures. false false
priceMin
Minimum price for PLP searches for properties and vehicles.
integer Optional Minimum price, integer greater than or equal to zero. - 500000
priceMax
Maximum price for PLP searches for properties and vehicles.
integer Optional Maximum price, integer greater than or equal to priceMin. - 1200000
areaMin
Minimum area (m²) for real estate searches PLP.
integer Optional Minimum usable area in m², integer and greater than or equal to zero. - 70
areaMax
Maximum area (m²) for real estate searches PLP.
integer Optional Maximum usable area in m², entire and greater than or equal to areaMin. - 180
sort
Ordering for VivaReal, Chaves na Mão, OLX and Webmotors PLP, Booking Review and Hotels Review. VivaReal: relevance/date/price/biggest_price/biggest_area. Webmotors: relevance/price/biggest_price/year_desc/mileage_asc. OLX: relevance/date/price/biggest_price/price_relevance. Booking/Hotels Review: most_relevant/newest_first/oldest_first/score_desc/score_asc.
"relevance" | "date" | "price" | "biggest_price" | "biggest_area" | "price_relevance" | "most_relevant" | "newest_first" | "oldest_first" | "score_desc" | "score_asc" | "year_desc" | "mileage_asc" Optional Structured search ordering: relevance, date, price, biggest_price or biggest_area. relevance biggest_area
target
Target source for extraction.
enum Required Always required and must be vivareal.com.br. - vivareal.com.br
type
Extraction type: pdp, idp, plp, ilp, quote, review or places.
enum Required Always required and must be plp. - plp
page
Pagination. In PLP, including Trivago, and in Reclame AQUI ILP starts in 1; in review (MercadoLivre, Booking and Hotels) starts in 0. The Reclame AQUI ILP even accepts the page 100.
integer Optional Page 1-based, between 1 and 500. In URL mode, it overwrites the page parameter. 1 1

Request examples

Structured search with filters

Recommended flow: send businessType and the desired filters. Location is optional; city requires state and neighborhood requires city + state.

Structured search with filters
{
  "target": "vivareal.com.br",
  "type": "plp",
  "businessType": "sale",
  "state": "SP",
  "city": "São Paulo",
  "neighborhood": "Vila Mariana",
  "propertyTypes": [
    "apartment",
    "penthouse"
  ],
  "amenities": [
    "pool",
    "balcony"
  ],
  "bedrooms": [
    2,
    3
  ],
  "bathrooms": [
    2
  ],
  "parkingSpots": [
    1,
    2
  ],
  "priceMin": 500000,
  "priceMax": 1200000,
  "areaMin": 70,
  "areaMax": 180,
  "sort": "biggest_area",
  "page": 1
}

Search for public URL

Send a results URL to preserve the navigation and filters exposed by VivaReal. page can overwrite URL's page.

Search for public URL
{
  "target": "vivareal.com.br",
  "type": "plp",
  "url": "https://www.vivareal.com.br/venda/sp/sao-paulo/casa_residencial/?precoMaximo=1200000&proximoMetro=true&stamps=Datazap",
  "page": 2
}

Launches with advanced filters from URL

URL is the way to preserve advanced interface filters, such as condominium, proximity to the subway, below-market seal and construction stage.

Launches with advanced filters from URL
{
  "target": "vivareal.com.br",
  "type": "plp",
  "url": "https://www.vivareal.com.br/imoveis-lancamento/sao-paulo/apartamento_residencial/status-na-planta/?precoMinimo=300000&precoMaximo=1200000&precoMinimoCondo=100&precoMaximoCondo=1500&proximoMetro=true&stamps=Datazap&tipo=Na+planta",
  "page": 1
}

Response schema

Leaf paths and expected types. Field names and enum values are part of the API contract.

responseSchema
{
  "requestId": "string (uuid)",
  "executionId": "string (uuid)",
  "notFound": "boolean (optional; true only when upstream reports a missing entity and data is null)",
  "data.source": "\"vivareal.com.br\"",
  "data.type": "\"plp\"",
  "data.parser": "\"1.0.0\"",
  "data.url": "string (standardized public URL)",
  "data.responseUrl": "string (final URL after redirects)",
  "data.apiUrl": "string | null",
  "data.extractedAt": "string (ISO datetime)",
  "data.searchId": "string | null",
  "data.meta": "object | null",
  "data.meta.title": "string | null",
  "data.meta.description": "string | null",
  "data.meta.robots": "string | null",
  "data.meta.primaryHeading": "string | null",
  "data.filters": "object",
  "data.filters.businessType": "\"sale\" | \"rent\"",
  "data.filters.state": "string | null",
  "data.filters.stateName": "string | null",
  "data.filters.city": "string | null",
  "data.filters.neighborhood": "string | null",
  "data.filters.propertyTypes[]": "string",
  "data.filters.amenities[]": "string",
  "data.filters.bedrooms[]": "integer",
  "data.filters.bathrooms[]": "integer",
  "data.filters.parkingSpots[]": "integer",
  "data.filters.priceMin": "integer | null",
  "data.filters.priceMax": "integer | null",
  "data.filters.areaMin": "integer | null",
  "data.filters.areaMax": "integer | null",
  "data.filters.sort": "string",
  "data.filters.directOwner": "boolean",
  "data.filters.condominium": "boolean",
  "data.filters.includeLaunches": "boolean",
  "data.filters.latitude": "number | null",
  "data.filters.longitude": "number | null",
  "data.filters.page": "integer",
  "data.totalResults": "integer",
  "data.primaryResults": "integer",
  "data.page": "integer",
  "data.resultsPerPage": "integer",
  "data.offset": "integer",
  "data.nextPage": "integer | null",
  "data.nextPageUrl": "string | null",
  "data.facets": "array<object>",
  "data.items[].position": "integer | null",
  "data.items[].id": "string | null",
  "data.items[].sourceId": "string | null",
  "data.items[].externalId": "string | null",
  "data.items[].legacyId": "string | null",
  "data.items[].title": "string | null",
  "data.items[].description": "string | null",
  "data.items[].url": "string | null",
  "data.items[].businessType": "string | null",
  "data.items[].listingType": "string | null",
  "data.items[].propertyType": "string | null",
  "data.items[].unitTypes[]": "string",
  "data.items[].unitSubTypes[]": "string",
  "data.items[].usageTypes[]": "string",
  "data.items[].contractType": "string | null",
  "data.items[].publicationType": "string | null",
  "data.items[].status": "string | null",
  "data.items[].nonActivationReason": "string | null",
  "data.items[].constructionStatus": "string | null",
  "data.items[].condominiumName": "string | null",
  "data.items[].createdAt": "string | null",
  "data.items[].updatedAt": "string | null",
  "data.items[].prices[].businessType": "string | null",
  "data.items[].prices[].value": "number | null",
  "data.items[].prices[].condominium": "number | null",
  "data.items[].prices[].iptu": "number | null",
  "data.items[].prices[].iptuPeriod": "string | null",
  "data.items[].prices[].rentalPeriod": "string | null",
  "data.items[].prices[].multiple": "boolean | null",
  "data.items[].attributes.usableAreas[]": "number",
  "data.items[].attributes.totalAreas[]": "number",
  "data.items[].attributes.bedrooms[]": "number",
  "data.items[].attributes.bathrooms[]": "number",
  "data.items[].attributes.suites[]": "number",
  "data.items[].attributes.parkingSpaces[]": "number",
  "data.items[].attributes.floors[]": "number",
  "data.items[].attributes.unitFloor": "integer | null",
  "data.items[].attributes.unitsOnTheFloor": "integer | null",
  "data.items[].attributes.ceilingHeights[]": "number",
  "data.items[].attributes.capacityLimits[]": "number",
  "data.items[].address": "object | null",
  "data.items[].address.country": "string | null",
  "data.items[].address.state": "string | null",
  "data.items[].address.stateAcronym": "string | null",
  "data.items[].address.city": "string | null",
  "data.items[].address.zone": "string | null",
  "data.items[].address.neighborhood": "string | null",
  "data.items[].address.street": "string | null",
  "data.items[].address.streetNumber": "string | null",
  "data.items[].address.zipCode": "string | null",
  "data.items[].address.fullAddress": "string | null",
  "data.items[].address.locationId": "string | null",
  "data.items[].address.displayType": "string | null",
  "data.items[].address.approximate": "boolean | null",
  "data.items[].address.coordinates.latitude": "number",
  "data.items[].address.coordinates.longitude": "number",
  "data.items[].address.nearby": "object | null",
  "data.items[].amenities[]": "string",
  "data.items[].mergedAmenities[]": "string",
  "data.items[].aiAmenities[]": "string",
  "data.items[].stamps[]": "string",
  "data.items[].flags": "record<string, string>",
  "data.items[].advertiser.id": "string | null",
  "data.items[].advertiser.legacyId": "string | null",
  "data.items[].advertiser.name": "string | null",
  "data.items[].advertiser.url": "string | null",
  "data.items[].advertiser.tier": "string | null",
  "data.items[].advertiser.license": "string | null",
  "data.items[].advertiser.createdAt": "string | null",
  "data.items[].advertiser.verified": "boolean | null",
  "data.items[].advertiser.listingsCount": "integer | null",
  "data.items[].advertiser.rating": "number | null",
  "data.items[].advertiser.imageUrl": "string | null",
  "data.items[].advertiser.websiteUrl": "string | null",
  "data.items[].advertiser.phoneNumbers[]": "string",
  "data.items[].advertiser.whatsappNumber": "string | null",
  "data.items[].advertiser.addresses": "object | null",
  "data.items[].media[].id": "string | null",
  "data.items[].media[].type": "string | null",
  "data.items[].media[].url": "string | null",
  "data.items[].media[].alt": "string | null",
  "data.items[].media[].seo": "boolean | null",
  "data.items[].videos": "array<media>",
  "data.items[].floorPlans": "array<media>",
  "data.items[].propertyDevelopers": "array<developer>",
  "data.items[].children": "array<VivaRealListing>",
  "data.items[].showPrice": "boolean | null",
  "data.items[].acceptExchange": "boolean | null",
  "data.items[].resale": "boolean | null",
  "data.items[].transacted": "boolean | null",
  "data.items[].uniqueUnit": "boolean | null",
  "data.items[].noWarrantorRent": "boolean | null",
  "data.items[].enhancedDevelopment": "boolean | null",
  "data.items[].tripleBundle": "boolean | null",
  "data.items[].videoTourUrl": "string | null",
  "data.items[].whatsappNumber": "string | null",
  "data.items[].decoratedVisitCalendar": "array<object>",
  "data.items[].constructionStatusCalendar": "array<object>"
}

Example response

Illustrative response. Product names, reviews and other source content retain their original language. Missing and null values do not imply zero stock, free shipping or zero reviews.

responseExample
{
  "requestId": "4c22d970-a1d0-4d3f-a688-c128e2f97301",
  "executionId": "4c22d970-a1d0-4d3f-a688-c128e2f97302",
  "data": {
    "source": "vivareal.com.br",
    "type": "plp",
    "parser": "1.0.0",
    "url": "https://www.vivareal.com.br/venda/sp/sao-paulo/vila-mariana/apartamento_residencial/?quartos=2%2C3&precoMinimo=500000&precoMaximo=1200000&areaMinima=70&areaMaxima=180&ordem=BIGGEST_AREA",
    "responseUrl": "https://glue-api.vivareal.com/v2/listings?business=SALE&addressCity=Sao+Paulo&page=1&size=30",
    "apiUrl": "https://glue-api.vivareal.com/v2/listings?business=SALE&addressCity=Sao+Paulo&addressState=Sao+Paulo&unitTypes=APARTMENT&page=1&size=30",
    "extractedAt": "2026-07-12T15:40:00.000Z",
    "searchId": "vr-search-7b8f2b",
    "meta": {
      "title": "Apartamentos à venda em Vila Mariana, São Paulo",
      "description": "Apartamentos à venda em Vila Mariana com fotos, preços e detalhes.",
      "robots": "index,follow",
      "primaryHeading": "Apartamentos à venda em Vila Mariana"
    },
    "filters": {
      "businessType": "sale",
      "state": "SP",
      "stateName": "São Paulo",
      "city": "São Paulo",
      "neighborhood": "Vila Mariana",
      "propertyTypes": [
        "apartment"
      ],
      "amenities": [
        "POOL",
        "BALCONY"
      ],
      "bedrooms": [
        2,
        3
      ],
      "bathrooms": [
        2
      ],
      "parkingSpots": [
        1,
        2
      ],
      "priceMin": 500000,
      "priceMax": 1200000,
      "areaMin": 70,
      "areaMax": 180,
      "sort": "biggest_area",
      "directOwner": false,
      "condominium": false,
      "includeLaunches": false,
      "latitude": -23.5892,
      "longitude": -46.6344,
      "page": 1
    },
    "totalResults": 1842,
    "primaryResults": 30,
    "page": 1,
    "resultsPerPage": 30,
    "offset": 0,
    "nextPage": 2,
    "nextPageUrl": "https://www.vivareal.com.br/venda/sp/sao-paulo/vila-mariana/apartamento_residencial/?pagina=2",
    "facets": [
      {
        "name": "unitTypes",
        "value": [
          "APARTMENT",
          "PENTHOUSE"
        ]
      }
    ],
    "items": [
      {
        "position": 1,
        "id": "2787552284",
        "sourceId": "VR-SP-2787552284",
        "externalId": "CA12345",
        "legacyId": "987654321",
        "title": "Apartamento com 3 quartos e varanda na Vila Mariana",
        "description": "Apartamento bem iluminado, com lazer completo e duas vagas.",
        "url": "https://www.vivareal.com.br/imovel/apartamento-3-quartos-vila-mariana-sao-paulo-com-garagem-112m2-venda-RS980000-id-2787552284/",
        "businessType": "SALE",
        "listingType": "USED",
        "propertyType": "UNIT",
        "unitTypes": [
          "APARTMENT"
        ],
        "unitSubTypes": [
          "STANDARD"
        ],
        "usageTypes": [
          "RESIDENTIAL"
        ],
        "contractType": "BROKER",
        "publicationType": "PREMIUM",
        "status": "ACTIVE",
        "nonActivationReason": "NONE",
        "constructionStatus": "BUILT",
        "condominiumName": "Residencial Vila Verde",
        "createdAt": "2026-05-10T12:30:00.000Z",
        "updatedAt": "2026-07-11T18:45:00.000Z",
        "prices": [
          {
            "businessType": "SALE",
            "value": 980000,
            "condominium": 780,
            "iptu": 2650,
            "iptuPeriod": "YEARLY",
            "rentalPeriod": "MONTHLY",
            "multiple": false
          }
        ],
        "attributes": {
          "usableAreas": [
            112
          ],
          "totalAreas": [
            145
          ],
          "bedrooms": [
            3
          ],
          "bathrooms": [
            2
          ],
          "suites": [
            1
          ],
          "parkingSpaces": [
            2
          ],
          "floors": [
            14
          ],
          "unitFloor": 8,
          "unitsOnTheFloor": 4,
          "ceilingHeights": [
            2.7
          ],
          "capacityLimits": [
            6
          ]
        },
        "address": {
          "country": "Brasil",
          "state": "São Paulo",
          "stateAcronym": "SP",
          "city": "São Paulo",
          "zone": "Zona Sul",
          "neighborhood": "Vila Mariana",
          "street": "Rua Domingos de Morais",
          "streetNumber": "1200",
          "zipCode": "04010000",
          "fullAddress": "Rua Domingos de Morais, Vila Mariana, São Paulo - SP",
          "locationId": "BR-SAO-PAULO-VILA-MARIANA",
          "displayType": "ALL",
          "approximate": false,
          "coordinates": {
            "latitude": -23.5892,
            "longitude": -46.6344
          },
          "nearby": {
            "subway": "Vila Mariana",
            "distanceMeters": 450
          }
        },
        "amenities": [
          "POOL",
          "BALCONY",
          "ELEVATOR"
        ],
        "mergedAmenities": [
          "POOL",
          "BALCONY",
          "GYM"
        ],
        "aiAmenities": [
          "NATURAL_LIGHT",
          "OPEN_VIEW"
        ],
        "stamps": [
          "Datazap"
        ],
        "flags": {
          "FEATURED": "true"
        },
        "advertiser": {
          "id": "55123",
          "legacyId": "179386",
          "name": "Imobiliária Exemplo",
          "url": "https://www.vivareal.com.br/imobiliaria/imobiliaria-exemplo-55123/",
          "tier": "PREMIUM",
          "license": "CRECI J-12345-SP",
          "createdAt": "2018-03-09T10:00:00.000Z",
          "verified": true,
          "listingsCount": 169,
          "rating": 4.7,
          "imageUrl": "https://resizedimgs.vivareal.com/fit-in/900x900/vr.images.sp/logo.webp",
          "websiteUrl": "https://www.imobiliaria-exemplo.com.br/",
          "phoneNumbers": [
            "1130001000"
          ],
          "whatsappNumber": "11987654321",
          "addresses": {
            "city": "São Paulo",
            "state": "SP"
          }
        },
        "media": [
          {
            "id": "image-1",
            "type": "IMAGE",
            "url": "https://resizedimgs.vivareal.com/fit-in/900x900/vr.images.sp/imovel-1.webp",
            "alt": "Sala do apartamento",
            "seo": true
          }
        ],
        "videos": [],
        "floorPlans": [],
        "propertyDevelopers": [],
        "children": [],
        "showPrice": true,
        "acceptExchange": false,
        "resale": true,
        "transacted": false,
        "uniqueUnit": true,
        "noWarrantorRent": false,
        "enhancedDevelopment": false,
        "tripleBundle": false,
        "videoTourUrl": "https://tour.example.com/2787552284",
        "whatsappNumber": "11987654321",
        "decoratedVisitCalendar": [],
        "constructionStatusCalendar": []
      }
    ]
  }
}

Complete field reference

PathTypeDescriptionExample
data.apiUrl string | null URL from internal API when structured search uses Glue; may be null in page modes. https://glue-api.vivareal.com/v2/listings?business=SALE&addressCity=Sao+Paulo&addressState=Sao+Paulo&unitTypes=APARTMENT&page=1&size=30
data.extractedAt string (ISO datetime) Extraction Timestamp UTC. 2026-07-12T15:40:00.000Z
data.facets array<object> Dynamic facets returned by internal API when available. [{"name":"unitTypes","value":["APARTMENT","PENTHOUSE"]}]
data.filters object Normalized structured search filters or fragments of URI returned by VivaReal in URL mode. {"businessType":"sale","state":"SP","stateName":"São Paulo","city":"São Paulo","neighborhood":"Vila Mariana","propertyTypes":["apartment"],"amenities":["POOL","BALCONY"],"bedrooms":[2,3],"bathrooms":[2],"parkingSpots":[1,2],"priceMin":500000,"priceMax":1200000,"areaMin":70,"areaMax":180,"sort":"biggest_area","directOwner":false,"condominium":false,"includeLaunches":false,"latitude":-23.5892,"longitude":-46.6344,"page":1}
data.filters.amenities[] string Applied amenities. POOL
data.filters.areaMax integer | null Maximum usable area applied. 180
data.filters.areaMin integer | null Minimum usable area applied. 70
data.filters.bathrooms[] integer Bathroom quantities selected. 2
data.filters.bedrooms[] integer Room quantities selected. 2
data.filters.businessType "sale" | "rent" Standard business type. sale
data.filters.city string | null Search city. São Paulo
data.filters.condominium boolean Indicates condominium type inclusion. false
data.filters.directOwner boolean Indicates filter by direct advertiser. false
data.filters.includeLaunches boolean Indicates whether postings can appear. false
data.filters.latitude number | null Latitude used when searching for a point. -23.5892
data.filters.longitude number | null Longitude used in the point search. -46.6344
data.filters.neighborhood string | null Search neighborhood. Vila Mariana
data.filters.page integer Page requested. 1
data.filters.parkingSpots[] integer Number of vacancies selected. 1
data.filters.priceMax integer | null Maximum price applied. 1200000
data.filters.priceMin integer | null Minimum price applied. 500000
data.filters.propertyTypes[] string Standard property types. apartment
data.filters.sort string Standard ordering. biggest_area
data.filters.state string | null UF. SP
data.filters.stateName string | null Full state name. São Paulo
data.items[].acceptExchange boolean | null Indicates exchange acceptance. false
data.items[].address object | null Standardized address and geolocation. {"country":"Brasil","state":"São Paulo","stateAcronym":"SP","city":"São Paulo","zone":"Zona Sul","neighborhood":"Vila Mariana","street":"Rua Domingos de Morais","streetNumber":"1200","zipCode":"04010000","fullAddress":"Rua Domingos de Morais, Vila Mariana, São Paulo - SP","locationId":"BR-SAO-PAULO-VILA-MARIANA","displayType":"ALL","approximate":false,"coordinates":{"latitude":-23.5892,"longitude":-46.6344},"nearby":{"subway":"Vila Mariana","distanceMeters":450}}
data.items[].address.approximate boolean | null Indicates approximate location. false
data.items[].address.city string | null City of property. São Paulo
data.items[].address.coordinates.latitude number Latitude published. -23.5892
data.items[].address.coordinates.longitude number Published longitude. -46.6344
data.items[].address.country string | null Country of property. Brasil
data.items[].address.displayType string | null Address display policy. ALL
data.items[].address.fullAddress string | null Formatted address. Rua Domingos de Morais, Vila Mariana, São Paulo - SP
data.items[].address.locationId string | null Internal geographic identifier. BR-SAO-PAULO-VILA-MARIANA
data.items[].address.nearby object | null Points and proximity information available. {"subway":"Vila Mariana","distanceMeters":450}
data.items[].address.neighborhood string | null Neighborhood of the property. Vila Mariana
data.items[].address.state string | null Property status. São Paulo
data.items[].address.stateAcronym string | null UF of the property. SP
data.items[].address.street string | null Street when the advertisement discloses it. Rua Domingos de Morais
data.items[].address.streetNumber string | null Number when released. 1200
data.items[].address.zipCode string | null CEP of the property. 04010000
data.items[].address.zone string | null City area. Zona Sul
data.items[].advertiser.addresses object | null Advertiser's business addresses. {"city":"São Paulo","state":"SP"}
data.items[].advertiser.createdAt string | null Advertiser registration date. 2018-03-09T10:00:00.000Z
data.items[].advertiser.id string | null Advertiser identifier. 55123
data.items[].advertiser.imageUrl string | null Advertiser logo or image. https://resizedimgs.vivareal.com/fit-in/900x900/vr.images.sp/logo.webp
data.items[].advertiser.legacyId string | null Advertiser's legacy identifier. 179386
data.items[].advertiser.license string | null Professional registration, such as CRECI. CRECI J-12345-SP
data.items[].advertiser.listingsCount integer | null Quantity of advertiser ads. 169
data.items[].advertiser.name string | null Advertiser name. Imobiliária Exemplo
data.items[].advertiser.phoneNumbers[] string Published telephone numbers. 1130001000
data.items[].advertiser.rating number | null Advertiser's note when displayed. 4.7
data.items[].advertiser.tier string | null Advertiser's commercial tier. PREMIUM
data.items[].advertiser.url string | null Advertiser's public page. https://www.vivareal.com.br/imobiliaria/imobiliaria-exemplo-55123/
data.items[].advertiser.verified boolean | null Indicates verified advertiser. true
data.items[].advertiser.websiteUrl string | null External website published. https://www.imobiliaria-exemplo.com.br/
data.items[].advertiser.whatsappNumber string | null WhatsApp published. 11987654321
data.items[].aiAmenities[] string Characteristics inferred in the structured payload. NATURAL_LIGHT
data.items[].amenities[] string Amenities stated in listing. POOL
data.items[].attributes.bathrooms[] number Bathroom quantities. 2
data.items[].attributes.bedrooms[] number Room quantities. 3
data.items[].attributes.capacityLimits[] number Occupancy limits when entered. 6
data.items[].attributes.ceilingHeights[] number Ceiling heights available. 2.7
data.items[].attributes.floors[] number Quantities of flooring. 14
data.items[].attributes.parkingSpaces[] number Number of vacancies. 2
data.items[].attributes.suites[] number Quantity of suites. 1
data.items[].attributes.totalAreas[] number Total available areas in m². 145
data.items[].attributes.unitFloor integer | null Unit floor. 8
data.items[].attributes.unitsOnTheFloor integer | null Units per floor. 4
data.items[].attributes.usableAreas[] number Useful areas available in m². 112
data.items[].businessType string | null Business entered in the item, such as SALE or RENTAL. SALE
data.items[].children array<VivaRealListing> Child units or variations, especially in enterprises. []
data.items[].condominiumName string | null Name of the condominium. Residencial Vila Verde
data.items[].constructionStatus string | null Construction stage for launches. BUILT
data.items[].constructionStatusCalendar array<object> Construction stage schedule. []
data.items[].contractType string | null Advertiser/contract type, such as OWNER, BROKER, or PROPERTY_DEVELOPER. BROKER
data.items[].createdAt string | null Ad creation date. 2026-05-10T12:30:00.000Z
data.items[].decoratedVisitCalendar array<object> Decorated visit schedule when available. []
data.items[].description string | null Textual description without HTML. Apartamento bem iluminado, com lazer completo e duas vagas.
data.items[].enhancedDevelopment boolean | null Indicates enriched enterprise. false
data.items[].externalId string | null Identifier defined by the advertiser or integration. CA12345
data.items[].flags record<string, string> Relevant dynamic ad flags. {"FEATURED":"true"}
data.items[].floorPlans array<media> Blueprints of the property or project. []
data.items[].id string | null Ad primary identifier. 2787552284
data.items[].legacyId string | null Legacy identifier when available. 987654321
data.items[].listingType string | null Listing type, such as USED or DEVELOPMENT. USED
data.items[].media[].alt string | null Alternative text. Sala do apartamento
data.items[].media[].id string | null Media identifier. image-1
data.items[].media[].seo boolean | null Indicates media marked for SEO. true
data.items[].media[].type string | null Media type. IMAGE
data.items[].media[].url string | null URL materialized from the image. https://resizedimgs.vivareal.com/fit-in/900x900/vr.images.sp/imovel-1.webp
data.items[].mergedAmenities[] string Amenities consolidated by VivaReal. POOL
data.items[].nonActivationReason string | null Reason for inactivation when applicable. NONE
data.items[].noWarrantorRent boolean | null Indicates rental without guarantor. false
data.items[].position integer | null Absolute position of the ad in the results. 1
data.items[].prices[].businessType string | null Business associated with price. SALE
data.items[].prices[].condominium number | null Condominium fee. 780
data.items[].prices[].iptu number | null Value of IPTU. 2650
data.items[].prices[].iptuPeriod string | null Periodicity of IPTU. YEARLY
data.items[].prices[].multiple boolean | null Indicates whether the ad represents multiple value ranges. false
data.items[].prices[].rentalPeriod string | null Rental frequency. MONTHLY
data.items[].prices[].value number | null Main value. 980000
data.items[].propertyDevelopers array<developer> Associated developers. []
data.items[].propertyType string | null Broad property category. UNIT
data.items[].publicationType string | null Ad publishing level. PREMIUM
data.items[].resale boolean | null Indicates resale property. true
data.items[].showPrice boolean | null Indicates whether the price should be displayed. true
data.items[].sourceId string | null Ad source identifier. VR-SP-2787552284
data.items[].stamps[] string Ad stamps, including Datazap when present. Datazap
data.items[].status string | null Current status of the ad. ACTIVE
data.items[].title string | null Ad title. Apartamento com 3 quartos e varanda na Vila Mariana
data.items[].transacted boolean | null Indicates property already transacted. false
data.items[].tripleBundle boolean | null Triple bundle commercial flag. false
data.items[].uniqueUnit boolean | null Indicates single unit. true
data.items[].unitSubTypes[] string Unit subtypes. STANDARD
data.items[].unitTypes[] string Unit types, such as APARTMENT or HOME. APARTMENT
data.items[].updatedAt string | null Ad update date. 2026-07-11T18:45:00.000Z
data.items[].url string | null URL absolute publicity of the advertisement or enterprise. https://www.vivareal.com.br/imovel/apartamento-3-quartos-vila-mariana-sao-paulo-com-garagem-112m2-venda-RS980000-id-2787552284/
data.items[].usageTypes[] string Residential or commercial uses. RESIDENTIAL
data.items[].videos array<media> Videos associated with the ad. []
data.items[].videoTourUrl string | null Video tour URL. https://tour.example.com/2787552284
data.items[].whatsappNumber string | null WhatsApp associated directly with the ad. 11987654321
data.meta object | null SEO metadata and results page heading. {"title":"Apartamentos à venda em Vila Mariana, São Paulo","description":"Apartamentos à venda em Vila Mariana com fotos, preços e detalhes.","robots":"index,follow","primaryHeading":"Apartamentos à venda em Vila Mariana"}
data.meta.description string | null Search description SEO. Apartamentos à venda em Vila Mariana com fotos, preços e detalhes.
data.meta.primaryHeading string | null Main heading of the results page. Apartamentos à venda em Vila Mariana
data.meta.robots string | null Page robots directive. index,follow
data.meta.title string | null Search title SEO. Apartamentos à venda em Vila Mariana, São Paulo
data.nextPage integer | null Next page number or null when finished. 2
data.nextPageUrl string | null public URL of the next page or null when finished. https://www.vivareal.com.br/venda/sp/sao-paulo/vila-mariana/apartamento_residencial/?pagina=2
data.offset integer Offset of the first item on the page. 0
data.page integer Current page, 1-based. 1
data.parser "1.0.0" Stable version of the API response format. 1.0.0
data.primaryResults integer Quantity of primary items returned on this page. 30
data.responseUrl string (final URL after redirects) URL final answered by upstream, after redirects. https://glue-api.vivareal.com/v2/listings?business=SALE&addressCity=Sao+Paulo&page=1&size=30
data.resultsPerPage integer Page size. 30
data.searchId string | null Search identifier exposed by page payload when available. vr-search-7b8f2b
data.source "vivareal.com.br" Normalized extraction source. vivareal.com.br
data.totalResults integer Total results reported by VivaReal. 1842
data.type "plp" Seam PLP listing and searching. plp
data.url string (standardized public URL) public URL corresponding to the search performed. https://www.vivareal.com.br/venda/sp/sao-paulo/vila-mariana/apartamento_residencial/?quartos=2%2C3&precoMinimo=500000&precoMaximo=1200000&areaMinima=70&areaMaxima=180&ordem=BIGGEST_AREA
executionId string (uuid) Identifier of the asynchronous execution that produced the result. 4c22d970-a1d0-4d3f-a688-c128e2f97302
notFound boolean (optional; true only when upstream reports a missing entity and data is null) Present and true when the upstream reports that the entity does not exist; in this case data is null. N/A
requestId string (uuid) Unique identifier of the request in GeckoAPI. 4c22d970-a1d0-4d3f-a688-c128e2f97301

Errors and missing data

When supported by this operation, an entity not found upstream can return HTTP 200 with data: null and notFound: true. Check the documented response fields before interpreting an empty result. Source-specific behavior and exceptions are described above.

HTTP statusError codeMeaning
400INVALID_PAYLOADInvalid JSON or a request that violates the documented validation rules.
401UNAUTHORIZEDMissing authorization or an invalid API key or token.
402INSUFFICIENT_CREDITSThe account has insufficient credits for this operation.
403FORBIDDENThe account does not have access, or the API is temporarily disabled.
409EXECUTION_CONFLICTThe execution identifier conflicts with an incompatible execution state.
429RATE_LIMIT_EXCEEDED / TOO_MANY_INFLIGHT_REQUESTSA rate limit or simultaneous request limit was exceeded.
5xxUPSTREAM_TIMEOUT / UPSTREAM_HTTP_ERROR / WORKER_FUNCTION_ERRORAn upstream, worker or gateway failure. Failed requests follow the platform refund policy.

Other VivaReal operations