https://github.com/whois-api-llc/reverse-ns-py
Reverse NS API client library for Python
https://github.com/whois-api-llc/reverse-ns-py
nameserver python reverse-dns reverse-ns whoisxmlapi
Last synced: 9 months ago
JSON representation
Reverse NS API client library for Python
- Host: GitHub
- URL: https://github.com/whois-api-llc/reverse-ns-py
- Owner: whois-api-llc
- License: mit
- Created: 2021-07-09T12:36:37.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-23T01:24:34.000Z (about 3 years ago)
- Last Synced: 2025-03-06T07:37:39.162Z (over 1 year ago)
- Topics: nameserver, python, reverse-dns, reverse-ns, whoisxmlapi
- Language: Python
- Homepage: https://reverse-ns.whoisxmlapi.com/api
- Size: 10.7 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE
- Authors: AUTHORS.rst
Awesome Lists containing this project
README
.. image:: https://img.shields.io/badge/License-MIT-green.svg
:alt: reverse-ns-py license
:target: https://opensource.org/licenses/MIT
.. image:: https://img.shields.io/pypi/v/reverse-ns.svg
:alt: reverse-ns-py release
:target: https://pypi.org/project/reverse-ns
.. image:: https://github.com/whois-api-llc/reverse-ns-py/workflows/Build/badge.svg
:alt: reverse-ns-py build
:target: https://github.com/whois-api-llc/reverse-ns-py/actions
========
Overview
========
The client library for
`Reverse NS API `_
in Python language.
The minimum Python version is 3.6.
Installation
============
.. code-block:: shell
pip install reverse-ns
Examples
========
Full API documentation available `here `_
Create a new client
-------------------
.. code-block:: python
from reversens import *
client = Client('Your API key')
Make basic requests
-------------------
.. code-block:: python
# Get categories for a domain name.
response = client.get('ns.google.com')
for row in response.result:
print("Domain: " + row.name)
Advanced usage
-------------------
Extra request parameters
.. code-block:: python
# Iterating over all pages
# Specify the target name server.
client.name_server = "ns2.google.com"
# Now you can use the `Client` instance as an iterable object
for page in client:
# Precess the data:
for row in page.result:
print(row.name)
# You can access the last response object via `last_result` property
print(client.last_result.size)
# Please note, that `client.get_raw(...)` method doesn't
# update value of the `last_result` field.
# Also, `iter(client)` will reset the `last_result` value to None
# Getting raw API response in XML
xml = client.get_raw('ns.google.com', output_format=Client.XML_FORMAT)
Using Response model reference
------------------------------
.. code-block:: python
response = client.get('....')
# Getting list of domains
response.result
# Checking the size of the domain list
response.size
# Checking if there is a next page
if response.has_next():
....
# `current_page` shows the `search_from` value
...
r = client.get(ns='ns', search_from='last.domain.of.the.previous.page.com')
print(r.current_page)
# >>'last.domain.of.the.previous.page.com'