vivareal.com.br

VivaReal API

Query public VivaReal data with GeckoAPI and receive structured JSON. Choose an operation to review its inputs, credit cost and response fields.

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

Try VivaReal in the sandbox Read the API reference

GeckoAPI is independent of VivaReal. This integration reads public data; it does not grant access to private accounts or account management operations.

Available operations

Get listing details

vivareal.com.br:klp

Search VivaReal autocomplete suggestions by keyword (KLP — Keyword List Page), returning the original JSON in data. Costs 1 credit per successful request.

1 credit per request

Documentation Try this operation

Search listings

vivareal.com.br:plp

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

1 credit per request

Documentation Try this operation

Get listing details

vivareal.com.br:pdp

Extracts all relevant details of a property or project from VivaReal, including status, prices, attributes, address, advertiser, media, plans, units and construction data.

1 credit per request

Documentation Try this operation

These are standard credit costs. Account-specific pricing is shown in the dashboard. Each operation has its own supported inputs and regional coverage.

Make your first request

The example uses search listings. Replace YOUR_API_KEY with your server-side API key. Copy supported inputs from the reference for the operation you choose.

VivaReal · 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
}'

Example JSON response

Abbreviated example from the same operation. Arrays and nested objects are shortened here; the endpoint reference includes the full documented schema. Source content retains its original language.

Abbreviated response

{
  "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
    },
    "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"
        ]
      }
    ]
  }
}

Explore the full response and field descriptions

Integrate with REST or MCP

Call POST /v1/extract from your backend, or use the operation-specific tool on POST /v1/mcp. The API reference includes both request formats. Keep credentials in your backend and handle missing fields, pagination and errors according to that operation's rules.

Authentication and getting started

Ready to test the VivaReal API?

Open the documented example in the sandbox and inspect the response before integrating it into your application.

Try the API Plans and credit pricing