> cat /dev/github | grep security-tools
discovered 30 Mar 2026

whatsapp-osint

Python โ˜… 1312 via github-topic
โ†’ View on GitHub

AI Summary: WhatsApp Beacon is an OSINT tracking tool designed to monitor the online status of specific WhatsApp contacts, storing session data in SQLite for analysis. It features automated installation, headless operation, and advanced analytics capabilities, including exporting data to Excel and generating detailed HTML reports with visualizations. This tool emphasizes ethical use for educational and research purposes.


README

๐Ÿ•ต๏ธโ€โ™‚๏ธ WhatsApp Beacon (OSINT Tracker)

PyPI License Python Platform

WhatsApp Beacon tracks when specific WhatsApp contacts go online and stores every completed session in SQLite. It can export to Excel, generate a polished analytics dashboard, and run fully headless once the session is authenticated.

View Interactive Presentation | Animated overview of the project

TitleOverview
ArchitectureFeatures
Tech StackGetting Started

Disclaimer: This tool is for educational and research purposes only. Do not use it for stalking or any illegal activities.


โœจ Features

  • PyPI install: pip install whatsapp-osint gets you the package fast.
  • One-command installer: clone, create a local .venv, install the package, and verify the browser setup.
  • Best-effort Linux bootstrap: if Git, Python, or Chrome/Chromium are missing, the installer will try to install them with sudo.
  • Automated browser driver resolution: Selenium Manager handles matching drivers, with manual override flags if you need them.
  • Headless tracking: authenticate once, then run quietly in the background.
  • SQLite session history: every finished online session is stored locally.
  • Excel export: turn the database into History_wp.xlsx.
  • Advanced analytics dashboard: generate a static HTML report with filters, heatmaps, leaderboards, and recent-session views.

๐Ÿš€ Installation

Install from PyPI

python3 -m pip install whatsapp-osint

The package installs 2 equivalent entry points:

  • whatsapp-osint
  • whatsapp-beacon

One-click installer from GitHub

curl -fsSL https://raw.githubusercontent.com/jasperan/whatsapp-osint/master/install.sh | bash

What it does:

  • clones or updates the repo into ./whatsapp-osint
  • creates ./whatsapp-osint/.venv
  • installs the package and the whatsapp-beacon command
  • on Linux, uses sudo when needed to install missing system packages and Chrome/Chromium
  • verifies that a browser binary is available before it finishes

If you want a custom location:

PROJECT_DIR=/opt/whatsapp-osint curl -fsSL https://raw.githubusercontent.com/jasperan/whatsapp-osint/master/install.sh | bash
Manual / development install

Use this only if you explicitly want to manage setup yourself.

git clone https://github.com/jasperan/whatsapp-osint.git
cd whatsapp-osint
python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip setuptools wheel
python -m pip install -e ".[dev]"

โ–ถ๏ธ Run it

If you installed from PyPI:

whatsapp-osint -u "John Doe"

whatsapp-osint and whatsapp-beacon run the same CLI. The rest of the examples keep using whatsapp-beacon.

If you used the GitHub installer:

cd whatsapp-osint
source .venv/bin/activate
whatsapp-beacon -u "John Doe"

If you do not want to activate the venv first:

./whatsapp-osint/.venv/bin/whatsapp-beacon -u "John Doe"

First run

The first run must authenticate with WhatsApp Web.

  • Non-headless is the easiest path. Scan the QR code once, then the saved browser profile will be reused.
  • Headless also works. If the session is not authenticated yet, the tool will save a QR screenshot to qrcode.png.

Example:

whatsapp-beacon -u "Maria" --headless

๐Ÿ“Š Advanced analytics

Generate a static HTML dashboard from the collected SQLite history:

whatsapp-beacon --analytics

By default, the report is written to:

analytics/index.html

Custom output path:

whatsapp-beacon --analytics --analytics-output reports/contact-dashboard.html

Once generated, open it in your browser:

xdg-open analytics/index.html
# or on macOS
open analytics/index.html

The dashboard includes:

  • top-level KPIs
  • per-contact leaderboard
  • daily online-time bars
  • weekday/hour heatmap
  • duration distribution
  • recent sessions and longest sessions tables
  • live filtering by contact inside the page

๐Ÿ–ผ๏ธ Screenshots

First-run WhatsApp Web authentication flow

First-run WhatsApp Web authentication

Advanced analytics dashboard overview

Captured from a demo dataset generated through the built-in analytics exporter.

Analytics dashboard overview

Advanced analytics dashboard filtered to a single contact

Same dashboard, narrowed to one contact to show the live filter state.

Analytics dashboard filtered view


โš™๏ธ Command line arguments

ArgumentDescriptionDefault
-u, --usernameExact WhatsApp contact name to track.Required for tracking
-l, --languageWhatsApp Web language code (en, es, fr, etc.).en
-e, --excelExport the database to Excel before doing anything else.False
--headlessRun without a visible browser window.False
--chrome-driver-pathExplicit path to chromedriver.Auto-detect
--chrome-binary-pathExplicit path to Chrome or Chromium.Auto-detect
--analyticsGenerate the analytics dashboard and exit.False
--analytics-outputOutput path for the analytics HTML report.analytics/index.html
--configPath to a custom config file.config.yaml

โš™๏ธ Configuration

You can keep defaults in config.yaml:

username: "Target Name"
language: "en"
headless: false
excel: false
browser: "chrome"
log_level: "INFO"
data_dir: "data"
chrome_binary_path: null

๐Ÿ“ฆ Output

  • Logs: logs/whatsapp_beacon.log
  • Database: data/victims_logs.db
  • Excel export: History_wp.xlsx
  • Analytics report: analytics/index.html by default
  • Saved WhatsApp profile: data/chrome_profile

๐Ÿ”ง Troubleshooting

cannot find Chrome binary

The installer now tries to fix this automatically on Linux. If your distro keeps the browser in a weird place, launch with an explicit path:

whatsapp-beacon -u "John Doe" --chrome-binary-path /full/path/to/browser

Useful checks:

which google-chrome google-chrome-stable chromium chromium-browser
whatsapp-beacon --help

Username is required

Tracking mode needs a contact name:

whatsapp-beacon -u "John Doe"

Analytics mode does not:

whatsapp-beacon --analytics

๐Ÿค Contributing

Contributions are welcome. Fork it, build what you need, and send a PR.


๐Ÿ“œ License

Distributed under the MIT License. See LICENSE for more information.

๐Ÿ™Œ Credits

Original concept developed in 2019. Revamped in 2025 for better performance and usability.


GitHubย  LinkedIn