Skip to main content

FundaScraper 🏡

Project Status: Active – The project has reached a stable, usable state and is being actively developed. Build Status codecov Downloads PyPI version PEP8

FundaScaper provides the easiest way to perform web scraping on Funda, the Dutch housing website. You can find houses either for sale or for rent, and access historical data from the past few years.

Please note:

  1. Scraping this website is ONLY allowed for personal use (as per Funda's Terms and Conditions).
  2. Any commercial use of this Python package is prohibited. The author holds no liability for any misuse of the package.

Install

Install with pip:

pip install funda-scraper

Clone the repository:

git clone https://github.com/whchien/funda-scraper.git
cd funda-scraper
export PYTHONPATH=${PWD}
python funda_scraper/scrape.py --area amsterdam --want_to rent --page_start 1 --n_pages 3 --save

Quickstart

from funda_scraper import FundaScraper

scraper = FundaScraper(
    area="amsterdam", 
    want_to="rent", 
    find_past=False, 
    page_start=1, 
    n_pages=3, 
    min_price=500, 
    max_price=2000
)
df = scraper.run(raw_data=False, save=True, filepath="test.csv")
df.head()

image

  • Note for Windows Users: Please add if name == 'main': before your script.

Customizing Your Scraping

You can pass several arguments to FundaScraper() for customized scraping:

  • area: Specify the city or specific area you want to look for, e.g. Amsterdam, Utrecht, Rotterdam, etc.
  • want_to: Choose either buy or rent to find houses either for sale or for rent.
  • find_past: Set to True to find historical data; the default is False.
  • page_start: Indicate which page to start scraping from; the default is 1.
  • n_pages: Indicate how many pages to scrape; the default is 1.
  • min_price: Indicate the lowest budget amount.
  • max_price: Indicate the highest budget amount.
  • min_floor_area: Indicate the minimum floor area.
  • max_floor_area: Indicate the maximum floor area.
  • days_since:: Specify the maximum number of days since the listing date.
  • property_type: Specify the desired property type(s).
  • sort: Specify sorting criteria.

The scraped raw result contains following information:

  • url
  • price
  • address
  • description
  • listed_since
  • zip_code
  • size
  • year_built
  • living_area
  • kind_of_house
  • building_type
  • num_of_rooms
  • num_of_bathrooms
  • layout
  • energy_label
  • insulation
  • heating
  • ownership
  • exteriors
  • parking
  • neighborhood_name
  • date_list
  • date_sold
  • term
  • price_sold
  • last_ask_price
  • last_ask_price_m2
  • city

To fetch the data without preprocessing, specify scraper.run(raw_data=True).

Note: Information regarding listing dates is no longer available since Q4 2023. Funda requires users to log in to see this information.

More information

Check the example notebook for further details. If you find this project helpful, please give it a star.

Metadata

Release files for funda-scraper 1.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for funda-scraper 1.2.1
File Size Uploaded
funda_scraper-1.2.1.tar.gz 101.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for funda-scraper 1.2.1
File Interpreter ABI Platform
funda_scraper-1.2.1-py3-none-any.whl Python 3 none any Details

Total release size: 125.7 kB

Release files / funda_scraper-1.2.1.tar.gz

Download URL funda_scraper-1.2.1.tar.gz
Size 101.0 kB
Tags Source
SHA-256 checksum
How to use checksums
b90d73831d67d498e9d661651c933fb62cf3ee1769b8a181abfee24ba8becd44
BLAKE2b-256 checksum
How to use checksums
20876ddaba09fcf97efd51cf50e472a7c888bbf411af183d829c1ffccfe5804f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.8.9

Release files / funda_scraper-1.2.1-py3-none-any.whl

Download URL funda_scraper-1.2.1-py3-none-any.whl
Size 24.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
82ae411f80249c7745dd1796d822597c743c9107e2fb1ff861f014ed45fc9ba7
BLAKE2b-256 checksum
How to use checksums
8143ee2de17e758f0c845a15174fe90b53fe1499c9ebed17aa7eae3498488383
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.8.9

Release history Release notifications | RSS feed

This release

1.2.1 This release

2 release files

1.2.0

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.9

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.0.3

1 release file

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page