bulk-whois-api

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]

Changelog

1.1.1 (2023-07-31)

Bump whois-api

1.1.0 (2023-07-31)

Bump requests & whois-api
Drop Python 3.6 support

1.0.0 (2022-01-15)

First release

Metadata

Release files for bulk-whois-api 1.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bulk-whois-api 1.1.1
File	Size	Uploaded
bulk-whois-api-1.1.1.tar.gz	11.8 kB	Jul 31, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for bulk-whois-api 1.1.1
File	Interpreter	ABI	Platform	Reset
bulk_whois_api-1.1.1-py3-none-any.whl 11.0 kB Jul 31, 2023	Python 3	none	any	Details

Total release size: 22.8 kB

Release files / bulk-whois-api-1.1.1.tar.gz

Download URL	bulk-whois-api-1.1.1.tar.gz
Size	11.8 kB
Tags	Source
SHA-256 checksum How to use checksums	`34d9e820942ffd125150eb42af3bd27de05f5bda0e306493221d84d094bd56de`
BLAKE2b-256 checksum How to use checksums	`49a938d94e62d4c0532fdd70e9debf8ecf970e07f60ef6c217613dd8909da461`
Upload date	Jul 31, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.16`

Release files / bulk_whois_api-1.1.1-py3-none-any.whl

Download URL	bulk_whois_api-1.1.1-py3-none-any.whl
Size	11.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`8d78313aef410b8c072379025873def4006511b7a73a7a1d9b3ef3efbec5a11d`
BLAKE2b-256 checksum How to use checksums	`8dae004b3295d484a590df1f933efa1351bb99d6832dbb6bb407bd260482d6f1`
Upload date	Jul 31, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.16`