https://github.com/whois-api-llc/bulk-whois-api-py

Bulk Whois API client library for Python
https://github.com/whois-api-llc/bulk-whois-api-py

bulk bulk-whois python whois whois-client whois-lookup whoisxmlapi

Last synced: about 1 month ago
JSON representation

Bulk Whois API client library for Python

• Host: GitHub
• URL: https://github.com/whois-api-llc/bulk-whois-api-py
• Owner: whois-api-llc
• License: mit
• Created: 2022-01-15T09:44:53.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-21T06:01:01.000Z (7 months ago)
• Last Synced: 2024-11-12T18:53:47.590Z (about 2 months ago)
• Topics: bulk, bulk-whois, python, whois, whois-client, whois-lookup, whoisxmlapi
• Language: Python
• Homepage: https://whois.whoisxmlapi.com/bulk-api
• Size: 16.6 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: bulk-whois-api-py license

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

.. image:: https://img.shields.io/pypi/v/bulk-whois-api.svg

    :alt: bulk-whois-api-py release

    :target: https://pypi.org/project/bulk-whois-api

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

    :alt: bulk-whois-api-py build

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

========

Overview

========

The client library for

`Bulk Whois API `_

in Python language.

The minimum Python version is 3.7.

Installation

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

.. code-block:: shell

    pip install bulk-whois-api

Examples

========

Full API documentation available `here `_

Create a new client

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

.. code-block:: python

    from bulkwhoisapi import *

    client = Client('Your API key')

Create bulk request

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

.. code-block:: python

    domains = [

        'example.com',

        'example.org'

    ]

    result = client.create_request(domains=domains)

    # Used for further requests

    request_id = result.request_id

Get Whois records

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

.. code-block:: python

    result = client.get_records(

        request_id=request_id,

        max_records=len(domains)

    )

    # Finished once result.records_left == 0

    print(result)

List your requests

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

.. code-block:: python

    result = client.get_requests()

Download CSV result

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

.. code-block:: python

    client.download(filename='records.csv', request_id=request_id)

Extras

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

.. code-block:: python

    # Paginate over processed records and get results in XML

    result = client.get_records_raw(

        request_id=request_id,

        max_records=1,

        start_index=2,

        output_format=Client.XML_FORMAT

    )

Response model overview

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

.. code-block:: python

    ResponseCreate:

        - request_id: str

        - invalid_domains: [str]

    ResponseRecords:

        - no_data_available: bool

        - request_id: str

        - total_records: int

        - records_left: int

        - records_processed: int

        - domain_list: [str]

        - whois_records: [BulkWhoisRecord]

    ResponseRequests:

        - user_requests: [BulkRequest]