Skip to main content

Python client library for Bulk Whois API.

Project description

bulk-whois-api-py license bulk-whois-api-py release bulk-whois-api-py build

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


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)

Uploaded Source

Built Distribution

bulk_whois_api-1.1.1-py3-none-any.whl (11.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page