Website Screenshot API POST

Web Screenshots is a simple tool for capturing screenshots of web pages. It returns an image screenshot of the web page provided.

Try it — live request, no key required

Request

POSTapi.apiverve.com/v1/webscreenshots

Verification

Format

No key required to try it. Get a key to use it in your app.

200 OK

{
  "status": "ok",
  "error": null,
  "data": {
    // Website Screenshot response payload
  }
}

About the Website Screenshot API

Web Screenshots works by using a headless browser to load the web page and capture a screenshot of the entire page or a specific element. It returns the screenshot as an image. This runs entirely in the cloud, so you don't need to worry about setting up a browser or infrastructure.

What people use it for

Web Design: Use the Web Screenshots API to capture screenshots of web pages for web design. Use the data to create mockups, showcase designs, and improve user experience
SEO Optimization: Capture webpage screenshots by using the Web Screenshots API for SEO optimization. Use the data to analyze layouts, optimize content, and enhance search rankings
Content Creation: Use the Web Screenshots API to capture screenshots of web pages for content creation. Use the data to create visuals, generate images, and enhance storytelling
Monitoring & Analysis: Capture webpage screenshots by using the Web Screenshots API for monitoring and analysis. Use the data to track changes, analyze trends, and make informed decisions

Ways to call it

One endpoint, many ways in — REST with JSON, XML, YAML and CSV, plus GraphQL and an MCP interface for AI agents.

JSON: Default REST response
XML: Markup format
YAML: Human-readable
CSV: Tabular export
GraphQL: Query language
MCP: For AI agents

View all integrations →

Other ways to use Website Screenshot

Same data, same APIVerve account, same credit balance — one key works on all of them.

Give it to an AI agentConnect over MCP and your agent calls it as a native tool — Claude, Cursor, ChatGPT.on VerveKit

Questions.

Common questions about the Website Screenshot API.

Read the docs →

What does the Website Screenshot API do?

Web Screenshots is a simple tool for capturing screenshots of web pages. It returns an image screenshot of the web page provided.

How do I authenticate Website Screenshot API requests?

Pass your API key in the x-api-key header over HTTPS. One key works across all 300+ APIVerve APIs — there are no per-endpoint credentials.

How much does the Website Screenshot API cost?

Each call spends 40 credits from your shared pool. The free tier includes 200 credits every month, and paid plans add more headroom.

How fast is the Website Screenshot API?

Response time depends on the endpoint — the p50 through p99 latency for this API is published on this page. Requests are served over HTTPS through a global edge network.

What response formats does the Website Screenshot API support?

JSON by default, plus XML and YAML via the format parameter. GraphQL and an MCP interface for AI agents are available across the catalog.

What HTTP method does the Website Screenshot API use?

POST over HTTPS, following standard REST conventions with a consistent { status, error, data } response envelope.

Request parameters — POST /v1/webscreenshots

Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them. Anything not listed here is dropped rather than passed through.

Required

