Website Screenshot API Reference

API Overview

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

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

View API in Directory

Capture Screenshot

10 Token

Capture a screenshot of a web page

	
#POST Request
https://api.apiverve.com/v1/webscreenshots	

	
					

x-api-key (required)

This is a required header on every request. Your API Key is found from within your dashboard

accept

This is an optional header. Set the value to application/json, application/xml, or application/yaml


urlstring(required)

The URL of the web page to capture the screenshot (e.g., https://example.com)

typestring

The type of the screenshot (png, jpeg, or webp)

widthint

The width of the screenshot in pixels (e.g., 1920). Must be between 100 and 3840

heightint

The height of the screenshot in pixels (e.g., 1080). Must be between 100 and 3840

fullpagebool

Whether to capture the full page screenshot (true or false)


Sample Request
	
import requests

url = "https://api.apiverve.com/v1/webscreenshots"

payload = { "url": "https://ebay.com/", "type": "png", "width": 1024, "height": 600, "fullpage": false }
headers = {
	"x-api-key": "YOUR_API_KEY",
	"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
	
							
	
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
	Method = HttpMethod.Post,
	RequestUri = new Uri("https://api.apiverve.com/v1/webscreenshots"),
	Headers =
	{
		{ "x-api-key", "YOUR_API_KEY" }
	},
	Content = new StringContent("{ \"url\": \"https://ebay.com/\", \"type\": \"png\", \"width\": 1024, \"height\": 600, \"fullpage\": false }")
	{
		Headers =
		{
			ContentType = new MediaTypeHeaderValue("application/json")
		}
	}
};
using (var response = await client.SendAsync(request))
{
	response.EnsureSuccessStatusCode();
	var body = await response.Content.ReadAsStringAsync();
	Console.WriteLine(body);
}
	
							
	
const data = JSON.stringify({ "url": "https://ebay.com/", "type": "png", "width": 1024, "height": 600, "fullpage": false });

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener('readystatechange', function () {
	if (this.readyState === this.DONE) {
		console.log(this.responseText);
	}
});

xhr.open('POST', 'https://api.apiverve.com/v1/webscreenshots');
xhr.setRequestHeader('x-api-key', 'YOUR_API_KEY');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Accept', 'application/json');

xhr.send(data);
	
							
	
const request = require('request');

const options = {
  method: 'POST',
  url: 'https://api.apiverve.com/v1/webscreenshots',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json'
  },
  body: { "url": "https://ebay.com/", "type": "png", "width": 1024, "height": 600, "fullpage": false },
  json: true
};

request(options, function (error, response, body) {
	if (error) throw new Error(error);

	console.log(body);
});
	
							
	
HttpRequest request = HttpRequest.newBuilder()
		.uri(URI.create("https://api.apiverve.com/v1/webscreenshots"))
		.header("x-api-key", "YOUR_API_KEY")
		.header("Content-Type", "application/json")
		.header("Accept", "application/json")
		.method("POST", HttpRequest.BodyPublishers.ofString("{ \"url\": \"https://ebay.com/\", \"type\": \"png\", \"width\": 1024, \"height\": 600, \"fullpage\": false }"))
		.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
	
							
	
import Foundation

let headers = [
	"x-api-key": "YOUR_API_KEY",
	"Content-Type": "application/json"
]
let parameters = ["url" : "https://ebay.com/", "type" : "png", "width" : 1024, "height" : 600, "fullpage" : False,] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.apiverve.com/v1/webscreenshots")! as URL,
				cachePolicy: .useProtocolCachePolicy,
                timeoutInterval: 10.0)

request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
	if (error != nil) {
		print(error as Any)
	} else {
		let httpResponse = response as? HTTPURLResponse
		print(httpResponse)
	}
})

dataTask.resume()
	
							
	
curl --request POST \
	--url https://api.apiverve.com/v1/webscreenshots \
	--header 'Accept: application/json' \
	--header 'Content-Type: application/json' \
	--header 'x-api-key: YOUR_API_KEY' \
	--data '{ "url": "https://ebay.com/", "type": "png", "width": 1024, "height": 600, "fullpage": false }'
	
							

Sample Response
	
{
  "status": "ok",
  "error": null,
  "data": {
    "width": 1024,
    "height": 600,
    "scaleFactor": 1,
    "imageName": "78bdb087-756b-4107-83e1-82fd40171ed1.png",
    "expires": 1725356395837,
    "url": "https://ebay.com/",
    "downloadURL": "https://storage.googleapis.com/apiverve-helpers.appspot.com/webscreenshots/78bdb087-756b-4107-83e1-82fd40171ed1.png?GoogleAccessId=1089020767582-compute%40developer.gserviceaccount.com&Expires=1725356395&Signature=jqAuoBhrbsSqs61blsFdnXEU35QOanhFnL0FN2d82cDDTXAUWonuRURUjyyhmABe02dVD3sMpvQDh0V39ROFcukPFASdIhr4HdWnKl743JLx03jrW%2FJ2baK3lZCZemPkS%2F61VqcHV1YB5XsxqsDNNkQ8QL8xlzUslHUgjuVKsorDCpBL5iFPSLo0l5DO3wvZ6UudJJP11j1MAnRmWQC7%2FkUBc7AP4akQvm6N7lftFkx8z6%2FptdxBt60w1XR6Ixoy6Vl31tvd6UjyWhjmF8JbujRSRYXmh0vjTNZBp5BX7xUntQUSMXhQf%2Bj3bXq7ZcsfMAAtqonqbzC6SBZgzSu2kA%3D%3D"
  },
  "code": 200
}
	
							
	
