#!/usr/bin/perl -w

use strict;
use warnings;
use Carp;

use WebService::Browshot;

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################


my $browshot = WebService::Browshot->new(
	key	=> 'my_api_key',
	debug	=> 1, # print more debug information
);

my ($code, $png) = $browshot->simple(url => 'http://mobilito.net/', cache => 60 * 60 * 24 * 365, instance_id => 12); # 1 year cache, free screenshot
# code above is blocking, it will return when the screenshot finished or failed

if ($code == 200) { # success
	open PNG, "> screenshot.png" or croak "Could not open screenshot.png: $!\n";
	binmode PNG;
	print PNG $png;
	close PNG;
	
	print "Screenshot saved to screenshot.png\n";
}
else {
	print "Screenshot failed!\n";
	# the reason for the error is sent as part of the HTTP response in the X-Error header but it is not exposed by this library
}

# quicker way to save a screenshot
my ($new_code, $file) = $browshot->simple_file(url => 'http://mobilito.net/', file => "mobilito.png", cache => 0, instance_id => 65, screen_width => 1280, screen_height => 1024); # no cache, premium browser
if ($file ne '') {
	print "Screenshot saved to $file\n";
}
else {
	print "The screenshot failed\n";
}

# use the default cache. The previous screenshto will be returned (same parameters) except if the previous failed
($code, $file) = $browshot->simple_file(url => 'http://mobilito.net/', file => "/tmp/mobilito-2.png", instance_id => 65, instance_id => 65, screen_width => 1280, screen_height => 1024, width => 200); # thumbnail
if ($file ne '') {
	print "Screenshot saved to $file\n";
}
else {
	print "The screenshot failed\n";
}

# host a screenshot on S3

($code, $file) = $browshot->simple_file(
	url => 'http://mobilito.net/', 
	file => "/tmp/mobilito-2.png", 
	instance_id => 65, 
	screen_width => 1280,
	screen_height => 1024,
	hosting => 's3',
	hosting_bucket => 'my_bucket',
	hosting_file => 'youtube.png',
	hosting_width => 200 # thumbnail
);

Download code sample

<?php

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

require 'vendor/autoload.php'; # Composer
# require_once 'Browshot.php'; # or download Browshot.php

$browshot = new Browshot('my_api_key');


$data = $browshot->simple(array('url' => 'http://mobilito.net/', 'instance_id' => 12)); # default cache, free screenshot
# code above is blocking, it will return when the screenshot finished or failed

if ($data['code'] == "200") { # success
	$fp = fopen("screenshot.png", 'w');
	fwrite($fp, $data['image']);
	fclose($fp);

	echo "Screenshot saved to screenshot.png\n";
}
else {
	echo "Screenshot failed!\n";
	# the reason for the error is sent as part of the HTTP response in the X-Error header but it is not exposed by this library
}



# quicker way to save a screenshot
$info = $browshot->simple_file('mobilito.png', array('url' => 'http://mobilito.net/', 'cache' => 0, 'instance_id' => 65, 'screen_width' => 1280, 'screen_height' => 1024)); # no cache, premium browser

if ($info['file'] != "") {
  echo sprintf("Screenshot saved to %s\n", $info['file']);
}
else {
  echo "The screenshot failed\n";
}


# use the default cache. The previous screenshto will be returned (same parameters) except if the previous failed
$info = $browshot->simple_file('mobilito-2.png', array('url' => 'http://mobilito.net/', 'instance_id' => 65, 'instance_id' => 65, 'screen_width' => 1280, 'screen_height' => 1024, 'width' => 200)); # thumbnail
if ($info['file'] != "") {
	 echo sprintf("Screenshot saved to %s\n", $info['file']);
}
else {
	echo "The screenshot failed\n";
}

# host a screenshot on S3
$info = $browshot->simple_file('mobilito-2.png', array(
	'url' => 'http://mobilito.net/',  
	'instance_id' => 65, 
	'screen_width' => 1280,
	'screen_height' => 1024,
	'hosting' => 's3',
	'hosting_bucket' => 'my_bucket',
	'hosting_file' => 'youtube.png',
	'hosting_width' => 200 # thumbnail
));


?>

Download code sample

# -*- coding: utf-8 -*-
#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

from browshot import BrowshotClient

browshot = BrowshotClient('my_api_key')

data = browshot.simple('http://mobilito.net/', {'instance_id': 12}) # default cache, free screenshot
# code above is blocking, it will return when the screenshot finished or failed

if data['code'] == "200": # success
  image = open("screenshot.png", mode='wb')
  image.write(data['png'])
  image.close()
  
  print "Screenshot saved to screenshot.png\n"
else:
  print "Screenshot failed!\n"
  # the reason for the error is sent as part of the HTTP response in the X-Error header but it is not exposed by this library


# quicker way to save a screenshot
info = browshot.simple_file('http://mobilito.net/', 'mobilito.png', { 'cache': 0, 'instance_id': 65, 'screen_width': 1280, 'screen_height': 1024 }) # no cache, premium browser

if info['file'] != "":
  print "Screenshot saved to %s\n" % info['file'];
else:
  print "The screenshot failed\n"


# use the default cache. The previous screenshto will be returned (same parameters) except if the previous failed
info = browshot.simple_file('http://mobilito.net/', 'mobilito-2.png', { 'instance_id': 65, 'instance_id': 65, 'screen_width': 1280, 'screen_height': 1024, 'width': 200 }) # thumbnail
if info['file'] != "":
  print "Screenshot saved to %s\n" % info['file']
else:
  print "The screenshot failed\n"

# host a screenshot on S3
info = browshot.simple_file('http://mobilito.net/','mobilito-3.png',  
{
	'instance_id': 65, 
	'screen_width': 1280,
	'screen_height': 1024,
	'hosting': 's3',
	'hosting_bucket': 'my_bucket',
	'hosting_file': 'mobilito.png',
	'hosting_width': 200 # thumbnail
})

Download code sample

#!/usr/bin/env ruby

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

require 'browshot'

browshot = Browshot.new('my_api_key')

data = browshot.simple({ 'url' => 'http://mobilito.net/', 'instance_id' => 12 }) # default cache, free screenshot
# code above is blocking, it will return when the screenshot finished or failed

if (data[:code].to_i == 200)
	File.open("screenshot.png", 'w') {|f| f.write(data[:png]) }

	puts "Screenshot saved to screenshot.png\n"
else
	puts "Screenshot failed!\n"
	# the reason for the error is sent as part of the HTTP response in the X-Error header but it is not exposed by this library
end

# quicker way to save a screenshot
info = browshot.simple_file('mobilito.png', { 'url' => 'http://mobilito.net/', 'cache' => 0, 'instance_id' => 65, 'screen_width' => 1280, 'screen_height' => 1024 }) # no cache, premium browser

if (info[:file] != "")
  print "Screenshot saved to #{info[:file]}\n"
else
  print "The screenshot failed\n"
end

# use the default cache. The previous screenshto will be returned (same parameters) except if the previous failed
info = browshot.simple_file('mobilito-2.png', { 'url' => 'http://mobilito.net/', 'instance_id' => 65, 'instance_id' => 65, 'screen_width' => 1280, 'screen_height' => 1024, 'width' => 200 }) # thumbnail
if (info[:file] != "")
  puts "Screenshot saved to #{info[:file]}\n"
else
  puts "The screenshot failed\n"
end

# host a screenshot on S3
info = browshot.simple_file('mobilito-3.png',  
{
	'url' => 'http://mobilito.net/',
	'instance_id' => 65, 
	'screen_width' => 1280,
	'screen_height' => 1024,
	'hosting' => 's3',
	'hosting_bucket' => 'my_bucket',
	'hosting_file' => 'mobilito.png',
	'hosting_width' => 200 # thumbnail
})

Download code sample

/**********************
* WARNING
* Running this code sample will cost you Browshot credits
***********************/
'use strict';

const browshot = require('browshot');
const fs = require("fs");

var client = new browshot('my_api_key');


// default cache, free screenshot
client.simple({ url: 'http://mobilito.net/', instance_id: 12 }, function(result) {
	// it will return when the screenshot finished or failed
	if (result.code == 200) {
		fs.writeFile("screenshot.png", result.data, (err) => {
			if (err) {
				console.log(`Failed to write image to screenshot.png: ${err}`);
			}
			else {
				console.log("Image saved to screenshot.png");
			}
		});
	}
	else {
		console.log("Screenshot failed!");
		// The reason for the error is sent as part of the HTTP response in the X-Error header but it is not exposed by this library.
	}
});

// quicker way to save a screenshot
client.simpleFile('mobilito.png', 
	{ url: 'http://mobilito.net/', cache: 0, instance_id: 65, screen_width: 1280, screen_height: 1024 }, //no cache, premium browser
	function(data) {
		if (data.file != '')
			console.log(`Screenshot saved to ${data.file}`);
		else
			console.log("The screenshot failed");
	}
);

// use the default cache. The previous screenshto will be returned (same parameters) except if the previous failed
client.simpleFile('mobilito-2.png', 
	{ url: 'http://mobilito.net/', instance_id: 65, instance_id: 65, screen_width: 1280, screen_height: 1024, width: 200 }, // thumbnail
	function(data) {
		if (data.file != '')
			console.log(`Screenshot saved to ${data.file}`);
		else
			console.log("The screenshot failed");
	}
);

// host a screenshot on S3
client.simpleFile('mobilito-3.png',  
	{
		url: 'http://mobilito.net/',
		instance_id: 65, 
		screen_width: 1280,
		screen_height: 1024,
		hosting: 's3',
		hosting_bucket: 'my_bucket',
		hosting_file: 'mobilito.png',
		hosting_width: 200 // thumbnail
	}, function(data) {
		if (data.file != '')
			console.log(`Screenshot saved to ${data.file}`);
		else
			console.log("The screenshot failed");
	}
);

Download code sample

#!/usr/bin/perl -w

use strict;
use warnings;
use Carp;

use WebService::Browshot;

#######################
# WARNING
# Running this code sample will cost you Browshot credits.
#######################



my $browshot = WebService::Browshot->new(
	key	=> 'my_api_key',
	debug	=> 0, # no more debug information
);

my $screenshot = $browshot->screenshot_create(url => 'http://www.google.com/', instance_id => 12, size => 'page'); # all default parameters, instance_id = 12 (free)
# If the screenshot is already in cache, it could be finished already. Otherwise, wait longer
while ($screenshot->{status} ne 'finished' &&  $screenshot->{status} ne 'error') {
	print "Wait...\n";
	sleep 10;
	$screenshot = $browshot->screenshot_info(id => $screenshot->{id});
}

# screenshot is done: finished (sucessful) or error (failed)
if ($screenshot->{status} eq 'error') {
	print "Screenshot failed: ", $screenshot->{error}, "\n"; # display the reason for the error
}
else { # request the thumbnail
	my $image = $browshot->screenshot_thumbnail(id => $screenshot->{id});
	
	# save the screenshot
	open PNG, "> browshot.png" or croak "Cannot open browshot.png: $!\n";
	binmode PNG;
	print PNG $image;
	close PNG;
}


# you can combine several calls into 1: screenshot_create + screenshot_host
$screenshot = $browshot->screenshot_create(
	url 			=> 'https://browshot.com/', 
	instance_id 	=> 24, # premium
	screen_width => 1600, # wide screen
	screen_height => 1200, 
	size => 'page', # full page
	delay => 25, # greater delay if the page si very longer
	hosting => 's3', # make sure you have set up your S3 bucket with the right ACL
	hosting_bucket => 'my_bucket',
	hosting_file => 'myfile.png', # can be omitted
	hosting_width => 400, # thumbnail 400px wide
);


# Make multiple screenshots of the same page (loaded once)
$screenshot = $browshot->screenshot_create(
	url 			=> 'https://youtube.com/', 
	instance_id 	=> 24, # premium
	shots => 5 ,          # 5 screenshots
	shot_interval => 10, # every 10 seconds
	screen_width => 1280,
	screen_height => 1024,
);

sleep 60;

$screenshot = $browshot->screenshot_info(id => $screenshot->{id});
if ($screenshot->{status} eq 'finished') {
	# download the 5 screenshots
	for (my $i = 1; $i <= 5; $i++) {
		$browshot->screenshot_thumbnail_file(id => $screenshot->{id}, height => 600, shot => $i, file => "$i.png");
	}
}


# Host the screenshot on S3
$screenshot = $browshot->screenshot_create(
	url => 'https://youtube.com/', 
	instance_id => 24, # premium
	screen_width => 1280,
	screen_height => 1024,
	hosting => 's3',
	hosting_bucket => 'my_bucket',
	hosting_file => 'youtube.png',
	hosting_width => 600 # thumbnail
);

sleep 60;

$screenshot = $browshot->screenshot_info(id => $screenshot->{id});
if ($screenshot->{status} eq 'finished') {
	# The screenshot may not be hosted yet
	if (exists($screenshot->{hosted_url}) && $screenshot->{hosted_url} ne '') {
		print "\nScreenshot hosted at ", $screenshot->{hosted_url}, "\n";
	}
}

Download code sample

<?php

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

require 'vendor/autoload.php'; # Composer
# require_once 'Browshot.php'; # or download Browshot.php

$browshot = new Browshot('my_api_key');

$screenshot = $browshot->screenshot_create(array('url' => 'http://www.google.com/', 'instance_id' => 12, 'size' => 'page')); # all default parameters, instance_id = 12 (free)
# If the screenshot is already in cache, it could be finished already. Otherwise, wait longer
while ($screenshot->{'status'} != 'finished' &&  $screenshot->{'status'} != 'error') {
	echo "Wait...\n";
	sleep(10);
	$screenshot = $browshot->screenshot_info($screenshot->{'id'});
}

# screenshot is done: finished (sucessful) or error (failed)
if ($screenshot->{'status'} == 'error') {
	echo sprintf("Screenshot failed: %s\n", $screenshot->{'error'}); # display the reason for the error
}
else { # request the thumbnail
	$image = $browshot->screenshot_thumbnail($screenshot->{'id'});
	
	# save the screenshot
	$fp = fopen("browshot.png", 'w');
	fwrite($fp, $image);
	fclose($fp);
	
	echo "Screenshot saved to browshot.png\n";
}


# you can combine several calls into 1: screenshot_create + screenshot_host
$screenshot = $browshot->screenshot_create(array(
	'url' 			=> 'https://browshot.com/', 
	'instance_id' 	=> 24, # premium
	'screen_width' => 1600, # wide screen
	'screen_height' => 1200, 
	'size' => 'page', # full page
	'delay' => 25, # greater delay if the page si very longer
	'hosting' => 's3', # make sure you have set up your S3 bucket with the right ACL
	'hosting_bucket' => 'my_bucket',
	'hosting_file' => 'myfile.png', # can be omitted
	'hosting_width' => 400, # thumbnail 400px wide
));


