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

Domains & Subdomains Discovery API client library for Python
https://github.com/whois-api-llc/domain-discovery-py

discovery domain python subdomain whois whoisxmlapi

Last synced: about 1 year ago
JSON representation

Domains & Subdomains Discovery API client library for Python

• Host: GitHub
• URL: https://github.com/whois-api-llc/domain-discovery-py
• Owner: whois-api-llc
• License: mit
• Created: 2021-11-19T12:59:00.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-11-19T13:22:07.000Z (over 4 years ago)
• Last Synced: 2025-03-10T11:47:34.564Z (about 1 year ago)
• Topics: discovery, domain, python, subdomain, whois, whoisxmlapi
• Language: Python
• Homepage: https://domains-subdomains-discovery.whoisxmlapi.com/
• Size: 9.77 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• 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-discovery-py license

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

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

    :alt: domain-discovery-py release

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

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

    :alt: domain-discovery-py build

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

========

Overview

========

The client library for

`Domains & Subdomains Discovery API `_

in Python language.

The minimum Python version is 3.6.

Installation

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

.. code-block:: shell

    pip install domain-discovery

Examples

========

Full API documentation available `here `_

Create a new client

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

.. code-block:: python

    from domaindiscovery import *

    client = Client('Your API key')

Domains

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

.. code-block:: python

    terms = {

        'include': ['example.*']

    }

    # Get the list of domains (up to 10,000)

    result = client.get(domains=terms)

    # Total count

    print(result.domains_count)

Subdomains

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

.. code-block:: python

    domain_terms = {

        'include': ['blog.*'],

        'exclude': ['*.com']

    }

    subdomain_terms = {

        'include': ['*news*']

    }

    # Search for subdomains

    result = client.get(subdomains=subdomain_terms)

    # Search in subdomains of the required domain names

    result = client.get(

        domains=domain_terms,

        subdomains=subdomain_terms)

Extras

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

.. code-block:: python

    import datetime

    terms = {

        'include': ['blog.*'],

        'exclude': ['*.com']

    }

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

    # Get raw response in XML and filter by date

    raw_result = client.get_raw(

        domains=terms,

        output_format=Client.XML_FORMAT,

        since_date=since_date)

Response model overview

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

.. code-block:: python

    Response:

        - domains_count: int

        - domains_list: [str]