Take Screenshot

Overview

The PeekShot Screenshot API allows you to capture high-quality screenshots of web pages programmatically. Easily integrate it into your applications for website monitoring, SEO tracking, and more.

Endpoint

POST https://api.peekshot.com/api/v1/screenshots

Authentication

All requests must include the x-api-key header with a valid API key.

Request Headers

Header	Description
x-api-key	Your unique API key for authentication
Content-Type	application/json

Request Body Parameters

Send a JSON payload with the following parameters:

Parameter	Type	Required	Description
project_id	string	Yes	Unique project identifier.
url	string	Yes	The website URL to capture.
width	string	No	Screenshot width (default: 1680).
height	string	No	Screenshot height (default: 867).
inject_css	string	No	Custom CSS to apply.
inject_js	string	No	Custom JS to apply.
file_type	string	No	Image format (jpeg, png, etc.).
retina	string	No	true for high-resolution screenshots.
delay	string	No	Time (in seconds) to wait before capturing.
full_page	string	No	true to capture the entire page, false for viewport only.
disable_javascript	string	No	true to disable JavaScript execution.
emulate_device	string	No	Supported Devices
disable_animations	string	No	true to disable Animations.
proxy_url	string	No	Supports proxies with or without authentication.
custom_header	string	No	Inject custom header into request

Using a Proxy

You can route screenshot captures through a custom HTTP proxy using the proxy_url option.

Note: HTTPS and SOCKS5 proxies are not supported. Only HTTP proxies are allowed.

Proxy URL Syntax

http://username:password@host:port

Example Request

cURL

curl --location 'https://api.peekshot.com/api/v1/screenshots' \
  --header 'x-api-key: your-api-key' \
  --header 'Content-Type: application/json' \
  --data '{
      "project_id": "1",
      "url": "https://www.yourdomain.com/",
      "width": 1680,
      "height": 867,
      "inject_css": ".container { background: red !important; }",
      "inject_js": "document.querySelectorAll('.fixed, .sticky').forEach(el => { el.style.position = 'static'; }); const watermark = document.createElement('div'); watermark.style.position = 'fixed'; watermark.style.bottom = '10px'; watermark.style.right = '10px'; watermark.style.padding = '5px 10px'; watermark.style.background = 'rgba(0,0,0,0.7)'; watermark.style.color = 'white'; watermark.style.borderRadius = '4px'; watermark.style.fontSize = '12px'; watermark.textContent = 'Screenshot by PeekShot'; document.body.appendChild(watermark); document.querySelectorAll('img').forEach(img => { if (!img.complete) { img.style.border = '2px solid #ff0000'; } });",
      "file_type": "jpeg",
      "retina": true,
      "delay": 0,
      "full_page": false,
      "disable_javascript": false
  }'

Node.js

const axios = require('axios');
let data = JSON.stringify({
    "project_id": "1",
    "url": "https://www.yourdomain.com/",
    "width": "1680",
    "height": "867",
    "inject_css": ".container { background: red !important; }",
    "inject_js": "document.querySelectorAll('.fixed, .sticky').forEach(el => { el.style.position = 'static'; }); const watermark = document.createElement('div'); watermark.style.position = 'fixed'; watermark.style.bottom = '10px'; watermark.style.right = '10px'; watermark.style.padding = '5px 10px'; watermark.style.background = 'rgba(0,0,0,0.7)'; watermark.style.color = 'white'; watermark.style.borderRadius = '4px'; watermark.style.fontSize = '12px'; watermark.textContent = 'Screenshot by PeekShot'; document.body.appendChild(watermark); document.querySelectorAll('img').forEach(img => { if (!img.complete) { img.style.border = '2px solid #ff0000'; } });",
    "file_type": "jpeg",
    "retina": "true",
    "delay": "0",
    "full_page": "false",
    "disable_javascript": "false"
});

let config = {
    method: 'post',
    maxBodyLength: Infinity,
    url: 'https://api.peekshot.com/api/v1/screenshots',
    headers: { 
        'x-api-key': 'your-api-key', 
        'Content-Type': 'application/json'
    },
    data: data
};

axios.request(config)
    .then((response) => {
        console.log(JSON.stringify(response.data));
    })
    .catch((error) => {
        console.log(error);
    });

Python

import requests
import json

# API endpoint and API key
url = "https://api.peekshot.com/api/v1/screenshots"
api_key = "your-api-key"

