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.6.

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.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.0.0.tar.gz (11.9 kB view details)

Uploaded Source

Built Distribution

bulk_whois_api-1.0.0-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

Details for the file bulk-whois-api-1.0.0.tar.gz.

File metadata

  • Download URL: bulk-whois-api-1.0.0.tar.gz
  • Upload date:
  • Size: 11.9 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.3

File hashes

Hashes for bulk-whois-api-1.0.0.tar.gz
Algorithm Hash digest
SHA256 50051a40d5ce76abcfbe6ea6d9c543f873dd7bb5becf57ccaa642e4c092ae41f
MD5 de43589fff72383037c96d9aff60a203
BLAKE2b-256 ceabd829e239615b59765cefd7a7f65143c14ce72b975f9a553f9b6a06f2a833

See more details on using hashes here.

File details

Details for the file bulk_whois_api-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: bulk_whois_api-1.0.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.3

File hashes

Hashes for bulk_whois_api-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5c0d408bf3c7a0793798a676f81402e428720745f83b15979c335dddbcafcb0d
MD5 af061235b4ac0dfa9c117c0245db845c
BLAKE2b-256 e28728418a47bee2db64366c99ebc3c07248e27215552b61a424957fa2d58e14

See more details on using hashes here.

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