TOOLS
Capture Website Screenshot API
Render any public web page in headless Chromium and return a PNG or JPEG screenshot as base64 — viewport or full page, with a configurable viewport size, wait strategy and settle delay.
Part of: Screenshot API
How to call it
Send one POST to api.upapi.io/screenshot.post with your key in the X-Api-Key header and the parameters below as a JSON body. Each call spends 20 weighted units of your monthly quota. The operation times out after 25 seconds. Identical requests are served from cache for 60 seconds, unbilled.
POST https://api.upapi.io/screenshot.post
Capture Website Screenshot API reference
Request parameters
- url
- stringrequired — Absolute http(s) URL of the page to capture (e.g. https://example.com). URLs resolving to private, loopback, link-local or cloud-metadata addresses are rejected.
- width
- integer — Viewport width in CSS pixels (e.g. 1280).
- format
- enum — Image encoding: 'png' is lossless and sharper for text; 'jpeg' is far smaller and accepts
quality(e.g. png). - height
- integer — Viewport height in CSS pixels. Still sets the layout viewport when fullPage is true, but the image then grows to the document height (e.g. 800).
- delayMs
- integer — Extra settle time after navigation before the shot, in milliseconds — for animations or late hydration (e.g. 500).
- quality
- integer — JPEG encoder quality, 1-100 (default 80). Rejected when format is png, which is lossless (e.g. 80).
- blockAds
- boolean — Abort requests to known ad and tracker hosts before they load, so they cannot appear in the image (e.g. true).
- fullPage
- boolean — Capture the entire scrollable document instead of just the viewport (e.g. false).
- waitUntil
- enum — When navigation counts as done: 'domcontentloaded' is fastest, 'load' waits for subresources, 'networkidle' waits for the network to go quiet and suits lazy-rendered apps (e.g. load).
Response fields
- bytes
- integerrequired — Size of the DECODED image in bytes (the base64 string is ~4/3 of this).
- image
- stringrequired — Base64-encoded image bytes. No
data:URI prefix — decode directly. - width
- integerrequired — Image width in pixels.
- format
- enumrequired — Encoding of the returned image.
- height
- integerrequired — Image height in pixels — the full document height when fullPage was true.
- finalUrl
- stringrequired — URL of the page actually captured, after any redirects.
Example request and response
The example response is generated from this operation’s published output schema — it shows the shape and field names, not values from a recorded call.
{
"url": "https://example.com",
"width": 1280,
"format": "png",
"height": 800,
"delayMs": 0,
"blockAds": false,
"fullPage": false,
"waitUntil": "load"
}{
"bytes": 1,
"image": "example",
"width": 1,
"format": "png",
"height": 1,
"finalUrl": "example"
}Code snippets
cURL
curl -X POST https://api.upapi.io/screenshot.post \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY' \
-d '{ "url": "https://example.com", "width": 1280, "format": "png", "height": 800, "delayMs": 0, "blockAds": false, "fullPage": false, "waitUntil": "load" }'JavaScript
const response = await fetch('https://api.upapi.io/screenshot.post', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'x-api-key': 'YOUR_API_KEY',
},
body: JSON.stringify({
"url": "https://example.com",
"width": 1280,
"format": "png",
"height": 800,
"delayMs": 0,
"blockAds": false,
"fullPage": false,
"waitUntil": "load"
}),
});
const data = await response.json();
console.log(data);Python
import requests
response = requests.post(
'https://api.upapi.io/screenshot.post',
headers={
'Content-Type': 'application/json',
'x-api-key': 'YOUR_API_KEY',
},
json={
"url": "https://example.com",
"width": 1280,
"format": "png",
"height": 800,
"delayMs": 0,
"blockAds": False,
"fullPage": False,
"waitUntil": "load"
},
)
print(response.json())Go
package main
import (
"bytes"
"encoding/json"
"fmt"
"io"
"net/http"
)
func main() {
payload := []byte(`{ "url": "https://example.com", "width": 1280, "format": "png", "height": 800, "delayMs": 0, "blockAds": false, "fullPage": false, "waitUntil": "load" }`)
req, _ := http.NewRequest("POST", "https://api.upapi.io/screenshot.post", bytes.NewBuffer(payload))
req.Header.Set("Content-Type", "application/json")
req.Header.Set("x-api-key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
var result map[string]any
json.Unmarshal(body, &result)
fmt.Println(result)
}PHP
<?php
$payload = json_encode([
'url' => 'https://example.com',
'width' => 1280,
'format' => 'png',
'height' => 800,
'delayMs' => 0,
'blockAds' => false,
'fullPage' => false,
'waitUntil' => 'load',
]);
$ch = curl_init('https://api.upapi.io/screenshot.post');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $payload,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
'x-api-key: YOUR_API_KEY',
],
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
var_dump($data);Ruby
require 'net/http'
require 'uri'
require 'json'
uri = URI('https://api.upapi.io/screenshot.post')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'
request = Net::HTTP::Post.new(uri.path)
request['Content-Type'] = 'application/json'
request['x-api-key'] = 'YOUR_API_KEY'
request.body = { "url": "https://example.com", "width": 1280, "format": "png", "height": 800, "delayMs": 0, "blockAds": false, "fullPage": false, "waitUntil": "load" }.to_json
response = http.request(request)
puts JSON.parse(response.body)Java
import okhttp3.*;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.util.Map;
OkHttpClient client = new OkHttpClient();
ObjectMapper mapper = new ObjectMapper();
String json = "{ \"url\": \"https://example.com\", \"width\": 1280, \"format\": \"png\", \"height\": 800, \"delayMs\": 0, \"blockAds\": false, \"fullPage\": false, \"waitUntil\": \"load\" }";
RequestBody body = RequestBody.create(json, MediaType.get("application/json"));
Request request = new Request.Builder()
.url("https://api.upapi.io/screenshot.post")
.post(body)
.addHeader("Content-Type", "application/json")
.addHeader("x-api-key", "YOUR_API_KEY")
.build();
try (Response response = client.newCall(request).execute()) {
Map<?, ?> result = mapper.readValue(response.body().string(), Map.class);
System.out.println(result);
}C#
using System.Net.Http;
using System.Net.Http.Json;
using System.Text.Json;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");
var payload = JsonSerializer.Deserialize<object>("{ \"url\": \"https://example.com\", \"width\": 1280, \"format\": \"png\", \"height\": 800, \"delayMs\": 0, \"blockAds\": false, \"fullPage\": false, \"waitUntil\": \"load\" }");
var response = await client.PostAsJsonAsync("https://api.upapi.io/screenshot.post", payload);
var result = await response.Content.ReadFromJsonAsync<JsonElement>();
Console.WriteLine(result);Frequently asked questions
How much does the Capture Website Screenshot API cost per call?
Each call spends 20 weighted units of your plan's monthly quota. Full pricing is at https://upapi.io/pricing.
How do I authenticate to the Capture Website Screenshot API?
Send your key in the X-Api-Key header. A free guest key is available without creating an account.
Are Capture Website Screenshot API responses cached?
Yes — identical requests are served from cache for 60 seconds, and a cache hit is not billed.