Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.

Web to PDF

Generate PDF Documents from Webpages.



Input Parameter Descriptions

Index Name Example Description
0 content string The HTML content. This can be either a URL to load HTML from or an actual HTML content string
1 margin integer The PDF document margin (in mm)
2 html_width integer The width (in px) to render the HTML document at
3 title string The PDF document title

Making a Request

>> require 'web_to_pdf'
=> true

# Note: the 'Controller' here is not a reference to Rails controllers
# but an internal structure, won't interfere with your Rails app and will 
# work fine in a standalone ruby app or another framework

>> wtp =

>> data = wtp.lookup("", "10", "1024", "Wikipedia")

# Writes the PDF file to the local directory
>>"news-yc.pdf","w"){|f| f.write(data)}


# In your Gemfile
gem 'webtopdf', git: ''

Live Interactive Testing

Doublecheck results, use a Live Proxy and check your API Key with the interactive documentation at:

You will need your WEBTOPDF_API_KEY from the setup screen where you've provisioned the Web to PDF add-on.


As a sanity check it is sometimes useful to bypass your app stack and check the endpoint, your API Key and parameters directly.

Test with your browser

# Modify the following to use your actual API Key

A successful call will return your requested data with a HTTP result code of 200 and be in JSON format. We recommend the JSON Formatter extension as a useful tool.

In Development

The Web to PDF gem relies upon the environment variable ENV['WEBTOPDF_API_KEY'] being present and correctly configured to authenticate to the service. You will need to have this variable present in your local environment for the gem to work correctly.

If you're using Heroku, please read their Guide to Heroku Local which has instructions on easily copying your config values to your development environment.


If you're trying to use Web to PDF in your local development or test environment with the dotenv gem be sure that you are loading the dotenv-rails gem with the rails-now requirement.

# Example Gemfile excerpt

gem 'dotenv-rails', :require => 'dotenv/rails-now'
gem 'iptoearth'


If you're having issues with configuring dotenv, you might want to try foreman which will also autoload .env files in your local environment.

Test in the Rails console

Launch rails c in your development project directory and at the prompt enter ENV[WEBTOPDF_API_KEY] which, if you've configured your development environment correctly should display your API Key.

Issues and Security Concerns

Please email


The Web to PDF gem is licensed under the MIT license.

Additional Add-ons

If you found Web to PDF useful, please check out our other similarly structured services and gems.

<td align='center' width='33%'>
   <img src="" width="70"/>
  <h5><a href='//'>WEIGHTS & MEASURES</a></h5>
  <p>Conversational interface to convert between units of measure.</p>

<td align='center' width='33%'>
   <img src="" width="70"/>
  <h5><a href='//'>SCRAPETASTIC</a></h5>
  <p>Pull structured data from any website.</p>
<td align='center' width='33%'>
   <img src="" width="70"/>
  <h5><a href='//'>IP INVESTIGATOR</a></h5>
  <p>Check if an IP address is hosting Proxies, Bots or Malware.</p>

<td align='center' width='33%'>
   <img src="" width="70"/>
  <h5><a href='//'>RESIZER</a></h5>
  <p>Resize images for Retina use, thumbnails and social promotion.</p>
<td align='center' width='33%'>
   <img src="" width="70"/>
  <h5><a href='//'>WEB TO PDF</a></h5>
  <p>Generate PDF Documents from Webpages.</p>

<td align='center' width='33%'>
   <img src="" width="70"/>
  <h5><a href='//'>WATERMARKER</a></h5>
  <p>Identify and protect images by adding a watermark to them.</p>
<td align='center' width='33%'>
   <img src="" width="70"/>
  <h5><a href='//'>GEOCODY</a></h5>
  <p>Convert mailing addresses into Lat,Long Coordinates.</p>

<td align='center' width='33%' cellpadding='10'>
   <img src="" width="70"/>
  <h5><a href='//'>REAL EMAIL</a></h5>
  <p>Reduce bounced emails and errors by validating emails against MX records.</p>

Generate QR codes for use anywhere.


Boost User Agent identification with our always up to date UA parsing.


Pull website status and domain information for any URL.


Find the Country and City of origin for an IP Address.

You can’t perform that action at this time.