https://github.com/whois-api-llc/domain-availability-py

Domain Availability API client library for Python
https://github.com/whois-api-llc/domain-availability-py

domain-availability domain-availability-checker python whoisxmlapi

Last synced: about 1 month ago
JSON representation

Domain Availability API client library for Python

• Host: GitHub
• URL: https://github.com/whois-api-llc/domain-availability-py
• Owner: whois-api-llc
• License: mit
• Created: 2021-04-27T07:50:11.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-05-23T01:11:32.000Z (over 1 year ago)
• Last Synced: 2024-08-10T06:48:23.471Z (5 months ago)
• Topics: domain-availability, domain-availability-checker, python, whoisxmlapi
• Language: Python
• Homepage: https://domain-availability.whoisxmlapi.com/api
• Size: 9.77 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
.. image:: https://img.shields.io/badge/License-MIT-green.svg

    :alt: domain-availability-py license

    :target: https://opensource.org/licenses/MIT

.. image:: https://img.shields.io/pypi/v/domain-availability.svg

    :alt: domain-availability-py release

    :target: https://pypi.org/project/domain-availability

.. image:: https://github.com/whois-api-llc/domain-availability-py/workflows/Build/badge.svg

    :alt: domain-availability-py build

    :target: https://github.com/whois-api-llc/domain-availability-py/actions

========

Overview

========

The client library for

`Domain Availability API `_

in Python language.

The minimum Python version is 3.6.

Installation

============

.. code-block:: shell

    pip install domain-availability

Examples

========

Full API documentation available `here `_

Create a new client

-------------------

.. code-block:: python

    from domainavailability import *

    client = Client('Your API key')

Make basic requests

-------------------

.. code-block:: python

    # Get parsed records as a model instance.

    result = client.data('whoisxmlapi.com')

    print(result.domain_availability)

    if result.is_available() is True:

        print('This domain name is available.')

    # Get raw API response

    raw_result = client.raw_data('whoisxmlapi.com')

Advanced usage

-------------------

Extra request parameters

.. code-block:: python

    result = client.data(

        'whoisxmlapi.com',

        mode=Client.DNS_AND_WHOIS_MODE,

        credits_type=Client.DOMAIN_AVAILABILITY_CREDITS)

    raw_result = client.raw_data(

        'whoisxmlapi.com',

        mode=Client.DNS_ONLY_MODE,

        credits_type=Client.WHOIS_CREDITS,

        output_format=Client.XML_FORMAT)