View our

Screenshot API Code Examples

PHP Code Example

Basic PHP example using cURL. We will get a screenshot for the domain name “whoapi.com”.

<?php
// Prepare vars
$fullurl    = "whoapi.com";     // page url
$r          = "screenshot";     // API request type
$apikey     = "demokey";        // your API key
$process    = "thumb";          // thumb image only (first viewport without scroll)
$resolution = "1366x768";       // screen resolution to use

// API call
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.whoapi.com?apikey=$apikey&r=$r&fullurl=$fullurl&process=$process&resolution=$resolution&asap=&node_geo=&delay=&thumbwidth=&thumbheight=");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$output = json_decode(curl_exec($ch), true);
curl_close($ch);

// Success
if (isset($output['status']) && $output['status'] == 0) {
    echo "Success. Small thumbnail for \"$fullurl\": ".$output['thumbnail_https'];
    
// API error
} elseif (!empty($output['status_desc'])) {
    echo "API reports error: ".$output['status_desc'];
    
// Unknown error
} else {
    echo "Unknown error";
}
?>

Javascript Code Example

We will get a screenshot for the domain name “whoapi.com”.

<script type="text/javascript">
var fullurl    = "whoapi.com";            // page url
var r          = "screenshot";            // API request type
var apikey     = "demokey";               // your API key
var process    = "thumb";                 // thumb image only (first viewport without scroll)
var resolution = "1366x768";              // screen resolution to use

var xhr = new XMLHttpRequest();
xhr.open("GET", 'https://api.whoapi.com?apikey='+apikey+'&r='+r+'&fullurl='+fullurl+'&process='+process+'&resolution='+resolution+'&asap=&node_geo=&delay=&thumbwidth=&thumbheight=', true);
xhr.onreadystatechange = function () {
    if (xhr.readyState === 4 && xhr.status === 200) {
        var json = JSON.parse(xhr.responseText);
        if (json.status == 0) {
            document.getElementById("result").innerHTML = "Success. Small thumbnail: " + json.thumbnail_https;
        } else {
            document.getElementById("result").innerHTML = "API reports error: " + json.status_desc;
        }
    } else {
        document.getElementById("result").innerHTML = "Unknown error";
    }
};
xhr.send();
</script>
<div id="result">please wait...</div>

Ruby Code Example

We will get a screenshot for the domain name “whoapi.com”.

require 'open-uri'
require 'json'

fullurl    = "whoapi.com";            # page url
r          = "screenshot";            # API request type
apikey     = "demokey";               # your API key
process    = "thumb";                 # thumb image only (first viewport without scroll)
resolution = "1366x768";              # screen resolution to use

output = JSON.parse(URI.open("https://api.whoapi.com?apikey=#{apikey}&r=#{r}&fullurl=#{fullurl}&process=#{process}&resolution=#{resolution}&asap=&node_geo=&delay=&thumbwidth=&thumbheight=").read)

if output["status"].to_i == 0
 puts "Success. Small thumbnail: " + output["thumbnail_https"]
elsif !output["status_desc"].nil?
 puts "API reports error: " + output["status_desc"]
else
 puts "Unknown error"
end

Python Code Example

We will get a screenshot for the domain name “whoapi.com”.

#!/usr/bin/env python
import requests


def whoapi_request(fullurl, r, apikey, process, resolution) -> None:

    res = requests.get('https://api.whoapi.com', dict(
        fullurl=fullurl,
        r=r,
        apikey=apikey,
        process=process,
        resolution=resolution))

    if res.status_code == 200:
        data = res.json()
        if int(data['status']) == 0:
            print("Success. Small thumbnail: " + data["thumbnail_https"])
        else:
            print("API reports error: " + data['status_desc'])
    else:
        raise Exception('Unexpected status code %d' % res.status_code)


fullurl = 'whoapi.com'      # page url
r = 'screenshot'            # API request type
apikey = 'demokey'          # key
process = "thumb";          # thumb image only (first viewport without scroll)
resolution = "1366x768";    # screen resolution to use

whoapi_request(fullurl, r, apikey, process, resolution)

Objective C Code Example

