Welcome to portcheckerio 👋

This repository is the counterpart script which ports portchecker.io

This package is a nice alternative way to using tools like nc to query the port connectivity. The main benefits is that it will work with hostnames, IPv4 and IPv6 addresses (if your client has IPv6 of course). You can also query multiple ports at the same time and receive a sweet JSON response.

Installation

Portchecker can be installed from PyPI using pip or your package manager of choice:

pip install portcheckerio

Usage

CLI

You can use Portchecker as a CLI tool using the portcheck command.

Example:

$ portcheck --host google.com --ports 443
{
    "2a00:1450:4009:815::200e": {
        "type": "ipv6",
        "results": [
            {
                "port": 443,
                "connectable": true
            }
        ]
    },
    "172.217.16.238": {
        "type": "ipv4",
        "results": [
            {
                "port": 443,
                "connectable": true
            }
        ]
    }
}

You can query multiple ports for a given host in the same command:

$ portcheck --host google.com --ports 443 22
{
    "172.217.16.238": {
        "type": "ipv4",
        "results": [
            {
                "port": 443,
                "connectable": true
            },
            {
                "port": 22,
                "connectable": false
            }
        ]
    },
    "2a00:1450:4009:815::200e": {
        "type": "ipv6",
        "results": [
            {
                "port": 443,
                "connectable": true
            },
            {
                "port": 22,
                "connectable": false
            }
        ]
    }
}