This page describes how to use the Pdfcrowd online API to convert web pages and HTML to images from the command line. Refer to HTML to Image API for general information about the converter.
pip install pdfcrowd
Check out other installation options.
Here are Command Line examples for quickly getting started with the API. See more examples.
The credentials to access the API are your Pdfcrowd username and the API key. You can try out the API without registering using the following demo credentials:
demo
ce544b6ea52a5621fb9d55f8b542d14d
To get your personal API credentials, you can start a free API trial or buy the API license.
To get a quick idea of what the API output will look like, enter a web page or upload an HTML file using the form below. It will generate several API output previews with different conversion settings. You can then choose the one that looks best, and simply copy and paste the auto-generated command line options.
The API enables conversion of a web page, a local HTML file, or a string containing HTML. Conversion output can be saved to to a local file, a stream object or a variable. See the conversion input section of the documentation for more details.
The table below lists the most common customizations. You can also interactively explore the API in the API Playground.
Image size | Set image dimensions with -screenshot_width and -screenshot_height. |
Image format | Specify a different output image format with -output_format. |
Hide or remove elements |
You can use the following classes in your HTML
code to hide or remove elements from the output:
|
Use @media print | You can switch to the print version of the page (if it exists) with -use_print_media. |
Run custom JavaScript | You can use -on_load_javascript or -custom_javascript to alter the HTML contents with a custom JavaScript. In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library . |
Custom CSS styling |
You can alter CSS styling used during conversion
with a custom JavaScript or using the
pdfcrowd-body
CSS class, which is automatically set on the HTML
<body> element. You can, for example, set
the H1 height to 48px by adding the following line
to your CSS:
.pdfcrowd-body h1 { font-size: 48px; }
|
HTML Templates | Add data to your HTML template and convert it to an image. Learn more in HTML Template to Image. |
-debug-log
to get detailed info about the conversion, such as
load errors, load times, browser console output, etc.
-custom-javascript
with libPdfcrowd.highlightHtmlElements
method call to visualize all HTML elements. See the
backgrounds example
,
borders example
and helper
JavaScript library
documentation.
Refer to the HTML to Image Command Line Reference Manual for a description of all command line options.