Whois API User Guide - Whois XML API
  • Sign In / Sign Up
      Forgot Username/Password ?
      New User ?
HOME
  • PRODUCTS
    • APIs
    • Whois API
    • Domain Availability API
    • Whois History API
    • Reverse Whois API
    • Reverse IP/DNS API
    • Reverse MX API
    • Reverse NS API
    • Brand Alert API
    • Registrant Alert API
    • Bulk Whois API
    • DNS Lookup API
    • Email Verification API
    • IP Geolocation API
    • IP Netblocks API
    • Domain Reputation API
    • DOMAIN RESEARCH
    • Whois Lookup
    • Reverse Whois/Registrant Search
    • Bulk Whois Lookup
    • Bulk Email Verification
    • ENTERPRISE PACKAGES
    • Enterprise API Package
    • Enterprise Data Feed Packages
    • Enterprise Tools Packages
    • DATA FEEDS
    • Whois Database Download
    • Newly Registered Domains
    • All Registered Domains
    • DNS Database Download
    • Real-time Domain Registration
    • IP Geolocation Data Feed
    • IP Netblocks Whois Data Feed
    • Website Contact Database
    • OTHER DATA FEEDS
    • Website Classification Database
    • Internet Retailer Database
    • Threat Intelligence Data Feeds
    • CUSTOM SOLUTIONS
    • Whois API Software Package
    • Registrar Whois Service
    • Internet Statistics Reports
    • CYBER-SECURITY RESEARCH
    • Threat Intelligence Platform
    • Threat Intelligence API
  • |
  • SOLUTIONS
    • Cyber Security Solutions
    • Domainer Solutions
    • Brand Protection Solutions
    • Marketing Research Solutions
    • Registrar Solutions
    • Law Enforcement Solutions
    • Fraud Detection Solutions
    • Investment Fund & Banking Solutions
  • |
  • TOOLS
    • DASHBOARD
    • MONITOR TOOLS
    • Domain Monitor
    • Brand Monitor
    • Registrant Monitor
    • SEARCH TOOLS
    • Whois Search
    • Reverse Whois Search
    • Domain Availability
    • Bulk Whois Search
    • Bulk Email Verification
    • SETTINGS
    • PRICING
  • |
  • CONTACT US
  • |
  • BLOG
Unified & Consistent
Whois API & Whois
Parser System
Example: google.com or 74.125.45.100

Whois API User Guide

This version of the API is deprecated. For the latest version, please visit
whoisapi.whoisxmlapi.com/docs
Our Hosted Whois Web Service provides registration details, also known as Whois Records, of domain names or IP addresses.
WhoisXmlApi.com provides RESTful APIs. It is designed for server-to-server communication between your system and the WhoisXmlApi.com network using standard HTTP or HTTPS protocols. Query responses are delivered in either XML or JSON format based on your requests which are made via GET/POST methods.
To get started you need a developer's account with WhoisXmlApi.com. Authentication is required each time in order to use the API. The first 500 Whois API calls are complimentary when you register for a free developer account.

API status

You can check the API's current performance and availability status on the API Status Page.

Making a Call to Whois API Web Service

Use the following URL:
https://www.whoisxmlapi.com/whoisserver/WhoisService?domainName=google.com&username=xxxxx&password=xxxxx
Supported input parameters
Parameters Values
domainName required, the domain for which whois data is requested
username required unless ApiKey authentication is used, your account username
password required unless ApiKey authentication is used, your account password;
make sure it is URL-encoded if it contains special characters (&, %, * etc.)
requestObject required unless password authentication is used, encoded user identifier for ApiKey authentication
digest required unless password authentication is used, ApiKey access token
outputFormat XML | JSON (defaults to XML)
da 0 | 1 | 2 (defaults to 0)
1 results in a quick check on domain availability, 2 is slower but more accurate
preferFresh 0 | 1 (defaults to 0)
1 results in getting the latest Whois record even if it's incomplete
ip 0 | 1 (defaults to 0)
1 results in returning ips for the domain name
ipWhois 0 | 1 (defaults to 0)
1 results in returning the whois record for the hosting ip if the whois record for the tld of the input domain is not supported
checkProxyData 0 | 1 (defaults to 0)
1 results in fetching proxy/whois guard data, if it exists, in the WhoisRecord → privateWhoisProxy schema element
thinWhois 0 | 1 (defaults to 0)
1 results in returning whois data from registry only, without fetching data from registrar;
returned registry data corresponds to the WhoisRecord → registryData schema element
ignoreRawTexts 0 | 1 (defaults to 0)
1 results in stripping all raw text from the output
callback a javascript function used when outputFormat is JSON;
this is an implementation known as JSONP which invokes the callback on the returned response
_parse 0 | 1 (defaults to 0)
1 provides parsing for input whois raw texts described below
registryRawText a string representing the registry whois raw text to be parsed;
works only when the _parse parameter is equal to 1
registrarRawText a string representing the registrar whois raw text to be parsed;
works only when the _parse parameter is equal to 1

Authentication

