---
title: "Price Insights"
method: GET
path: "/vivareal/price-insights"
tags: ["VivaReal"]
---

# Price Insights

`GET /vivareal/price-insights`

## Request

- Base URL: `https://scrappa.co/api`
- URL: `https://scrappa.co/api/vivareal/price-insights`
- Auth: API key in header `X-API-KEY`

Average price, area and price per m2 for a neighbourhood or city, with price brackets and nearby locations.

## Query parameters

- `portal` 'ZAP' | 'VIVAREAL' | 'zap' | 'vivareal'
- `city` string, required
- `state` string, required
- `neighborhood` string
- `business_type` 'RENTAL' | 'SALE' | 'rental' | 'sale', required
- `unit_type` string, required
- `latitude` number, required
- `longitude` number, required
- `location_id` string, required

## Response `200`

- union
  - string
  - object

## Other responses

- `401`: Unauthorized - API key is missing or invalid
- `422`: Validation error

---

[API](https://skmtc.dev/scrappa/apis/scrappa-api-documentation.md) · [All operations](https://skmtc.dev/scrappa/apis/scrappa-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/scrappa/apis/scrappa-api-documentation/revisions/2f4af6143d10?raw)