.. image:: https://img.shields.io/badge/License-MIT-green.svg
:alt: bulk-whois-api-py license
:target: https://opensource.org/licenses/MIT
.. image:: https://img.shields.io/pypi/v/bulk-whois-api.svg
:alt: bulk-whois-api-py release
:target: https://pypi.org/project/bulk-whois-api
.. image:: https://github.com/whois-api-llc/bulk-whois-api-py/workflows/Build/badge.svg
:alt: bulk-whois-api-py build
:target: https://github.com/whois-api-llc/bulk-whois-api-py/actions
========
Overview
========
The client library for
`Bulk Whois API <https://whois.whoisxmlapi.com/bulk-api>`_
in Python language.
The minimum Python version is 3.7.
Installation
============
.. code-block:: shell
pip install bulk-whois-api
Examples
========
Full API documentation available `here <https://whois.whoisxmlapi.com/bulk-api/documentation/making-requests>`_
Create a new client
-------------------
.. code-block:: python
from bulkwhoisapi import *
client = Client('Your API key')
Create bulk request
-------------------
.. code-block:: python
domains = [
'example.com',
'example.org'
]
result = client.create_request(domains=domains)
# Used for further requests
request_id = result.request_id
Get Whois records
-------------------
.. code-block:: python
result = client.get_records(
request_id=request_id,
max_records=len(domains)
)
# Finished once result.records_left == 0
print(result)
List your requests
-------------------
.. code-block:: python
result = client.get_requests()
Download CSV result
-------------------
.. code-block:: python
client.download(filename='records.csv', request_id=request_id)
Extras
-------------------
.. code-block:: python
# 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
-----------------------
.. code-block:: python
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
Raw data
{
"_id": null,
"home_page": "https://github.com/whois-api-llc/bulk-whois-api-py",
"name": "bulk-whois-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "bulk,whois,api,whoisxmlapi",
"author": "WHOIS API, Inc",
"author_email": "support@whoisxmlapi.com",
"download_url": "https://files.pythonhosted.org/packages/49/a9/38d94e62d4c0532fdd70e9debf8ecf970e07f60ef6c217613dd8909da461/bulk-whois-api-1.1.1.tar.gz",
"platform": null,
"description": ".. image:: https://img.shields.io/badge/License-MIT-green.svg\n :alt: bulk-whois-api-py license\n :target: https://opensource.org/licenses/MIT\n\n.. image:: https://img.shields.io/pypi/v/bulk-whois-api.svg\n :alt: bulk-whois-api-py release\n :target: https://pypi.org/project/bulk-whois-api\n\n.. image:: https://github.com/whois-api-llc/bulk-whois-api-py/workflows/Build/badge.svg\n :alt: bulk-whois-api-py build\n :target: https://github.com/whois-api-llc/bulk-whois-api-py/actions\n\n========\nOverview\n========\n\nThe client library for\n`Bulk Whois API <https://whois.whoisxmlapi.com/bulk-api>`_\nin Python language.\n\nThe minimum Python version is 3.7.\n\nInstallation\n============\n\n.. code-block:: shell\n\n pip install bulk-whois-api\n\nExamples\n========\n\nFull API documentation available `here <https://whois.whoisxmlapi.com/bulk-api/documentation/making-requests>`_\n\nCreate a new client\n-------------------\n\n.. code-block:: python\n\n from bulkwhoisapi import *\n\n client = Client('Your API key')\n\nCreate bulk request\n-------------------\n\n.. code-block:: python\n\n domains = [\n 'example.com',\n 'example.org'\n ]\n\n result = client.create_request(domains=domains)\n\n # Used for further requests\n request_id = result.request_id\n\nGet Whois records\n-------------------\n\n.. code-block:: python\n\n result = client.get_records(\n request_id=request_id,\n max_records=len(domains)\n )\n\n # Finished once result.records_left == 0\n print(result)\n\nList your requests\n-------------------\n\n.. code-block:: python\n\n result = client.get_requests()\n\nDownload CSV result\n-------------------\n\n.. code-block:: python\n\n client.download(filename='records.csv', request_id=request_id)\n\nExtras\n-------------------\n\n.. code-block:: python\n\n # Paginate over processed records and get results in XML\n result = client.get_records_raw(\n request_id=request_id,\n max_records=1,\n start_index=2,\n output_format=Client.XML_FORMAT\n )\n\nResponse model overview\n-----------------------\n\n.. code-block:: python\n\n ResponseCreate:\n - request_id: str\n - invalid_domains: [str]\n\n ResponseRecords:\n - no_data_available: bool\n - request_id: str\n - total_records: int\n - records_left: int\n - records_processed: int\n - domain_list: [str]\n - whois_records: [BulkWhoisRecord]\n\n ResponseRequests:\n - user_requests: [BulkRequest]\n\n\n\nChangelog\n=========\n\n1.1.1 (2023-07-31)\n------------------\n\n* Bump whois-api\n\n1.1.0 (2023-07-31)\n------------------\n\n* Bump requests & whois-api\n* Drop Python 3.6 support\n\n1.0.0 (2022-01-15)\n------------------\n\n* First release\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python client library for Bulk Whois API.",
"version": "1.1.1",
"project_urls": {
"Homepage": "https://github.com/whois-api-llc/bulk-whois-api-py"
},
"split_keywords": [
"bulk",
"whois",
"api",
"whoisxmlapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8dae004b3295d484a590df1f933efa1351bb99d6832dbb6bb407bd260482d6f1",
"md5": "f4c7465710bbd5a8326b803704388b00",
"sha256": "8d78313aef410b8c072379025873def4006511b7a73a7a1d9b3ef3efbec5a11d"
},
"downloads": -1,
"filename": "bulk_whois_api-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f4c7465710bbd5a8326b803704388b00",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 10994,
"upload_time": "2023-07-31T11:53:01",
"upload_time_iso_8601": "2023-07-31T11:53:01.299461Z",
"url": "https://files.pythonhosted.org/packages/8d/ae/004b3295d484a590df1f933efa1351bb99d6832dbb6bb407bd260482d6f1/bulk_whois_api-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "49a938d94e62d4c0532fdd70e9debf8ecf970e07f60ef6c217613dd8909da461",
"md5": "24ee68b1d9c092973f1eefe58195d68d",
"sha256": "34d9e820942ffd125150eb42af3bd27de05f5bda0e306493221d84d094bd56de"
},
"downloads": -1,
"filename": "bulk-whois-api-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "24ee68b1d9c092973f1eefe58195d68d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 11835,
"upload_time": "2023-07-31T11:53:03",
"upload_time_iso_8601": "2023-07-31T11:53:03.660307Z",
"url": "https://files.pythonhosted.org/packages/49/a9/38d94e62d4c0532fdd70e9debf8ecf970e07f60ef6c217613dd8909da461/bulk-whois-api-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-31 11:53:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "whois-api-llc",
"github_project": "bulk-whois-api-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "bulk-whois-api"
}
JSON
