WEB to JPG Rest API.

The API for converting Web Pages to JPG files.

Available converters

API Request

Parameter Description Value
Secret

Optional

String

Authentication secret must be provided as a query parameter. If omitted, token must be provided.

Secret
Token

Optional

String

Authentication token must be provided as a query parameter. If omitted, secret must be provided.

Token
Parameter Description Value
FileName

Optional

String

File name (without extension) of the converted file.

FileName
Url

Required

String

URI of a web page to convert. Must start with http:// or https://. If URI has special characters like ? or & they must be encoded.

Url
Parameter Description Value
Timeout

Optional

Integer

Conversion timeout in seconds.

Default: 300

Values: 10 .. 1200

Timeout
StoreFile

Optional

Bool

Store converted file on server.

Default: False

StoreFile
ConversionDelay

Optional

Integer

Delay in seconds before page load and PDF creation. Sometimes usefull to let web page to load in full.

Default: 0

Values: 0 .. 30

ConversionDelay
Parameter Description Value
AuthUsername

Optional

String

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

AuthUsername
AuthPassword

Optional

String

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

AuthPassword
Parameter Description Value
AdBlock

Optional

Bool

Block ads in converting page.

Default: False

AdBlock
Zoom

Optional

Float

Set the default zoom level of webpages.

Default: 1

Values: 0.001 .. 10.0

Zoom
Parameter Description Value
ImageWidth

Optional

Integer

Image width in pixels.

Default: 1280

Values: 1 .. 16384

ImageWidth
ImageHeight

Optional

Integer

Image height in pixels.

Values: 1 .. 16384

ImageHeight
CropX

Optional

Integer

Screenshot crop X offset.

Default: 0

Values: 0 .. 16384

CropX
CropY

Optional

Integer

Screenshot crop Y offset.

Default: 0

Values: 0 .. 16384

CropY
CropWidth

Optional

Integer

Screenshot crop width.

Values: 1 .. 16384

CropWidth
CropHeight

Optional

Integer

Screenshot crop height.

Values: 1 .. 16384

CropHeight
Parameter Description Value
JpgQuality

Optional

Integer

Set JPG quality.

Default: 75

Values: 1 .. 100

JpgQuality

Snippets are autogenerated according to converter parameter choices above. Please select file in "File" or "Files" parameter before using code snippets.