# Make multiple screenshots of the same page (loaded once)
$screenshot = $browshot->screenshot_create(array(
	'url' 			=> 'https://youtube.com/', 
	'instance_id' 	=> 24, # premium
	'shots' => 5 ,          # 5 screenshots
	'shot_interval' => 10, # every 10 seconds
	'screen_width' => 1280,
	'screen_height' => 1024,
));

sleep(60);

$screenshot = $browshot->screenshot_info($screenshot->{'id'});
if ($screenshot->{'status'} == 'finished') {
	# download the 5 screenshots
	for ($i = 1; $i <= 5; $i++) {
		$browshot->screenshot_thumbnail_file($screenshot->{'id'}, "$i.png", array('height' => 600, 'shot' => $i));
	}
}


# Host the screenshot on S3
$screenshot = $browshot->screenshot_create(array(
	'url' => 'https://youtube.com/', 
	'instance_id' => 24, # premium
	'screen_width' => 1280,
	'screen_height' => 1024,
	'hosting' => 's3',
	'hosting_bucket' => 'my_bucket',
	'hosting_file' => 'youtube.png',
	'hosting_width' => 600 # thumbnail
));

sleep(60);

$screenshot = $browshot->screenshot_info($screenshot->{'id'});
if ($screenshot->{'status'} == 'finished') {
	# The screenshot may not be hosted yet
	if (array_key_exists('hosted_url', $screenshot) && $screenshot->{'hosted_url'} != '') {
		echo sprintf("\nScreenshot hosted at %s\n", $screenshot->{'hosted_url'});
	}
}
?>

Download code sample

# -*- coding: utf-8 -*-
#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

from browshot import BrowshotClient
import time

browshot = BrowshotClient('my_api_key')

screenshot = browshot.screenshot_create('http://www.google.com/', { 'instance_id': 12, 'size': 'page' }) # all default parameters, instance_id = 12 (free)

# If the screenshot is already in cache, it could be finished already. Otherwise, wait longer
while screenshot['status'] != 'finished' and  screenshot['status'] != 'error':
  print "Wait...\n"
  time.sleep(10)
  screenshot = browshot.screenshot_info(screenshot['id'])


# screenshot is done: finished (sucessful) or error (failed)
if screenshot['status'] == 'error':
  print "Screenshot failed: %s\n" % screenshot['error'] # display the reason for the error
else: # request the thumbnail
  image = browshot.screenshot_thumbnail(screenshot['id'])
  
  # save the screenshot
  fp = open("browshot.png", mode='wb')
  fp.write(image)
  fp.close()


# you can combine several calls into 1: screenshot_create + screenshot_host
screenshot = browshot.screenshot_create('https://browshot.com/',
{
	'instance_id': 24, # premium
	'screen_width': 1600, # wide screen
	'screen_height': 1200, 
	'size': 'page', # full page
	'delay': 25, # greater delay if the page si very longer
	'hosting': 's3', # make sure you have set up your S3 bucket with the right ACL
	'hosting_bucket': 'my_bucket',
	'hosting_file': 'myfile.png', # can be omitted
	'hosting_width': 400, # thumbnail 400px wide
})


# Make multiple screenshots of the same page (loaded once)
screenshot = browshot.screenshot_create('https://youtube.com/', 
{
	'instance_id': 24, # premium
	'shots': 5 ,          # 5 screenshots
	'shot_interval': 10, # every 10 seconds
	'screen_width': 1280,
	'screen_height': 1024,
})

time.sleep(60)

screenshot = browshot.screenshot_info(screenshot['id'])
if screenshot['status'] == 'finished':
  # download the 5 screenshots
  for i in range (1, 5):
    browshot.screenshot_thumbnail_file(screenshot['id'], "%d.png" % i, { 'height': 600, 'shot': i })


# Host the screenshot on S3
screenshot = browshot.screenshot_create('https://youtube.com/',
{
	'instance_id': 24, # premium
	'screen_width': 1280,
	'screen_height': 1024,
	'hosting': 's3',
	'hosting_bucket': 'my_bucket',
	'hosting_file': 'youtube.png',
	'hosting_width': 600 # thumbnail
})

time.sleep(60)

screenshot = browshot.screenshot_info(screenshot['id'])
if screenshot['status'] == 'finished':
  # The screenshot may not be hosted yet
  if 'hosted_url' in screenshot and screenshot['hosted_url'] != '':
    print "\nScreenshot hosted at %s\n" % screenshot['hosted_url']

Download code sample

#!/usr/bin/env ruby

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

require 'browshot'

browshot = Browshot.new('my_api_key')

screenshot = browshot.screenshot_create('http://www.google.com/', { 'instance_id' => 12, 'size' => 'page' }) # all default parameters, instance_id = 12 (free)

# If the screenshot is already in cache, it could be finished already. Otherwise, wait longer
while (screenshot['status'] != 'finished' &&  screenshot['status'] != 'error')
  puts "Wait (#{screenshot['status']})...\n"
  sleep(10)
  screenshot = browshot.screenshot_info(screenshot['id'])
end


# screenshot is done: finished (sucessful) or error (failed)
if (screenshot['status'] == 'error')
  puts "Screenshot failed: #{screenshot['error']}\n"  # display the reason for the error
else # request the thumbnail
  image = browshot.screenshot_thumbnail(screenshot['id'])
  
  # save the screenshot
  File.open("browshot.png", 'w') {|f| f.write(image) }
end

# you can combine several calls into 1: screenshot_create + screenshot_host
screenshot = browshot.screenshot_create('https://browshot.com/',
{
	'instance_id' => 24, # premium
	'screen_width' => 1600, # wide screen
	'screen_height' => 1200, 
	'size' => 'page', # full page
	'delay' => 25, # greater delay if the page si very longer
	'hosting' => 's3', # make sure you have set up your S3 bucket with the right ACL
	'hosting_bucket' => 'my_bucket',
	'hosting_file' => 'myfile.png', # can be omitted
	'hosting_width' => 400, # thumbnail 400px wide
})


# Make multiple screenshots of the same page (loaded once)
screenshot = browshot.screenshot_create('https://youtube.com/',
{
	'instance_id' => 24, # premium
	'shots' => 5 ,          # 5 screenshots
	'shot_interval' => 10, # every 10 seconds
	'screen_width' => 1280,
	'screen_height' => 1024,
})

sleep(60)

screenshot = browshot.screenshot_info(screenshot['id'])
if (screenshot['status'] == 'finished')
  # download the 5 screenshots
  for i in 1..5
    browshot.screenshot_thumbnail_file(screenshot['id'], "#{i}.png" , { 'height' => 600, 'shot' => i })
   end
end


# Host the screenshot on S3
screenshot = browshot.screenshot_create('https://youtube.com/',
{
	'instance_id' => 24, # premium
	'screen_width' => 1280,
	'screen_height' => 1024,
	'hosting' => 's3',
	'hosting_bucket' => 'my_bucket',
	'hosting_file' => 'youtube.png',
	'hosting_width' => 600 # thumbnail
})

sleep(60)

screenshot = browshot.screenshot_info(screenshot['id'])
if (screenshot['status'] == 'finished')
  # The screenshot may not be hosted yet
  if (screenshot.key?('hosted_url') && screenshot['hosted_url'] != '')
    puts "\nScreenshot hosted at #{screenshot['hosted_url']}\n"
  end
end

Download code sample

/**********************
* WARNING
* Running this code sample will cost you Browshot credits
***********************/

const browshot = require('browshot');
const fs = require("fs");

var client = new browshot('my_api_key');

var interval;

// all default parameters, instance_id = 12 (free)
client.screenshotCreate(
	{url: 'http://www.google.com/', instance_id: 12, size: 'page' }, 
	function(screenshot) {
		// If the screenshot is already in cache, it could be finished already. Otherwise, wait longer
		if (screenshot.status == 'error') {
			console.log(`Screenshot #${screenshot.id} failed: ${screenshot.error}`);
		}
		else if (screenshot.status == 'finished') {
			screenshotFinished(screenshot);
		}
		else {
			interval = setInterval(checkScreenshot, 1000 * 10, screenshot.id);
		}
	}
);


function checkScreenshot(id) {
	client.screenshotInfo(id, { }, function(screenshot) {
		if (screenshot.status == 'error') {
			clearInterval(interval);
			
			console.log(`Screenshot #${screenshot.id} failed: ${screenshot.error}`);
		}
		else if (screenshot.status == 'finished') {
			clearInterval(interval);
			
			screenshotFinished(screenshot);
		}
		else {
			console.log(`Waiting for screenshot #${screenshot.id} to finish...`);
		}
	});
}

function screenshotFinished(screenshot) {
	// request the thumbnail
	client.screenshotThumbnail(screenshot.id, { }, function(image) {
		fs.writeFile("browshot.png", image, (err) => {
			if (err) {
				console.log(`Failed to write image to browshot.png: ${err}`);
			}
			else {
				console.log("Image saved to browshot.png");
			}
		});
	});
}

// you can combine several calls into 1: screenshot_create + screenshot_host
client.screenshotCreate({
		url: 'https://browshot.com/',
		instance_id: 24, // premium
		screen_width: 1600, // wide screen
		screen_height: 1200, 
		size: 'page', // full page
		delay: 25, // greater delay if the page si very longer
		hosting: 's3', // make sure you have set up your S3 bucket with the right ACL
		hosting_bucket: 'my_bucket',
		hosting_file: 'myfile.png', // can be omitted
		hosting_width: 400, // thumbnail 400px wide
	}, function() {});


// Make multiple screenshots of the same page (loaded once)
client.screenshotCreate({
		url: 'https://youtube.com/',
		instance_id: 24, 		// premium
		shots: 5 ,          // 5 screenshots
		shot_interval: 10, // every 10 seconds
		screen_width: 1280,
		screen_height: 1024,
	}, function() { });

Download code sample

{
  "error": "Wrong URL format",
  "status": "error",
  "priority": 1,
  "cost": 0
}

{
  "error": "No free screenshots available",
  "status": "error",
  "priority": 1,
  "cost": 0
}

{
  "id": 12589,
  "status": "in_queue",
  "priority": 2
 }

{
  "id": 12589,
  "status": "finished",
  "screenshot_url": "https://www.browshot.com/screenshot/image/12589?scale=1&key=my_api_key",
  "priority": 3,
  "url": "http://www.google.com/",
  "size": "screen",
  "width": 1024,
  "height": 768,
  "request_time": 1312106111,
  "started": 1312258803994,
  "load": 1312258829461,
  "content": 1312258829661,
  "finished": 1312258829681,
  "instance_id": 12,
  "response_code": 200,
  "final_url": "http://www.google.com/",
  "content_type":"text/html",
  "scale": "1",
  "cost": 0,
  "referer": "http://www.google.com/",
  "post_data": "",
  "cookie": "",
  "delay": 5,
  "script": "",
  "shared_url": "",
  "details": 2,
  "shots": 1,
  "shot_interval": 5
}

Request screenshots for 2 URLs with 2 instances (4 screenshots in total):

https://api.browshot.com/api/v1/screenshot/multiple?url=http://www.google.com/&url=http://www.google.com/&instance_id=65&instance_id=22&key=my_api_key

#!/usr/bin/perl -w

use strict;
use warnings;
use Carp;

use WebService::Browshot;

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################


my $browshot = WebService::Browshot->new(
	key	=> 'my_api_key',
	debug	=> 1, # print more debug information
);

my $list = $browshot->screenshot_multiple(
	urls => ['http://www.google.com/', 'https://browshot.com/', 'http://mobilito.net/'], # up to 5 URLs
	instances => [12, 24, 72], # up to 10
	size => 'page', # all options of screenshot/create are valid
);


my @ids = (); # will hold all screenshot IDs

foreach my $id (keys %$list) {
	push(@ids, $id);
}

sleep 20;


while (scalar @ids > 0) { # go through each screenshot
	my $i = 0;
	while ($i < scalar @ids) {
		my $id = $ids[$i];

		my $info = $browshot->screenshot_info(id => $id);
		if ($info->{status} eq 'finished') {
			$browshot->screenshot_thumbnail_file(id => $id, file => "$id.png");
			splice(@ids, $i, 1); # remove ID from the list
		}
		elsif ($info->{status} eq 'error') {
			print "Screenshot failed: ", $info->{error}, "\n";
			print "\tURL: ", $info->{url}, "\n";
			print "\tinstance_id: ", $info->{instance_id}, "\n";
			print "\n";
			
			splice(@ids, $i, 1); # remove ID from the list
		}
		else {
			# wait
			$i++;
		}
	}
	
	sleep 10 if (scalar @ids > 0);
}

Download code sample

<?php

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################


require 'vendor/autoload.php'; # Composer
# require_once 'Browshot.php'; # or download Browshot.php

$browshot = new Browshot('my_api_key', 1); # more debug information


$list = $browshot->screenshot_multiple(array('http://www.google.com/', 'https://browshot.com/', 'http://mobilito.net/'), # up to 5 URLs
	array(12, 24, 72), # up to 10
	array('size' => 'page') # all options of screenshot/create are valid
);


$ids = array(); # will hold all screenshot IDs

foreach ($list as $id => $screenshot) {
	array_push($ids, $id);
}

sleep(20);


while (count($ids) > 0) { # go through each screenshot
	$i = 0;
	while ($i < count($ids)) {
		$id = $ids[$i];

		$info = $browshot->screenshot_info($id);
		if ($info->{'status'} == 'finished') {
			$browshot->screenshot_thumbnail_file($id, "$id.png");
			array_splice($ids, $i, 1); # remove ID from the list
		}
		elseif ($info->{'status'} == 'error') {
			echo sprintf("Screenshot failed: %s\n", $info->{'error'});
			echo printf("\tURL: %s\n", $info->{'url'});
			echo printf("\tinstance_id: %s\n", $info->{'instance_id'});
			echo "\n";
			
			array_splice($ids, $i, 1); # remove ID from the list
		}
		else {
			# wait
			$i++;
		}
	}
	
	if (count($ids) > 0)
		sleep(10);
}

?>

Download code sample

# -*- coding: utf-8 -*-
#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

from browshot import BrowshotClient
import time

browshot = BrowshotClient('my_api_key', 1) # more debug information


list = browshot.screenshot_multiple({ 'urls': ['http://www.google.com/', 'https://browshot.com/', 'http://mobilito.net/'], 'instances': [12, 24, 72], 'size': 'page' }) # up to 5 URLs

time.sleep(20)
ids = list.keys() #  hold all screenshot IDs


