.. image:: https://img.shields.io/badge/License-MIT-green.svg
:alt: whois-api-py license
:target: https://opensource.org/licenses/MIT
.. image:: https://img.shields.io/pypi/v/whois-api.svg
:alt: whois-api-py release
:target: https://pypi.org/project/whois-api
.. image:: https://github.com/whois-api-llc/whois-api-py/workflows/Build/badge.svg
:alt: whois-api-py build
:target: https://github.com/whois-api-llc/whois-api-py/actions
========
Overview
========
The client library for
`Whois API <https://whois.whoisxmlapi.com/>`_
in Python language.
The minimum Python version is 3.7.
Installation
============
::
pip install whois-api
Examples
========
Full API documentation available `here <https://whois.whoisxmlapi.com/api/documentation/making-requests>`_
Create a new client
-------------------
::
from whoisapi import *
client = Client(api_key='Your API key')
Make basic requests
-------------------
::
# Get parsed whois record as a model instance.
whois = client.data('whoisxmlapi.com')
# Get particular field of the whois record
print(whois.created_date_raw)
# Get raw API response
resp_str = client.raw_data('whoisxmlapi.com')
Additional options
-------------------
You can specify a custom parameters for particular request
::
params = RequestParameters(ignore_raw_texts=1, da=2)
whois = client.data('whoisxmlapi.com', params)
print(whois.domain_availability_raw)
# Also you can modify default values of parameters:
client.parameters.output_format = 'xml'
print(client.raw_data('whoisxmlapi.com'))
Changelog
=========
1.2.0 (2023-07-31)
------------------
* Fix datetime parsing
1.1.4 (2023-07-31)
------------------
* Fix datetime parsing
* Add postal_code_str field
1.1.3 (2023-07-31)
------------------
* Bump requests
* Drop Python 3.6 support
1.1.2 (2022-11-08)
------------------
* Bump urllib3
1.1.1 (2021-11-19)
------------------
* Added postal address error handling
1.1.0 (2021-04-21)
------------------
* Minor fixes
* Error class 'UnparableApiResponse' was renamed to 'UnparsableApiResponseError'
1.0.0 (2021-04-12)
------------------
* First release
Raw data
{
"_id": null,
"home_page": "https://github.com/whois-api-llc/whois-api-py",
"name": "whois-api",
"maintainer": "",
"docs_url": null,
"requires_python": "~=3.7",
"maintainer_email": "",
"keywords": "whois,api,whoisxmlapi",
"author": "WHOIS API, Inc",
"author_email": "support@whoisxmlapi.com",
"download_url": "https://files.pythonhosted.org/packages/9a/6e/a8dc555db3def55710c44f91135543ab1501822a9e1f3682502d50fe8434/whois-api-1.2.0.tar.gz",
"platform": null,
"description": ".. image:: https://img.shields.io/badge/License-MIT-green.svg\n :alt: whois-api-py license\n :target: https://opensource.org/licenses/MIT\n\n.. image:: https://img.shields.io/pypi/v/whois-api.svg\n :alt: whois-api-py release\n :target: https://pypi.org/project/whois-api\n\n.. image:: https://github.com/whois-api-llc/whois-api-py/workflows/Build/badge.svg\n :alt: whois-api-py build\n :target: https://github.com/whois-api-llc/whois-api-py/actions\n\n========\nOverview\n========\n\nThe client library for\n`Whois API <https://whois.whoisxmlapi.com/>`_\nin Python language.\n\nThe minimum Python version is 3.7.\n\nInstallation\n============\n::\n\n pip install whois-api\n\nExamples\n========\n\nFull API documentation available `here <https://whois.whoisxmlapi.com/api/documentation/making-requests>`_\n\nCreate a new client\n-------------------\n\n::\n\n from whoisapi import *\n\n client = Client(api_key='Your API key')\n\nMake basic requests\n-------------------\n\n::\n\n # Get parsed whois record as a model instance.\n whois = client.data('whoisxmlapi.com')\n # Get particular field of the whois record\n print(whois.created_date_raw)\n\n # Get raw API response\n resp_str = client.raw_data('whoisxmlapi.com')\n\nAdditional options\n-------------------\nYou can specify a custom parameters for particular request\n\n\n::\n\n params = RequestParameters(ignore_raw_texts=1, da=2)\n\n whois = client.data('whoisxmlapi.com', params)\n print(whois.domain_availability_raw)\n\n # Also you can modify default values of parameters:\n client.parameters.output_format = 'xml'\n print(client.raw_data('whoisxmlapi.com'))\n\n\nChangelog\n=========\n\n1.2.0 (2023-07-31)\n------------------\n\n* Fix datetime parsing\n\n1.1.4 (2023-07-31)\n------------------\n\n* Fix datetime parsing\n* Add postal_code_str field\n\n1.1.3 (2023-07-31)\n------------------\n\n* Bump requests\n* Drop Python 3.6 support\n\n1.1.2 (2022-11-08)\n------------------\n\n* Bump urllib3\n\n1.1.1 (2021-11-19)\n------------------\n\n* Added postal address error handling\n\n1.1.0 (2021-04-21)\n------------------\n\n* Minor fixes\n* Error class 'UnparableApiResponse' was renamed to 'UnparsableApiResponseError'\n\n\n1.0.0 (2021-04-12)\n------------------\n\n* First release\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python client library for Whois API.",
"version": "1.2.0",
"project_urls": {
"Homepage": "https://github.com/whois-api-llc/whois-api-py"
},
"split_keywords": [
"whois",
"api",
"whoisxmlapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bee2f3afb9ead94e58e96c0c34dbc1e2f9bdc016fda3211398ac02f12ff90192",
"md5": "3b1f8a783adbb2445f0d504b109da60f",
"sha256": "4c780441faab557995e83a719a7957931b78f63011cf941ab879265546a9eb8b"
},
"downloads": -1,
"filename": "whois_api-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3b1f8a783adbb2445f0d504b109da60f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.7",
"size": 11755,
"upload_time": "2023-07-31T11:35:27",
"upload_time_iso_8601": "2023-07-31T11:35:27.101766Z",
"url": "https://files.pythonhosted.org/packages/be/e2/f3afb9ead94e58e96c0c34dbc1e2f9bdc016fda3211398ac02f12ff90192/whois_api-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9a6ea8dc555db3def55710c44f91135543ab1501822a9e1f3682502d50fe8434",
"md5": "1b191a61e43ae633a9dae3bccfdfb81a",
"sha256": "8b18d084332dfc7be8f9d992f076468a2a545ea3037c99fc50732ca3db87addf"
},
"downloads": -1,
"filename": "whois-api-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "1b191a61e43ae633a9dae3bccfdfb81a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.7",
"size": 10410,
"upload_time": "2023-07-31T11:35:29",
"upload_time_iso_8601": "2023-07-31T11:35:29.143099Z",
"url": "https://files.pythonhosted.org/packages/9a/6e/a8dc555db3def55710c44f91135543ab1501822a9e1f3682502d50fe8434/whois-api-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-31 11:35:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "whois-api-llc",
"github_project": "whois-api-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "whois-api"
}
JSON
