Making requests | Documentation | Domains & Subdomains Discovery API | WhoisXML API

Making requests

POST https://domains-subdomains-discovery.whoisxmlapi.com/api/v1
It takes up to a minute to activate your account after the registration.

POST request body sample: domains only (1 DRS credit)

Return only domains that match the specified search terms in domain and TLD zones, excluding subdomain zones.

{
    "apiKey": "YOUR_API_KEY",
    "domains": {
        "include": [
            "amazon.*"
        ]
    }
}

POST request body sample: subdomains only (10 DRS credits)

Return only subdomains that match the specified search terms in subdomain zones, excluding domain and TLD zones.

{
    "apiKey": "YOUR_API_KEY",
    "subdomains": {
        "include": [
            "adidas*"
        ],
        "exclude": [
            "*shoes*"
        ]
    }
}

POST request body sample: domains and subdomains (11 DRS credits)

Return domains AND subdomains that match the specified search terms in the entire hostname.

{
    "apiKey": "YOUR_API_KEY",
    "domains": {
        "include": [
            "amazon.com"
        ]
    },
    "subdomains": {
        "include": [
            "aws*"
        ],
        "exclude": [
            "*portal*",
            "*beta*"
        ]
    }
}

You can provide up to four include and exclude search terms within one request.

Input parameters

apiKey

Required. Get your personal API KEY on My products page.

[domains|subdomains].include

Required. Array of included search terms. Maximum 4 items. Case insensitive.

[domains|subdomains].exclude

Optional. Array of excluded search terms. Maximum 4 items. Case insensitive.

sinceDate

Optional. Date in "YYYY-MM-DD" format.

If present, search through domains/subdomains discovered since the given date.

outputFormat

Optional. Response output format.

Acceptable values: JSON | XML

Default: JSON

1 request to Domains & Subdomains Discovery API costs:

  • Domains only: 1 DRS credit
  • Subdomains only: 10 DRS credits
  • Domains and subdomains: 11 DRS credits

Wildcard Search

You can use wildcards in order to search. Note that such queries might be slow.

{
    "apiKey": "YOUR_API_KEY",
    "domains": {
        "include": [
            "amazon.*"
        ]
    },
    "subdomains": {
        "include": [
            "aws*"
        ],
        "exclude": [
            "*portal*",
            "*beta*"
        ]
    }
}

Free access

After Sign Up you automatically get a free subscription plan limited to 100 DRS credits per month.

Usage limits and requests throttling

The maximum number of requests per second is 30. In case that the limit is breached, your subsequent requests will be rejected until the next second.

Have questions?

We are here to listen. For a quick response, please select your request type or check our Contact us page for more information. By submitting a request, you agree to our Terms of Service and Privacy Policy.

Or shoot us an email to