Skip to main content

Python wrapper for LeakCheck API & also a CLI tool

Project description

LeakCheck API

LeakCheck <3 Python

Discord PyPI - Downloads PyPI Uptime Robot ratio (30 days) GitHub

Dependencies:

  • Python >= 3.5
  • requests
  • tabulate
  • pysocks
  • setuptools
  • wheel

Installation:

pip3 install leakcheck

Or download tarball / git clone and execute

python3 setup.py install

First start:

To start working with this package you need to obtain personal API key from here and link IP address of your server or personal computer. It can be IPv6 as well as IPv4.

Public API can be used without IP linking.

Package automatically creates "PyLCAPI.json" file in the working directory on the first startup. Then, API key and/or proxy settings can be loaded from there.

Using as a CLI:

usage: leakcheck [-h] [--key KEY] [--proxy PROXY] [--type TYPE] [-lo] [-p]
             query

CLI version of LeakCheck API (v1.0.1). Licensed under MIT license

positional arguments:
query          What are we going to search?

optional arguments:
-h, --help     show this help message and exit
--key KEY      Set an API key (taken from config by default)
--proxy PROXY  Set proxy (supported: HTTP/HTTPS/SOCKS4/SOCKS5, default:
                empty)
--type TYPE    Set a type of the query (default: auto)
-lo            Print lines only (default: False
-p             Lookup privately (hashes data with SHA256, then truncates
                hash to 24 characters; works for email, pass_email only,
                default: False)

Using as a library:

from leakcheck import LeakCheckAPI

# Initialising API class
api = LeakCheckAPI()

# API key setting
api.set_key("YOUR_KEY")

# Now we're ready to make our first request
# A lookup type is detected automatically. To explicitly set it, see below
result = api.lookup("example@example.com") # list of dicts

# A request with the lookup type
result = api.lookup("example@example.com", "email") # list of dicts

Using a proxy:

# HTTP/HTTPS/SOCKS4/SOCKS5 supported
# Handled by requests[proxy], requests[socks]
api.set_proxy("socks5://127.0.0.1:8123")

Getting your IP:

from leakcheck import LeakCheckAPI

# Initialising API class
api = LeakCheckAPI()

ip = api.getIP() # string

Getting your limits:

from leakcheck import LeakCheckAPI

# Initialising API class
api = LeakCheckAPI()

# API key setting
api.set_key("YOUR_KEY")

limits = api.getLimits() # dict

Response errors:

Error Description
Missing params (key, check, type) Some params haven't passed in the request
Invalid type Type you provide is invalid
API Key is wrong Key you provide is invalid
API Key is blocked Your key is blocked due to some reasons, contact support
No license on this key Key you provide does not have a license
Your query contains invalid characters There are some forbidden characters in your query
Enter at least 3 characters to search Query passed without minimal number of characters
Invalid email E-mail type is specified, but your query is not a mail
IP linking is required IPs are not linked or invalid
Not found There are no results
Too many entries, try to concretize your query You made a search that contains too many entries, try to search "alex@" instead of "alex"

Server Errors:

Error Description Resolution
429 Too Many Requests Your server is sending too many automated requests. API is limited by 3 requests/second per one IP. Try to reduce amount of sendings.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

leakcheck-1.0.1.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

leakcheck-1.0.1-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file leakcheck-1.0.1.tar.gz.

File metadata

  • Download URL: leakcheck-1.0.1.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.2

File hashes

Hashes for leakcheck-1.0.1.tar.gz
Algorithm Hash digest
SHA256 c827b9d154cedc430569d9b82f64e9648a74bad29c5475be172ff5e877931e14
MD5 d5aa32903af28bbe52a24db548939268
BLAKE2b-256 e7cdd7871a49fe1e2ae6c4f89bfd6719bdc52db5f9e325a943e6dc674738c005

See more details on using hashes here.

File details

Details for the file leakcheck-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: leakcheck-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.2

File hashes

Hashes for leakcheck-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1c7cb4e6cb7d2379e92bd6751c393a11b894ff89d72acc53db0aa0860bbab466
MD5 418e4fafb8ffb4ba9d9d2ccc6d985427
BLAKE2b-256 38923987e051e33616669a8973dfb55533b17a17144c9b9cc80df8c5d2ccf28a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page