https://github.com/whois-api-llc/registrant-alert-py

Registrant Alert API client library for Python
https://github.com/whois-api-llc/registrant-alert-py

domain domain-registrant python registrant registrant-alert whois whoisxmlapi

Last synced: about 1 month ago
JSON representation

Registrant Alert API client library for Python

• Host: GitHub
• URL: https://github.com/whois-api-llc/registrant-alert-py
• Owner: whois-api-llc
• License: mit
• Created: 2021-09-15T11:37:41.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-05-23T01:29:29.000Z (over 1 year ago)
• Last Synced: 2024-10-29T20:57:31.536Z (about 2 months ago)
• Topics: domain, domain-registrant, python, registrant, registrant-alert, whois, whoisxmlapi
• Language: Python
• Homepage: https://registrant-alert.whoisxmlapi.com/api
• Size: 12.7 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• 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: registrant-alert-py license

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

.. image:: https://img.shields.io/pypi/v/registrant-alert.svg

    :alt: registrant-alert-py release

    :target: https://pypi.org/project/registrant-alert

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

    :alt: registrant-alert-py build

    :target: https://github.com/whois-api-llc/registrant-alert-py/actions

========

Overview

========

The client library for

`Registrant Alert API `_

in Python language.

The minimum Python version is 3.6.

Installation

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

.. code-block:: shell

    pip install registrant-alert

Examples

========

Full API documentation available `here `_

Create a new client

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

.. code-block:: python

    from registrantalert import *

    client = Client('Your API key')

Make basic requests

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

.. code-block:: python

    # Get the number of domains.

    terms = {

        'include': ['blog']

    }

    result = client.preview(basic_terms=terms)

    print(result.domains_count)

    # Get raw API response

    raw_result = client.raw_data(

        basic_terms=terms,

        response_format=Client.XML_FORMAT,

        mode=Client.PREVIEW_MODE)

    # Get a list of registered/dropped domains (up to 10,000)

    result = client.purchase(

        basic_terms=terms

    )

Advanced usage

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

Extra request parameters

.. code-block:: python

    advanced_terms = [{

        'field': Fields.registrant_contact_organization,

        'term': 'Airbnb, Inc.',

        'exactMatch': True

    }]

    since_date = datetime.date(2021, 8, 12)

    result = client.purchase(

        advanced_terms=advanced_terms,

        since_date=since_date,

        punycode=False)

Response model overview

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

.. code-block:: python

    Response:

        - domains_count: int

        - domains_list: [Domain]

            - domain_name: str

            - date: datetime.date

            - action: str