Getting WHOIS records | Documentation | Bulk WHOIS API | WhoisXML API

Getting WHOIS records

POST https://www.whoisxmlapi.com/BulkWhoisLookup/bulkServices/getRecords

Since processing all the input domains may take some time, you'll have to repeatedly query this resource until the returned recordsLeft field value is 0.

Set the maxRecords input parameter to 1 if you don't need to monitor each record's progress.

Otherwise, each element of the whoisRecords array contains the whoisRecordStatus field:

  • 0 - processed;
  • 1/2 - incomplete / missing data;
  • 3 - processing.

The domainStatus field contains the processing status of the record:

  • N - unavailable;
  • I - available.

POST request body sample

{
    "apiKey": "API_KEY",
    "requestId": "ece0f949-c22a-4ecc-...",
    "maxRecords": 1,
    "startIndex": 1,
    "outputFormat": "JSON"
}

Input parameters

apiKey

Required. Get your personal API key on the My products page.

requestId

Required. String.

Bulk request identifier.

maxRecords

Required. Number.

Maximum amount of WHOIS records to be returned.

startIndex

Optional. Number.

The first WHOIS record to be returned by the server.

Acceptable values: 1+

Default: 1

outputFormat

Optional. Response output format.

Acceptable values: JSON | XML

Default: XML

Sample output

{
    "noDataAvailable": false,
    "domainList": [
        "google.com",
        "yahoo.com"
    ],
    "requestId": "e1b32d19-6ad6-4313-....-....",
    "whoisRecords": [
        {
            "domainName": "google.com",
            "domainStatus": "I",
            "whoisRecordStatus": 0,
            "domainFetchedTime": "1739951825139",
            "whoisRecord": {
                ...
            },
            "index": 1
        },
        {
            "domainName": "yahoo.com",
            "domainStatus": "I",
            "whoisRecordStatus": 0,
            "domainFetchedTime": "1739951825140",
            "whoisRecord": {
                ...
            },
            "index": 2
        }
    ],
    "domains": [],
    "totalRecords": 2,
    "recordsLeft": 0,
    "recordsProcessed": 2
}

Code: 200 OK.

Output parameters

noDataAvailable

Boolean.

Indicates whether WHOIS data is available for the requested domain.

domainList

Array.

List of requested domains.

requestId

String.

Request ID.

whoisRecords

Array.

Array of WHOIS records.

whoisRecords[k].index

String.

Index of the WHOIS record.

whoisRecords[k].domainName

String.

Domain name.

whoisRecords[k].domainStatus

String.

Domain processing status.

whoisRecords[k].whoisRecordStatus

Integer.

WHOIS record retrieval status.

whoisRecords[k].domainFetchedTime

String.

Time when the domain was fetched.

whoisRecords[k].whoisRecord

Object.

WHOIS record. Output parameters are described in the WHOIS API documentation.

domains

Array.

List of domains for which WHOIS records are not available.

totalRecords

Integer.

Total number of WHOIS records.

recordsLeft

Integer.

Number of WHOIS records left to be processed.

recordsProcessed

Integer.

Number of WHOIS records processed.