Retrieve domain whois information.
| Parameter | Type | Description | Required |
|---|---|---|---|
| action | string | "DomainWhois" | Required |
| domain | string | The domain name to lookup | Required |
| Parameter | Type | Description |
|---|---|---|
| result | string | The result of the operation: success or error |
| status | string | The registration status: available or unavailable |
| whois | string | Whois server response |
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
http_build_query(
array(
'action' => 'DomainWhois',
// See https://developers.whmcs.com/api/authentication
'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
'password' => 'SECRET_OR_HASHED_PASSWORD',
'domain' => 'example.com',
'responsetype' => 'json',
)
)
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);$command = 'DomainWhois';
$postData = array(
'domain' => 'example.com',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later
$results = localAPI($command, $postData, $adminUsername);
print_r($results);{
"result": "success",
"status": "unavailable",
"whois": "xxx"
}Possible error condition responses include:
- Domain not valid
- The given TLD is not supported for WHOIS lookups
| Version | Changelog |
|---|---|
| 1.0 | Initial Version |