while len(ids) > 0: # go through each screenshot
  i = 0
  while i < len(ids):
    id = ids[i]
    
    info = browshot.screenshot_info(id)
    if info['status'] == 'finished':
      browshot.screenshot_thumbnail_file(id, "%s.png" % id)
      del ids[i] # remove ID from the list
    elif info['status'] == 'error':
      print "Screenshot failed: %s\n" % info['error']
      print "\tURL: %s\n", info['url']
      print "\tinstance_id: %s\n" % info['instance_id']
      print "\n"
      
      del ids[i] # remove ID from the list
    else:
      # wait
      i += 1
  
  
  if len(ids) > 0:
    time.sleep(10)

Download code sample

#!/usr/bin/env ruby

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

require 'browshot'

browshot = Browshot.new('my_api_key', true) # more debug information


list = browshot.screenshot_multiple({ 'urls' => ['http://www.google.com/', 'https://browshot.com/', 'http://mobilito.net/'], 'instances' => [12, 24, 72], 'size' => 'page' }) # up to 5 URLs

sleep(20)
ids = list.keys() #  hold all screenshot IDs


while (ids.count() > 0) # go through each screenshot
  i = 0
  while (i < ids.count())
    id = ids[i]
    
    info = browshot.screenshot_info(id)
    if (info['status'] == 'finished')
      browshot.screenshot_thumbnail_file(id, "#{id}.png")
      ids.delete_at(i) # remove ID from the list
    elsif (info['status'] == 'error')
      puts "Screenshot failed: #{info['error']}\n"
      puts "\tURL: #{info['url']}\n"
      puts "\tinstance_id: #{info['instance_id']}\n"
      puts "\n"
      
      ids.delete_at(i) # remove ID from the list
    else
      # wait
      i += 1
    end
  end
  
  if (ids.count() > 0)
    sleep(10)
  end
end

Download code sample

/**********************
* WARNING
* Running this code sample will cost you Browshot credits
***********************/
'use strict';

const browshot = require('browshot');

var client = new browshot('my_api_key');

// up to 5 URLs
client.screenshotMultiple(
	{ urls: ['http://www.google.com/', 'https://browshot.com/', 'http://mobilito.net/'], instances: [12, 24, 72], size: 'page' },
	function(list) {
		for(var i in list) {
			console.log(`Screenshot ID: ${list[i].id}: ${list[i].status}`);
		}
	}
);

Download code sample

#!/usr/bin/perl -w

use strict;
use warnings;
use Carp;

use WebService::Browshot;

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################


my $browshot = WebService::Browshot->new(
	key	=> 'my_api_key',
	debug	=> 0, # no more debug information
);

my $screenshot = $browshot->screenshot_create(url => 'https://browshot.com/', details => 3, instance => 24, screen_width => 1280, screen_height => 1024); # extra details
# the call to screenshot/create sends the same response as screenshot/information
# so screenshot/create and screenshot/info can be interchanged as long as the cache value is long enough
while ($screenshot->{status} ne 'finished' &&  $screenshot->{status} ne 'error') {
	print "Wait...\n";
	sleep 10;
	$screenshot = $browshot->screenshot_info(id => $screenshot->{id});
	# or $screenshot = $browshot->screenshot_create(url => 'https://browshot.com/', details => 3, instance => 24, screen_width => 1280, screen_height => 1024);
}

# screenshot is done: finished (sucessful) or error (failed)
if ($screenshot->{status} eq 'error') {
	print "Screenshot failed: ", $screenshot->{error}, "\n"; # display the reason for the error
	
	# If you call $browshot->screenshot_create with the same parameters, a new screenshot will be requested.
}
else { # screenshot is finished
	# did the page load (200 OK) or was mnissing (404 Not Found) or some error (40X, 50X);
	if ($screenshot->{response_code} != 200) {
		print "The page may not have be reached, HTTP response code was: ", $screenshot->{response_code}, "\n";
	}
	
	# Was it an HTML page, PDF or image?
	if ($screenshot->{content_type} ne 'text/html') {
		print "The page is not HTML, it is ", $screenshot->{content_type}, "\n";
	}
	
	# with details = 3, you can check what asserts were loaded on the page: images, javascript, frames, etc.
	print "There are ", scalar(@{ $screenshot->{images} }), " images on this page:\n";
	foreach my $url (@{ $screenshot->{images} }) {
		print "$url\n";
	}
}

Download code sample

<?php

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

require 'vendor/autoload.php'; # Composer
# require_once 'Browshot.php'; # or download Browshot.php

$browshot = new Browshot('my_api_key', 1); # more debug information



$screenshot = $browshot->screenshot_create(array('url' => 'https://browshot.com/', 'details' => 3, 'instance' => 24, 'screen_width' => 1280, 'screen_height' => 1024)); # extra details
# the call to screenshot/create sends the same response as screenshot/information
# so screenshot/create and screenshot/info can be interchanged as long as the cache value is long enough
while ($screenshot->{'status'} != 'finished' &&  $screenshot->{'status'} != 'error') {
	echo "Wait...\n";
	sleep(10);
	$screenshot = $browshot->screenshot_info($screenshot->{'id'}, array('details' => 3));
	# or $screenshot = $browshot->screenshot_create(array('url' => 'https://browshot.com/', 'details' => 3, 'instance' => 24, 'screen_width' => 1280, 'screen_height' => 1024));
}

# screenshot is done: finished (sucessful) or error (failed)
if ($screenshot->{'status'} == 'error') {
	echo sprintf("Screenshot failed: %s\n", $screenshot->{'error'}); # display the reason for the error
	
	# If you call $browshot->screenshot_create with the same parameters, a new screenshot will be requested.
}
else { # screenshot is finished
	# did the page load (200 OK) or was mnissing (404 Not Found) or some error (40X, 50X);
	if ($screenshot->{'response_code'} != 200) {
		echo sprintf("The page may not have be reached, HTTP response code was: %s\n", $screenshot->{'response_code'});
	}
	
	# Was it an HTML page, PDF or image?
	if ($screenshot->{'content_type'} != 'text/html') {
		echo sprintf("The page is not HTML, it is %s\n", $screenshot->{'content_type'});
	}
	
	# with details = 3, you can check what asserts were loaded on the page: images, javascript, frames, etc.
	echo sprintf("There are %d images on this page:\n", count($screenshot->{'images'}));
	foreach ($screenshot->{'images'} as $url) {
		echo "$url\n";
	}
}

Download code sample

# -*- coding: utf-8 -*-
#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

from browshot import BrowshotClient
import time

browshot = BrowshotClient('my_api_key', 1) # more debug information


screenshot = browshot.screenshot_create('https://browshot.com/', { 'details': 3, 'instance': 24, 'screen_width': 1280, 'screen_height': 1024 }) # extra details
# the call to screenshot/create sends the same response as screenshot/information
# so screenshot/create and screenshot/info can be interchanged as long as the cache value is long enough
while screenshot['status'] != 'finished' and  screenshot['status'] != 'error':
  print "Wait...\n"
  time.sleep(10)
  screenshot = browshot.screenshot_info(screenshot['id'], { 'details': 3 })
  # or $screenshot = $browshot->screenshot_create(array('url' => 'https://browshot.com/', 'details' => 3, 'instance' => 24, 'screen_width' => 1280, 'screen_height' => 1024));

# screenshot is done: finished (sucessful) or error (failed)
if screenshot['status'] == 'error':
  print "Screenshot failed: %s\n" % screenshot['error'] # display the reason for the error
  
  # If you call $browshot->screenshot_create with the same parameters, a new screenshot will be requested.
else: # screenshot is finished
  # did the page load (200 OK) or was mnissing (404 Not Found) or some error (40X, 50X);
  if screenshot['response_code'] != 200:
    print "The page may not have be reached, HTTP response code was: %s\n" % screenshot['response_code']
  
  # Was it an HTML page, PDF or image?
  if screenshot['content_type'] != 'text/html':
    print "The page is not HTML, it is %s\n" % screenshot['content_type']
  
  # with details = 3, you can check what asserts were loaded on the page: images, javascript, frames, etc.
  if 'images' in screenshot and isinstance(screenshot['images'], list):
    print "There are %d images on this page:\n" % len(screenshot['images'])
    for url in screenshot['images']:
      print "%s\n" % url

Download code sample

#!/usr/bin/env ruby

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

require 'browshot'

browshot = Browshot.new('my_api_key', true) # more debug information


screenshot = browshot.screenshot_create('https://browshot.com/', { 'details' => 3, 'instance' => 24, 'screen_width' => 1280, 'screen_height' => 1024 }) # extra details
# the call to screenshot/create sends the same response as screenshot/information
# so screenshot/create and screenshot/info can be interchanged as long as the cache value is long enough
while (screenshot['status'] != 'finished' && screenshot['status'] != 'error')
  puts "Wait...\n"
  sleep(10)
  screenshot = browshot.screenshot_info(screenshot['id'], { 'details' => 3 })
  # or $screenshot = $browshot->screenshot_create(array('url' => 'https://browshot.com/', 'details' => 3, 'instance' => 24, 'screen_width' => 1280, 'screen_height' => 1024));
end

# screenshot is done: finished (sucessful) or error (failed)
if (screenshot['status'] == 'error')
  puts "Screenshot failed: #{screenshot['error']}\n" # display the reason for the error

  # If you call $browshot->screenshot_create with the same parameters, a new screenshot will be requested.
else # screenshot is finished
  # did the page load (200 OK) or was mnissing (404 Not Found) or some error (40X, 50X);
  if (screenshot['response_code'].to_i != 200)
    puts "The page may not have be reached, HTTP response code was: #{screenshot['response_code']}\n"
  end
  
  # Was it an HTML page, PDF or image?
  if (screenshot['content_type'] != 'text/html')
    puts "The page is not HTML, it is #{screenshot['content_type']}\n"
  end
  
  # with details = 3, you can check what asserts were loaded on the page: images, javascript, frames, etc.
  if (screenshot.key?('images') && screenshot['images'].kind_of?(Array))
    puts "There are #{screenshot['images'].count} images on this page:\n"
    
    screenshot['images'].each { |url|
      puts "#{url}\n"
    }
  end
end

Download code sample

/**********************
* WARNING
* Running this code sample will cost you Browshot credits
***********************/
'use strict';

const browshot = require('browshot');

var client = new browshot('my_api_key');

var interval;

// the call to screenshot/create sends the same response as screenshot/info
// so screenshot/create and screenshot/info can be interchanged as long as the cache value is long enough
client.screenshotCreate(
  // additional details
	{url: 'https://browshot.com/', instance_id: 24, size: 'page', details: 3, screen_width: 1280, screen_height: 1024}, 
	function(screenshot) {
		// If the screenshot is already in cache, it could be finished already. Otherwise, wait longer
		if (screenshot.status == 'error') {
			console.log(`Screenshot #${screenshot.id} failed: ${screenshot.error}`);
		}
		else if (screenshot.status == 'finished') {
			screenshotFinished(screenshot);
		}
		else {
			interval = setInterval(checkScreenshot, 1000 * 10, screenshot.id);
		}
	}
);

function checkScreenshot(id) {
	client.screenshotInfo(id, { details: 3 }, function(screenshot) {
		if (screenshot.status == 'error') {
			clearInterval(interval);
			
			console.log(`Screenshot #${screenshot.id} failed: ${screenshot.error}`);
		}
		else if (screenshot.status == 'finished') {
			clearInterval(interval);
			
			screenshotFinished(screenshot);
		}
		else {
			console.log(`Waiting for screenshot #${screenshot.id} to finish...`);
		}
	});
}

function screenshotFinished(screenshot) {
	// Did the page load (200 OK) or was mnissing (404 Not Found) or some error (40X, 50X);
	if (screenshot.response_code != 200) {
		console.log(`The page may not have be reached, HTTP response code was: ${screenshot.response_code}`);
	}
	
	// Was it an HTML page, PDF or image?
	if (screenshot.content_type != 'text/html') {
    console.log(`The page is not HTML, it is ${screenshot.content_type}`);
  }
  
  // with details = 3, you can check what asserts were loaded on the page: images, javascript, frames, etc.
  if (screenshot.hasOwnProperty('images')) {
		console.log(`There are ${screenshot.images.length} images on this page:`);
		
		for(var i in screenshot.images) {
			console.log("\t" + screenshot.images[i]);
		}
  }
}

Download code sample

{
	  "id": 12589,
	  "status": "error",
	  "screenshot_url": "https://www.browshot.com/screenshot/image/12589?scale=1&key=my_api_key",
	  "priority": 2,
	  "url": "http://www.google.com/",
	  "size": "screen",
	  "width": 1024,
	  "height": 768,
	  "request_time": 1312106111,
	  "started": 1312258803994,
	  "load": "0",
	  "content": 0,
	  "finished": 1312258829681,
	  "instance_id": 12,
	  "response_code": "",
	  "final_url": "",
	  "content_type":"",
	  "scale":1,
	  "cost": 0,
	  "referer": "",
	  "post_data": "",
	  "cookie: "",
	  "delay": 5,
	  "script": "",
	  "shared_url": "",
	  "details": 2
	  }

{
	  "id": 12589,
	  "status": "error",
	  "screenshot_url": "",
	  "priority": 3
	  }

{
	  "id": 12589,
	  "status": "in_queue",
	  "screenshot_url": "",
	  "cost": 0
	  }

#!/usr/bin/perl -w

use strict;
use warnings;
use Carp;

use WebService::Browshot;

my $browshot = WebService::Browshot->new(
	key	=> 'my_api_key',
	debug	=> 0, # no more debug information
);


my $list = $browshot->screenshot_list(limit => 5, status => 'finished'); # last 5 screenshots
foreach my $id (keys %$list) {
	my $url = $list->{$id}->{final_url};
	print "#$id $url\n";
}


# Number of errors
$list = $browshot->screenshot_list(status => 'error');
print scalar(keys %$list), " of the last last 100 screenshots failed\n";

Download code sample

<?php

require 'vendor/autoload.php'; # Composer
# require_once 'Browshot.php'; # or download Browshot.php

$browshot = new Browshot('my_api_key');


$list = $browshot->screenshot_list(array('limit' => 5, 'status' => 'finished')); # last 5 screenshots
foreach ($list as $id => $screenshot) {
	echo sprintf("#%d %s\n", $id, $screenshot->{'url'});
}


# Number of errors
$list = $browshot->screenshot_list(array('status' => 'error'));
echo count($list). " of the last last 100 screenshots failed\n";

?>

Download code sample

# -*- coding: utf-8 -*-

from browshot import BrowshotClient

browshot = BrowshotClient('my_api_key')


list = browshot.screenshot_list({ 'limit': 5, 'status': 'finished' }) # last 5 screenshots
for id, screenshot in list.iteritems():
	print "#%d %s" % (int(id), screenshot['url'])


# Number of errors
list = browshot.screenshot_list({ 'status': 'error' })
print str(len(list)) + " of the last last 100 screenshots failed"

Download code sample

#!/usr/bin/env ruby

require 'browshot'

