whois-api

.. image:: https://img.shields.io/badge/License-MIT-green.svg :alt: whois-api-py license :target: https://opensource.org/licenses/MIT

.. image:: https://img.shields.io/pypi/v/whois-api.svg :alt: whois-api-py release :target: https://pypi.org/project/whois-api

.. image:: https://github.com/whois-api-llc/whois-api-py/workflows/Build/badge.svg :alt: whois-api-py build :target: https://github.com/whois-api-llc/whois-api-py/actions

======== Overview

The client library for Whois API <https://whois.whoisxmlapi.com/>_ in Python language.

The minimum Python version is 3.7.

Installation

::

pip install whois-api

Examples

Full API documentation available here <https://whois.whoisxmlapi.com/api/documentation/making-requests>_

Create a new client

::

from whoisapi import *

client = Client(api_key='Your API key')

Make basic requests

::

# Get parsed whois record as a model instance.
whois = client.data('whoisxmlapi.com')
# Get particular field of the whois record
print(whois.created_date_raw)

# Get raw API response
resp_str = client.raw_data('whoisxmlapi.com')

Additional options

You can specify a custom parameters for particular request

::

params = RequestParameters(ignore_raw_texts=1, da=2)

whois = client.data('whoisxmlapi.com', params)
print(whois.domain_availability_raw)

# Also you can modify default values of parameters:
client.parameters.output_format = 'xml'
print(client.raw_data('whoisxmlapi.com'))

Changelog

1.2.0 (2023-07-31)

• Fix datetime parsing

1.1.4 (2023-07-31)

• Fix datetime parsing
• Add postal_code_str field

1.1.3 (2023-07-31)

• Bump requests
• Drop Python 3.6 support

1.1.2 (2022-11-08)

• Bump urllib3

1.1.1 (2021-11-19)

• Added postal address error handling

1.1.0 (2021-04-21)

• Minor fixes
• Error class 'UnparableApiResponse' was renamed to 'UnparsableApiResponseError'

1.0.0 (2021-04-12)

• First release