API Documents - GuGuData | Production-Ready APIs Built for Developers
  1. Website Tools
API Documents - GuGuData | Production-Ready APIs Built for Developers
  • GuGuData API documents
  • Metadata
    • DEMO
      • [DEMO] Global QS World University Rankings
      • [DEMO] Global University
      • [DEMO] Chinese Poem
    • Global QS World University Rankings
      GET
    • Global University
      GET
    • Chinese Poem
      GET
  • Website Tools
    • DEMO
      • [DEMO] Webpage Readable Content Extraction
      • [DEMO] Domain SSL Certificate Information Parsing
      • [DEMO] Domain DNS Information Query
      • [DEMO] Query Website Favicon and Title
      • [DEMO] Format International Phone
      • [DEMO] URL to static HTML
      • [DEMO] URL to Image
      • [DEMO] URL to Markdown
      • [DEMO] Get URL links
      • [DEMO] Website Snapshot
      • [DEMO] Domain Whois
      • [DEMO] IP Address
      • [DEMO] Article Extract
      • [DEMO] Geographic Coordinate System Converter
      • [DEMO] Extract Structured JSON from Webpage
    • Webpage Readable Content Extraction
      POST
    • Domain SSL Certificate Information Parsing
      GET
    • Domain DNS Information Query
      GET
    • Query Website Favicon and Title
      GET
    • Format International Phone
      GET
    • URL to static HTML
      POST
    • URL to Image
      GET
    • URL to Markdown
      POST
    • Get URL links
      GET
    • Website Snapshot
      POST
    • Domain Whois
      GET
    • IP Address
      GET
    • Article Extract
      POST
    • Geographic Coordinate System Converter
      GET
    • Extract Structured JSON from Webpage
      POST
  • Image Recognition
    • DEMO
      • [DEMO] HTML to PDF
      • [DEMO] Image OCR
      • [DEMO] PDF to Format
      • [DEMO] PDF Splitting
      • [DEMO] Markdown to PDF
      • [DEMO] PPT to Images
      • [DEMO] PDF to HTML
      • [DEMO] PDF Summary
      • [DEMO] Image Compress
      • [DEMO] Word to HTML
    • HTML to PDF
      POST
    • Image OCR
      POST
    • PDF to Format
      POST
    • PDF Splitting
      POST
    • Markdown to PDF
      POST
    • PPT to Images
      POST
    • PDF to HTML
      POST
    • PDF Summary
      POST
    • Image Compress
      POST
    • Word to HTML
      POST
  • QRcode and Barcode
    • DEMO
      • [DEMO] QR Code
      • [DEMO] Wifi QR Code
      • [DEMO] Bar Code
    • QR Code
    • Wifi QR Code
    • Bar Code
  • Text Tools
    • DEMO
      • [DEMO] Simplified and Traditional Chinese Converter
      • [DEMO] Text Similarity Calculator
    • Simplified and Traditional Chinese Converter
    • Text Similarity Calculator
  • healthcheck
    GET
  1. Website Tools

Website Snapshot

POST
https://api.gugudata.io/v1/websitetools/url2snapshot
Last modified:2026-02-11 09:08:02
Convert URL to Snapshot
Capture high-quality webpage screenshots with optional CDN hosting via Cloudflare R2
Method: POST
Path: /v1/websitetools/url2snapshot?appkey={{appkey}}
Demo: https://api.gugudata.io/v1/websitetools/url2snapshot/demo
Request Parameters:
appkey (string, required): Obtained after payment
url (string, required): The webpage URL to capture
responseFormat (string, optional): Return format: base64 (default) or url for CDN image link
fullPage (boolean, optional): Whether to capture the entire page
width (integer, optional): Viewport width in pixels
height (integer, optional): Viewport height in pixels
deviceScaleFactor (integer, optional): Device scale factor for HiDPI rendering (1-4)
userAgent (string, optional): Custom user agent string for rendering
isMobile (boolean, optional): Whether to emulate a mobile device
Response Fields Count: 10
Response Field Examples:
dataStatus: Response status information
dataStatus.statusCode: HTTP status code
dataStatus.status: Response status
dataStatus.statusDescription: Status description
dataStatus.responseDateTime: Response timestamp
dataStatus.dataTotalCount: Data count
dataStatus.requestParameter: Logged request parameters
data: Snapshot result data
... total 10 fields
Key Features:
Capture full-page or viewport screenshots from any public URL
Optional CDN hosting on Cloudflare R2 with secure HTTPS URLs
Customizable viewport size, scale factor, and user agent
Supports desktop and mobile rendering modes
Best-effort capture using Cloudflare browser rendering
Details:
https://gugudata.io/details/url2snapshot

Request

Query Params

Header Params

Body Params application/json

Example
{
    "url": "https://www.gugudata.io",
    "responseFormat": "url",
    "fullPage": true,
    "width": 1920,
    "height": 1080,
    "deviceScaleFactor": 1,
    "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36",
    "isMobile": false
  }

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://api.gugudata.io/v1/websitetools/url2snapshot?appkey=sk-******' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "https://www.gugudata.io",
    "responseFormat": "url",
    "fullPage": true,
    "width": 1920,
    "height": 1080,
    "deviceScaleFactor": 1,
    "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36",
    "isMobile": false
  }'

Responses

⚪0
application/json
Body

Example
{
  "dataStatus": {
    "statusCode": 0,
    "status": "string",
    "statusDescription": "string",
    "responseDateTime": "string",
    "dataTotalCount": 0,
    "requestParameter": "string"
  },
  "data": {
    "image": "string",
    "content": "string"
  },
  "DataStatus": {
    "StatusCode": 100,
    "StatusDescription": "OK",
    "ResponseDateTime": "2026-01-01 00:00:00",
    "DataTotalCount": 1
  }
}
Modified at 2026-02-11 09:08:02
Previous
Get URL links
Next
Domain Whois
Built with