browshot = Browshot.new('my_api_key')


list = browshot.screenshot_list({ 'limit' => 5, 'status' => 'finished' }) # last 5 screenshots
list.each { |id, screenshot|
	puts "##{id} #{screenshot['url']}\n"
}

# Number of errors
list = browshot.screenshot_list({ 'status' => 'error' })
puts "#{list.count} of the last last 100 screenshots failed\n"

Download code sample

'use strict';

const browshot = require('browshot');

var client = new browshot('my_api_key');

// last 5 screenshots
client.screenshotList({ limit: 5, status: 'finished' }, function(list) {
	for(var i in list) {
		console.log(`${list[i].id} ${list[i].url}`);
	}
});

// Number of errors
client.screenshotList({ status: 'error' }, function(list) {
	var count = list.length || 'none';
	console.log(`${count} of the last last 100 screenshots failed`);
});

Download code sample

#!/usr/bin/perl -w

use strict;
use warnings;
use Carp;

use WebService::Browshot;

my $browshot = WebService::Browshot->new(
	key	=> 'my_api_key',
	debug	=> 0, # no more debug information
);


my $list = $browshot->screenshot_search(url => 'google.com', limit => 5, status => 'finished'); # last screenshots of google.com
foreach my $id (keys %$list) {
	my $url = $list->{$id}->{final_url};
	print "#$id $url\n";
}
print "\n";


# no match
$list = $browshot->screenshot_search(url => 'foo.bar');
print "Screenshots for foo.bar: ", scalar(keys %$list), "\n";

Download code sample

<?php

require 'vendor/autoload.php'; # Composer
# require_once 'Browshot.php'; # or download Browshot.php

$browshot = new Browshot('my_api_key');

$list = $browshot->screenshot_search('google.com', array('limit' => 5, 'status' => 'finished')); # last screenshots of google.com
foreach ($list as $id => $screenshot) {
	echo sprintf("#%d %s\n", $id, $screenshot->{'url'});
}
echo "\n";


# no match
$list = $browshot->screenshot_search('foo.bar');
echo "Screenshots for foo.bar: " . count($list) . "\n";

?>

Download code sample

# -*- coding: utf-8 -*-

from browshot import BrowshotClient

browshot = BrowshotClient('my_api_key')


list = browshot.screenshot_search('google.com', { 'limit': 5, 'status': 'finished' }) # last screenshots of google.com
for id, screenshot in list.iteritems():
  print "#%d %s"% (int(id), screenshot['url'])

print ""


# no match
list = browshot.screenshot_search('foo.bar')
print "Screenshots for foo.bar: %d" % len(list)

Download code sample

#!/usr/bin/env ruby

require 'browshot'

browshot = Browshot.new('my_api_key')


list = browshot.screenshot_search('google.com', { 'limit' => 5, 'status' => 'finished' }) # last screenshots of google.com
list.each { |id, screenshot| 
  puts "##{id} #{screenshot['url']}\n"
}
puts "\n"


# no match
list = browshot.screenshot_search('foo.bar')
puts "Screenshots for foo.bar: #{list.count}\n"

Download code sample

'use strict';

const browshot = require('browshot');

var client = new browshot('my_api_key');

// last screenshots of google.com
client.screenshotSearch('google.com', { limit: 5, status: 'finished' }, function(list) {
	for(var i in list) {
		console.log(`#${list[i].id} ${list[i].url}`);
	}
});


// no match
client.screenshotSearch('foo.bar', { }, function(list) {
	console.log(`Screenshots for foo.bar: ${list.length || 0}`);
});

Download code sample

#!/usr/bin/perl -w

use strict;
use warnings;
use Carp;

use WebService::Browshot;

my $browshot = WebService::Browshot->new(
	key	=> 'my_api_key',
	debug	=> 0, # no more debug information
);


# You can only host screenshots in finished state
my $list = $browshot->screenshot_list(limit => 1, status => 'finished');

my $screenshot = { };
foreach my $id (keys %$list) {
	$screenshot = $list->{id};
}

if (! exists $screenshot->{id}) {
	print "No screenshot finished\n";
}
else {
	my $result = $browshot->screenshot_host(
	  id => $screenshot->{id}, 
	  hosting => 's3', 
	  bucket => 'my_bucket', 
	  file => 'youtube.png', 
	  width => 600
	); # host a thumbnail
	
	if ($result->{status} eq 'ok') {
		print "The screenshot is now hosted at ", $result->{url}, "\n";
	}
	else {
		print "hosting failed: ", $result->{error}, "\n";
	}
}

Download code sample

<?php

require 'vendor/autoload.php'; # Composer
# require_once 'Browshot.php'; # or download Browshot.php

$browshot = new Browshot('my_api_key');


# You can only host screenshots in finished state
$list = $browshot->screenshot_list(array('limit' => 1, 'status' => 'finished'));

if(count($list) == 0) {
	echo "No screenshot finished\n";
}
else {
	$id = 0;
	foreach ($list as $key => $data) {
		$id = $key;
	}
	
	$result = $browshot->screenshot_host($id, array(
	  'hosting' => 's3', 
	  'bucket' => 'my_bucket', 
	  'file' => 'youtube.png', 
	  'width' => 600
	)); # host a thumbnail
	
	if ($result->{'status'} == 'ok') {
		echo sprintf("The screenshot is now hosted at %s\n", $result->{'url'});
	}
	else {
		echo sprintf("hosting failed: %s\n", $result->{'error'});
	}
}

?>

Download code sample

# -*- coding: utf-8 -*-

from browshot import BrowshotClient

browshot = BrowshotClient('my_api_key')


# You can only host screenshots in finished state
list = browshot.screenshot_list({ 'limit': 1, 'status': 'finished' })

if len(list) == 0:
	print "No screenshot finished"
else:
  id = 0
  for key, screenshot in list.iteritems():
    id = key
  
  result = browshot.screenshot_host(id, {
    'hosting': 's3', 
    'bucket': 'my_bucket', 
    'file': 'youtube.png', 
    'width': 600
  }) # host a thumbnail
  
  if result['status'] == 'ok':
    print "The screenshot is now hosted at %s" % result['url']
  else:
    print "hosting failed: %s" % result['error']

Download code sample

#!/usr/bin/env ruby

require 'browshot'

browshot = Browshot.new('my_api_key', true)



# You can only host screenshots in finished state
list = browshot.screenshot_list({ 'limit' => 1, 'status' => 'finished' })

if (list.count == 0)
	puts "No screenshot finished\n"
else
  id = 0
  list.each { |key, screenshot|
    id = key
  }
  
  result = browshot.screenshot_host(id, 's3', {
    'bucket' => 'my_bucket', 
    'file' => 'youtube.png', 
    'width' => 600
  }) # host a thumbnail
  
  if (result['status'] == 'ok')
    puts "The screenshot is now hosted at #{result['url']}\n"
  else
    print "hosting failed: #{result['error']}\n"
  end
end

Download code sample

'use strict';

var browshot = require('browshot');

var client = new browshot('my_api_key');



// You can only host screenshots in finished state
client.screenshotList({ limit: 1, status: 'finished' }, function (list) {
	if (list.length == 0) {
		console.log("No screenshot finished");
	}
	else {
		for(var i in list) {
			// host a thumbnail
			client.screenshotHost(list[i].id,
				{
					hosting: 's3',
					bucket: 'my_bucket', 
					file: 'youtube.png', 
					width: 600
				}, function(screenshot) {
					if (screenshot.status == 'ok') {
						console.log(`The screenshot is now hosted at ${screenshot.url}`);
					}
					else {
						console.log(`Hosting failed: ${screenshot.error}`);
					}
				}
			);
		}
	}
});

Download code sample

An error is sent back if the screenshot failed, or if an error occurred during the S3 upload (bad bucket name, wrong ACLs, etc.), etc.

{
  "status": "error",
  "error": "Invalid screenshot id",
  "id": 3965421
}

{
  "status": "error",
  "error": "Screenshot failed previously",
  "id": 3965421
}

{
  "status": "error",
  "error" : "Screenshot failed previously",
  "id": 3965421
}

#!/usr/bin/perl -w

use strict;
use warnings;
use Carp;

use WebService::Browshot;

my $browshot = WebService::Browshot->new(
	key	=> 'my_api_key',
	debug	=> 0, # no more debug information
);

my $screenshot = $browshot->screenshot_create(url => 'http://www.google.com/', instance_id => 12); # all default parameters, instance_id = 12 (free)
# If the screenshot is already in cache, it could be finished already. Othwewise, wait longer
while ($screenshot->{status} ne 'finished' &&  $screenshot->{status} ne 'error') {
	print "Wait...\n";
	sleep 10;
	$screenshot = $browshot->screenshot_info(id => $screenshot->{id});
}

# You can request multiple thumbnails of the same screenshot at no cost
# Get a thumbnail at 1/3 (33%) of the original
$browshot->screenshot_thumbnail_file(id => $screenshot->{id}, zoom => 33, file => "google-1.png");
print "Thumbnail saved to google-1.png\n";

# Get a thumbnail with a height of 100 pixels
$browshot->screenshot_thumbnail_file(id => $screenshot->{id}, height => 100, file => "google-2.png");
print "Thumbnail saved to google-2.png\n";

# Get a thumbnail of 200 by 100 pixels at most
$browshot->screenshot_thumbnail_file(id => $screenshot->{id}, height => 100, width => 200, file => "google-3.png");
print "Thumbnail saved to google-3.png\n";

# Crop the screenshot to 768x768, scale it to a 300x300 thumbnail
$browshot->screenshot_thumbnail_file(id => $screenshot->{id}, right => 768, bottom => 768, height => 300, width => 300, ratio => 'fit', file => "google-4.png");
print "Thumbnail saved to google-4.png\n";

Download code sample

<?php

require 'vendor/autoload.php'; # Composer
# require_once 'Browshot.php'; # or download Browshot.php

$browshot = new Browshot('my_api_key');

$screenshot = $browshot->screenshot_create(array('url' => 'http://www.google.com/', 'instance_id' => 12)); # all default parameters, instance_id = 12 (free)
# If the screenshot is already in cache, it could be finished already. Othwewise, wait longer
while ($screenshot->{'status'} != 'finished' &&  $screenshot->{'status'} != 'error') {
	echo "Wait...\n";
	sleep(10);
	$screenshot = $browshot->screenshot_info($screenshot->{'id'});
}

# You can request multiple thumbnails of the same screenshot at no cost
# Get a thumbnail at 1/3 (33%) of the original
$browshot->screenshot_thumbnail_file($screenshot->{'id'}, "google-1.png", array('zoom' => 33));
echo "Thumbnail saved to google-1.png\n";

# Get a thumbnail with a height of 100 pixels
$browshot->screenshot_thumbnail_file($screenshot->{'id'}, "google-2.png", array('height' => 100));
echo "Thumbnail saved to google-2.png\n";

# Get a thumbnail of 200 by 100 pixels at most
$browshot->screenshot_thumbnail_file($screenshot->{'id'}, "google-3.png", array('height' => 100, 'width' => 200));
echo "Thumbnail saved to google-3.png\n";

# Crop the screenshot to 768x768, scale it to a 300x300 thumbnail
$browshot->screenshot_thumbnail_file($screenshot->{'id'}, "google-4.png", array('right' => 768, 'bottom' => 768, 'height' => 300, 'width' => 300, 'ratio' => 'fit'));
echo "Thumbnail saved to google-4.png\n";

?>

Download code sample

# -*- coding: utf-8 -*-

from browshot import BrowshotClient
import time

browshot = BrowshotClient('my_api_key')


screenshot = browshot.screenshot_create('http://www.google.com/', { 'instance_id': 12 }) # all default parameters, instance_id = 12 (free)
# If the screenshot is already in cache, it could be finished already. Othwewise, wait longer
while screenshot['status'] != 'finished' and screenshot['status'] != 'error':
  print "Wait..."
  time.sleep(10)
  screenshot = browshot.screenshot_info(screenshot['id'])

# You can request multiple thumbnails of the same screenshot at no cost
# Get a thumbnail at 1/3 (33%) of the original
browshot.screenshot_thumbnail_file(screenshot['id'], "google-1.png", { 'zoom': 33 })
print "Thumbnail saved to google-1.png"

# Get a thumbnail with a height of 100 pixels
browshot.screenshot_thumbnail_file(screenshot['id'], "google-2.png", { 'height': 100 })
print "Thumbnail saved to google-2.png"

# Get a thumbnail of 200 by 100 pixels at most
browshot.screenshot_thumbnail_file(screenshot['id'], "google-3.png", { 'height': 100, 'width': 200 })
print "Thumbnail saved to google-3.png"

# Crop the screenshot to 768x768, scale it to a 300x300 thumbnail
browshot.screenshot_thumbnail_file(screenshot['id'], "google-4.png", { 'right': 768, 'bottom': 768, 'height': 300, 'width': 300, 'ratio': 'fit' })
print "Thumbnail saved to google-4.png"

Download code sample

#!/usr/bin/env ruby

require 'browshot'

browshot = Browshot.new('my_api_key')


screenshot = browshot.screenshot_create('http://www.google.com/', { 'instance_id' => 12 }) # all default parameters, instance_id = 12 (free)
# If the screenshot is already in cache, it could be finished already. Othwewise, wait longer
while (screenshot['status'] != 'finished' && screenshot['status'] != 'error')
  puts "Wait...\n"
  sleep(10)
  screenshot = browshot.screenshot_info(screenshot['id'])
end

# You can request multiple thumbnails of the same screenshot at no cost
# Get a thumbnail at 1/3 (33%) of the original
browshot.screenshot_thumbnail_file(screenshot['id'], "google-1.png", { 'zoom' => 33 })
puts "Thumbnail saved to google-1.png\n"

# Get a thumbnail with a height of 100 pixels
browshot.screenshot_thumbnail_file(screenshot['id'], "google-2.png", { 'height' => 100 })
puts "Thumbnail saved to google-2.png\n"

# Get a thumbnail of 200 by 100 pixels at most
browshot.screenshot_thumbnail_file(screenshot['id'], "google-3.png", { 'height' => 100, 'width' => 200 })
puts "Thumbnail saved to google-3.png\n"

# Crop the screenshot to 768x768, scale it to a 300x300 thumbnail
browshot.screenshot_thumbnail_file(screenshot['id'], "google-4.png", { 'right' => 768, 'bottom' => 768, 'height' => 300, 'width' => 300, 'ratio' => 'fit' })
puts "Thumbnail saved to google-4.png\n"

Download code sample

'use strict';

const browshot = require('browshot');

var client = new browshot('my_api_key');

var interval;

