Go to file
Phyks (Lucas Verney) e0f8434877 Fix whooshalchemy
Whooshalchemy was adding an event every time a new db session was
created, thus increasing a lot the computation time at each new call.

This is now fixed, and is a partial fix for #43.
2017-05-05 11:04:29 +02:00
.ci Styling update, fix some Pylint errors 2017-04-13 23:22:11 +02:00
doc Add screenshots in the README.md file 2017-05-04 10:51:28 +02:00
flatisfy Fix whooshalchemy 2017-05-05 11:04:29 +02:00
hooks Switch to a Vue-based web app 2017-05-03 15:54:26 +02:00
.babelrc Switch to a Vue-based web app 2017-05-03 15:54:26 +02:00
.eslintrc Switch to a Vue-based web app 2017-05-03 15:54:26 +02:00
.gitignore Status of flats was not correctly set at first import 2017-05-04 15:33:20 +02:00
CONTRIBUTING.md Write some documentation 2017-05-03 15:54:59 +02:00
LICENSE.md Initial commit 2017-04-13 20:03:59 +02:00
package.json Write some documentation 2017-05-03 15:54:59 +02:00
README.md Add screenshots in the README.md file 2017-05-04 10:51:28 +02:00
requirements.txt Add a search feature and matching UI elements 2017-05-03 15:55:08 +02:00
webpack.config.js Write some documentation 2017-05-03 15:54:59 +02:00
wsgi.py Switch to a Vue-based web app 2017-05-03 15:54:26 +02:00


Flatisfy is your new companion to ease your search of a new housing :)

Note: This software is under heavy development at the moment, and the database schema could change at any time. Do not consider it as being production ready. However, I am currently using it for my own housing search and it is working fine :)

Note: For the moment, it requires this MR on Weboob which has not yet been merged.

It uses Weboob to get all the housing posts on most of the websites offering housings posts, and then offers a bunch of pipelines to filter and deduplicate the fetched housings.

It can be used as a command-line utility, but also exposes a web API and visualisation, to browse through the results.

Note: It is targeted at French users (due to the currently supported websites), and in particular at people living close to Paris, as I developped it for my personal use, and am currently living in Paris :) Any feedback and merge requests to better support other countries / cities are more than welcome!

Note: In this repository and across the code, I am using the name "flat". I use it as a placeholder for "housing" and consider both are interchangeable. This code is not restricted to handling flats only!

Getting started

See the getting started guide.


See the dedicated folder.


Home page

Display available flats on a map:

And list them with the details in a sortable table:

Details page

Uniform display of the flat information in a dedicated page, with the contact etc:

Follow flats

Track interesting flats and store them with notes:


I am using the following datasets, available under flatisfy/data_files, which covers Paris. If you want to run the script using some other location, you might have to change these files by matching datasets.

  • LaPoste Hexasmal for the list of cities and postal codes in France.
  • RATP stations for the list of subway stations with their positions in Paris and nearby areas.

Both datasets are licensed under the Open Data Commons Open Database License (ODbL): https://opendatacommons.org/licenses/odbl/.


The content of this repository is licensed under an MIT license, unless explicitly mentionned otherwise.


See the CONTRIBUTING.md file for more infos.


  • Weboob
  • The OpenData providers listed above!
  • Navitia for their really cool public transportation API.
  • A lots of Python modules, required for this script (see requirements.txt).
  • Kresus which gave me part of the original idea (at least proved me such software based on scraping can achieve a high quality level :)
  • Current favicon is from Wikipedia