https://github.com/whois-api-llc/reverse-mx-py

Reverse MX API client library for Python
https://github.com/whois-api-llc/reverse-mx-py

email mail-server mx mx-record python whoisxmlapi

Last synced: 27 days ago
JSON representation

Reverse MX API client library for Python

• Host: GitHub
• URL: https://github.com/whois-api-llc/reverse-mx-py
• Owner: whois-api-llc
• License: mit
• Created: 2021-05-26T11:25:46.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-05-23T01:16:33.000Z (over 1 year ago)
• Last Synced: 2024-10-07T14:46:53.196Z (3 months ago)
• Topics: email, mail-server, mx, mx-record, python, whoisxmlapi
• Language: Python
• Homepage: https://reverse-mx.whoisxmlapi.com/api
• Size: 10.7 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
.. image:: https://img.shields.io/badge/License-MIT-green.svg

    :alt: reverse-mx-py license

    :target: https://opensource.org/licenses/MIT

.. image:: https://img.shields.io/pypi/v/reverse-mx.svg

    :alt: reverse-mx-py release

    :target: https://pypi.org/project/reverse-mx

.. image:: https://github.com/whois-api-llc/reverse-mx-py/workflows/Build/badge.svg

    :alt: reverse-mx-py build

    :target: https://github.com/whois-api-llc/reverse-mx-py/actions

========

Overview

========

The client library for

`Reverse MX API `_

in Python language.

The minimum Python version is 3.6.

Installation

============

.. code-block:: shell

    pip install reverse-mx

Examples

========

Full API documentation available `here `_

Create a new client

-------------------

.. code-block:: python

    from reversemx import *

    client = Client('Your API key')

Make basic requests

-------------------

.. code-block:: python

    # Get the number of domains.

    result = client.data('aspmx.l.google.com')

    print(result.size)

    # Get raw API response

    raw_result = client.raw_data(

        "aspmx.l.google.com",

        response_format=Client.XML_FORMAT

    )

Advanced usage

-------------------

Extra request parameters

.. code-block:: python

    result = client.data("aspmx.l.google.com", search_from="9")

    resp = client.data("aspmx.l.google.com")

    if resp.has_next():

        next_page = client.next_page("aspmx.l.google.com", resp)

    for page in client.iterate_pages("aspmx.l.google.com"):

        print(page)