Quickstart#

Dependencies#

This module requires API key to function. You may sign up for a free API key at https://www.ip2location.io/pricing.

Installation#

PyPI Installation#

Use the following command to install the module:

pip install ip2location-io

Arch Linux#

For Arch Linux user, you can install the module using the following command:

git clone https://aur.archlinux.org/ip2location-io-python.git && cd ip2location-io-python
export IP2LOCATION_API_KEY=YOUR_API_KEY
makepkg -si

Sample Codes#

Lookup IP Address Geolocation Data#

You can make a geolocation data lookup for an IP address as below:

import ip2locationio

# Configures IP2Location.io API key
configuration = ip2locationio.Configuration('YOUR_API_KEY')
ipgeolocation = ip2locationio.IPGeolocation(configuration)

# Lookup ip address geolocation data
print(ipgeolocation.lookup('8.8.8.8', 'en')) # The language parameter is only available for Plus and Security plan only.

Lookup Domain Information#

You can lookup domain information as below:

import ip2locationio

# Configures IP2Location.io API key
configuration = ip2locationio.Configuration('YOUR_API_KEY')
domainwhois = ip2locationio.DomainWHOIS(configuration)

# Lookup domain information
print(domainwhois.lookup('example.com'))

Convert Normal Text to Punycode#

You can convert an international domain name to Punycode as below:

import ip2locationio

# Configures IP2Location.io API key
configuration = ip2locationio.Configuration('YOUR_API_KEY')
domainwhois = ip2locationio.DomainWHOIS(configuration)

# Convert normal text to punycode
print(domainwhois.getpunycode('täst.de'))

Convert Punycode to Normal Text#

You can convert a Punycode to international domain name as below:

import ip2locationio

# Configures IP2Location.io API key
configuration = ip2locationio.Configuration('YOUR_API_KEY')
domainwhois = ip2locationio.DomainWHOIS(configuration)

# Convert punycode to normal text
print(domainwhois.getnormaltext('xn--tst-qla.de'))

Get Domain Name#

You can extract the domain name from an url as below:

import ip2locationio

# Configures IP2Location.io API key
configuration = ip2locationio.Configuration('YOUR_API_KEY')
domainwhois = ip2locationio.DomainWHOIS(configuration)

# Get domain name from URL
print(domainwhois.getdomainname('https://www.example.com/exe'))

Get Domain Extension#

You can extract the domain extension from a domain name or url as below:

import ip2locationio

# Configures IP2Location.io API key
configuration = ip2locationio.Configuration('YOUR_API_KEY')
domainwhois = ip2locationio.DomainWHOIS(configuration)

# Get domain extension (gTLD or ccTLD) from URL or domain name
print(domainwhois.getdomainextension('example.com'))

Get Hosted Domain List#

You can get the domains hosted within the IP using following codes:

import ip2locationio

# Configures IP2Location.io API key
configuration = ip2locationio.Configuration('YOUR_API_KEY')
hosteddomain = ip2locationio.HostedDomain(configuration)

# Get the list of the hosted domain on the IP.
result = hosteddomain.lookup('8.8.8.8')
print(result)

Testing#

For testing, you can use pytest with the following steps:

Setup your IP2Location.io API Key by export to the environment variable, or set it as a command-line argument when running the pytest later. To export the API Key to the environment variable, run export IP2LOCATION_API_KEY=YOUR_API_KEY. Be sure to change the ‘YOUR_API_KEY’ to your corresponding API Key.
Run the pytest after you had clone our repository to your local. If you prefer to set your API key as the argument to the pytest command, you can run it as pytest --apikey YOUR_API_KEY, where you need to substitute the YOUR_API_KEY to your corresponding API Key.

Quickstart

Contents