Skip to content

❤️ Fredy - [F]ind [R]eal [E]states [D]amn Eas[y] - Fredy will constantly search for new listings on sites like Immoscout or Immowelt and send new results to you, so that you can focus on more important things in life ;)

License

Notifications You must be signed in to change notification settings

orangecoding/fredy

Repository files navigation

Fredy – Self-Hosted Real Estate Search & Alerts for Germany

Searching for an apartment or house in Germany can be frustrating.
Fredy makes it easier: it scrapes ImmoScout24, Immowelt, Immonet, eBay Kleinanzeigen, and WG-Gesucht, and notifies you instantly via Slack, Telegram, Email, ntfy, and more when new listings match your requirements.

Fredy includes a web UI to configure your searches, prevents duplicates even across multiple platforms, and stores results so you won’t receive the same listing twice.

Test Create and publish Docker image Check the sourcecode

Key-Features

  • ✅ Scrapes ImmoScout24, Immowelt, Immonet, eBay Kleinanzeigen, WG-Gesucht
  • ✅ Instant notifications: Slack, Telegram, Email (SendGrid, Mailjet), ntfy
  • ✅ Reverse-engineered ImmoScout mobile API for reliable results
  • ✅ Runs anywhere: Docker, Node.js, self-hosted
  • ✅ Modern stack: Node.js, Express, React, Vite
  • ✅ Web UI to manage your searches
  • ✅ Deduplication and configurable search intervals

Demo

If you want to try out Fredy, you can access the demo version here 🤘


Sponsorship

If you find Fredy useful, consider supporting my work.
I maintain Fredy and other open source projects in my spare time – your sponsorship helps keep development active. Thanks for your support!

JetBrains

Fredy is proudly supported by JetBrains under their Open Source Support Program.

Usage

  • Requires Node.js 20 or higher
  • Install dependencies and start both backend and frontend:
yarn
yarn run start:backend   # in one terminal
yarn run start:frontend  # in another terminal

Fredy will start on port 9998.
Open http://localhost:9998 in your browser.

Default login:

Username: admin
Password: admin

Screenshots

Job Configuration Job Analytics Job Overview
Screenshot showing job configuration in Fredy Screenshot showing job analytics in Fredy Screenshot showing job overview in Fredy

Understanding the fundamentals

There are 3 important parts in Fredy, that you need to understand to leverage the full power of Fredy.

Provider

Fredy supports multiple services. Immonet, Immowelt and Ebay are just a few examples. Those services are called providers within Fredy. When creating a new job, you can choose one or more providers. A provider contains the URL that points to the search results for the respective service. If you go to immonet.de and search for something, the displayed URL in the browser is what the provider needs to do its magic. It is important that you order the search results by date, so that Fredy always picks the latest results first!

Adapter

Fredy supports multiple adapters, such as Slack, SendGrid, Telegram etc. A search job can have as many adapters as supported by Fredy. Each adapter needs different configuration values, which you have to provide when using them. An adapter dictates how the frontend renders by telling the frontend what information it needs in order to send listings to the user.

Jobs

A Job wraps adapters and providers. Fredy runs the configured jobs in a specific interval (can be configured in /conf/config.json).

Creating your first job

To create your first job, click on the button "Create New Job" on the job table. The job creation dialog should be self-explanatory, however there is one important thing. When configuring providers, before copying the URL from your browser, make sure that you have sorted the results by date to make sure Fredy always picks the latest results first.

User management

As an administrator, you can create, edit and remove users from Fredy. Be careful, each job is connected to the user that has created the job. If you remove the user, their jobs will also be removed.

Development

Running Fredy in development mode

Start the backend with:

yarn run start:backend:dev

For the frontend, run:

yarn run start:frontend:dev

You should now be able to access Fredy from your browser. Check your Terminal to see what port the frontend is running on.

Running Tests

To run the tests, run

yarn run test

Architecture

flowchart TD
 subgraph Jobs["Jobs"]
        A1["Job 1"]
        A2["Job 2"]
        A3["Job 3"]
  end
 subgraph Providers["Providers"]
        C1["Provider 1"]
        C2["Provider 2"]
        C3["Provider 3"]
  end
 subgraph NotificationAdapters["Notification Adapters"]
        F1["Notification Adapter 1"]
        F2["Notification Adapter 2"]
  end

    A1 --> B["FredyRuntime"]
    A2 --> B
    A3 --> B
    B --> C1 & C2 & C3
    C1 --> D["Similarity-Check"]
    C2 --> D
    C3 --> D
    D --> E{"Found<br>similarity?"}
    E -- No --> F1
    F1 --> F2

    style A1 fill:#fde9a0,stroke:#333333,color:#333333
    style A2 fill:#fde9a0,stroke:#333333,color:#333333
    style A3 fill:#fde9a0,stroke:#333333,color:#333333
    style C1 fill:#c4c9f1,stroke:#333333,color:#333333
    style C2 fill:#c4c9f1,stroke:#333333,color:#333333
    style C3 fill:#c4c9f1,stroke:#333333,color:#333333
    style F1 fill:#d2edba,stroke:#333333,color:#333333
    style F2 fill:#d2edba,stroke:#333333,color:#333333
    style B fill:#abd8f9,stroke:#333333,color:#333333
    style D fill:#fab4a8,stroke:#333333,color:#333333
    style E fill:#fffbb4,stroke:#333333,color:#333333
Loading

Immoscout

Immoscout has implemented advanced bot detection. In order to work around this, we are using a reversed engineered version of their mobile api. See Immoscout Reverse Engineering Documentation

Analytics

Fredy is completely free (and will always remain free). However, it would be a huge help if you’d allow me to collect some analytical data. Before you freak out, let me explain...
If you agree, Fredy will send a ping to my Mixpanel project each time it runs.
The data includes: names of active adapters/providers, OS, architecture, Node version, and language. The information is entirely anonymous and helps me understand which adapters/providers are most frequently used.

Thanks🤘

Docker

Use the Dockerfile in this repository to build an image.

Example: docker build -t fredy/fredy /path/to/your/Dockerfile

Or use docker-compose:

Example docker-compose build

Or use the container that will be built automatically.

docker pull ghcr.io/orangecoding/fredy:master

Create & run a container

Put your config.json into a path of your choice, such as /path/to/your/conf/.

Example: docker create --name fredy -v /path/to/your/conf/:/conf -p 9998:9998 fredy/fredy

Logs

You can browse the logs with docker logs fredy -f.

👐 Contributing

Thanks to all the people who already contributed!

See Contributing

Star History

Star History Chart

About

❤️ Fredy - [F]ind [R]eal [E]states [D]amn Eas[y] - Fredy will constantly search for new listings on sites like Immoscout or Immowelt and send new results to you, so that you can focus on more important things in life ;)

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Sponsor this project

 

Packages