Misc Domain API


Find MX

Convenience API to find and return the MX records for domain in higher priority order

POST
                
  https://api.clearout.io/v2/domain/resolve/mx
                
              
                      
  curl -X POST 'https://api.clearout.io/v2/domain/resolve/mx' \
  -H 'Authorization: Bearer REPLACE_WITH_YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ "domain": "gmail.com" }'
                      
                    

Header

FieldTypeDescription
Content-TypeStringDefault value: application/json
AuthorizationStringDefault value: Bearer REPLACE_WITH_YOUR_API_TOKEN

Parameter

FieldTypeDescription
domainStringFind MX records for domain
timeout optionalNumberRequest wait time (in milliseconds),
Maximum allowed wait time should not exceed 110000 milliseconds
Default value: 90000
                      
  HTTP/1.1 200 OK
  {
    "status": "success",
    "data": {
      "domain": "gmail.com",
      "mx_records": [
        {
          "exchange": "gmail-smtp-in.l.google.com",
          "priority": 5
        },
        {
          "exchange": "alt1.gmail-smtp-in.l.google.com",
          "priority": 10
        },
        {
          "exchange": "alt2.gmail-smtp-in.l.google.com",
          "priority": 20
        },
        {
          "exchange": "alt3.gmail-smtp-in.l.google.com",
          "priority": 30
        },
        {
          "exchange": "alt4.gmail-smtp-in.l.google.com",
          "priority": 40
        }
      ],
      "verified_on": "2020-11-17T04:17:45.473Z",
      "time_taken": 3
    }
  }
  
                      
                    
                      
  HTTP/1.1 200 OK
  {
    "status": "failed",
    "error": {
      "code": 1017,
      "message": "You have reached daily verify limit, please try next day or contact [email protected]"
    }
  }
                      
                    
                      
  HTTP/1.1 400 Bad Request
  {
    "status": "failed",
    "error": {
      "message": "validation failed",
      "reasons": [
        {
          "field": [
            "domain"
          ],
          "location": "body",
          "messages": [
            "\"domain\" is required"
          ],
          "types": [
            "any.required"
          ]
        }
      ]
    }
  }
                      
                    
                      
  HTTP/1.1 402 Payment Required
  {
    "status": "failed",
    "error": {
      "code": 1002
      "message": "You have exhausted your credits, please add additional credits to continue"
    }
  }
                      
                    
                      
  HTTP/1.1 401 Unauthorized
  {
    "status": "failed",
    "error": {
      "code": 1000,
      "message": "Invalid API Token, please generate new token"
    }
  }
                      
                    
                      
  HTTP/1.1 503 Service Unavailable
                      
                    
                      
  HTTP/1.1 524 A Timeout Occurred
  {
    "status": "failed",
    "error": {
      "message": "Timeout occurred",
      "additional_info": {
        "resource_name": "domain"
        "resource_value": "gmail.com"
      }
    }
  }
                      
                    

Find Whois

Convenience API to find and return the Whois record for domain in JSON format

POST
                
  https://api.clearout.io/v2/domain/resolve/whois
                
              
                      
  curl -X POST 'https://api.clearout.io/v2/domain/resolve/whois' \
  -H 'Authorization: Bearer REPLACE_WITH_YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ "domain": "apple.com" }'
                      
                    

Header

FieldTypeDescription
Content-TypeStringDefault value: application/json
AuthorizationStringDefault value: Bearer REPLACE_WITH_YOUR_API_TOKEN

Parameter

