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.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.0.tar.gz
(11.8 kB
view details)
Built Distribution
File details
Details for the file bulk-whois-api-1.1.0.tar.gz
.
File metadata
- Download URL: bulk-whois-api-1.1.0.tar.gz
- Upload date:
- Size: 11.8 kB
- Tags: Source
- Uploaded using 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
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5deddacfe3d1fc39046abff78c836b278df9da6697f405a4637c95f5a87436fd |
|
MD5 | a9b82bb2b6058d9a58044339cdcb8f50 |
|
BLAKE2b-256 | 776a82a100e9c1eef77734ea0a1d037fce36f57d38d78c7b2aec4a9ad1d9155e |
File details
Details for the file bulk_whois_api-1.1.0-py3-none-any.whl
.
File metadata
- Download URL: bulk_whois_api-1.1.0-py3-none-any.whl
- Upload date:
- Size: 11.0 kB
- Tags: Python 3
- Uploaded using 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
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06c853bfb7362d7f940a4e656dec048a5ce065ebbd17a4f424a639bd6ac44f43 |
|
MD5 | 98e960aaa88cc0ad46f76b8a94e6c550 |
|
BLAKE2b-256 | 8652647173b8d8dff2e3c726560306f08649f02b93013bacc5fd0329c57ac36d |