Skip to main content
GET
Price Insights
1 credit per successful call; failed calls are free. See the VivaReal API overview for every VivaReal endpoint.

Authorizations

X-API-Key
string
header
required

Query Parameters

portal
enum<string>
Available options:
ZAP,
VIVAREAL,
zap,
vivareal
city
string
required
Maximum string length: 120
state
string
required
Maximum string length: 120
neighborhood
string
Maximum string length: 120
business_type
enum<string>
required
Available options:
RENTAL,
SALE,
rental,
sale
unit_type
string
required
Maximum string length: 40
latitude
number
required
longitude
number
required
location_id
string
required
Maximum string length: 255

Response

Success

The response is of type object.