HTML to PNG using NodeJS

The NodeJS library for converting HTML files to PNG images.

Try for FREE

ConvertAPI Node.js library install

ConvertAPI provides a Node.js library that allows you to perform a HTML to PNG conversion with just a few lines of code. First, install our convertapi library from npm:

        NPM package >
    
npm install convertapi --save

Node.js client GitHub

Authenticate your Node.js library

You can obtain your secret key by signing up for a free account. Once you sign up, you'll receive 250 free conversions instantly! Grab your authentication secret from the account dashboard, and authenticate the ConvertAPI Node.js library like this:

// get your secret key here: https://www.convertapi.com/a/auth

var convertapi = require('convertapi')('your-api-secret');

Or using ES modules:

        import ConvertAPI from 'convertapi';
    
const convertapi = new ConvertAPI('your-api-secret');

Convert HTML to PNG using Node.js in no time!

Once you have your authentication in place, simply copy-paste this html to png conversion code snippet into your Node.js project:

// Code snippet is using the ConvertAPI JavaScript Client: https://github.com/ConvertAPI/convertapi-js

// Code snippet is using the ConvertAPI Node.js Client: https://github.com/ConvertAPI/convertapi-nodejs

// Code snippet is using the ConvertAPI PHP Client: https://github.com/ConvertAPI/convertapi-php

// Code snippet is using the ConvertAPI Java Client: https://github.com/ConvertAPI/convertapi-java

// Code snippet is using the ConvertAPI C# Client: https://github.com/ConvertAPI/convertapi-dotnet

# Code snippet is using the ConvertAPI Ruby Client: https://github.com/ConvertAPI/convertapi-ruby

# Code snippet is using the ConvertAPI Python Client: https://github.com/ConvertAPI/convertapi-python

// Code snippet is using the ConvertAPI Go Client: https://github.com/ConvertAPI/convertapi-go

REM Code snippet is using the command line utility program: https://github.com/ConvertAPI/convertapi-cli

Upload the file and see how it works

You can set up the advanced conversion parameters and test the conversion result online using our interactive demo tool. It will auto-generate the code snippet for you!

Advanced HTML to PNG conversion parameters

AuthUsername String

HTTP authentication username. Could be used if conversion web page is protected with HTTP authentication.

AuthPassword String

HTTP authentication password. Could be used if conversion web page is protected with HTTP authentication.

Cookies String

Set additional cookies for the page request. Exaple: cookiename1=cookievalue1; cookiename2=cookievalue2; cookiename3=cookievalue3

ConversionDelay Integer

Delay in seconds before page load and PDF creation. Sometimes useful to let web page fully load.

AdBlock Bool

Block ads in converting page.

CookieConsentBlock Bool

Tries to remove EU regulation required cookie warnings from web pages.

JavaScript Bool

Allow web pages to run JavaScript.

WaitElement String

Element selector string of the DOM element. Converter will wait for this element to appear in DOM before conversion begins.

UserJs String

Execute provided JavaScript before conversion begins.

UserCss String

Apply additional CSS before conversion begins.

HideElements String

Element selector string of the DOM elements that needs to be hidden during conversion.

CssMediaType String

Use CSS media type in conversion process. The default screen and print media types are supported but not limited to these. The custom media type, like convertapi can be used too.

CropElement String

Element selector string of the DOM element that should be converted. Element will be cropped from the document.

Zoom Double

Set the default zoom level of webpages.

TransparentBackground Bool

Sets default background color to transparent to get transparency in the image. Also, for this property to work, the source HTML BODY background color should be set to none.

ImageWidth Integer

Image width in pixels.

ImageHeight Integer

Image height in pixels.

CropX Integer

Screenshot crop X offset.

CropY Integer

Screenshot crop Y offset.

CropWidth Integer

Screenshot crop width.

CropHeight Integer

Screenshot crop height.