// all default parameters, instance_id = 12 (free)
client.screenshotCreate(
	{url: 'http://www.google.com/', instance_id: 12, size: 'page' }, 
	function(screenshot) {
		// If the screenshot is already in cache, it could be finished already. Otherwise, wait longer
		if (screenshot.status == 'error') {
			console.log(`Screenshot #${screenshot.id} failed: ${screenshot.error}`);
		}
		else if (screenshot.status == 'finished') {
			screenshotFinished(screenshot);
		}
		else {
			interval = setInterval(checkScreenshot, 1000 * 10, screenshot.id);
		}
	}
);


function checkScreenshot(id) {
	client.screenshotInfo(id, { }, function(screenshot) {
		if (screenshot.status == 'error') {
			clearInterval(interval);
			
			console.log(`Screenshot #${screenshot.id} failed: ${screenshot.error}`);
		}
		else if (screenshot.status == 'finished') {
			clearInterval(interval);
			
			screenshotFinished(screenshot);
		}
		else {
			console.log(`Waiting for screenshot #${screenshot.id} to finish...`);
		}
	});
}

function screenshotFinished(screenshot) {
	// Get a thumbnail at 1/3 (33%) of the original
	client.screenshotThumbnailFile(screenshot.id, "google-1.png", { zoom: 33 }, function(file) {
		console.log(`Thumbnail saved to ${file}`);
	});
	
	// Get a thumbnail with a height of 100 pixels
	client.screenshotThumbnailFile(screenshot.id, "google-2.png", { height: 100 }, function(file) {
		console.log(`Thumbnail saved to ${file}`);
	});
	
	// Get a thumbnail of 200 by 100 pixels at most
	client.screenshotThumbnailFile(screenshot.id, "google-3.png", { height: 100, width: 200 }, function(file) {
		console.log(`Thumbnail saved to ${file}`);
	});
	
	// Crop the screenshot to 768x768, scale it to a 300x300 thumbnail
	client.screenshotThumbnailFile(screenshot.id, "google-4.png", { right:768, bottom: 768, height: 300, width: 300, ratio: 'fit' }, function(file) {
		console.log(`Thumbnail saved to ${file}`);
	});
}

Download code sample

#!/usr/bin/perl -w

use strict;
use warnings;
use Carp;

use WebService::Browshot;

my $browshot = WebService::Browshot->new(
	key	=> 'my_api_key',
	debug	=> 0, # no more debug information
);


my $screenshot = $browshot->screenshot_create(url => 'http://mobilio.net/', instance_id => 12); 
sleep 60;

if ($screenshot->{status} eq 'error') {
	print "Screenshot failed: ", $screenshot->{error}, "\n";
	exit(0);
}

# Share this screenshot
$screenshot = $browshot->screenshot_info(id => $screenshot->{id});
if ($screenshot->{status} eq 'finished') { 
	# share a screenshot (must be in finished state)
	my $share = $browshot->screenshot_share(id => $screenshot->{id}, note => 'Browshot is great!');
	if ($share->{status} eq 'ok') {
		print "Screenshot shared at ", $share->{url}, "\n";
	}
	else {
		print "Sharing failed: ", $share->{error}, "\n";
	}
}

Download code sample

<?php

require 'vendor/autoload.php'; # Composer
# require_once 'Browshot.php'; # or download Browshot.php

$browshot = new Browshot('my_api_key');


$screenshot = $browshot->screenshot_create(array('url' => 'http://mobilio.net/', 'instance_id' => 12)); 
sleep(60);

if ($screenshot->{'status'} == 'error') {
	echo sprintf("Screenshot failed: %s\n", $screenshot->{'error'});
	exit(0);
}

# Share this screenshot
$screenshot = $browshot->screenshot_info($screenshot->{'id'});
if ($screenshot->{'status'} == 'finished') { 
	# share a screenshot (must be in finished state)
	$share = $browshot->screenshot_share($screenshot->{'id'}, array('note' => 'Browshot is great!'));
	if ($share->{'status'} == 'ok') {
		echo sprintf("Screenshot shared at %s\n", $share->{'url'});
	}
	else {
		echo sprintf("Sharing failed: %s\n", $share->{'error'});
	}
}

?>

Download code sample

# -*- coding: utf-8 -*-

from browshot import BrowshotClient
import time

browshot = BrowshotClient('my_api_key')


screenshot = browshot.screenshot_create('http://mobilio.net/', { 'instance_id': 12 })
time.sleep(60)

if screenshot['status'] == 'error':
  print "Screenshot failed: %s" % screenshot['error']
  exit(0)

# Share this screenshot
screenshot = browshot.screenshot_info(screenshot['id'])
if screenshot['status'] == 'finished':
  # share a screenshot (must be in finished state)
  share = browshot.screenshot_share(screenshot['id'], { 'note': 'Browshot is great!' })
  if share['status'] == 'ok':
    print "Screenshot shared at %s" % share['url']
  else:
    print "Sharing failed: %s\n" % share['error']

Download code sample

#!/usr/bin/env ruby

require 'browshot'

browshot = Browshot.new('my_api_key')

screenshot = browshot.screenshot_create('http://mobilio.net/', { 'instance_id' => 12 })
sleep(60)

if (screenshot['status'] == 'error')
  puts "Screenshot failed: #{screenshot['error']}\n"
  exit(0)
end

# Share this screenshot
screenshot = browshot.screenshot_info(screenshot['id'])
if (screenshot['status'] == 'finished')
  # share a screenshot (must be in finished state)
  share = browshot.screenshot_share(screenshot['id'], { 'note' => 'Browshot is great!' })
  if (share['status'] == 'ok')
    puts "Screenshot shared at #{share['url']}\n"
  else
    puts "Sharing failed: #{share['error']}\n"
  end
end

Download code sample

'use strict';

const browshot = require('browshot');

var client = new browshot('my_api_key');

var interval;

client.screenshotCreate({url: 'http://mobilio.net/', instance_id: 12 }, function(screenshot) {
		// If the screenshot is already in cache, it could be finished already. Otherwise, wait longer
		if (screenshot.status == 'error') {
			console.log(`Screenshot #${screenshot.id} failed: ${screenshot.error}`);
		}
		else if (screenshot.status == 'finished') {
			screenshotFinished(screenshot);
		}
		else {
			interval = setInterval(checkScreenshot, 1000 * 10, screenshot.id);
		}
	}
);

function checkScreenshot(id) {
	client.screenshotInfo(id, { }, function(screenshot) {
		if (screenshot.status == 'error') {
			clearInterval(interval);
			
			console.log(`Screenshot #${screenshot.id} failed: ${screenshot.error}`);
		}
		else if (screenshot.status == 'finished') {
			clearInterval(interval);
			
			screenshotFinished(screenshot);
		}
		else {
			console.log(`Waiting for screenshot #${screenshot.id} to finish...`);
		}
	});
}

function screenshotFinished(screenshot) {
	// share a screenshot (must be in finished state)
	client.screenshotShare(screenshot.id, { note: 'Browshot is great!' }, function(share) {
		if (share.status == 'ok')
			console.log(`Screenshot shared at ${share.url}`);
		else
			console.log(`Sharing failed: ${share.error}`);
	});
}

Download code sample

{
  "status": "error",
  "error" : "Invalid screenshot id",
  "id": 3965421
}

{
  "status": "ok",
  "url": "https://browshot.com/share/U6uVs0VysLbf9VCms",
  "id": 3965421
}

#!/usr/bin/perl -w

use strict;
use warnings;
use Carp;

use WebService::Browshot;

my $browshot = WebService::Browshot->new(
	key	=> 'my_api_key',
	debug	=> 0, # no more debug information
);


my $screenshot = $browshot->screenshot_create(url => 'http://mobilio.net/', instance_id => 12); 
sleep 60;

# Delete the screenshto URL
$browshot->screenshot_delete(id => $screenshot->{id}, data => 'url');

my $info = $browshot->screenshot_info(id => $screenshot->{id});
if (! exists ($info->{url}) || $info->{url} eq '') {
	print "URL has been deleted for screenshot #", $screenshot->{id}, "\n";
}

# Delete the image
$browshot->screenshot_delete(id => $screenshot->{id}, data => 'image');
my $image = $browshot->screenshot_thumbnail(id => $screenshot->{id});
if (length($image) == 0) {
	print "Screenshot for #", $screenshot->{id}, " has been deleted\n";
}

# Delete everything
$browshot->screenshot_delete(id => $screenshot->{id}, data => 'all');

Download code sample

<?php

require 'vendor/autoload.php'; # Composer
# require_once 'Browshot.php'; # or download Browshot.php

$browshot = new Browshot('my_api_key');


$screenshot = $browshot->screenshot_create(array('url' => 'http://mobilio.net/', 'instance_id' => 12)); 
sleep(60);

# Delete the screenshto URL
$browshot->screenshot_delete($screenshot->{'id'}, array('data' => 'url'));

$info = $browshot->screenshot_info($screenshot->{'id'});
if (! array_key_exists('url', $info) || $info->{'url'} == '') {
	echo sprintf("URL has been deleted for screenshot #%d\n", $screenshot->{'id'});
}

# Delete the image
$browshot->screenshot_delete($screenshot->{'id'}, array('data' => 'image'));
$image = $browshot->screenshot_thumbnail($screenshot->{'id'});
if (strlen($image) == 0) {
	echo sprintf("Screenshot for #%d has been deleted\n", $screenshot->{'id'});
}

# Delete everything
$browshot->screenshot_delete($screenshot->{'id'}, array('data' => 'all'));

?>

Download code sample

# -*- coding: utf-8 -*-

from browshot import BrowshotClient
import time

browshot = BrowshotClient('my_api_key')


screenshot = browshot.screenshot_create('http://mobilio.net/', { 'instance_id': 12 })
time.sleep(60)

# Delete the screenshto URL
browshot.screenshot_delete(screenshot['id'], { 'data': 'url' })

info = browshot.screenshot_info(screenshot['id'])
if not 'url' in info or info['url'] == '':
  print "URL has been deleted for screenshot #%d" % int(screenshot['id'])

# Delete the image
browshot.screenshot_delete(screenshot['id'], { 'data': 'image' })
image = browshot.screenshot_thumbnail(screenshot['id'])
if len(image) == 0:
  print "Screenshot for #%d has been deleted" % int(screenshot['id'])

# Delete everything
browshot.screenshot_delete(screenshot['id'], { 'data': 'all' })

Download code sample

#!/usr/bin/env ruby

require 'browshot'

browshot = Browshot.new('my_api_key')


screenshot = browshot.screenshot_create('http://mobilio.net/', { 'instance_id' => 12 })
sleep(60)

# Delete the screenshto URL
browshot.screenshot_delete(screenshot['id'], { 'data' => 'url' })

info = browshot.screenshot_info(screenshot['id'])
if (! info.key?('url') || info['url'] == '')
  puts "URL has been deleted for screenshot ##{screenshot['id']}\n"
end

# Delete the image
browshot.screenshot_delete(screenshot['id'], { 'data' => 'image' })
image = browshot.screenshot_thumbnail(screenshot['id'])
if (image.length == 0)
  puts "Screenshot for ##{screenshot['id']} has been deleted\n"
end

# Delete everything
browshot.screenshot_delete(screenshot['id'], { 'data' => 'all' })

Download code sample

var browshot = require('browshot');

var client = new browshot('my_api_key');

var interval;

client.screenshotCreate({url: 'http://mobilio.net/', instance_id: 12 }, function(screenshot) {
	// If the screenshot is already in cache, it could be finished already. Otherwise, wait longer
	if (screenshot.status == 'error') {
		console.log(`Screenshot #${screenshot.id} failed: ${screenshot.error}`);
	}
	else if (screenshot.status == 'finished') {
		screenshotFinished(screenshot);
	}
	else {
		interval = setInterval(checkScreenshot, 1000 * 10, screenshot.id);
	}

});


function checkScreenshot(id) {
	client.screenshotInfo(id, { }, function(screenshot) {
		if (screenshot.status == 'error') {
			clearInterval(interval);
			
			console.log(`Screenshot #${screenshot.id} failed: ${screenshot.error}`);
		}
		else if (screenshot.status == 'finished') {
			clearInterval(interval);
			
			screenshotFinished(screenshot);
		}
		else {
			console.log(`Waiting for screenshot #${screenshot.id} to finish...`);
		}
	});
}

function screenshotFinished(screenshot) {
	// delete URL
	client.screenshotDelete(screenshot.id, { data: 'url' }, function(screenshot) {
		client.screenshotInfo(screenshot.id, { }, function(info) {
			if (! info.hasOwnProperty('url') || info.url == '') {
				console.log(`URL has been deleted for screenshot #${info.id}`);
			}
		});
	});
	
	// delete the image
	client.screenshotDelete(screenshot.id, { data: 'image' }, function(screenshot) {
		client.screenshotThumbnail(screenshot.id, { }, function(image) {
			if (image.length == 0) {
			console.log(`Image has been deleted for screenshot #${screenshot.id}`);
			}
		});
	});
	
	// Delete everything
	client.screenshotDelete(screenshot.id, { data: 'all' }, function(screenshot) {
		console.log("All data have been deleted");
	});
}

Download code sample

{
  "status": "error",
  "error" : "Invalid screenshot id",
  "id": 3965421
}

{
  "status": "ok",
  "id": 3965421
}

#!/usr/bin/perl -w

use strict;
use warnings;
use Carp;

use WebService::Browshot;

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################


my $browshot = WebService::Browshot->new(
	key	=> 'my_api_key',
	debug	=> 0, # no more debug information
);


# You must request HTML when creating the screenshot
my $screenshot = $browshot->screenshot_create(url => 'http://mobilio.net/', instance_id => 24, screen_width => 1280, screen_height => 1024, html => 1); 
sleep 60;

$screenshot = $browshot->screenshot_info(id => $screenshot->{id});
if ($screenshot->{status} eq 'finished') {
	my $html = $browshot->screenshot_html(id => $screenshot->{id});
	if (length($html) > 0) {
		print "HTML is available\n";
# 		print "$html\n";
	}
}

Download code sample

<?php

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

require 'vendor/autoload.php'; # Composer
# require_once 'Browshot.php'; # or download Browshot.php

$browshot = new Browshot('my_api_key');

# You must request HTML when creating the screenshot
$screenshot = $browshot->screenshot_create(array('url' => 'http://mobilio.net/', 'instance_id' => 24, 'screen_width' => 1280, 'screen_height' => 1024, 'html' => 1)); 
sleep(60);

$screenshot = $browshot->screenshot_info($screenshot->{'id'});
if ($screenshot->{'status'} == 'finished') {
	$html = $browshot->screenshot_html($screenshot->{'id'});
	if (strlen($html) > 0) {
		echo "HTML is available\n";
# 	echo "$html\n";
	}
}

?>

Download code sample

# -*- coding: utf-8 -*-
#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

from browshot import BrowshotClient
import time

browshot = BrowshotClient('my_api_key')

