Webpage Screenshot Capture API Documentation

Webpage Screenshot Capture API: Technical Guide and Integration Notes

The Webpage Screenshot Capture API from GuGuData helps developers capture a screenshot of a target webpage and return the generated image resource.

This article is written for developers who want a crawlable, readable reference before integrating the endpoint into a product, data pipeline, internal tool, or technical workflow. The official detail page is https://gugudata.io/details/url2snapshot.

API details

Item	Value
API name	Webpage Screenshot Capture
Category	Website Tools APIs
Method	POST
Endpoint	https://api.gugudata.io/v1/websitetools/url2snapshot
Content type	application/json
Demo endpoint	https://api.gugudata.io/v1/websitetools/url2snapshot/demo
Detail page	https://gugudata.io/details/url2snapshot
OpenAPI JSON	https://gugudata.io/assets/openapi/gugudata.openapi.3.1.json

When to use this API

• Create screenshot records of public pages.
• Archive page appearance during content review.
• Generate screenshot assets for technical reports.

Request parameters

This endpoint accepts parameters through the query string plus request body. Keep appkey out of client-side public code and send it only from trusted server-side environments.

Parameter	Type	Required	Default	Description
appkey	string	Yes	YOUR_APPKEY	Application key used for request authentication. Supply the value as a query parameter, form field, or multipart field according to the request content type.
url	string	Yes	-	Target webpage URL.
responseFormat	string	No	base64	Requested output format for the generated response.
fullPage	boolean	No	true	Whether the capture should include the full page height instead of the visible viewport only.
width	integer	No	1920	Output width in pixels.
height	integer	No	1080	Output height in pixels.
deviceScaleFactor	integer	No	1	Device scale factor used during page rendering.
userAgent	string	No	Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36	Optional user agent string used for page rendering.
isMobile	boolean	No	false	Whether the renderer should emulate a mobile device viewport.

Example request

curl -X POST "https://api.gugudata.io/v1/websitetools/url2snapshot?appkey=YOUR_APPKEY" \
  -H "Content-Type: application/json" \
  -d '
{
  "url": "https://example.com/article",
  "responseFormat": "base64",
  "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
}
'

Response fields

The response body contains the fields below for successful JSON responses. For binary endpoints, the success response is returned as binary content and JSON is used for error responses.

Field	Type	Required	Description
dataStatus	object	Yes	Response metadata returned by the API response.
dataStatus.requestParameter	string	Yes	Normalized request parameters echoed by the service. Sensitive credentials are omitted when available.
dataStatus.statusCode	integer	Yes	Application-level status code returned by the API response. Successful demo responses currently return 200.
dataStatus.status	string	Yes	Application-level status enum. Successful demo responses currently return SUCCESS.
dataStatus.statusDescription	string	Yes	Application-level status message returned by the API response.
dataStatus.responseDateTime	string	Yes	Response timestamp returned by the API response.
dataStatus.dataTotalCount	integer	Yes	Total number of records that match the request.
data	object	Yes	Primary response payload returned by the endpoint.
data.image	string	Yes	Base64 string or CDN URL of the screenshot
data.content	string	Yes	HTML content returned by Cloudflare snapshot

Response example

{
  "dataStatus": {
    "statusCode": 200,
    "statusDescription": "successfully",
    "responseDateTime": "2026-04-10T00:00:00Z",
    "dataTotalCount": 1,
    "status": "SUCCESS",
    "requestParameter": ""
  },
  "data": {
    "image": "sample value",
    "content": "sample value"
  }
}

HTTP status codes

Use the HTTP status code for transport-level handling. If the response body contains dataStatus.statusCode, treat it as an application-level status field in the JSON payload.

HTTP status	Meaning	Recommended handling
200	Request processed successfully.	Parse the documented response body for the endpoint result.
400	Invalid request parameters or request format.	Check required fields, data types, and request body format.
401	Missing or unknown application key.	Send a valid appkey with the request.
403	The application key is recognized but access is not allowed.	Check subscription, trial state, and endpoint access.
429	Request rate or trial usage limit exceeded.	Reduce concurrency or retry after the limit window resets.
500	Internal service error.	Retry later or contact support if the error persists.
503	Upstream service unavailable.	Retry later when the dependency is available again.

Implementation notes

• Validate required parameters before sending the request so 400 responses are easier to diagnose.
• Keep server-side retries conservative for 429, 500, and 503 responses.
• Cache stable metadata responses when your use case allows it, especially for lookup and directory endpoints.
• Log the HTTP status code and dataStatus.statusDescription together for easier debugging.
• Use the demo endpoint for a quick connectivity check, then switch to the authenticated endpoint for production data.

FAQ

Where is the official API detail page?

The official detail page is https://gugudata.io/details/url2snapshot. It is the best place to review the latest public endpoint information before publishing or integrating.

Should I handle dataStatus.statusCode as the HTTP status code?

No. Use the HTTP status code for request-level behavior such as authentication, permission, rate limiting, and server errors. Use dataStatus.statusCode only as the response body status field when it is present.

Can I use the demo endpoint in production?

No. The demo endpoint is for quick testing and examples. Use the authenticated endpoint with your appkey for production workflows.

Related GuGuData APIs

• Webpage Readable Content Extraction
• Domain SSL Certificate Information Parsing
• Domain DNS Information Query

For more developer APIs, visit GuGuData.