Python client library for Bulk Whois API.
Project description
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
bulk-whois-api-1.1.1.tar.gz
(11.8 kB
view hashes)
Built Distribution
Close
Hashes for bulk_whois_api-1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d78313aef410b8c072379025873def4006511b7a73a7a1d9b3ef3efbec5a11d |
|
MD5 | f4c7465710bbd5a8326b803704388b00 |
|
BLAKE2b-256 | 8dae004b3295d484a590df1f933efa1351bb99d6832dbb6bb407bd260482d6f1 |