Overview

The client library for Bulk Whois API in Python language.

The minimum Python version is 3.7.

Installation

pip install bulk-whois-api

Examples

Full API documentation available here

Create a new client

from bulkwhoisapi import *

client = Client('Your API key')

Create bulk request

domains = [
    'example.com',
    'example.org'
]

result = client.create_request(domains=domains)

# Used for further requests
request_id = result.request_id

Get Whois records

result = client.get_records(
    request_id=request_id,
    max_records=len(domains)
)

# Finished once result.records_left == 0
print(result)

List your requests

result = client.get_requests()

Download CSV result

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

Extras

# 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

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]