We will get a screenshot for the domain name “whoapi.com”.

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[]) {
    NSString *fullurl    = @"whoapi.com";         // page url
    NSString *r          = @"screenshot";         // API request type
    NSString *apikey     = @"demokey";            // your API key
    NSString *process    = @"thumb";              // thumb image only (first viewport without scroll)
    NSString *resolution = @"1366x768";           // screen resolution to use
    
    NSString *urlAsString = [NSString stringWithFormat:@
    "https://api.whoapi.com/?fullurl=%@&r=%@&apikey=%@&process=%@&resolution=%@", fullurl, r, apikey, process, resolution];
    
    NSMutableURLRequest *urlRequest = [[NSMutableURLRequest alloc] initWithURL:[NSURL URLWithString:urlAsString]];
    [urlRequest setHTTPMethod:@"GET"];
    NSURLSession *session = [NSURLSession sharedSession];
    
    // Semaphore used only for the debug purpose
    dispatch_semaphore_t sema = dispatch_semaphore_create(0);
    
    NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:urlRequest completionHandler:^(NSData *data, NSURLResponse *response, NSError *error)
    {
        NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *)response;
        if(httpResponse.statusCode == 200)
        {
            NSError *parseError = nil;
            NSDictionary *responseDictionary = [NSJSONSerialization JSONObjectWithData:data options:0 error:&parseError];
            
            NSNumber *status;
            if([responseDictionary[@"status"] isKindOfClass:[NSString class]]) {
                NSNumberFormatter *f = [[NSNumberFormatter alloc] init];
                f.numberStyle = NSNumberFormatterDecimalStyle;
                status = [f numberFromString:responseDictionary[@"status"]];
            } else {
                status = responseDictionary[@"status"];
            }
            if([status isEqualToNumber:@0])
            {
                NSLog(@"Success. Small thumbnail: %@", responseDictionary[@"thumbnail_https"]);
            } else {
                NSLog(@"API reports error: %@", responseDictionary[@"status_desc"]);
            }
        }
        else
        {
            NSLog(@"Unexpected status code\n");
        }
        
        // Semaphore used only for the debug purpose
        dispatch_semaphore_signal(sema);
    }];
    [dataTask resume];
    
    // Semaphore used only for the debug purpose
    dispatch_semaphore_wait(sema, DISPATCH_TIME_FOREVER);
    
    return 0;
}

C#(.NET) Code Example

We will get a screenshot for the domain name “whoapi.com”.

using Newtonsoft.Json.Linq;
using System;
using System.IO;
using System.Net;

public class Program
{
    public static void Main()
    {
        string apiType = "screenshot"; // API request type
        string fullurl = "whoapi.com"; // page url
        string apiKey = "demokey"; // api key
        string process = "thumb"; // thumb image only (first viewport without scroll)
        string resolution = "1366x768"; // screen resolution to use

        WebRequest request = WebRequest.Create(String.Format("https://api.whoapi.com/?fullurl={0}&r={1}&apikey={2}&process={3}&resolution={4}", fullurl, apiType, apiKey, process, resolution));
        WebResponse response = request.GetResponse();

        StreamReader reader = new StreamReader(response.GetResponseStream());
        string responseFromServer = reader.ReadToEnd();

        JObject json = JObject.Parse(responseFromServer);

        if (json.Value<int>("status") == 0)
        {
            Console.WriteLine(String.Format("Success. Small thumbnail: {0}. ", json["thumbnail_https"]));
        }
        else
        {
            Console.WriteLine(String.Format("API reports error: {0}. ", json["status_desc"]));
        }
    }
}

Java Code Example

We will get a screenshot for the domain name “whoapi.com”.

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import org.json.JSONObject;

class Main {
    public static void main(String args[]) {
      try {
        // Set data
        String fullurl = "whoapi.com"; // page url
        String rtype = "screenshot"; // API request type
        String apikey = "demokey"; // your API key
        String process = "thumb"; // thumb image only (first viewport without scroll)
        String resolution = "1366x768"; // screen resolution to use

        // Send request to API
        URL obj = new URL("https://api.whoapi.com/?fullurl=" + fullurl + "&r=" + rtype + "&apikey=" + apikey + "&process=" + process + "&resolution=" + resolution);
        HttpURLConnection con = (HttpURLConnection) obj.openConnection();
        
        // Validate HTTP response code
        int responseCode = con.getResponseCode();
        if (responseCode != 200) {
          System.out.println("HTTP request error, code: " + responseCode);
          return;
        }
        
        // Read API reply
        BufferedReader in = new BufferedReader(new InputStreamReader(con.getInputStream()));
        String inputLine;
        StringBuffer response = new StringBuffer();
        while ((inputLine = in.readLine()) != null) {
          response.append(inputLine);
        }
        in.close();
        
        // Get JSON
        JSONObject myResponse = new JSONObject(response.toString());
        int status = myResponse.getInt("status");
        String statusDesc = myResponse.getString("status_desc");
        
        // Validate request status
        if (status != 0) {
          System.out.println("API reports error: " + statusDesc);
          return;
        }
        
        String thumbURL = myResponse.getString("thumbnail_https");
        
        System.out.println("Success. Small thumbnail: " + thumbURL);
        
      } catch (Exception e) {
          e.printStackTrace();
      }
    }
}