# Request payload
data = {
    "project_id": "1",
    "url": "https://www.yourdomain.com/",
    "width": "1680",
    "height": "867",
    "inject_css": ".container { background: red !important; }",
    "inject_js": "document.querySelectorAll('.fixed, .sticky').forEach(el => { el.style.position = 'static'; }); const watermark = document.createElement('div'); watermark.style.position = 'fixed'; watermark.style.bottom = '10px'; watermark.style.right = '10px'; watermark.style.padding = '5px 10px'; watermark.style.background = 'rgba(0,0,0,0.7)'; watermark.style.color = 'white'; watermark.style.borderRadius = '4px'; watermark.style.fontSize = '12px'; watermark.textContent = 'Screenshot by PeekShot'; document.body.appendChild(watermark); document.querySelectorAll('img').forEach(img => { if (!img.complete) { img.style.border = '2px solid #ff0000'; } });",
    "file_type": "jpeg",
    "retina": "true",
    "delay": "0",
    "full_page": "false",
    "disable_javascript": "false"
}

# Headers
headers = {
    "x-api-key": api_key,
    "Content-Type": "application/json"
}

# Sending POST request
response = requests.post(url, headers=headers, data=json.dumps(data))

# Print response
print("Response Code:", response.status_code)
print("Response Body:", response.json())

Go

package main

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

func main() {
	// Define the request payload
	data := map[string]string{
		"project_id":           "1",
		"url":                  "https://www.yourdomain.com/",
		"width":                "1680",
		"height":               "867",
        "inject_css": ".container { background: red !important; }",
        "inject_js": "document.querySelectorAll('.fixed, .sticky').forEach(el => { el.style.position = 'static'; }); const watermark = document.createElement('div'); watermark.style.position = 'fixed'; watermark.style.bottom = '10px'; watermark.style.right = '10px'; watermark.style.padding = '5px 10px'; watermark.style.background = 'rgba(0,0,0,0.7)'; watermark.style.color = 'white'; watermark.style.borderRadius = '4px'; watermark.style.fontSize = '12px'; watermark.textContent = 'Screenshot by PeekShot'; document.body.appendChild(watermark); document.querySelectorAll('img').forEach(img => { if (!img.complete) { img.style.border = '2px solid #ff0000'; } });",
		"file_type":            "jpeg",
		"retina":               "true",
		"delay":                "0",
		"full_page":            "false",
		"disable_javascript":   "false",
	}

	// Convert the data to JSON
	jsonData, err := json.Marshal(data)
	if err != nil {
		fmt.Println("Error marshalling JSON:", err)
		return
	}

	// Create an HTTP request
	req, err := http.NewRequest("POST", "https://api.peekshot.com/api/v1/screenshots", bytes.NewBuffer(jsonData))
	if err != nil {
		fmt.Println("Error creating request:", err)
		return
	}

	// Set headers
	req.Header.Set("x-api-key", "your-api-key")
	req.Header.Set("Content-Type", "application/json")

	// Send the request using http.Client
	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		fmt.Println("Error sending request:", err)
		return
	}
	defer resp.Body.Close()

	// Read and print the response
	body, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		fmt.Println("Error reading response:", err)
		return
	}

	fmt.Println("Response:", string(body))
}

Java

import java.io.*;
import java.net.HttpURLConnection;
import java.net.URL;
import org.json.JSONObject;

