APIs / Real estate / VivaReal

1 credit per call9 endpoints

VivaReal API

Get VivaReal data as structured JSON with one API key: search, advertiser, advertiser listings and count. Free credits every month.

VivaReal
GET/v1/vivareal/search?portal=ZAP&business=RENTAL&rows=5&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros&bedrooms=2&sort=BIGGEST_PRICE
curl "https://api.perceptlayer.com/v1/vivareal/search?portal=ZAP&business=RENTAL&rows=5&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros&bedrooms=2&sort=BIGGEST_PRICE" \
  -H "X-API-Key: $API_KEY"
cURL1 credit per successful call
Run this call below or from your dashboard to see a live response.

Playground

Run this API

cURLshell
curl "https://api.perceptlayer.com/v1/vivareal/search?portal=ZAP&business=RENTAL&rows=5&location_id=BR%3ESao+Paulo%3ENULL%3ESao+Paulo%3EZona+Oeste%3EPinheiros&bedrooms=2&sort=BIGGEST_PRICE" \
  -H "X-API-Key: $API_KEY"

VivaReal · 9 endpoints

Endpoints

Every endpoint takes the same key. Open one for its parameters and an example request.

EndpointRequired parametersCost
GET/v1/vivareal/advertiser
advertiser_id+1 optional
1 credit
GET/v1/vivareal/advertiser-listings
advertiser_id+4 optional
1 credit
GET/v1/vivareal/count
None+7 optional
1 credit
GET/v1/vivareal/listing
id+2 optional
1 credit
GET/v1/vivareal/location-autocomplete
q+2 optional
1 credit
GET/v1/vivareal/map-pins
None+7 optional
1 credit
GET/v1/vivareal/parse-filters
q+1 optional
1 credit
GET/v1/vivareal/price-insights
citystatebusiness_typeunit_typelatitudelongitudelocation_id+2 optional
1 credit
GET/v1/vivareal/search
None+12 optional
1 credit

Overview

About the VivaReal API

What you can get

The VivaReal API returns search, advertiser, advertiser listings and count as clean JSON. Each successful call costs one credit, and calls that fail are free.

Real estateJSONRESTMCP

More real estate APIs

Use cases

Monitor listing prices and new listings

Use the VivaReal API to monitor listing prices and new listings

Pull comparables for valuations

Use the VivaReal API to pull comparables for valuations

Power alerts and investment analysis

Use the VivaReal API to power alerts and investment analysis

FAQ

Questions

How much does the VivaReal API cost?

Each successful call costs one credit. New accounts get free credits every month, and credit packs bring the price down as you scale.

What format are responses in?

Every endpoint returns JSON, with no HTML parsing on your side.

Do I need a separate key for VivaReal?

No. One key works for every API in the catalogue.

Try the VivaReal API with 1,000 free credits

No credit card. Failed calls are never billed.