Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.25 KB

README.md

File metadata and controls

44 lines (30 loc) · 1.25 KB

🔮 Sparrot

Uses the Whoxy API to interactively discover related domains, companies, and e-mails.
Automatically detects Whois Privacy and filters official registrars.

Installation

You can install it from source using Poetry:

git clone https://github.com/karrni/sparrot
cd sparrot
poetry install
poetry run sparrot

Alternatively, you can install using pip (or even better, pipx):

pip install git+https://github.com/karrni/sparrot

After that, the sparrot command should be available from your command line.

Whoxy

The Whoxy Whois API is not free - you need to create an account and buy credits to use it.

After you've done that, get your API key from the "Account Manager" page.

Usage

Pretty straightforward. Specify your API key and the domain from which you want to start:

sparrot -k [YOUR_KEY] target.com

NOTE: If you want you can store the API key in the config file ~/.config/sparrot.toml. It will be created when running sparrot for the first time.irst time.