# You must request HTML when creating the screenshot
screenshot = browshot.screenshot_create('http://mobilio.net/', { 'instance_id': 24, 'screen_width': 1280, 'screen_height': 1024, 'html': 1 })
time.sleep(60)

screenshot = browshot.screenshot_info(screenshot['id'])
if screenshot['status'] == 'finished':
  html = browshot.screenshot_html(screenshot['id'])
  if len(html) > 0:
    print "HTML is available"
#    print html

Download code sample

#!/usr/bin/env ruby

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

require 'browshot'

browshot = Browshot.new('my_api_key')

# You must request HTML when creating the screenshot
screenshot = browshot.screenshot_create('http://mobilio.net/', { 'instance_id' => 24, 'screen_width' => 1280, 'screen_height' => 1024, 'html' => 1 })
sleep(60)

screenshot = browshot.screenshot_info(screenshot['id'])
if (screenshot['status'] == 'finished')
  html = browshot.screenshot_html(screenshot['id'])
  if (html.length > 0)
    puts "HTML is available\n"
#    puts html
  end
end

Download code sample

/**********************
* WARNING
* Running this code sample will cost you Browshot credits
***********************/
'use strict';

const browshot = require('browshot');

var client = new browshot('my_api_key');

var interval;

// You must request HTML when creating the screenshot
client.screenshotCreate(
	{
		url: 'http://mobilio.net/',
		instance_id: 24, 
		screen_width: 1280, 
		screen_height: 1024, 
		html: 1 
	}, function(screenshot) {
		// If the screenshot is already in cache, it could be finished already. Otherwise, wait longer
		if (screenshot.status == 'error') {
			console.log(`Screenshot #${screenshot.id} failed: ${screenshot.error}`);
		}
		else if (screenshot.status == 'finished') {
			screenshotFinished(screenshot);
		}
		else {
			interval = setInterval(checkScreenshot, 1000 * 10, screenshot.id);
		}
	}
);

function checkScreenshot(id) {
	client.screenshotInfo(id, { }, function(screenshot) {
		if (screenshot.status == 'error') {
			clearInterval(interval);
			
			console.log(`Screenshot #${screenshot.id} failed: ${screenshot.error}`);
		}
		else if (screenshot.status == 'finished') {
			clearInterval(interval);
			
			screenshotFinished(screenshot);
		}
		else {
			console.log(`Waiting for screenshot #${screenshot.id} to finish...`);
		}
	});
}

function screenshotFinished(screenshot) {
	client.screenshotHtml(screenshot.id, function(html) {
		if (html.length > 0) {
			console.log("HTML is available");
		}
	
	});
}

Download code sample

<?php

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

require 'vendor/autoload.php'; # Composer
# require_once 'Browshot.php'; # or download Browshot.php

$browshot = new Browshot('my_api_key');

# Create a text file with a list of URLs
$fp = fopen("batch.txt", 'w') or die("Unable to open batch.txt!");;
fwrite($fp, "google.com\n");
fwrite($fp, "mobilito.net\n");
fclose($fp);


$batch = $browshot->batch_create("batch.txt", array('instance_id' => 65, 'screen_width' => 1600, 'screen_height' => 1200, 'size' => 'page')); # Get full size thumbnails
if ($batch->{'status'} == 'error') {
	echo sprintf("Batch failed: %s\n", $batch->{'error'});
	exit(0);
}

echo sprintf("Batch #%d in process\n", $batch->{'id'});

sleep(30);
while ($batch->{'status'} != 'finished' && $batch->{'status'} != 'error') {
	sleep(15);
	$batch = $browshot->batch_info($batch->{'id'});
}

if ($batch->{'status'} == 'error') {
	echo sprintf("Batch failed: %s\n", $batch->{'error'});
	exit(0);
}

# The batch succeeded, download the archive. There may be more than 1 URL
foreach ($batch->{'urls'} as $url) {
	echo "Downloading $url...\n";
	# download the URL
}

if (count($batch->{'urls'}) > 1) {
	# Run 7a if the archive was split into multiple files
}

?>

Download code sample

# -*- coding: utf-8 -*-
#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

from browshot import BrowshotClient
import time

browshot = BrowshotClient('my_api_key')

# Create a text file with a list of URLs
fp = open("batch.txt", mode='w')
fp.write("google.com\n")
fp.write("mobilito.net\n")
fp.close()


batch = browshot.batch_create("batch.txt", { 'instance_id': 65, 'screen_width': 1600, 'screen_height': 1200, 'size': 'page' }) # Get full size thumbnails
if batch['status'] == 'error':
  print("Batch failed: %s" % batch['error'])
  exit(0)


print "Batch #%d in process" % int(batch['id'])

time.sleep(30)
while batch['status'] != 'finished' and batch['status'] != 'error':
  time.sleep(15)
  batch = browshot.batch_info(batch['id'])


if batch['status'] == 'error':
  print("Batch failed: %s" % batch['error'])
  exit(0)

# The batch succeeded, download the archive. There may be more than 1 URL
for url in batch['urls']:
  print "Downloading %s..." % url

Download code sample

#!/usr/bin/env ruby

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

require 'browshot'

browshot = Browshot.new('my_api_key')

# Create a text file with a list of URLs
File.open("batch.txt", 'w') {|f| 
	f.write("google.com\n")
	f.write("mobilito.net\n")
}


batch = browshot.batch_create(65, "batch.txt", { 'screen_width' => 1600, 'screen_height' => 1200, 'size' => 'page' }) # Get full size thumbnails
if (batch['status'] == 'error')
  puts "Batch failed: #{batch['error']}\n"
  exit(0)
end

print "Batch ##{batch['id']} in process\n"

sleep(30)
while (batch['status'] != 'finished' && batch['status'] != 'error')
  sleep(15)
  batch = browshot.batch_info(batch['id'])
end

if (batch['status'] == 'error')
  puts "Batch failed: #{batch['error']}\n"
  exit(0)
end

# The batch succeeded, download the archive. There may be more than 1 URL.
if (batch.key?('urls'))
	batch['urls'].each { |url|
		puts "Downloading #{url}...\n"
	}
end

Download code sample

/**********************
* WARNING
* Running this code sample will cost you Browshot credits
***********************/

var browshot = require('browshot');
const fs = require("fs");

var client = new browshot('my_api_key');

var timeout;

// Create a text file with a list of URLs
fs.writeFile("batch.txt", "google.com\nmobilito.net\n", (err) => {
	if (err) {
		console.log(`Failed to write list of URLs batch.txt: ${err}`);
	}
	else {
		submitBatch("batch.txt");
	}
});


function submitBatch(file) {
	client.batchCreate(
		file, 65, { screen_width: 1600, screen_height: 1200, size: 'page' }, 
		function(batch) {
			fs.unlink(file, function() {});
			
			if (batch.status == 'error') {
				console.log("Batch failed: " + batch.error);
			}
			else {
				console.log(`Batch #${batch.id} in process`);
				
				// Check the status of the batch every 30 seconds
				timeout = setInterval(checkBatch , 1000 * 30, batch.id);
			}
		}
	);
}

function checkBatch(id) {
	client.batchInfo(id, { }, function(batch) {
		if (batch.status == 'error') {
			clearInterval(timeout);
			
			console.log("Batch failed: " + batch.error);
		}
		else if (batch.status == 'finished') {
			clearInterval(timeout);
			
			// The batch succeeded, download the archive. There may be more than 1 URL
			for(var i in batch.urls) {
				console.log(`Downloading ${batch.urls[i]}  ...`);
			}
		}
		else {
			console.log(`Waiting for batch ${batch.id} to finish`);
		}
	});
}

Download code sample

{
  "status": "error",
  "error" : "Missing file"
}

{
  "status": "in_queue",
  "id": 5
}

#!/usr/bin/perl -w

use strict;
use warnings;
use Carp;

use WebService::Browshot;

#######################
# WARNING
# Running this code sample will cost you Browshot credits.
#######################



my $browshot = WebService::Browshot->new(
	key	=> 'my_api_key',
	debug	=> 0, # no more debug information
);


# Create a text file with a lsit of URLs
open SOURCE, "> batch.txt" or croak "Cannot create file: $!\n";
print SOURCE "google.com\n";
print SOURCE "mobilito.net\n";
close SOURCE;


my $batch = $browshot->batch_create(file => "batch.txt", instance_id => 65, screen_width => 1600, 
  screen_height => 1200, size => 'page', width => 600); # Get thumbnails
  
if ($batch->{status} eq 'error') {
	print "Batch failed: ", $batch->{error}, "\n";
	exit(0);
}

print "Batch #", $batch->{id}, " in process\n";

sleep 30;
while ($batch->{status} ne 'finished' && $batch->{status} ne 'error') {
	sleep 15;
	$batch = $browshot->batch_info(id => $batch->{id});
}

if ($batch->{status} eq 'error') {
	print "Batch failed: ", $batch->{error}, "\n";
	exit(0);
}

# Check how many screenshot failed
print $batch->{failed}, "/", $batch->{count}, " screenshots failed\n";

# The batch succeeded, download the archive. There may be fore than 1 URL
foreach my $url (@{ $batch->{urls} }) {
	print "Downloading $url...\n";
	# Use LWP::Simple or LWP::UserAgent to download the archive
}

if (scalar @{ $batch->{urls} } > 1) {
	# Run 7a if the archive was split into multiple files
}

Download code sample

<?php

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

require 'vendor/autoload.php'; # Composer
# require_once 'Browshot.php'; # or download Browshot.php

$browshot = new Browshot('my_api_key');


# Create a text file with a lsit of URLs
$fp = fopen("batch.txt", 'w') or die("Unable to open batch.txt!");;
fwrite($fp, "google.com\n");
fwrite($fp, "mobilito.net\n");
fclose($fp);


$batch = $browshot->batch_create("batch.txt", array('instance_id' => 65, 'screen_width' => 1600, 
  'screen_height' => 1200, 'size' => 'page', 'width' => 600)); # Get thumbnails
  
if ($batch->{'status'} == 'error') {
	echo sprintf("Batch failed: %s\n", $batch->{'error'});
	exit(0);
}

sprintf("Batch #%d in process\n", $batch->{'id'});

sleep(30);
while ($batch->{'status'} != 'finished' && $batch->{'status'} != 'error') {
	sleep(15);
	$batch = $browshot->batch_info($batch->{'id'});
}

if ($batch->{'status'} == 'error') {
	echo sprintf("Batch failed: %s\n", $batch->{'error'});
	exit(0);
}

# Check how many screenshot failed
echo sprintf("%d/%d screenshots failed\n", $batch->{'failed'}, $batch->{'count'});

# The batch succeeded, download the archive. There may be fore than 1 URL
foreach ($batch->{'urls'} as $url) {
	echo "Downloading $url...\n";
	# Download the archive
}

if (count($batch->{'urls'}) > 1) {
	# Run 7a if the archive was split into multiple files
}

?>

Download code sample

# -*- coding: utf-8 -*-
#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

from browshot import BrowshotClient
import time

browshot = BrowshotClient('my_api_key')

# Create a text file with a lsit of URLs
fp = open("batch.txt", mode='w')
fp.write("google.com\n")
fp.write("mobilito.net\n")
fp.close()



batch = browshot.batch_create("batch.txt", { 'instance_id': 65, 'screen_width': 1600, 
  'screen_height': 1200, 'size': 'page', 'width': 600 }); # Get thumbnails
  
if batch['status'] == 'error':
  print "Batch failed: %s" % batch['error']
  exit(0)

print "Batch #%d in process" % int(batch['id'])

time.sleep(30)
while batch['status'] != 'finished' and batch['status'] != 'error':
  time.sleep(15)
  batch = browshot.batch_info(batch['id'])

if batch['status'] == 'error':
  print "Batch failed: %s" % batch['error']
  exit(0)

# Check how many screenshot failed
print "%d/%d screenshots failed" % (int(batch['failed']), int(batch['count']))

if 'urls' in batch:
  # The batch succeeded, download the archive. There may be fore than 1 URL
  for url in batch['urls']:
    print "Downloading %s..." % url 
    # Download the archive

  if len(batch['urls']) > 1:
    # Run 7a if the archive was split into multiple files
    print "7a ..."

Download code sample

#!/usr/bin/env ruby

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

require 'browshot'

browshot = Browshot.new('my_api_key')

# Create a text file with a list of URLs
File.open("batch.txt", 'w') {|f| 
	f.write("google.com\n")
	f.write("mobilito.net\n")
}


batch = browshot.batch_create(65, "batch.txt", { 'screen_width' => 1600, 
  'screen_height' => 1200, 'size' => 'page', 'width' => 600 }); # Get thumbnails
  
if (batch['status'] == 'error')
  puts "Batch failed: #{ batch['error']}\n"
  exit(0)
end

puts "Batch ##{batch['id']} in process\n"

sleep(30)
while (batch['status'] != 'finished' && batch['status'] != 'error')
  sleep(15)
  batch = browshot.batch_info(batch['id'])
end

if (batch['status'] == 'error')
  puts "Batch failed: #{batch['error']}\n"
  exit(0)
end

# Check how many screenshot failed
puts "#{batch['failed']}/#{batch['count']} screenshots failed\n"

if (batch.key?('urls'))
  # The batch succeeded, download the archive. There may be more than 1 URL.
  batch['urls'].each { |url|
    puts "Downloading #{url}...\n"
    # Download the archive
  }

  if (batch['urls'].count > 1)
    # Run 7a if the archive was split into multiple files
    puts "7a ...\n"
  end
end

Download code sample

/**********************
* WARNING
* Running this code sample will cost you Browshot credits
***********************/

const browshot = require('browshot');
const fs = require("fs");

var client = new browshot('my_api_key');


// Create a text file with a list of URLs
fs.writeFile("batch.txt", "google.com\nmobilito.net\n", (err) => {
	if (err) {
		error(err);
	}
	else {
		submitBatch("batch.txt");
	}
});


function submitBatch(file) {
	client.batchCreate(
		file, 65, { screen_width: 1600, screen_height: 1200, size: 'page', width: 600 }, 
		function(batch) {
			fs.unlink(file, function() {});
			
			if (batch.status == 'error') {
				console.log("Batch failed: " + batch.error);
			}
			else {
				console.log(`Batch #${batch.id} in process`);
				
				// Check the status of the batch every 30 seconds
				timeout = setInterval(checkBatch , 1000 * 30, batch.id);
			}
		}
	);
}

function checkBatch(id) {
	client.batchInfo(id, { }, function(batch) {
		if (batch.status == 'error') {
			clearInterval(timeout);
			
			console.log("Batch failed: " + batch.error);
		}
		else if (batch.status == 'finished') {
			clearInterval(timeout);
			
			// Check how many screenshot failed
			console.log(`${batch.failed}/${batch.count} screenshots failed`);
			
			// The batch succeeded, download the archive. There may be more than 1 URL
			for(var i in batch.urls) {
				console.log(`Downloading ${batch.urls[i]}  ...`);
			}
			
			if (batch.urls.length > 1) {
				// Run 7a if the archive was split into multiple files
				console.log("7a ...");
			}
		}
		else {
			console.log(`Waiting for batch ${batch.id} to finish`);
		}
	});
}

