Skip to main content

FundaScaper provides you the easiest way to perform web scraping from Funda, the Dutch housing website.

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

funda_scraper-1.2.1.tar.gz (101.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

funda_scraper-1.2.1-py3-none-any.whl (24.7 kB view details)

Uploaded Python 3

File details

Details for the file funda_scraper-1.2.1.tar.gz.

File metadata

  • Download URL: funda_scraper-1.2.1.tar.gz
  • Upload date:
  • Size: 101.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.9

File hashes

Hashes for funda_scraper-1.2.1.tar.gz
Algorithm Hash digest
SHA256 b90d73831d67d498e9d661651c933fb62cf3ee1769b8a181abfee24ba8becd44
MD5 31603effa856930388b2d7bb8dfa6fd9
BLAKE2b-256 20876ddaba09fcf97efd51cf50e472a7c888bbf411af183d829c1ffccfe5804f

See more details on using hashes here.

File details

Details for the file funda_scraper-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: funda_scraper-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 24.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.9

File hashes

Hashes for funda_scraper-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 82ae411f80249c7745dd1796d822597c743c9107e2fb1ff861f014ed45fc9ba7
MD5 34e3677b810a4f8eba8fecc07ad1ec3c
BLAKE2b-256 8143ee2de17e758f0c845a15174fe90b53fe1499c9ebed17aa7eae3498488383

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page