Supported Hosted Domain API.

Author: ip2location-com

.gitignore

@@ -8,4 +8,5 @@ dist/
 htmlcov/
 .tox/
 docs/_build/
+docs/build/
 *.egg-info

LICENSE.TXT

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 - 2024 IP2Location.io
+Copyright (c) 2023 - 2025 IP2Location.io
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,9 +1,14 @@
 IP2Location.io Python SDK
 ========================
+![PyPI - Version](https://img.shields.io/pypi/v/ip2location-io)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ip2location-io)
+
 This Python module enables user to query for an enriched data set, such as country, region, city, latitude & longitude, ZIP code, time zone, ASN, ISP, domain, net speed, IDD code, area code, weather station data, MNC, MCC, mobile brand, elevation, usage type, address type, advertisement category, fraud score and proxy data with an IP address. It supports both IPv4 and IPv6 address lookup.
 
 In addition, this module provides WHOIS lookup api that helps users to obtain domain information, WHOIS record, by using a domain name. The WHOIS API returns a comprehensive WHOIS data such as creation date, updated date, expiration date, domain age, the contact information of the registrant, mailing address, phone number, email address, nameservers the domain is using and much more.
 
+There is also a Hosted Domain API that allowing users to get the list of hosted domain names by IP address in real time. The REST API supports both IPv4 and IPv6 address lookup.
+
 This module requires API key to function. You may sign up for a free API key at https://www.ip2location.io/pricing.
 
 Developer Documentation

docs/source/code.md

@@ -210,4 +210,32 @@ Get domain extension from a URL or domain.
 :param string str: (Required) The URL or domain.
 :return: Returns the domain extension in text.
 :rtype: string
+```
+
+## HostedDomain Class
+
+```{py:class} HostedDomain(config)
+Initialize the HostedDomain class.
+
+:param object config: (Required) The IP2Location.io Configuration object returned by Configuration class.
+```
+
+```{py:function} lookup(ip_address, page)
+Retrieve a list of hosted domains for an IP address.
+
+:param string ip_address: (Required) The IP address (IPv4 or IPv6).
+:param integer page: (Optional) Pagination result returns of the hosted domains. If unspecified, 1st page will be used. 
+:::
+:return: Returns the domain list in JSON. Refer below table for the fields avaliable in the JSON
+:rtype: json
+
+**RETURN FIELDS**
+| Parameter | Type | Description |
+|---|---|---|
+|ip|string|IP address.|
+|total_domains|integer|Total number of hosted domains found.|
+|page|integer|Current lookup page.|
+|per_page|integer|Number of domains displayed in the page.|
+|total_pages|integer|Total pages of the hosted domains.|
+|domains|array|Hosted domains of the lookup IP Address.|
 ```

docs/source/conf.py

@@ -6,7 +6,7 @@
 # -- Project information
 
 project = 'IP2Location.io Python SDK'
-copyright = '2024, IP2Location'
+copyright = '2025, IP2Location'
 author = 'IP2Location'
 
 release = '1.0.0'
@@ -46,7 +46,7 @@
 # https://myst-parser.readthedocs.io/en/latest/configuration.html#setting-html-metadata
 myst_html_meta = {
     "description": "IP2Location.io Python library allows user to query for an enriched data set based on IP address and provides WHOIS lookup api that helps users to obtain domain information.",
-    "keywords": "IP2Location, Geolocation, IP location, Python, WHOIS, domain",
+    "keywords": "IP2Location, Geolocation, IP location, Python, WHOIS, domain, hosted domain",
     "google-site-verification": "DeW6mXDyMnMt4i61ZJBNuoADPimo5266DKob7Z7d6i4",
 }
 

docs/source/index.md

@@ -1,9 +1,14 @@
 IP2Location.io Python SDK
 ========================
+![PyPI - Version](https://img.shields.io/pypi/v/ip2location-io)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ip2location-io)
+
 This Python module enables user to query for an enriched data set, such as country, region, city, latitude & longitude, ZIP code, time zone, ASN, ISP, domain, net speed, IDD code, area code, weather station data, MNC, MCC, mobile brand, elevation, usage type, address type, advertisement category, fraud score and proxy data with an IP address. It supports both IPv4 and IPv6 address lookup.
 
 In addition, this module provides WHOIS lookup api that helps users to obtain domain information, WHOIS record, by using a domain name. The WHOIS API returns a comprehensive WHOIS data such as creation date, updated date, expiration date, domain age, the contact information of the registrant, mailing address, phone number, email address, nameservers the domain is using and much more.
 
+There is also a Hosted Domain API that allowing users to get the list of hosted domain names by IP address in real time. The REST API supports both IPv4 and IPv6 address lookup.
+
 ## Table of contents
  ```{eval-rst}
  .. toctree::

docs/source/quickstart.md

@@ -9,13 +9,15 @@ This module requires API key to function. You may sign up for a free API key at
 ### PyPI Installation
 
 Use the following command to install the module:
+
 ```Bash
 pip install ip2location-io
 ```
 
 ### Arch Linux
 
 For Arch Linux user, you can install the module using the following command:
+
 ```Bash
 git clone https://aur.archlinux.org/ip2location-io-python.git && cd ip2location-io-python
 export IP2LOCATION_API_KEY=YOUR_API_KEY
@@ -114,6 +116,22 @@ domainwhois = ip2locationio.DomainWHOIS(configuration)
 print(domainwhois.getdomainextension('example.com'))
 ```
 
+### Get Hosted Domain List
+
+You can get the domains hosted within the IP using following codes:
+
+```python
+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:

ip2locationio/__init__.py

@@ -1,3 +1,4 @@
 from ip2locationio.configuration import Configuration
 from ip2locationio.ipgeolocation import IPGeolocation
-from ip2locationio.domainwhois import DomainWHOIS
+from ip2locationio.domainwhois import DomainWHOIS
+from ip2locationio.hosteddomain import HostedDomain

ip2locationio/hosteddomain.py

@@ -0,0 +1,39 @@
+import socket
+from ip2locationio.common import urlencode, httprequest, is_valid_ip
+
+# Windows version of Python does not provide it
+# for compatibility with older versions of Windows.
+if not hasattr(socket, 'inet_pton'):
+    def inet_pton(t, addr):
+        import ctypes
+        a = ctypes.WinDLL('ws2_32.dll')
+        in_addr_p = ctypes.create_string_buffer(b(addr))
+        if t == socket.AF_INET:
+            out_addr_p = ctypes.create_string_buffer(4)
+        elif t == socket.AF_INET6:
+            out_addr_p = ctypes.create_string_buffer(16)
+        n = a.inet_pton(t, in_addr_p, out_addr_p)
+        if n == 0:
+            raise ValueError('Invalid address')
+        return out_addr_p.raw
+    socket.inet_pton = inet_pton
+
+class HostedDomain:
+
+    def __init__(self,configuration):
+        self.apikey = configuration.getapikey()
+        self.moduleversion = configuration.getmoduleversion()
+    
+    def lookup(self,ip,page=''):
+        '''This function will lookup hosted domain information for an IP address.'''
+        parameters = urlencode((("key", self.apikey), ("ip", ip), ("format", "json"), ("page", page), ("source", "sdk-python-iplio"), ("source_version", self.moduleversion)))
+        response = httprequest("domains.ip2whois.com", "/domains?", parameters)
+        if (response == None):
+            # return False
+            raise IP2LocationIOAPIError('Hosted Domain lookup error.')
+        if ('error' in response):
+            raise IP2LocationIOAPIError(response['error']['error_message'])
+        return response
+  
+class IP2LocationIOAPIError(Exception):
+    """Raise for IP2Location API Error Message"""

ip2locationio/ipgeolocation.py

@@ -21,7 +21,6 @@ def inet_pton(t, addr):
 class IPGeolocation:
 
     def __init__(self,configuration):
-        # print('apikey: ' + configuration.getapikey())
         self.apikey = configuration.getapikey()
         self.moduleversion = configuration.getmoduleversion()
 
@@ -33,9 +32,7 @@ def lookup(self,ip,language=''):
             # return False
             raise IP2LocationIOAPIError('IPGeolocation lookup error.')
         if ('error' in response):
-        # if (('response' in response) and (response['response'] != 'OK')):
             raise IP2LocationIOAPIError(response['error']['error_message'])
-            # return(response['response'])
         return response
 
 class IP2LocationIOAPIError(Exception):