<Root>
  <status>ok</status>
  <error />
  <data>
    <width>1024</width>
    <height>600</height>
    <scaleFactor>1</scaleFactor>
    <imageName>78bdb087-756b-4107-83e1-82fd40171ed1.png</imageName>
    <expires>1725356395837</expires>
    <url>https://ebay.com/</url>
    <downloadURL>https://storage.googleapis.com/apiverve-helpers.appspot.com/webscreenshots/78bdb087-756b-4107-83e1-82fd40171ed1.png?GoogleAccessId=1089020767582-compute%40developer.gserviceaccount.com&amp;Expires=1725356395&amp;Signature=jqAuoBhrbsSqs61blsFdnXEU35QOanhFnL0FN2d82cDDTXAUWonuRURUjyyhmABe02dVD3sMpvQDh0V39ROFcukPFASdIhr4HdWnKl743JLx03jrW%2FJ2baK3lZCZemPkS%2F61VqcHV1YB5XsxqsDNNkQ8QL8xlzUslHUgjuVKsorDCpBL5iFPSLo0l5DO3wvZ6UudJJP11j1MAnRmWQC7%2FkUBc7AP4akQvm6N7lftFkx8z6%2FptdxBt60w1XR6Ixoy6Vl31tvd6UjyWhjmF8JbujRSRYXmh0vjTNZBp5BX7xUntQUSMXhQf%2Bj3bXq7ZcsfMAAtqonqbzC6SBZgzSu2kA%3D%3D</downloadURL>
  </data>
  <code>200</code>
</Root>
	
							
	
status: ok
error: 
data:
  width: 1024
  height: 600
  scaleFactor: 1
  imageName: 78bdb087-756b-4107-83e1-82fd40171ed1.png
  expires: 1725356395837
  url: https://ebay.com/
  downloadURL: https://storage.googleapis.com/apiverve-helpers.appspot.com/webscreenshots/78bdb087-756b-4107-83e1-82fd40171ed1.png?GoogleAccessId=1089020767582-compute%40developer.gserviceaccount.com&Expires=1725356395&Signature=jqAuoBhrbsSqs61blsFdnXEU35QOanhFnL0FN2d82cDDTXAUWonuRURUjyyhmABe02dVD3sMpvQDh0V39ROFcukPFASdIhr4HdWnKl743JLx03jrW%2FJ2baK3lZCZemPkS%2F61VqcHV1YB5XsxqsDNNkQ8QL8xlzUslHUgjuVKsorDCpBL5iFPSLo0l5DO3wvZ6UudJJP11j1MAnRmWQC7%2FkUBc7AP4akQvm6N7lftFkx8z6%2FptdxBt60w1XR6Ixoy6Vl31tvd6UjyWhjmF8JbujRSRYXmh0vjTNZBp5BX7xUntQUSMXhQf%2Bj3bXq7ZcsfMAAtqonqbzC6SBZgzSu2kA%3D%3D
code: 200
	
							
	
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "error": {},
    "data": {
      "$ref": "#/definitions/Data"
    },
    "code": {
      "type": "integer"
    }
  },
  "definitions": {
    "Data": {
      "type": "object",
      "properties": {
        "width": {
          "type": "integer"
        },
        "height": {
          "type": "integer"
        },
        "scaleFactor": {
          "type": "integer"
        },
        "imageName": {
          "type": "string"
        },
        "expires": {
          "type": "integer"
        },
        "url": {
          "type": "string"
        },
        "downloadURL": {
          "type": "string"
        }
      }
    }
  }
}
	
							
Live Test API in Playground

OpenAPI Schema

                                    
openapi: 3.0.4
info:
  title: APIVerve
  description: Unleash the potential of your applications with a single API Key and access to various APIs
  termsOfService: https://apiverve.com/terms/
  contact:
    name: APIVerve Support
    email: [email protected]
    url: https://apiverve.com/contact
  version: 1.0.9
externalDocs:
  description: Learn more about APIVerve
  url: https://docs.apiverve.com?utm_source=openapi
