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

Making requests

API endpoint

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

Postman collection

Postman is a desktop and web application that allows you to make requests to an API from a graphical user interface. We recommend using Postman with WhoisXML APIs endpoints when exploring the APIs functionality, as well as when you are troubleshooting issues with your application.

The WhoisXML API Postman collection is available at the following links:

The collection includes a preconfigured environment. You will need to set up the api_key variable to fire each request. Get your personal API KEY on the My products page. If you have questions related to the API, contact us.

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 the 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 500 DRS credits.

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.

This API is also available with a dedicated load balancer and premium endpoint to enable faster querying as part of our Premium API Services and Enterprise API Packages.