Parameter	Type	Example	Description
`url`Required	string	`https://www.github.com`	The URL of the web page to capture the screenshot (e.g., https://example.com) url

Optional

Parameter	Type	Example	Description
`type`Optional	string	`png`	The image format for the screenshot `pngjpegwebp` default png
`width`Optional	number	`1920`	The width of the screenshot in pixels (e.g., 1920). Must be between 100 and 3840 default 1920 · range 100-3840
`height`Optional	number	`1080`	The height of the screenshot in pixels (e.g., 1080). Must be between 100 and 3840 default 1080 · range 100-3840
`fullpage`OptionalPremium	boolean	`false`	Whether to capture the full page screenshot (true or false) default false

Example request

curl -X POST "https://api.apiverve.com/v1/webscreenshots" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://ebay.com/","type":"png","width":1024,"height":600,"fullpage":false}'

Authentication

Send your key in the x-api-key header. That is the only auth step — no token exchange, and no per-endpoint scope to configure.

Header	When	Value
`x-api-key`Required	Every request	Your API key. Header names are case-insensitive, so `X-API-Key` is the same header.
`Authorization`Alternate	Instead of the above	`Bearer <key>` — for clients that only expose bearer auth. Resolves to the same account and the same billing.
`content-type`Required	POST body	`application/json`

401 is the only auth verdict

A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.

Response — POST /v1/webscreenshots

Every APIVerve endpoint returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape.

Sample response

{
  "status": "ok",
  "error": null,
  "data": {
    "width": 1024,
    "height": 600,
    "scaleFactor": 1,
    "imageName": "77072426-6af8-45c2-93dd-d7013d2c765e.png",
    "expires": 1766097105719,
    "url": "https://ebay.com/",
    "downloadURL": "https://storage.googleapis.com/apiverve-helpers.appspot.com/webscreenshots/77072426-6af8-45c2-93dd-d7013d2c765e.png?GoogleAccessId=1089020767582-compute%40developer.gserviceaccount.com&Expires=1766097105&Signature=uZKa777XpeVnlwOZG7Uhjs%2BNkPzkEuiV4Wug2%2B%2BAHcPovRZ3iVjZEX%2FZhp7gnADXI6au5q0ggPwweoOFJeMCdk9zod6aZo4hlUDe1DsJf0oao4rh3tGUl5wPeudXLp7Y%2F3zVflup9Mp255LY6%2B2JdU0auOHdPnEYLDCvf705X9C%2BflmWQZKh7QKi74gvU8pqsP6Zc7SfJJsv5kmhP8SkO7TBZKBU6pAr2mNHKpKgB5mtfCRLbyPYcxawSGlTuyIyRXffWbkfHdDl6pquPX9J%2Fp5uGYM4jTrqrrrR1MPAOfkD7d9V5juqe5A7VvWmhiAyCMGDO%2BeqUO%2BSe6t9php0vA%3D%3D"
  }
}

Response fields

Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.

Field	Type	Example	Description
`width`Premium	number	`1024`	Actual width of captured screenshot in pixels
`height`Premium	number	`600`	Actual height of captured screenshot in pixels
`scaleFactor`Premium	number	`1`	Device pixel ratio used for screenshot capture
`imageName`	string	`"77072426-6af8-45c2-93dd-d7013d2c765e.png"`	Unique identifier for the generated screenshot image file
`expires`	number	`1766097105719`	Unix timestamp when the screenshot will expire
`url`	string	`"https://ebay.com/"`	Original URL that was screenshotted
`downloadURL`	string	`"https://storage.googleapis.com/apiverve-helpers.appspot.com/webscreenshots/77072426-6af8-45c2-93dd-d7013d2c765e.png?GoogleAccessId=10890207…`	Temporary signed URL to download the screenshot image

Response headers

Every response carries your balance, so your own code always knows where it stands without polling anything. All four are exposed to browsers through CORS.

Header	What it carries
`x-api-remaining-credits`	Credits left in the current cycle
`x-api-credits-used`	Credits spent in the current cycle
`x-api-max-credits`	The allowance for the cycle
`x-api-version`	Version of the endpoint that answered

Errors

Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change.

Status	Meaning	What to do
`400`	Input was rejected	Read `error`; it names the parameter that has to change.
`401`	Key missing or invalid	Check the header name and the key value.
`403`	Key valid, but not permitted here	A key restriction or an IP allow-list — never a bad key.
`429`	Rate limited, or out of credits	Read `error` to tell them apart, then back off or top up.

What a call costs — 40 credits per call

Credits are shared across every APIVerve API — one balance, one key, one bill. Failed requests never count against it, so a rejected input costs nothing.

Plan	Per month	Credits	Website Screenshot calls	Per 1,000 calls
Free	Free	200	5	Free
Starter	$29.99	200,000	5,000	$6.00
Pro	$99.99	1,000,000	25,000	$4.00
Mega	$299.99	4,000,000	100,000	$3.00

Calls are what the credits buy at this API's rate — spend them here, on any of the other APIs, or across both. Nothing is reserved per endpoint.

Compare all pricing tiers →

Call it from cURL — POST /v1/webscreenshots

No SDK to install — this is a plain HTTPS call to /v1/webscreenshots with your key in the x-api-key header. Swap in a real key and it runs as-is.

cURL

1
2

curl "https://api.apiverve.com/v1/webscreenshots" \
  -H "x-api-key: YOUR_API_KEY"

Resources

GitHubapiverve/webscreenshots-apiSource, issues and the examples this page is built from.ReferenceWebsite Screenshot API docsEvery parameter, every response field, and the errors.ParametersWhat this call acceptsRequired and optional inputs, with example values.

Also published for

@apiverve/webscreenshotsnpm APIVerve.API.WebsiteScreenshotNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from Node.js — POST /v1/webscreenshots

Install the Node.js SDK, then call the Website Screenshot API with your key. The client wraps the same HTTPS request, so anything it returns is what the endpoint returns.

Install — npm

npm install @apiverve/webscreenshots

Node.js

const res = await fetch("https://api.apiverve.com/v1/webscreenshots", {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const { data } = await res.json();
console.log(data);

Resources

npm@apiverve/webscreenshotsThe published Node.js client, versioned and signed.GitHubapiverve/webscreenshots-apiSource, issues and the examples this page is built from.ReferenceWebsite Screenshot API docsEvery parameter, every response field, and the errors.ParametersWhat this call acceptsRequired and optional inputs, with example values.

Also published for

APIVerve.API.WebsiteScreenshotNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from Python — POST /v1/webscreenshots

No SDK to install — this is a plain HTTPS call to /v1/webscreenshots with your key in the x-api-key header. Swap in a real key and it runs as-is.

Python

import requests

res = requests.get(
    "https://api.apiverve.com/v1/webscreenshots",
    headers={"x-api-key": "YOUR_API_KEY"},
)
print(res.json()["data"])

Resources

Also published for

@apiverve/webscreenshotsnpm APIVerve.API.WebsiteScreenshotNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from C# / .NET — POST /v1/webscreenshots

Install the C# / .NET SDK, then call the Website Screenshot API with your key. The client wraps the same HTTPS request, so anything it returns is what the endpoint returns.

Install — NuGet

dotnet add package APIVerve.API.WebsiteScreenshot

C# / .NET

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");

var json = await client.GetStringAsync("https://api.apiverve.com/v1/webscreenshots");
Console.WriteLine(json);

Resources

NuGetAPIVerve.API.WebsiteScreenshotThe published C# / .NET client, versioned and signed.GitHubapiverve/webscreenshots-apiSource, issues and the examples this page is built from.ReferenceWebsite Screenshot API docsEvery parameter, every response field, and the errors.ParametersWhat this call acceptsRequired and optional inputs, with example values.

Also published for

@apiverve/webscreenshotsnpm

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from Go — POST /v1/webscreenshots

No SDK to install — this is a plain HTTPS call to /v1/webscreenshots with your key in the x-api-key header. Swap in a real key and it runs as-is.

req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/webscreenshots", nil)
req.Header.Set("x-api-key", "YOUR_API_KEY")

res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))

Resources

Also published for

@apiverve/webscreenshotsnpm APIVerve.API.WebsiteScreenshotNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from PHP — POST /v1/webscreenshots

No SDK to install — this is a plain HTTPS call to /v1/webscreenshots with your key in the x-api-key header. Swap in a real key and it runs as-is.

PHP

$ch = curl_init("https://api.apiverve.com/v1/webscreenshots");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["x-api-key: YOUR_API_KEY"]);

