Docs

How to make screenshots in Ruby

Taking a screenshot of your website is very straightforward using ScrapingBee. You can either take a screenshot of the visible portion of the page, the whole page, or an element of the page.

That can be done by specifying one of these parameters with your request:

  • screenshot to true or false.
  • screenshot_full_page to true or false.
  • screenshot_selector to the CSS selector of the element.

In this tutorial, we will see how to take a screenshot of ScrapingBee’s  blog  using the three methods.
 

1. Using screenshot parameter:

The code below will take a screenshot of the blog home page:


require 'net/http'
require 'net/https'
require 'addressable/uri'

# Classic (GET)
def take_screenshot(user_url, file_path)
    uri = Addressable::URI.parse("https://app.scrapingbee.com/api/v1/")
    api_key = "YOUR-API-KEY"
    uri.query_values = {
      'api_key'  => api_key,
      'url' => user_url,
      'screenshot' => true # Take a screenshot of the page
    }
    uri = URI(uri)

    # Create client
    http = Net::HTTP.new(uri.host, uri.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_PEER

    # Create Request
    req =  Net::HTTP::Get.new(uri)

    # Fetch Request
    res = http.request(req)

    # Print response body
    File.open(file_path, 'w') { |file| file.write(res.body) }
rescue StandardError => e
    puts "HTTP Request failed (#{ e.message })"
end

take_screenshot("https://scrapingbee.com/blog", "screenshot.png")

As you’ll see below, the screenshot only covered the visible part of the scraper [1920x1080]. It didn’t cover the blog posts, or the footer.

So what affects the size of the image, and the visible parts of the page? The answer is the scraper’s default viewport. Its default width and height are 1920px and 1080px respectively. And to change them we’ll have to make the request with two additional parameters: window_width and window_height.

require 'net/http'
require 'net/https'
require 'addressable/uri'

# Classic (GET)
def take_screenshot(user_url, file_path)
    uri = Addressable::URI.parse("https://app.scrapingbee.com/api/v1/")
    api_key = "YOUR-API-KEY"
    uri.query_values = {
      'api_key'  => api_key,
      'url' => user_url,
      'screenshot' => true, # Take a screenshot of the page
      'window_width' => '1280', # Set viewport width to 1280 pixels
      'window_height' => '720' # Set viewport height to 1280 pixels
    }
    uri = URI(uri)

    # Create client
    http = Net::HTTP.new(uri.host, uri.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_PEER

    # Create Request
    req =  Net::HTTP::Get.new(uri)

    # Fetch Request
    res = http.request(req)

    # Print response body
    File.open(file_path, 'w') { |file| file.write(res.body) }
rescue StandardError => e
    puts "HTTP Request failed (#{ e.message })"
end

take_screenshot("https://scrapingbee.com/blog", "screenshot.png")

And as you will see, the image below is 1280x720 pixels.

2. Using screenshot_full_page parameter:

This parameter makes the request take a screenshot of the full page. Here’s how to use it:

require 'net/http'
require 'net/https'
require 'addressable/uri'

# Classic (GET)
def take_screenshot(user_url, file_path)
    uri = Addressable::URI.parse("https://app.scrapingbee.com/api/v1/")
    api_key = "YOUR-API-KEY"
    uri.query_values = {
      'api_key'  => api_key,
      'url' => user_url,
      'screenshot_full_page' => true, # Take a screenshot of the whole page
    }
    uri = URI(uri)

    # Create client
    http = Net::HTTP.new(uri.host, uri.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_PEER

    # Create Request
    req =  Net::HTTP::Get.new(uri)

    # Fetch Request
    res = http.request(req)

    # Print response body
    File.open(file_path, 'w') { |file| file.write(res.body) }
rescue StandardError => e
    puts "HTTP Request failed (#{ e.message })"
end

take_screenshot("https://scrapingbee.com/blog", "screenshot.png")

And the results as you’ll see, is a screenshot of the whole page.  Large screenshot, click here to see it .

3. Using screenshot_selector parameter:

This parameter will take a screenshot of any HTML element on the page. All you have to do, is to specify the CSS selector of that element.

Let’s say that we wanted to take a screenshot of the footer section on this page. We will simply make our request with this additional parameter: screenshot_selector="footer".

So the code will look like this:

require 'net/http'
require 'net/https'
require 'addressable/uri'

# Classic (GET)
def take_screenshot(user_url, file_path)
    uri = Addressable::URI.parse("https://app.scrapingbee.com/api/v1/")
    api_key = "YOUR-API-KEY"
    uri.query_values = {
      'api_key'  => api_key,
      'url' => user_url,
      'screenshot_selector' => 'footer', # Take a screenshot of the footer element
    }
    uri = URI(uri)

    # Create client
    http = Net::HTTP.new(uri.host, uri.port)
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_PEER

    # Create Request
    req =  Net::HTTP::Get.new(uri)

    # Fetch Request
    res = http.request(req)

    # Print response body
    File.open(file_path, 'w') { |file| file.write(res.body) }
rescue StandardError => e
    puts "HTTP Request failed (#{ e.message })"
end

take_screenshot("https://scrapingbee.com/blog", "screenshot.png")

And the result is a screenshot of the footer as you can see: 

 

Go back to tutorials