domain-reputation-py's Introduction

Overview

The client library for Domain Reputation API in Python language.

The minimum Python version is 3.6.

Installation

pip install domain-reputation

Examples

Full API documentation available here

Create a new client

from domainreputation import *

client = Client('Your API key')

Make basic requests

# 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

result = client.get(
    'samsung.com',
    Client.MODE_FULL)

Response model overview

Response:
    - mode: str
    - reputation_score: float
    - test_results: [TestResult]
        - test: str
        - test_code: int
        - warnings: [str]
        - warning_codes: [int]

Sample response

{
'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
          ]
      }
  ]
}

Recommend Projects