$response = curl_exec($ch);
echo $response;

Resources

Also published for

@apiverve/webscreenshotsnpm APIVerve.API.WebsiteScreenshotNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

Call it from Ruby — POST /v1/webscreenshots

No SDK to install — this is a plain HTTPS call to /v1/webscreenshots with your key in the x-api-key header. Swap in a real key and it runs as-is.

Ruby

require "net/http"

uri = URI("https://api.apiverve.com/v1/webscreenshots")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "YOUR_API_KEY"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

Resources

Also published for

@apiverve/webscreenshotsnpm APIVerve.API.WebsiteScreenshotNuGet

Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.

All articles →

Automating Visual Testing With ScreenshotsCatch visual bugs before users do. Here's how to add screenshot-based testing to your workflow.Read

Extract Clean Content from Any WebpageTurn messy web pages into clean Markdown. Perfect for content migration, archiving, AI training data, and building read-later tools.Read

Take Your App Multilingual (No Rewrite)Add language support to an existing app without rearchitecting. Practical strategies for translation, detection, and localization.Read

Website Screenshot API POST

Try it — live request, no key required

About the Website Screenshot API

What people use it for

Ways to call it

Other ways to use Website Screenshot

Questions.

Request parameters — POST /v1/webscreenshots

Required

Optional

Authentication

Response — POST /v1/webscreenshots

Response fields

Response headers

Errors

What a call costs — 40 credits per call

Call it from cURL — POST /v1/webscreenshots

Resources

Also published for

Call it from Node.js — POST /v1/webscreenshots

Resources

Also published for

Call it from Python — POST /v1/webscreenshots

Resources

Also published for

Call it from C# / .NET — POST /v1/webscreenshots

Resources

Also published for

Call it from Go — POST /v1/webscreenshots

Resources

Also published for

Call it from PHP — POST /v1/webscreenshots

Resources

Also published for

Call it from Ruby — POST /v1/webscreenshots

Resources

Also published for

Zero-code embed — one snippet, no backend

Changelog — Website Screenshot API

Data Scraping

Related articles

Ready to build with Website Screenshot? Start with 200 free credits — one key unlocks all 300+ APIs.

Explore the catalog