IPSpot: A Python Library for IP and Geolocation Data Retrieval

Introduction

IPSpot is a robust Python library developed by openscilab, offering a streamlined way to retrieve comprehensive IP address information. It supports both public and private IPv4 and IPv6 addresses, along with detailed geolocation data including country, city, region, latitude, and longitude. Designed with a simple and modular structure, IPSpot ensures reliable data retrieval through its intelligent fallback mechanism across various API providers. Whether you need to monitor network details or perform quick IP lookups, IPSpot provides an efficient solution directly from your machine.

Installation

IPSpot can be easily installed using pip:

pip install ipspot

For specific versions or to install from source, refer to the official GitHub repository.

Examples

IPSpot offers both a Python library for programmatic access and a command-line interface (CLI) for quick lookups.

Library Usage

Retrieve Public IPv4 with Geolocation:

from ipspot import get_public_ipv4, IPv4API

# Get public IPv4 address and basic API info
print(get_public_ipv4(api=IPv4API.IP_API_COM))

# Get public IPv4 with detailed geolocation data
print(get_public_ipv4(api=IPv4API.IP_API_COM, geo=True, timeout=10))

Retrieve Private IPv4:

from ipspot import get_private_ipv4

print(get_private_ipv4())

Retrieve Public IPv6 with Geolocation:

from ipspot import get_public_ipv6, IPv6API

# Get public IPv6 address and basic API info
print(get_public_ipv6(api=IPv6API.IP_SB))

# Get public IPv6 with detailed geolocation data
print(get_public_ipv6(api=IPv6API.IP_SB, geo=True, timeout=10))

Retrieve Private IPv6:

from ipspot import get_private_ipv6

print(get_private_ipv6())

CLI Usage

Basic IP and Geolocation Info:

ipspot

Get Version:

ipspot --version

Disable Geolocation Data:

ipspot --no-geo

Why Use IPSpot?

IPSpot stands out for several reasons:

• Comprehensive Data: It provides both public and private IPv4/IPv6 addresses, along with rich geolocation details.
• Reliability: Utilizes multiple API providers with a fallback mechanism, ensuring consistent data retrieval even if one service is down.
• Ease of Use: With a simple API and a straightforward CLI, it's easy to integrate into your projects or use for quick checks.
• Flexibility: Allows specifying preferred API providers and offers options to include or exclude geolocation data.
• Open Source: Being an open-source project, it benefits from community contributions and transparency.

Links

• GitHub Repository: https://github.com/openscilab/ipspot
• PyPI: https://pypi.org/project/ipspot/
• Discord Channel: https://discord.gg/yyDV3T4cwU
• Support the Project: https://openscilab.com/#donation