servers:
- url: https://api.apiverve.com/
paths:
  /v1/webscreenshots:
    post:
      summary: Capture Screenshot
      description: Web Screenshots is a simple tool for capturing screenshots of web pages. It returns an image screenshot of the web page provided.
      operationId: webscreenshots
      parameters:
      - name: body
        in: body
        description: Request body parameter
        required: true
        schema:
          type: object
          properties:
            url:
              type: string
              description: The URL of the web page to capture the screenshot (e.g., https://example.com)
              example: https://ebay.com/
            type:
              type: string
              description: The type of the screenshot (png, jpeg, or webp)
              default: jpg
              example: png
            width:
              type: integer
              description: The width of the screenshot in pixels (e.g., 1920). Must be between 100 and 3840
              default: '1920'
              example: 1024
            height:
              type: integer
              description: The height of the screenshot in pixels (e.g., 1080).  Must be between 100 and 3840
              default: '1080'
              example: 600
            fullpage:
              type: boolean
              description: Whether to capture the full page screenshot (true or false)
              default: false
              example: false
          required:
          - url
          example:
            url: https://ebay.com/
            type: png
            width: 1024
            height: 600
            fullpage: false
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: status
                  error:
                    type: string
                    description: error
                  data:
                    type: string
                    description: data
                  code:
                    type: number
                    description: code
              example:
                status: ok
                error: 
                data:
                  width: 1024
                  height: 600
                  scaleFactor: 1
                  imageName: 78bdb087-756b-4107-83e1-82fd40171ed1.png
                  expires: 1725356395837
                  url: https://ebay.com/
                  downloadURL: https://storage.googleapis.com/apiverve-helpers.appspot.com/webscreenshots/78bdb087-756b-4107-83e1-82fd40171ed1.png?GoogleAccessId=1089020767582-compute%40developer.gserviceaccount.com&Expires=1725356395&Signature=jqAuoBhrbsSqs61blsFdnXEU35QOanhFnL0FN2d82cDDTXAUWonuRURUjyyhmABe02dVD3sMpvQDh0V39ROFcukPFASdIhr4HdWnKl743JLx03jrW%2FJ2baK3lZCZemPkS%2F61VqcHV1YB5XsxqsDNNkQ8QL8xlzUslHUgjuVKsorDCpBL5iFPSLo0l5DO3wvZ6UudJJP11j1MAnRmWQC7%2FkUBc7AP4akQvm6N7lftFkx8z6%2FptdxBt60w1XR6Ixoy6Vl31tvd6UjyWhjmF8JbujRSRYXmh0vjTNZBp5BX7xUntQUSMXhQf%2Bj3bXq7ZcsfMAAtqonqbzC6SBZgzSu2kA%3D%3D
                code: 200
        '401':
          description: Your request was not authorized, or your API Key was invalid
        '404':
          description: Requested resource was not found
        '500':
          description: A server error has occured, try again later
components:
  securitySchemes:
    api_key:
      type: apiKey
      name: x-api-key
      in: header
security:
- api_key: []
                                    
                                
Live Test API in Playground

Client Libraries

To get started with minimal code, most of our APIs are available through client libraries and clients:

run in postman button npm logo pypi logo nuget logo swagger logo

Response Types

The Website Screenshot API supports the following response content types:

application/json, application/xml, application/yaml

You can specify the response content type by setting the Accept header in your request. If you don't specify a content type, the API will default to application/json.

Authentication

The Website Screenshot API uses an API Key to authenticate requests. You can view and manage your API key by visiting your dashboard.

Your API keys carry many privileges. To keep them from being abused, please do not share the keys on client-side code or Github etc. Keep them very secure.

All requests made to the API must contain the header x-api-key in each of your requests. API requests without authentication will fail.

All API requests must also be made over secure HTTPS. Requests made over plain HTTP will fail.

Error Code Meaning
401 Your request was made with invalid credentials. This error also appears when you don't pass the x-api-key header in your request.

Rate Limits

	
{
    "status": "error",
    "data": null,
    "error": "tokens have been depleted",
    "code": 429
}
	
							

Each subscription has its own monthly token limit. Your token count is based on your subscription plan. If you reach your limits, don't worry. You can always upgrade or downgrade at any time. View Pricing

When you reach your limit, the service will stop responding and typically return an HTTP 429 response status code. The error will also contain a detailed JSON.

The Website Screenshot API uses the following error code:

Error Code Meaning
429 You have exceeded your rate limit and further requests will be denied until the next cycle.

Error Codes

For reference, the Website Screenshot API uses the following error codes:

Error Code Meaning
Code Message
200 The request was successful. The response will include the requested data.
400 The request was invalid. The response will include a message that explains the error.
401 The request was not authorized. Usually, this means that the API key is missing or invalid.
403 This means that the request was trying to access a resource that it does not have permission to access.
404 This means that the resource you are trying to access does not exist.
429 This means that you have reached the rate limit. The response will include a Retry-After header that indicates how many seconds you need to wait before making a new request.
500 This means that there was an error on the server side. We are alerted when this happens and we will work to fix it as soon as possible.
ON THIS PAGE