Password authentication
This method uses your account's username and password to authenticate with the web service. Just pass your credentials as query string parameters (username, password).
API key authentication
Generate access tokens providing your API and secret keys to make Whois API calls without sending your username and password. These tokens will need to be included as part of the request URL (requestObject, digest). Please, note that all tokens expire after 5 minutes and will have to be regenerated. Access the API Key Management section of your account to create your keys (make sure the key you're using is marked as active).

Sample Output

XML
JSON

							

Usage of HTTP & HTTPS

You can use both http and https to make API queries. With HTTPS the connection will be more secure but slightly slower.

XML Schema / Whois Query Result Documentation

You can download the following for your reference:
Responsive image xml schema
Responsive image wsdl schema
Responsive image query result documentation
Responsive image sample xml result

Query Account Balance Information

In order to query your account balance, use the following URL:
https://www.whoisxmlapi.com/accountServices.php?servicetype=accountbalance&username=xxxxx&password=xxxxx
Supported input parameters
Parameters Values
servicetype required, type of service;
in this case, "accountBalance"
username required, your account username
password required, your account password;
make sure it is URL-encoded if it contains special characters (&, %, * etc.)
output_format XML | JSON (defaults to XML)
You will receive a response with your account balance.

Account Balance Low or Zero Notification

When your account balance falls below certain level (default is 100, but customizable as per your need) you will receive an email alert. Another email will be sent when your account balance reaches 0.
To customize the warning level, use the URL:
https://www.whoisxmlapi.com/accountServices.php?servicetype=accountUpdate&username=xxxxx&password=xxxxx&warn_threshold=30
Supported input parameters
Parameters Values
servicetype required, type of service;
in this case, "accountUpdate"
username required, your account username
password required, your account password;
make sure it is URL-encoded if it contains special characters (&, %, * etc.)
warn_threshold a positive number (defaults to 10)
when your account balance reaches this value a warning email will be sent
warn_threshold_enabled 0 | 1 (defaults to 1)
indicates whether the low balance warning notification should be sent at all
warn_empty_enabled 0 | 1 (defaults to 1)
indicates whether the zero balance email notification should be sent to you
output_format XML | JSON (defaults to XML)

TLDs Supported

We support thousands of TLDs, both gTLDs and ccTLDS. You can see the entire list here.

Sample code for making a query to Whois API Web Service

You may view examples of querying Whois API by clicking on the following links or visiting our GitHub page
User password authentication
Responsive image C# code: example, full project
Responsive image Java code: example, full project
Responsive image Javascript code: using the callback parameter
Responsive image Node.js code: example
Responsive image Perl code: example
Responsive image PHP code: example, XML & JSON parsing
Responsive image PowerShell code: example
Responsive image Python code: example
Responsive image Ruby code: example
API key authentication
Responsive image C# code: example, full project
Responsive image Java code: example, full project
Responsive image Javascript code: JSONP
Responsive image Node.js code: example
Responsive image Perl code: example
Responsive image PHP code: example
Responsive image PowerShell code: example
Responsive image Python code: example
Responsive image Ruby code: example

Output Schema


							

Usage Limits & 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.

Sample Output

XML
JSON

    

Frequently Asked Questions

Please click on the link below to view the FAQ
Whois API FAQ

Printable guide

You can also download the PDF version of this guide.

Terms of Service or SLA for using Whois API Web service

Please click on the link below to review the
Terms of Service
TRUSTED BY OVER
50,000
CUSTOMERS
Search over thousands of TLDs
SERVICES
APIs
  • Whois API
  • Domain Availability API
  • Whois History API
  • Reverse Whois API
  • Reverse IP/DNS API
  • Reverse MX API
  • Reverse NS API
  • Brand Alert API
  • Registrant Alert API
  • Bulk Whois API
  • DNS Lookup API
  • Email Verification API
  • IP Geolocation API
  • IP Netblocks API
  • Domain Reputation API
Domain Research
  • Whois Lookup
  • Reverse Whois/Registrant Search
  • Bulk Whois Lookup
  • Bulk Email Verification
Cyber-security Research
  • Threat Intelligence Platform
  • Threat Intelligence API
Custom Solutions
  • Whois Api Software Package
  • Registrar Whois Service
  • Internet Statistics Reports
Enterprise Packages
  • Enterprise API Package
  • Enterprise Data Feed Packages
  • Enterprise Tools Packages
Data Feeds
  • Whois Database Download
  • Website Contact Database
  • Newly Registered Domains
  • Website Classification Database
  • Internet Retailer Database
  • Threat Intelligence Data Feeds
  • All Registered Domains
  • Domain IP Database
  • Real-time Domain Registration
  • IP Geolocation Data Feed
  • IP Netblocks Whois Data Feed
SUBSCRIBE
MOBILE APPLICATION

Need access to whois data on the go?
Install our application on your device!

"Who Owns This Website"

THREE-YEAR GROWTH 1,640%

TOP IT SERVICES COMPANIES

Terms Of Use | Privacy Policy | Affiliate | Contact Us |
©2014-2021 Whois API, Inc. All rights reserved.
Header
Message
Loading.....