URL to Image

Convert Webpage to Image
Convert any webpage to high-quality image with customizable options

Method: GET
Path: /v1/websitetools/url2image
Demo: https://api.gugudata.io/v1/websitetools/url2image/demo

Request Parameters:

appkey (string, required): Obtained after payment

url (string, required): The URL of the webpage to capture

isFullPage (boolean, optional): Whether to capture the full page (true) or just viewport (false)

width (integer, optional): Image width in pixels

height (integer, optional): Image height in pixels

viewportWidth (integer, optional): Viewport width in pixels for rendering

viewportHeight (integer, optional): Viewport height in pixels for rendering

forceReload (boolean, optional): Whether to force reload the page ignoring cache

isMobile (boolean, optional): Whether to simulate mobile device

isDarkMode (boolean, optional): Whether to enable dark mode

deviceScaleFactor (integer, optional): Device scale factor for high-DPI displays (1-4)

Response Fields Count: 1
Response Field Examples:

image: PNG image file stream of the captured webpage

Key Features:

Support capturing screenshots from any publicly accessible webpage

Flexible image dimensions with customizable width and height

Full page capture or viewport-only screenshot options

Mobile device simulation for responsive design testing

Dark mode support for modern websites

Details:
https://gugudata.io/details/url2image

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Body

Example

{
  "image": null,
  "DataStatus": {
    "StatusCode": 100,
    "StatusDescription": "OK",
    "ResponseDateTime": "2026-01-01 00:00:00",
    "DataTotalCount": 1
  }
}

Request

Request Code Samples

Responses