Website Screenshot API

Overview

To use Website Screenshot, you need an API key. You can get one by creating a free account and visiting your dashboard.

POST Endpoint

https://api.apiverve.com/v1/webscreenshots

Example

How to call the Website Screenshot API in different programming languages.

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

const response = await fetch('https://api.apiverve.com/v1/webscreenshots', {
  method: 'POST',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "url": "https://ebay.com/",
    "type": "png",
    "width": 1024,
    "height": 600,
    "fullpage": false
})
});

const data = await response.json();
console.log(data);

import requests

headers = {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
}

payload = {
    "url": "https://ebay.com/",
    "type": "png",
    "width": 1024,
    "height": 600,
    "fullpage": false
}

response = requests.post('https://api.apiverve.com/v1/webscreenshots', headers=headers, json=payload)

data = response.json()
print(data)

package main

import (
    "fmt"
    "io"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    payload := map[string]interface{}{
        "url": "https://ebay.com/",
        "type": "png",
        "width": "1024",
        "height": "600",
        "fullpage": "false"
    }

    jsonPayload, _ := json.Marshal(payload)
    req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/webscreenshots", bytes.NewBuffer(jsonPayload))

    req.Header.Set("X-API-Key", "your_api_key_here")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

{
  "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"
  }
}

Authentication

The Website Screenshot API requires authentication via API key. Include your API key in the request header:

X-API-Key: your_api_key_here

Learn more about authentication →

Interactive API Playground

Test the Website Screenshot API directly in your browser with live requests and responses.

Parameters

The following parameters are available for the Website Screenshot API:

Response

The Website Screenshot API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.

Other Response Formats

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  <data>
    <width>1024</width>
    <height>600</height>
    <scaleFactor>1</scaleFactor>
    <imageName>77072426-6af8-45c2-93dd-d7013d2c765e.png</imageName>
    <expires>1766097105719</expires>
    <url>https://ebay.com/</url>
    <downloadURL>https://storage.googleapis.com/apiverve-helpers.appspot.com/webscreenshots/77072426-6af8-45c2-93dd-d7013d2c765e.png?GoogleAccessId=1089020767582-compute%40developer.gserviceaccount.com&amp;Expires=1766097105&amp;Signature=uZKa777XpeVnlwOZG7Uhjs%2BNkPzkEuiV4Wug2%2B%2BAHcPovRZ3iVjZEX%2FZhp7gnADXI6au5q0ggPwweoOFJeMCdk9zod6aZo4hlUDe1DsJf0oao4rh3tGUl5wPeudXLp7Y%2F3zVflup9Mp255LY6%2B2JdU0auOHdPnEYLDCvf705X9C%2BflmWQZKh7QKi74gvU8pqsP6Zc7SfJJsv5kmhP8SkO7TBZKBU6pAr2mNHKpKgB5mtfCRLbyPYcxawSGlTuyIyRXffWbkfHdDl6pquPX9J%2Fp5uGYM4jTrqrrrR1MPAOfkD7d9V5juqe5A7VvWmhiAyCMGDO%2BeqUO%2BSe6t9php0vA%3D%3D</downloadURL>
  </data>
</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 Structure

All API responses follow a consistent structure with the following fields:

Learn more about response formats →

Response Data Fields

When the request is successful, the data object contains the following fields:

Headers

Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →

GraphQL AccessALPHA

Access Website Screenshot through GraphQL to combine it with other API calls in a single request. Query only the website screenshot data you need with precise field selection, and orchestrate complex data fetching workflows.

Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.

POST https://api.apiverve.com/v1/graphql

query {
  webscreenshots(
    input: {
      url: "https://ebay.com/"
      type: "png"
      width: 1024
      height: 600
      fullpage: false
    }
  ) {
    width
    height
    scaleFactor
    imageName
    expires
    url
    downloadURL
  }
}

Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.

CORS Support

The Website Screenshot API accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →

Rate Limiting

Website Screenshot requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →

Error Codes

The Website Screenshot API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →

SDKs for Website Screenshot

Official Website Screenshot packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →

JitPack

No-Code Integrations

Website Screenshot works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →

Zapier

Make

Pipedream

n8n

Power Automate

Frequently Asked Questions

People who used this also used...

Based on your interest in Website Screenshot, you might also like these APIs:

Website Images Scraper

Web Image Scraper is a simple tool for scraping images from a website. It returns the URLs of the images found on the website.

10 credits per call

SEO Data Scraper

SEO Scraper is a simple tool for scraping SEO data. It returns the meta title, meta description, and more.

5 credits per call

Link Scraper

Link Scraper is a simple tool for scraping web page links. It returns all the links on a web page.

10 credits per call