public class ScreenshotAPI {
    public static void main(String[] args) {
        try {
            // Define API URL
            URL url = new URL("https://api.peekshot.com/api/v1/screenshots");
            HttpURLConnection conn = (HttpURLConnection) url.openConnection();

            // Set request method to POST
            conn.setRequestMethod("POST");
            conn.setRequestProperty("x-api-key", "your-api-key");
            conn.setRequestProperty("Content-Type", "application/json");
            conn.setDoOutput(true);

            // Create JSON payload
            JSONObject json = new JSONObject();
            json.put("project_id", "1");
            json.put("url", "https://www.yourdomain.com/");
            json.put("width", "1680");
            json.put("height", "867");
            json.put("inject_css", ".container { background: red !important; }");
            json.put("inject_js", "document.querySelectorAll('.fixed, .sticky').forEach(el => { el.style.position = 'static'; }); const watermark = document.createElement('div'); watermark.style.position = 'fixed'; watermark.style.bottom = '10px'; watermark.style.right = '10px'; watermark.style.padding = '5px 10px'; watermark.style.background = 'rgba(0,0,0,0.7)'; watermark.style.color = 'white'; watermark.style.borderRadius = '4px'; watermark.style.fontSize = '12px'; watermark.textContent = 'Screenshot by PeekShot'; document.body.appendChild(watermark); document.querySelectorAll('img').forEach(img => { if (!img.complete) { img.style.border = '2px solid #ff0000'; } });");
            json.put("file_type", "jpeg");
            json.put("retina", "true");
            json.put("delay", "0");
            json.put("full_page", "false");
            json.put("disable_javascript", "false");

            // Send JSON data
            OutputStream os = conn.getOutputStream();
            os.write(json.toString().getBytes("UTF-8"));
            os.flush();
            os.close();

            // Read response
            int responseCode = conn.getResponseCode();
            BufferedReader reader = new BufferedReader(new InputStreamReader(
                    (responseCode >= 200 && responseCode < 300) ? conn.getInputStream() : conn.getErrorStream()));

            StringBuilder response = new StringBuilder();
            String line;
            while ((line = reader.readLine()) != null) {
                response.append(line);
            }
            reader.close();

            // Print response
            System.out.println("Response: " + response.toString());

            // Close connection
            conn.disconnect();

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

PHP

<?php

$apiUrl = "https://api.peekshot.com/api/v1/screenshots";
$apiKey = "your-api-key";

// Prepare JSON payload
$data = [
    "project_id" => "1",
    "url" => "https://www.yourdomain.com/",
    "width" => "1680",
    "height" => "867",
    "inject_css": ".container { background: red !important; }",
    "inject_js": "document.querySelectorAll('.fixed, .sticky').forEach(el => { el.style.position = 'static'; }); const watermark = document.createElement('div'); watermark.style.position = 'fixed'; watermark.style.bottom = '10px'; watermark.style.right = '10px'; watermark.style.padding = '5px 10px'; watermark.style.background = 'rgba(0,0,0,0.7)'; watermark.style.color = 'white'; watermark.style.borderRadius = '4px'; watermark.style.fontSize = '12px'; watermark.textContent = 'Screenshot by PeekShot'; document.body.appendChild(watermark); document.querySelectorAll('img').forEach(img => { if (!img.complete) { img.style.border = '2px solid #ff0000'; } });",
    "file_type" => "jpeg",
    "retina" => "true",
    "delay" => "0",
    "full_page" => "false",
    "disable_javascript" => "false"
];

// Initialize cURL
$ch = curl_init($apiUrl);

// Set cURL options
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "x-api-key: $apiKey",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));

// Execute the request
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

// Check for errors
if (curl_errno($ch)) {
    echo "cURL Error: " . curl_error($ch);
} else {
    echo "Response (HTTP $httpCode): " . $response;
}

// Close cURL session
curl_close($ch);
?>

Ruby

require 'net/http'
require 'uri'
require 'json'

# API endpoint and API key
url = URI.parse("https://api.peekshot.com/api/v1/screenshots")
api_key = "your-api-key"

# Request payload
data = {
  "project_id" => "1",
  "url" => "https://www.yourdomain.com/",
  "width" => "1680",
  "height" => "867",
  "inject_css": ".container { background: red !important; }",
  "inject_js": "document.querySelectorAll('.fixed, .sticky').forEach(el => { el.style.position = 'static'; }); const watermark = document.createElement('div'); watermark.style.position = 'fixed'; watermark.style.bottom = '10px'; watermark.style.right = '10px'; watermark.style.padding = '5px 10px'; watermark.style.background = 'rgba(0,0,0,0.7)'; watermark.style.color = 'white'; watermark.style.borderRadius = '4px'; watermark.style.fontSize = '12px'; watermark.textContent = 'Screenshot by PeekShot'; document.body.appendChild(watermark); document.querySelectorAll('img').forEach(img => { if (!img.complete) { img.style.border = '2px solid #ff0000'; } });",
  "file_type" => "jpeg",
  "retina" => "true",
  "delay" => "0",
  "full_page" => "false",
  "disable_javascript" => "false"
}

# Create HTTP request
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = (url.scheme == "https")

request = Net::HTTP::Post.new(url)
request["x-api-key"] = api_key
request["Content-Type"] = "application/json"
request.body = data.to_json

# Send request and get response
response = http.request(request)

# Print response
puts "Response Code: #{response.code}"
puts "Response Body: #{response.body}"

Example Response

{
  "status": "success",
  "message": "screenshot request added in queue",
  "data": {
    "url": "https://www.yourdomain.com/",
    "requestId": 1,
    "creditRequired": 1,
    "organizationId": 1
  },
  "statusCode": 201
}

Error Responses

Status Code	Error Message	Description
400	Invalid Request	Check your input parameters.
403	Forbidden	Invalid or inactive API key.
500	Internal Server Error	Something went wrong on our end.

Notes

• The API supports high concurrency with minimal latency.
• Ensure the provided URL is publicly accessible.
• Large screenshots may take longer to process.

For further assistance, contact [email protected].