APIs / VivaReal / Search

VivaReal: Search

Search from VivaReal as JSON. 1 credit per successful call.

GET /v1/vivareal/search

Parameters

Send parameters in the query string.

ParameterTypeRequiredAllowed values
portalstringOptionalZAP, VIVAREAL, zap, vivareal
businessstringOptionalRENTAL, SALE, rental, sale
rowsintegerOptionalAny
pageintegerOptionalAny
location_idstringOptionalUp to 255 characters
qstringOptionalUp to 255 characters
advertiser_idstringOptionalUp to 64 characters
price_minintegerOptionalAny
price_maxintegerOptionalAny
bedroomsstringOptionalAny
area_minintegerOptionalAny
sortstringOptionalAny

Example request

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"

Run this endpoint in the playground with your own parameters. 1 credit per successful call; failed calls are free.