Making requests | Documentation | Screenshot API | WhoisXML API
Products APIs Data Feeds Web Tools Domain Research & Monitoring Enterprise Packages
WHOIS / WHOIS History
WHOIS / WHOIS History

Provide current and historical ownership information on domains / IPs. Identify all connections between domains, registrants, registrars, and DNS servers.

DNS / DNS History
DNS / DNS History

Look into all current and historical DNS / IP connections between domains and A, MX, NS, and other records. Monitor suspicious changes to DNS records.

IP Geolocation / IP Netblocks
IP Geolocation / IP Netblocks

Get detailed context on an IP address, including its user’s geolocation, time zone, connected domains, connection type, IP range, ASN, and other network ownership details.

Domain Research Suite (DRS)
Domain Research Suite (DRS)

Access our web-based solution to dig into and monitor all domain events of interest.

Domain Research Suite (DRS)
Domain Research Suite (DRS)

Get access to a web-based enterprise-grade solution to search and monitor domain registrations and ownership details for branded terms, fuzzy matches, registrants of interest, and more.

Research
Monitoring
White-Label
Enterprise API Packages
Enterprise API Packages

Our complete set of domain, IP, and DNS intelligence available via API calls as an annual subscription with predictable pricing.

Security Intelligence (SI) Suite
Security Intelligence (SI) Suite

Offers complete access to WHOIS, IP, DNS, and subdomain data for product enrichment, threat hunting and more.

Premium API Services
Premium API Services

Enjoy priority data access with our premium API services topped with extra perks including dedicated team support, enterprise-grade infrastructure, and SLAs for full scalability and high performance.

×
Contact Us
API docs Integrations Pricing
Making requests Output examples Error codes
Balance information Generate new API key

Making requests

API endpoint

GET https://website-screenshot.whoisxmlapi.com/api/v1?apiKey=YOUR_API_KEY&url=google.com&credits=DRS
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.

Input parameters

apiKey

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

Required. The target website's url.

Specifying port numbers is also supported, e.g. example.com:80.

Note that if the URL contains some "special characters", f.e. '&, ?, #, =', you should encode the URL.
credits

Optional.

SA — Screenshot API credits will be taken into account when the API is called.

DRS — Domain Research Suite credits will be taken into account when the API is called.

Acceptable values: SA | DRS

Default: SA
imageOutputFormat

Optional. Response output format.

Acceptable values: image | base64

Default: image
errorsOutputFormat

Optional. Errors output format.

Acceptable values: JSON | XML

Default: JSON
type

Optional. Image output type.

Acceptable values: jpg | png | pdf

Default: jpg
quality

Optional. Image quality. (only for jpg type).

Acceptable values: 40 < quality < 99

Default: jpg
width

Optional. Image width (px).

Acceptable values: 100 < width < 3000

Default: 800
height

Optional. Image height (px).

Acceptable values: 100 < width < 3000

Default: 600
thumbWidth

Optional. Image thumb width (px).

Acceptable values: 50 < thumbWidth < width param value

Default: 0
mode

Optional.

fast - waiting for the document.load event.

slow - waiting for network idle event.

Acceptable values: fast | slow

Default: fast
scroll

Optional. If specified (any value), scrolls down and to the scrollPosition (useful for full-page screenshots).
scrollPosition

Optional. Specifies scroll's behavior

Acceptable values: top | bottom

Default: top
fullPage

Optional. If specified (any value), makes full-page screenshot.
noJs

Optional. If specified (any value), disables JS.
delay

Optional. Custom delay (ms) before screen capture.

Acceptable values: 0 < delay < 10000 ms

Default: 250
timeout

Optional. Custom timeout (ms) for page loading. API will respond with an error if our server can't load the page within the specified timeout.

Acceptable values: 1000 < timeout < 30000 ms

Default: 15000
scale

Optional. deviceScaleFactor value for the emulator.

Acceptable values: 0.5 < scale < 4.0

Default: 1.0
retina

Optional. If specified (any value), emulates retina display.
ua

Optional. The 'User-Agent' header string.
cookies

Optional. The 'Cookie' header string in the following format: name1=value1;name2=value2.

Please ensure that the query string is properly encoded.
mobile

Optional. If specified (any value), emulates mobile device.
touchScreen

Optional. If specified (any value), emulates device with a touch screens.
landscape

Optional. If specified (any value), renders page in landscape mode (useful for smartphone emulation).
failOnHostnameChange

Optional. If specified (any value), the API responds with 422 HTTP error code when the target domain name is changed due to redirects.

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 minute is 120. In case that the limit is breached, your subsequent requests will be rejected until the next minute.

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.