Vivastreet Scraper API

Extract structured property data from public Vivastreet pages as JSON. Send a listing URL and receive the fields exposed by the target page.

Get your API key Read the documentation500 free credits per month, no card required.

Decide before you build

Endpoint: POST /scrape/real-estate
Scrapers: Vivastreet property listing pages
Cost: from 1 credit / call
Free plan: 500 credits / month
Call pattern: sync, POST
On failure: credits refunded
Response format: JSON
Concurrency: by plan tier

Real Estate requests are synchronous. Cost depends on the options selected for the request.

Try the Vivastreet scraper on your own targetRun a request against a public property listing page and inspect the JSON before you integrate.

Open the live test

What you get back

property data

Vivastreet data in JSON

Retrieve the property information exposed by the public Vivastreet page.

Listing title, description and images
Price, currency and property type when available
Location, surface area and room details
Agency and listing publication data when available

Request options

Control how the page is collected

Use rendering or proxy options only when the target requires them.

JavaScript rendering with useChrome
Premium proxy and country targeting
Public URL input; no account login required
Structured JSON in the same response

Call the Vivastreet scraper

Send a public listing URL to the Real Estate endpoint. The API returns the result in the same response.

Step 1Submit the Vivastreet listing URL and only the options required by the target.

bash

# POST - scrape a public property listing page
curl -X POST "https://api.scraping-bot.io/scrape/real-estate" \
  -u "yourUsername:yourApiKey" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://www.vivastreet.com/immobilier-appartement/antibes-06600/appartement-vue-mer/348537660",
  "options": {
    "useChrome": false,
    "premiumProxy": true
  }
}'

Code example

Authenticate with your ScrapingBot username and API key, then read the returned JSON.

const auth = "Basic " + Buffer.from("yourUsername:yourApiKey").toString("base64");

const response = await fetch("https://api.scraping-bot.io/scrape/real-estate", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: auth },
  body: JSON.stringify({ url: "https://www.vivastreet.com/immobilier-appartement/antibes-06600/appartement-vue-mer/348537660", options: { useChrome: false, premiumProxy: true } }),
});

const result = await response.json();

Run this call in two minutesCreate an account, copy your API key, then use the example above.

Get your API key

Request parameters

Parameter	Type	Default	Description
`url`	string	—	Full public page URL, including https://.
`options.useChrome`	boolean	false	Render JavaScript when the target page requires a browser.
`options.premiumProxy`	boolean	false	Use a premium proxy for targets that require it.
`options.proxyCountry`	string	—	Country targeting with a premium proxy.

Response example

Response returned for the public Vivastreet property listing page used in the request example, with long lists shortened. Available fields vary with the target page.

json

{
  "data": {
    "title": "appartement vue mer Antibes - 06600 348537660 | Vivastreet",
    "description": "le cap d'Antibes à 300 mètres de la plage de la Garoupe, proche toutes commodités. Au quatrième ...Trouvez l'appartement appartement vue mer à acheter parmi les milliers d'annonces d'appartements a vendre Antibes - 06600",
    "parcelSurfaceArea": null,
    "surfaceArea": 35,
    "surfaceAreaUnit": "sqm",
    "price": 399000,
    "currency": "EUR",
    "numberOfRooms": 2,
    "numberOfBedrooms": null,
    "publishingDate": "2026-09-16",
    "monthlyRent": null,
    "weeklyRent": null,
    "marketedBy": {},
    "energyClass": "E",
    "greenhouseGazClass": "B",
    "buildYear": null,
    "postalCode": null,
    "city": null,
    "image": [
      "https://eu.viva-images.com/vivastreet_fr/clad/348537660/large/40947fdf-2ab9-4a54-a021-917f1f4d4822.jpeg"
    ],
    "insulation": null,
    "siteURL": "https://www.vivastreet.com/immobilier-appartement/antibes-06600/appartement-vue-mer/348537660",
    "siteHtml": null,
    "statusCode": 200,
    "htmlLength": 210517,
    "captchaFound": false,
    "isHtmlPage": true,
    "host": "www.vivastreet.com"
  }
}

Credits, failures and limits

Case	Credits	Notes
Standard request	from 1 credit / call	Current plans start at this rate.
JavaScript rendering	Additional credits	Enable only when the target requires it.
Premium proxy	Additional credits	Use for targets that require a premium proxy.
Unsuccessful request	Not deducted	Only successful requests count towards the monthly limit.

Real Estate API or Raw HTML scraper?

	Real Estate API	Raw HTML scraper
Endpoint	/scrape/real-estate	/scrape/raw-html
Returns	Structured property JSON	Rendered page HTML
Flow	One synchronous request	One synchronous request
Starting cost	from 1 credit / call	from 1 credit / call
Use it when	You need parsed property fields	You need your own extraction logic

Questions about the Vivastreet API

Does the Vivastreet scraper access private data?: No. This guide covers public property listing pages and does not require signing in to a Vivastreet account.
Are all fields always available?: No. Returned data depends on what the public Vivastreet page exposes and what the extractor supports.
Can I collect multiple pages at once?: Each request takes one public URL. Submit one request per page you need to collect.
When should I use a premium proxy?: Use it only when a target requires it or when you need country targeting for a public page.

Source: ScrapingBot API documentation.

Other real estate scrapers

Real estate Scraper API Funda Scraper API Pap Scraper API PropertyPassBook Scraper API Zillow Scraper API ParuVendu Scraper API

Browse the Real Estate category for the complete list of guides. Visit the ScrapingBot blog for implementation guides.

4.9

★★★★★

133 Google reviews

Trusted by developers using Real Estate data.
Customer reviews apply to ScrapingBot's service overall, not specifically to this scraper.

Start scraping Vivastreet today

500 free credits every month. No card required, cancel anytime.

Get your API key Talk to us