Download code sample

{
  "status": "error",
  "error" : "Wrong batch ID"
}

{
  "status": "in_queue",
  "id": 5
}

{
  "status": "in_process",
  "id": 5,
  "started":  1312106111,
  "finished":  0,
  "count":  10000,
  "processed": 523,
  "failed": 7,
  "split": 1
}

{
  "status": "finished",
  "id": 5,
  "started":  1312106111,
  "finished":  10000,
  "count":  10000,
  "processed": 10000,
  "failed": 7,
  "urls": ["https://browshot.com/static/batch/browshot-5-GQdF0w8dMwkieE5wiUsTPAjGA.zip.001", 
    "https://browshot.com/static/batch/browshot-5-GQdF0w8dMwkieE5wiUsTPAjGA.zip.002"]
}

#!/usr/bin/perl -w

use strict;
use warnings;
use Carp;

use WebService::Browshot 1.29.0; # requires 1.29.0 or above

#######################
# WARNING
# Running this code sample will cost you Browshot credits.
#######################



my $browshot = WebService::Browshot->new(
	key	=> 'my_api_key',
	debug	=> 0, # no more debug information
);



my $crawl = $browshot->crawl_create(url => 'https://blitapp.com/', domain => 'blitapp.com', max => 50, instance_id => 65, screen_width => 1600, screen_height => 1200, size => 'page'); # Get full size thumbnails
if ($crawl->{status} eq 'error') {
	print "Crawl failed: ", $crawl->{error}, "\n";
	exit(0);
}

print "Crawl #", $crawl->{id}, " in process\n";

sleep 30;
while ($crawl->{status} ne 'finished' && $crawl->{status} ne 'error') {
	sleep 15;
	$crawl = $browshot->crawl_info(id => $crawl->{id});
}

if ($crawl->{status} eq 'error') {
	print "crawl failed: ", $crawl->{error}, "\n";
	exit(0);
}

# The crawl succeeded, download the thumbnails.
foreach my $url (@{ $crawl->{urls} }) {
	print "Downloading ", $url->screenshot_url, "...\n";
	 $browshot->screenshot_thumbnail_file(id => $url->id, file => '/tmp/' + $url->id +'.png')
}

Download code sample

<?php

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

require 'vendor/autoload.php'; # Composer
# require_once 'Browshot.php'; # or download Browshot.php

$browshot = new Browshot('my_api_key');


