socialscan

You can install socialscan using pip or by cloning the repository and installing from source.

Using pip:

pip install socialscan

Installing from source:

git clone https://github.com/iojw/socialscan.git
cd socialscan
pip install .

The socialscan CLI allows you to check if specific usernames or email addresses are in use across various online platforms. You can provide queries directly as command-line arguments or via an input file. The tool automatically detects if a query is an email address and queries accordingly.

Basic Usage

To check a single username or email across all supported platforms:

socialscan my_username
socialscan test@example.com

Input from File

To process a large list of queries, use the --input (or -i) flag pointing to a text file containing one query per line:

socialscan --input queries.txt

You can import socialscan into your Python projects to perform concurrent checks.

Use sync_execute_queries for a synchronous wrapper or execute_queries for an asynchronous implementation. Both take a list of queries and optional lists of platforms and proxies, returning results in the same order as the input queries.

To specify platforms, use the Platforms enum from socialscan.util.

from socialscan.util import Platforms, sync_execute_queries

queries = ["username1", "email2@gmail.com", "mail42@me.com"]
platforms = [Platforms.GITHUB, Platforms.LASTFM]
results = sync_execute_queries(queries, platforms)
for result in results:
    print(f"{result.query} on {result.platform}: {result.message} (Success: {result.success}, Valid: {result.valid}, Available: {result.available})")

socialscan supports both username and email checks on various platforms. Note that some platforms only support one type of check.

The CLI allows you to check the availability of usernames and email addresses across multiple platforms. You can pass a list of queries directly as arguments or use an input file.

Basic usage:

socialscan [list of usernames/email addresses to check]

Using an input file: Create a .txt file with one username or email per line, then use the --input flag:

socialscan --input input.txt