FieldTypeDescription
domainStringFind Whois record for domain
timeout optionalNumberRequest wait time (in milliseconds),
Maximum allowed wait time should not exceed 110000 milliseconds
Default value: 90000
                      
  HTTP/1.1 200 OK
  {
    "status": "success",
    "data": {
      "domain": "apple.com",
      "whoisRecord": {
        "domain": {
          "name": "apple.com",
          "id": "1225976_DOMAIN_COM-VRSN",
          "status": {
            "clientTransferProhibited": "http://www.icann.org/epp#clientTransferProhibited",
            "serverDeleteProhibited": "http://www.icann.org/epp#serverDeleteProhibited",
            "serverTransferProhibited": "http://www.icann.org/epp#serverTransferProhibited",
            "serverUpdateProhibited": "http://www.icann.org/epp#serverUpdateProhibited"
          },
          "created_date": "1987-02-19T04:00:00.000Z"
        },
        "registrar": {
          "name": "CSC CORPORATE DOMAINS, INC.",
          "whois_server": "whois.corporatedomains.com",
          "url": "www.cscprotectsbrands.com",
          "registration_expiry_date": "2021-02-20T04:00:00.000Z",
          "abuse_contact_email": "[email protected]",
          "abuse_contact_phone": "+1.8887802723"
        },
        "registrant": {
          "id": "",
          "name": "Domain Administrator",
          "organization": "Apple Inc.",
          "steet": "",
          "city": "Cupertino",
          "state": "",
          "postal_code": "95014",
          "country": "US",
          "phone": "+1.4089961010",
          "phone_ext": "",
          "fax": "+1.4089741560",
          "fax_ext": "",
          "email": "[email protected]",
          "admin": {
            "id": "",
            "name": "Domain Administrator",
            "organization": "Apple Inc.",
            "steet": "",
            "city": "Cupertino",
            "state": "",
            "postal_code": "95014",
            "country": "US",
            "phone": "+1.4089961010",
            "phone_ext": "",
            "fax": "+1.4089741560",
            "fax_ext": "",
            "email": "[email protected]"
          },
          "tech": {
            "id": "",
            "name": "Domain Administrator",
            "organization": "Apple Inc.",
            "steet": "",
            "city": "Cupertino",
            "state": "",
            "postal_code": "95014",
            "country": "US",
            "phone": "+1.4089961010",
            "phone_ext": "",
            "fax": "+1.4089741560",
            "fax_ext": "",
            "email": "[email protected]"
          }
        },
        "dnssec": "unsigned",
        "nameservers": [],
        "notice": "You are not authorized to access or query our WHOIS database through the use of high-volume, automated, electronic processes or for the purpose or purposes of using the data in any manner that violates these terms of use. The Data in the CSC WHOIS database is provided by CSC for information purposes only, and to assist persons in obtaining information about or related to a domain name registration record. CSC does not guarantee its accuracy. By submitting a WHOIS query, you agree to abide by the following terms of use",
        "term_of_use": "",
        "last_update_whois_database": ""
      },
      "verified_on": "2020-11-17T04:15:51.692Z",
      "time_taken": 687
    }
  }
                          
                      
                    
                      
  HTTP/1.1 200 OK
  {
    "status": "failed",
    "error": {
      "code": 1017,
      "message": "You have reached daily verify limit, please try next day or contact [email protected]"
    }
  }
                      
                    
                      
  HTTP/1.1 400 Bad Request
  {
    "status": "failed",
    "error": {
      "message": "validation failed",
      "reasons": [
        {
          "field": [
            "domain"
          ],
          "location": "body",
          "messages": [
            "\"domain\" is required"
          ],
          "types": [
            "any.required"
          ]
        }
      ]
    }
  }
                      
                    
                      
  HTTP/1.1 402 Payment Required
  {
    "status": "failed",
    "error": {
      "code": 1002
      "message": "You have exhausted your credits, please add additional credits to continue"
    }
  }
                      
                    
                      
  HTTP/1.1 401 Unauthorized
  {
    "status": "failed",
    "error": {
      "code": 1000,
      "message": "Invalid API Token, please generate new token"
    }
  }
                      
                    
                      
  HTTP/1.1 503 Service Unavailable
                      
                    
                      
  HTTP/1.1 524 A Timeout Occurred
  {
    "status": "failed",
    "error": {
      "message": "Timeout occurred",
      "additional_info": {
        "resource_name": "domain"
        "resource_value": "apple.com"
      }
    }
  }