$crawl = $browshot->crawl_create(array('url' => 'https://blitapp.com/', 'domain' => 'blitapp.com', max => 25, instance_id' => 65, 'screen_width' => 1600, 'screen_height' => 1200, 'size' => 'page')); # Get full size thumbnails
if ($crawl->{'status'} == 'error') {
	echo sprintf("Crawl failed: %s\n", $crawl->{'error'});
	exit(0);
}

echo sprintf("Crawl #%d in process\n", $crawl->{'id'});

sleep(30);
while ($crawl->{'status'} != 'finished' && $crawl->{'status'} != 'error') {
	sleep(15);
	$crawl = $browshot->crawl_info($crawl->{'id'});
}

if ($crawl->{'status'} == 'error') {
	echo sprintf("Crawl failed: %s\n", $crawl->{'error'});
	exit(0);
}

# The crawl succeeded, download the thumbnails.
foreach ($crawl->{'urls'} as $screenshot) {
	echo "Downloading $url...\n";
	# download the URL
  $browshot->screenshot_thumbnail_file($screenshot->{'id'}, "file-" . $screenshot->{'id'} . ".png", array('right' => 768, 'bottom' => 768, 'height' => 300, 'width' => 300, 'ratio' => 'fit'));
}


?>

Download code sample

# -*- coding: utf-8 -*-
#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

from browshot import BrowshotClient
import time

browshot = BrowshotClient('my_api_key')


crawl = browshot.crawl_create("blitapp.com", "https://blitapp.com/", { 'instance_id': 65, 'screen_width': 1600, 'screen_height': 1200, 'size': 'page' }) # Get full size thumbnails
if crawl['status'] == 'error':
  print("Crawl failed: %s" % crawl['error'])
  exit(0)


print "Crawl #%d in process" % int(crawl['id'])

time.sleep(30)
while crawl['status'] != 'finished' and crawl['status'] != 'error':
  time.sleep(15)
  crawl = browshot.crawl_info(crawl['id'])


if crawl['status'] == 'error':
  print("crawl failed: %s" % crawl['error'])
  exit(0)

# The crawl succeeded, download the thumbnails
for screenshot in batch['urls']:
  print "Downloading screenshot %s..." % screenshot.id
  browshot.screenshot_thumbnail_file(screenshot['id'], "file.png", { 'right': 768, 'bottom': 768, 'height': 300, 'width': 300, 'ratio': 'fit' })

Download code sample

#!/usr/bin/env ruby

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

require 'browshot'

browshot = Browshot.new('my_api_key')

crawl = browshot.crawl_create(65, "blitapp.com", "https://blitapp.com/", { 'screen_width' => 1600, 'screen_height' => 1200, 'size' => 'page' }) # Get full size thumbnails
if (crawl['status'] == 'error')
  puts "Crawl failed: #{crawl['error']}\n"
  exit(0)
end

print "Crawl ##{crawl['id']} in process\n"

sleep(30)
while (crawl['status'] != 'finished' && crawl['status'] != 'error')
  sleep(15)
  crawl = browshot.crawl_info(crawl['id'])
end

if (crawl['status'] == 'error')
  puts "crawl failed: #{crawl['error']}\n"
  exit(0)
end

# The crawl succeeded, download the thumbnails
if (crawl.key?('urls'))
	crawl['urls'].each { |screenshot|
		puts "Downloading #{screenshot['id']}...\n"
    browshot.screenshot_thumbnail_file(screenshot['id'], "file-#{screenshot['id']}.png", { 'right' => 768, 'bottom' => 768, 'height' => 300, 'width' => 300, 'ratio' => 'fit' })
	}
end

Download code sample

/**********************
* WARNING
* Running this code sample will cost you Browshot credits
***********************/

var browshot = require('browshot');
const fs = require("fs");

var client = new browshot('my_api_key');

var timeout;



function submitCrawl(file) {
	client.crawlCreate(
		"blitapp.com", "https://blitapp.com/", 65, { screen_width: 1600, screen_height: 1200, size: 'page' }, 
		function(crawl) {		
			if (crawl.status == 'error') {
				console.log("crawl failed: " + crawl.error);
			}
			else {
				console.log(`crawl #${crawl.id} in process`);
				
				// Check the status of the crawl every 30 seconds
				timeout = setInterval(checkCrawl , 1000 * 30, crawl.id);
			}
		}
	);
}

function checkCrawl(id) {
	client.crawlInfo(id, { }, function(crawl) {
		if (crawl.status == 'error') {
			clearInterval(timeout);
			
			console.log("crawl failed: " + crawl.error);
		}
		else if (crawl.status == 'finished') {
			clearInterval(timeout);
			
			// The crawl succeeded, download the thumbnails.
			for(var screenshot of crawl.urls) {
				console.log(`Downloading ${screenshot.id}  ...`);
        client.screenshotThumbnailFile(screenshot.id, `file-${screenshot.id}.png`, { zoom: 33 }, function(file) {
          console.log(`Thumbnail saved to ${file}`);
        });
			}
		}
		else {
			console.log(`Waiting for crawl ${crawl.id} to finish`);
		}
	});
}

Download code sample

{
  "status": "error",
  "error" : "Invalid crawl ID"
}

{
  "status": "finished",
  "id": 5
  "domain" : "blitapp.com",
  "url" :"https://blitapp.com/",
  "max": 100,
  "started"
  "finished":
  "count":  50,
  "processed": 50,
  "failed": 2,
  "urls": [
    {
      "id": 12589,
      "status": "finished",
      "screenshot_url": "https://browshot.com/screenshot/image/15/12589?scale=1&key=API_KEY",
      "priority": 12,
      "url": "http://blitapp.com/",
      "size": "screen",
      "width": 1024,
      "height": 768,
      "request_time": 1312106111,
      "started": 1312258803994,
      "load": 1312258829461,
      "content": 1312258829661,
      "finished": 1312258829681,
      "instance_id": 12,
      "response_code": 200,
      "final_url": "http://blitapp.com/",
      "content_type": "text/html",
      "scale": "1",
      "cost": 0,
      "referer": "",
      "post_data": "",
      "cookie": "",
      "delay": 5,
      "script": "",
      "shared_url": "",
      "details": 3
    },
    ...
  ]
}

#!/usr/bin/perl -w

use strict;
use warnings;
use Carp;

use WebService::Browshot 1.29.0; # requires 1.29.0 or above

#######################
# WARNING
# Running this code sample will cost you Browshot credits.
#######################



my $browshot = WebService::Browshot->new(
	key	=> 'my_api_key',
	debug	=> 0, # no more debug information
);



my $crawl = $browshot->crawl_create(url => 'https://blitapp.com/', domain => 'blitapp.com', max => 50, instance_id => 65, screen_width => 1600, screen_height => 1200, size => 'page'); # Get full size thumbnails
if ($crawl->{status} eq 'error') {
	print "Crawl failed: ", $crawl->{error}, "\n";
	exit(0);
}

print "Crawl #", $crawl->{id}, " in process\n";

sleep 30;
while ($crawl->{status} ne 'finished' && $crawl->{status} ne 'error') {
	sleep 15;
	$crawl = $browshot->crawl_info(id => $crawl->{id});
}

if ($crawl->{status} eq 'error') {
	print "crawl failed: ", $crawl->{error}, "\n";
	exit(0);
}

# The crawl succeeded, download the thumbnails.
foreach my $url (@{ $crawl->{urls} }) {
	print "Downloading ", $url->screenshot_url, "...\n";
	 $browshot->screenshot_thumbnail_file(id => $url->id, file => '/tmp/' + $url->id +'.png')
}

Download code sample

<?php

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

require 'vendor/autoload.php'; # Composer
# require_once 'Browshot.php'; # or download Browshot.php

$browshot = new Browshot('my_api_key');


$crawl = $browshot->crawl_create(array('url' => 'https://blitapp.com/', 'domain' => 'blitapp.com', max => 25, instance_id' => 65, 'screen_width' => 1600, 'screen_height' => 1200, 'size' => 'page')); # Get full size thumbnails
if ($crawl->{'status'} == 'error') {
	echo sprintf("Crawl failed: %s\n", $crawl->{'error'});
	exit(0);
}

echo sprintf("Crawl #%d in process\n", $crawl->{'id'});

sleep(30);
while ($crawl->{'status'} != 'finished' && $crawl->{'status'} != 'error') {
	sleep(15);
	$crawl = $browshot->crawl_info($crawl->{'id'});
}

if ($crawl->{'status'} == 'error') {
	echo sprintf("Crawl failed: %s\n", $crawl->{'error'});
	exit(0);
}

# The crawl succeeded, download the thumbnails.
foreach ($crawl->{'urls'} as $screenshot) {
	echo "Downloading $url...\n";
	# download the URL
  $browshot->screenshot_thumbnail_file($screenshot->{'id'}, "file-" . $screenshot->{'id'} . ".png", array('right' => 768, 'bottom' => 768, 'height' => 300, 'width' => 300, 'ratio' => 'fit'));
}


?>

Download code sample

# -*- coding: utf-8 -*-
#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

from browshot import BrowshotClient
import time

browshot = BrowshotClient('my_api_key')


crawl = browshot.crawl_create("blitapp.com", "https://blitapp.com/", { 'instance_id': 65, 'screen_width': 1600, 'screen_height': 1200, 'size': 'page' }) # Get full size thumbnails
if crawl['status'] == 'error':
  print("Crawl failed: %s" % crawl['error'])
  exit(0)


print "Crawl #%d in process" % int(crawl['id'])

time.sleep(30)
while crawl['status'] != 'finished' and crawl['status'] != 'error':
  time.sleep(15)
  crawl = browshot.crawl_info(crawl['id'])


if crawl['status'] == 'error':
  print("crawl failed: %s" % crawl['error'])
  exit(0)

# The crawl succeeded, download the thumbnails
for screenshot in batch['urls']:
  print "Downloading screenshot %s..." % screenshot.id
  browshot.screenshot_thumbnail_file(screenshot['id'], "file.png", { 'right': 768, 'bottom': 768, 'height': 300, 'width': 300, 'ratio': 'fit' })

Download code sample

#!/usr/bin/env ruby

#######################
# WARNING
# Running this code sample will cost you Browshot credits
#######################

require 'browshot'

browshot = Browshot.new('my_api_key')

crawl = browshot.crawl_create(65, "blitapp.com", "https://blitapp.com/", { 'screen_width' => 1600, 'screen_height' => 1200, 'size' => 'page' }) # Get full size thumbnails
if (crawl['status'] == 'error')
  puts "Crawl failed: #{crawl['error']}\n"
  exit(0)
end

print "Crawl ##{crawl['id']} in process\n"

sleep(30)
while (crawl['status'] != 'finished' && crawl['status'] != 'error')
  sleep(15)
  crawl = browshot.crawl_info(crawl['id'])
end

if (crawl['status'] == 'error')
  puts "crawl failed: #{crawl['error']}\n"
  exit(0)
end

# The crawl succeeded, download the thumbnails
if (crawl.key?('urls'))
	crawl['urls'].each { |screenshot|
		puts "Downloading #{screenshot['id']}...\n"
    browshot.screenshot_thumbnail_file(screenshot['id'], "file-#{screenshot['id']}.png", { 'right' => 768, 'bottom' => 768, 'height' => 300, 'width' => 300, 'ratio' => 'fit' })
	}
end

Download code sample

/**********************
* WARNING
* Running this code sample will cost you Browshot credits
***********************/

var browshot = require('browshot');
const fs = require("fs");

var client = new browshot('my_api_key');

var timeout;



function submitCrawl(file) {
	client.crawlCreate(
		"blitapp.com", "https://blitapp.com/", 65, { screen_width: 1600, screen_height: 1200, size: 'page' }, 
		function(crawl) {		
			if (crawl.status == 'error') {
				console.log("crawl failed: " + crawl.error);
			}
			else {
				console.log(`crawl #${crawl.id} in process`);
				
				// Check the status of the crawl every 30 seconds
				timeout = setInterval(checkCrawl , 1000 * 30, crawl.id);
			}
		}
	);
}

function checkCrawl(id) {
	client.crawlInfo(id, { }, function(crawl) {
		if (crawl.status == 'error') {
			clearInterval(timeout);
			
			console.log("crawl failed: " + crawl.error);
		}
		else if (crawl.status == 'finished') {
			clearInterval(timeout);
			
			// The crawl succeeded, download the thumbnails.
			for(var screenshot of crawl.urls) {
				console.log(`Downloading ${screenshot.id}  ...`);
        client.screenshotThumbnailFile(screenshot.id, `file-${screenshot.id}.png`, { zoom: 33 }, function(file) {
          console.log(`Thumbnail saved to ${file}`);
        });
			}
		}
		else {
			console.log(`Waiting for crawl ${crawl.id} to finish`);
		}
	});
}

Download code sample

{
  "status": "error",
  "error" : "Wrong crawl ID"
}

{
  "status": "in_queue",
  "id": 5
  "domain" : "blitapp.com",
  "url" :"https://blitapp.com/",
  "max": 100,
  "started"
  "finished":
  "count":  1,
  "processed": 0,
  "failed": 0,
  "urls": [
    {
      "id": 12589,
      "status": "in_queue",
      "screenshot_url": "https://browshot.com/screenshot/image/15/12589?scale=1&key=API_KEY",
      "url": "http://blitapp.com/",
      "size": "screen",
      "instance_id": 12,
      "content_type": "text/html",
      "cost": 0,
      "referer": "",
      "post_data": "",
      "cookie": "",
      "delay": 5,
      "script": "",
      "shared_url": "",
      "details": 3
    },
    ...
  ]
}

{
  "status": "in_process",
  "id": 5
  "domain" : "blitapp.com",
  "url" :"https://blitapp.com/",
  "max": 100,
  "started"
  "finished":
  "count":  25,
  "processed": 12,
  "failed": 0,
  "urls": [
    {
      "id": 12589,
      "status": "finished",
      "screenshot_url": "https://browshot.com/screenshot/image/15/12589?scale=1&key=API_KEY",
      "priority": 12,
      "url": "http://blitapp.com/",
      "size": "screen",
      "width": 1024,
      "height": 768,
      "request_time": 1312106111,
      "started": 1312258803994,
      "load": 1312258829461,
      "content": 1312258829661,
      "finished": 1312258829681,
      "instance_id": 12,
      "response_code": 200,
      "final_url": "http://blitapp.com/",
      "content_type": "text/html",
      "scale": "1",
      "cost": 0,
      "referer": "",
      "post_data": "",
      "cookie": "",
      "delay": 5,
      "script": "",
      "shared_url": "",
      "details": 3
    },
    ...
  ]
}

{
  "status": "finished",
  "id": 5
  "domain" : "blitapp.com",
  "url" :"https://blitapp.com/",
  "max": 100,
  "started"
  "finished":
  "count":  50,
  "processed": 50,
  "failed": 2,
  "urls": [
    {
      "id": 12589,
      "status": "finished",
      "screenshot_url": "https://browshot.com/screenshot/image/15/12589?scale=1&key=API_KEY",
      "priority": 12,
      "url": "http://blitapp.com/",
      "size": "screen",
      "width": 1024,
      "height": 768,
      "request_time": 1312106111,
      "started": 1312258803994,
      "load": 1312258829461,
      "content": 1312258829661,
      "finished": 1312258829681,
      "instance_id": 12,
      "response_code": 200,
      "final_url": "http://blitapp.com/",
      "content_type": "text/html",
      "scale": "1",
      "cost": 0,
      "referer": "",
      "post_data": "",
      "cookie": "",
      "delay": 5,
      "script": "",
      "shared_url": "",
      "details": 3
    },
    ...
  ]
}

#!/usr/bin/perl -w

use strict;
use warnings;
use Carp;

use WebService::Browshot;


my $browshot = WebService::Browshot->new(
	key	=> 'my_api_key',
	debug	=> 0, # no more debug information
);

my $account = $browshot->account_info();

# Check my balance
print "Free screenshots left for this month: ", $account->{free_screenshots_left}, "\n";
print "Credits left: ", $account->{balance}, "\n";

if ($account->{balance} < 100) {
	# Send an alarm when the balance is low
}

Download code sample

<?php

require 'vendor/autoload.php'; # Composer
# require_once 'Browshot.php'; # or download Browshot.php

$browshot = new Browshot('my_api_key');

$account = $browshot->account_info();

# Check my balance
echo sprintf("Free screenshots left for this month: %d\n", $account->{'free_screenshots_left'});
echo sprintf("Credits left: %d\n", $account->{'balance'});

if ($account->{'balance'} < 100) {
	# Send an alarm when the balance is low
}

?>

Download code sample

# -*- coding: utf-8 -*-

from browshot import BrowshotClient

browshot = BrowshotClient('my_api_key')


account = browshot.account_info()

# Check my balance
print "Free screenshots left for this month: %d" % int(account['free_screenshots_left'])
print "Credits left: %d\n" % int(account['balance'])

if int(account['balance']) < 100:
  # Send an alarm when the balance is low
  print "balance is low"

Download code sample

#!/usr/bin/env ruby

require 'browshot'

browshot = Browshot.new('my_api_key')


account = browshot.account_info()

# Check my balance
puts "Free screenshots left for this month: #{account['free_screenshots_left']}\n"
puts "Credits left: #{account['balance']}\n"

if (account['balance'].to_i < 100)
  # Send an alarm when the balance is low
  puts "balance is low\n"
end

Download code sample

var browshot = require('browshot');

var client = new browshot('my_api_key');


client.accountInfo({ }, function(info) {
	// Check my balance
	console.log("Free screenshots left for this month: " + info.free_screenshots_left);
	console.log("Credits left: " + info.balance);
	
	// Send an alarm when the balance is low
	if (info.balance < 100) {
		console.log("balance is low");
	}
});

Download code sample

#!/usr/bin/perl -w

use strict;
use warnings;
use Carp;

use WebService::Browshot;


my $browshot = WebService::Browshot->new(
	key	=> 'my_api_key',
	debug	=> 0, # no more debug information
);

my $instances = $browshot->instance_list();

# Check the list of free browser
print "Free browsers:\n";
foreach my $instance (@{ $instances->{free} }) {
	my $id = $instance->{id};
	print "\t#$id: ", $instance->{browser}->{name}, " ", $instance->{width}, "x", $instance->{height}, "\n";
}

Download code sample

<?php

require 'vendor/autoload.php'; # Composer
# require_once 'Browshot.php'; # or download Browshot.php

$browshot = new Browshot('my_api_key');

$instances = $browshot->instance_list();

# Check the list of free browser
echo "Free browsers:\n";
foreach ($instances->{'free'} as $instance) {
	$id = $instance->{'id'};
	echo "\t#$id: " . $instance->{'browser'}->{'name'} . " ", $instance->{'width'} . "x", $instance->{'height'} . "\n";
}

?>

Download code sample

# -*- coding: utf-8 -*-

from browshot import BrowshotClient

browshot = BrowshotClient('my_api_key')


instances = browshot.instance_list()

# Check the list of free browser
print "Free browsers:"
for instance in instances['free']:
  print "\t#" + instance['id'] + ": " + instance['browser']['name'] + " ", instance['width'] + "x" + instance['height']

Download code sample

#!/usr/bin/env ruby

require 'browshot'

browshot = Browshot.new('my_api_key')


instances = browshot.instance_list()

# Check the list of free browser
puts "Free browsers:"
instances['free'].each { |instance|
  puts "\t##{instance['id']}: #{instance['browser']['name']} #{instance['width']}x#{instance['height']}\n"
}

Download code sample

var browshot = require('browshot');

var client = new browshot('my_api_key');


client.instanceList(function(list) {
	// Check the list of free browsers
	console.log("Free instances:");
	for(var i in list.free) {
		console.log(`\t#${list.free[i].id}: ${list.free[i].browser.name} ${list.free[i].width}x${list.free[i].height}`);
	}
});

Download code sample

#!/usr/bin/perl -w

use strict;
use warnings;
use Carp;

use WebService::Browshot;


my $browshot = WebService::Browshot->new(
	key	=> 'my_api_key',
	debug	=> 0, # no more debug information
);

my $instance = $browshot->instance_info(id => 12);

print "Instance #12 costs ", $instance->{screenshot_cost}, " credit(s) per screenshot.\n";
if ($instance->{load} < 1) {
	print "New screenshots requests will be handled immediately.\n";
}
else {
	print "There may be some delay to start processing new screenshot requests.\n";
}

Download code sample

<?php

require 'vendor/autoload.php'; # Composer
# require_once 'Browshot.php'; # or download Browshot.php

$browshot = new Browshot('my_api_key');

$instance = $browshot->instance_info(12);

echo sprintf("Instance #12 costs %d credit(s) per screenshot.\n", $instance->{'screenshot_cost'});
if ($instance->{'load'} < 1) {
	echo "New screenshots requests will be handled immediately.\n";
}
else {
	echo "There may be some delay to start processing new screenshot requests.\n";
}

?>

Download code sample

# -*- coding: utf-8 -*-

from browshot import BrowshotClient

browshot = BrowshotClient('my_api_key')


instance = browshot.instance_info(12)

print "Instance #12 costs %d credit(s) per screenshot." % int(instance['screenshot_cost'])
if instance['load'] < 1:
  print "New screenshots requests will be handled immediately."
else:
  print "There may be some delay to start processing new screenshot requests."

Download code sample

#!/usr/bin/env ruby

require 'browshot'

browshot = Browshot.new('my_api_key')


instance = browshot.instance_info(12)

puts "Instance #12 costs #{instance['screenshot_cost']} credit(s) per screenshot.\n"
if (instance['load'].to_i < 1)
  puts "New screenshots requests will be handled immediately.\n"
else
  puts "There may be some delay to start processing new screenshot requests.\n"
end

Download code sample

var browshot = require('browshot');

var client = new browshot('my_api_key');

client.instanceInfo(12, function(instance) {
	console.log(`Instance #12 costs ${instance.screenshot_cost} credit(s) per screenshot.`);
});

Download code sample

{
  "error": "Instance not found",
  "status": "error"
}

{
  "width":1024,
  "height":768,
  "browser":{
    "id": 3,
    "name":"Firefox",
    "javascript":1,
    "mobile":0
  },
  "type":"public",
  "id":11,
  "load":"0.5",
  "active":1,
  "screenshot_cost":1,
  "country":"Australia"
}

#!/usr/bin/perl -w

use strict;
use warnings;
use Carp;

use WebService::Browshot;


my $browshot = WebService::Browshot->new(
	key	=> 'my_api_key',
	debug	=> 0, # no more debug information
);

my $browsers = $browshot->browser_list();

foreach my $id (keys %{ $browsers }) {
	my $browser = $browsers->{$id};
	print "Browser ", $browser->{name}, ":\n";
	print "\tmobile\n" if ($browser->{mobile} == 1);
	print "\n";
}

Download code sample

<?php

require 'vendor/autoload.php'; # Composer
# require_once 'Browshot.php'; # or download Browshot.php

$browshot = new Browshot('my_api_key');

$browsers = $browshot->browser_list();

foreach ($browsers as $id => $browser) {
	echo "Browser ". $browser->{'name'} . ":\n";
	if ($browser->{'mobile'} == 1) echo "\tmobile\n" ;
	echo "\n";
}

?>

Download code sample

# -*- coding: utf-8 -*-

from browshot import BrowshotClient

browshot = BrowshotClient('my_api_key')


browsers = browshot.browser_list()

for id, browser in browsers.iteritems():
  print "Browser " + browser['name'] + ":"
  if browser['mobile'] == 1:
    print "\tmobile\n"
  print ""

Download code sample

#!/usr/bin/env ruby

require 'browshot'

browshot = Browshot.new('my_api_key')

browsers = browshot.browser_list()

browsers.each { |id, browser|
  puts "Browser #{browser['name']}:\n"
  
  if (browser['mobile'].to_i == 1)
    puts "\tmobile\n"
  end
  
  puts "\n"
}

Download code sample

var browshot = require('browshot');

var client = new browshot('my_api_key');

client.browserList(function(list) {
	for(var id in list) {
		console.log(`Browser ${list[id].name}`);
		if (list[id].mobile == 1)
			console.log("\tmobile");
	}

});

Download code sample

#!/usr/bin/perl -w

use strict;
use warnings;
use Carp;

use WebService::Browshot;


my $browshot = WebService::Browshot->new(
	key	=> 'my_api_key',
	debug	=> 0, # no more debug information
);

my $instance = $browshot->instance_info(id => 12);

# Get details on the browser behind this instance
my $browser = $browshot->browser_info(id => $instance->{browser}->{id});

print "Instance #12 uses the browser ", $browser->{name}, "\n";
print "User Agent string: ", $browser->{user_agent} || 'default', "\n";

Download code sample

<?php

require 'vendor/autoload.php'; # Composer
# require_once 'Browshot.php'; # or download Browshot.php

$browshot = new Browshot('my_api_key');


$instance = $browshot->instance_info(12);

# Get details on the browser behind this instance
$browser = $browshot->browser_info($instance->{'browser'}->{'id'});

echo "Instance #12 uses the browser " . $browser->{'name'} . "\n";
echo "User Agent string: " . $browser->{'user_agent'} || 'default' . "\n";

?>

Download code sample

# -*- coding: utf-8 -*-

from browshot import BrowshotClient

browshot = BrowshotClient('my_api_key')


instance = browshot.instance_info(12)

# Get details on the browser behind this instance
browser = browshot.browser_info(instance['browser']['id'])

print "Instance #12 uses the browser " + browser['name']
print "User Agent string: " + browser['user_agent']

Download code sample

#!/usr/bin/env ruby

require 'browshot'

browshot = Browshot.new('my_api_key')


instance = browshot.instance_info(12)

# Get details on the browser behind this instance
browser = browshot.browser_info(instance['browser']['id'])

puts "Instance #12 uses the browser #{browser['name']}\n"
puts "User Agent string: #{browser['user_agent']}\n"

Download code sample

var browshot = require('browshot');

var client = new browshot('my_api_key');

client.instanceInfo(12, function(instance) {
	// Get details on the browser behind this instance
	var browser_id = instance.browser.id;
	
	client.browserInfo(instance.browser.id, function(browser) {
		console.log(`Instance #12 uses the browser ${browser.name}`);
		console.log(`User Agent string: ${browser.user_agent}`);
	});
});

Download code sample

{
  "error": "Browser not found",
  "status": "error"
}

{
  "name":"Yahoo Slurp",
  "user_agent":"Mozilla/5.0 (compatible; Yahoo! Slurp; http://help.yahoo.com/help/us/ysearch/slurp)",
  "appname":"",
  "vendorsub":"",
  "appcodename":"",
  "platform":"",
  "vendor":"",
  "appversion":"",
  "javascript":0,
  "mobile":0
}