Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/whois-api-llc/domain-reputation-py
Domain Reputation API client library for Python
https://github.com/whois-api-llc/domain-reputation-py
dns domain domain-reputation python reputation whoisxmlapi
Last synced: about 1 month ago
JSON representation
Domain Reputation API client library for Python
- Host: GitHub
- URL: https://github.com/whois-api-llc/domain-reputation-py
- Owner: whois-api-llc
- License: mit
- Created: 2021-10-25T18:18:08.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-05-23T01:31:44.000Z (over 1 year ago)
- Last Synced: 2024-07-08T09:38:48.848Z (6 months ago)
- Topics: dns, domain, domain-reputation, python, reputation, whoisxmlapi
- Language: Python
- Homepage: https://domain-reputation.whoisxmlapi.com/api
- Size: 11.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: domain-reputation-py license
:target: https://opensource.org/licenses/MIT
.. image:: https://img.shields.io/pypi/v/domain-reputation.svg
:alt: domain-reputation-py release
:target: https://pypi.org/project/domain-reputation
.. image:: https://github.com/whois-api-llc/domain-reputation-py/workflows/Build/badge.svg
:alt: domain-reputation-py build
:target: https://github.com/whois-api-llc/domain-reputation-py/actions
========
Overview
========
The client library for
`Domain Reputation API `_
in Python language.
The minimum Python version is 3.6.
Installation
============
.. code-block:: shell
pip install domain-reputation
Examples
========
Full API documentation available `here `_
Create a new client
-------------------
.. code-block:: python
from domainreputation import *
client = Client('Your API key')
Make basic requests
-------------------
.. code-block:: python
# Get DNS records for a domain name.
response = client.get('youtube.com')
print(response)
# Get raw API response in XML format
raw_result = client.get_raw('bbc.com',
output_format=Client.XML_FORMAT)
Advanced usage
-------------------
Extra request parameters
.. code-block:: python
result = client.get(
'samsung.com',
Client.MODE_FULL)
Response model overview
-----------------------
.. code-block:: python
Response:
- mode: str
- reputation_score: float
- test_results: [TestResult]
- test: str
- test_code: int
- warnings: [str]
- warning_codes: [int]
Sample response
---------------
.. code-block:: python
{
'mode': 'full',
'reputation_score': 81.16,
'test_results':
[
{
"test": "Name servers configuration meets best practices",
"testCode": 76,
"warnings": [
"Some name servers are located on a single ASN: \
ns44.domaincontrol.com - AS44273, ns43.domaincontrol.com - AS44273"
],
"warningCodes": [
1013
]
},
{
"test": "Mail servers configuration check",
"testCode": 80,
"warnings": [
"AAAA records not configured for mail servers",
"SPF record not configured",
"DMARC is not configured"
],
"warningCodes": [
5007,
5015,
5016
]
},
{
"test": "Malware databases check",
"testCode": 82,
"warnings": [
"Status: dangerous"
],
"warningCodes": [
4001
]
},
{
"test": "SSL Certificate configuration",
"testCode": 89,
"warnings": [
"No SSL certificates found"
],
"warningCodes": [
6023
]
}
]
}