Screenshot API

Erfassen Sie Screenshots, generieren Sie PDFs und überwachen Sie visuelle Änderungen für jede URL — mit Geräteemulation, Werbeblocker und Wasserzeichen.

API FAQ

API-Schlüssel erhalten Credits kaufen

Was können Sie tun?

URL- & HTML-Screenshots

Erfassen Sie jede URL oder benutzerdefiniertes HTML als PNG, JPG, WebP mit Geräteemulation, Ganzseitenmodus und Retina-Unterstützung.

PDF-Generierung

Generieren Sie PDFs mit benutzerdefiniertem Seitenformat, Ausrichtung, Rändern, Kopf- und Fußzeilen.

Massen- & geplante Erfassung

Verarbeiten Sie bis zu 50 URLs in einer einzigen Anfrage. Planen Sie wiederkehrende Erfassungen mit Cron-Ausdrücken und Änderungserkennung.

Visueller Vergleich & Monitoring

Vergleichen Sie Screenshots Pixel für Pixel. Erhalten Sie Differenzprozentsatz, geänderte Bereiche und E-Mail-Benachrichtigungen bei visuellen Änderungen.

Werbe- & Cookie-Blocking

Blockieren Sie Werbung, Cookie-Zustimmungsbanner, Chat-Widgets und Tracking-Skripte. Injizieren Sie benutzerdefiniertes CSS/JS für saubere Erfassungen.

Performance-Metriken

Erfassen Sie Core Web Vitals — LCP, FCP, CLS, TTI, TTFB und Ressourcenaufschlüsselung.

Endpoint:

99.9 % Verfügbarkeit

4164.3ms Antwort

20 req/s

0.05 Credits / Anfrage

URL Screenshot

POST https://link.yeb.to/v1/screenshot/capture

Capture a screenshot of any URL. Supports device emulation, full-page capture, element targeting, ad/cookie blocking, CSS/JS injection, watermarks, and more. Use async=true to queue the job and poll via /status.

Parameter	Typ	Erf.	Beschreibung
`api_key`	string	ja	Your API key
`url`	string	ja	URL to capture (max 2000 chars)
`viewport_width`	integer	opt.	Viewport width (320-3840, default: 1920)
`viewport_height`	integer	opt.	Viewport height (200-2160, default: 1080)
`full_page`	boolean	opt.	Capture full scrollable page (+0.03 credits)
`retina`	boolean	opt.	2x pixel density (+0.03 credits)
`device`	string	opt.	Device preset (e.g. `iphone-15`, `ipad-pro-12.9`). Overrides viewport.
`format`	string	opt.	`png` (default) \| `jpg` \| `webp`
`quality`	integer	opt.	JPG/WebP quality 1-100 (default: 80)
`delay_ms`	integer	opt.	Wait before capture in ms (0-30000)
`timeout_ms`	integer	opt.	Navigation timeout (default: 30000)
`selector`	string	opt.	CSS selector to capture specific element
`click_selectors`	array	opt.	Elements to click before capture (max 10)
`blur_selectors`	array	opt.	Elements to blur (max 20)
`remove_selectors`	array	opt.	Elements to remove from DOM (max 20)
`block_ads`	boolean	opt.	Block ad networks
`block_cookie_banners`	boolean	opt.	Remove cookie consent banners
`block_chat_widgets`	boolean	opt.	Remove chat widgets
`block_tracking`	boolean	opt.	Block tracking scripts
`dark_mode`	boolean	opt.	Emulate dark mode
`inject_css`	string	opt.	Custom CSS to inject
`inject_js`	string	opt.	Custom JavaScript to inject
`user_agent`	string	opt.	Custom User-Agent
`headers`	object	opt.	Custom HTTP headers
`cookies`	array	opt.	Browser cookies
`thumbnail_width`	integer	opt.	Generate thumbnail (50-800px)
`watermark`	object	opt.	`{text, position, opacity}`
`async`	boolean	opt.	Queue job and return immediately
`return_base64`	boolean	opt.	Include base64 image in response
`webhook_url`	string	opt.	Webhook URL for completion notification

Anfragebeispiele

# Basic screenshot
curl -s -X POST "https://link.yeb.to/v1/screenshot/capture" \
  -H "X-API-Key: YOUR_KEY" \
  -d "url=https://example.com&format=png"

# Full page with device preset and blocking
curl -s -X POST "https://link.yeb.to/v1/screenshot/capture" \
  -H "X-API-Key: YOUR_KEY" \
  -d "url=https://example.com&device=iphone-15&full_page=true&block_ads=true&block_cookie_banners=true"

API-Integrationen

curl -s -X POST "https://link.yeb.to/v1/screenshot/capture" \
  -H "X-API-Key: YOUR_KEY" \
  -d "url=https://example.com&format=png&full_page=true&block_ads=true"

use Illuminate\Support\Facades\Http;

$response = Http::asForm()->post('https://link.yeb.to/v1/screenshot/capture', [
    'api_key'              => config('services.yeb.key'),
    'url'                  => 'https://example.com',
    'format'               => 'png',
    'full_page'            => true,
    'block_ads'            => true,
    'block_cookie_banners' => true,
    'device'               => 'iphone-15',
]);

$data = $response->json();
// $data['url'] => screenshot URL

$ch = curl_init('https://link.yeb.to/v1/screenshot/capture');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query([
    'api_key'   => 'YOUR_KEY',
    'url'       => 'https://example.com',
    'format'    => 'png',
    'full_page' => true,
    'block_ads' => true,
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);

const params = new URLSearchParams({
  api_key: 'YOUR_KEY',
  url: 'https://example.com',
  format: 'png',
  full_page: 'true',
  block_ads: 'true',
  device: 'iphone-15'
});

const res = await fetch('https://link.yeb.to/v1/screenshot/capture', {
  method: 'POST',
  headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
  body: params.toString()
});
const data = await res.json();
console.log(data.url); // screenshot URL

import requests

r = requests.post('https://link.yeb.to/v1/screenshot/capture', data={
    'api_key': 'YOUR_KEY',
    'url': 'https://example.com',
    'format': 'png',
    'full_page': True,
    'block_ads': True,
    'device': 'iphone-15',
})
data = r.json()
print(data['url'])  # screenshot URL

Response Example

{
  "success": true,
  "job_id": 12345,
  "url": "https://cdn.yeb.to/.../ss_abc.png",
  "thumbnail_url": "https://cdn.yeb.to/.../thumb.jpg",
  "width": 1920,
  "height": 1080,
  "format": "png",
  "file_size": 245678,
  "response_code": 200,
  "response_time_ms": 2340
}

{
  "success": true,
  "job_id": 12345,
  "status": "queued",
  "message": "Screenshot job queued",
  "response_code": 200
}

{
  "error": "The url field is required.",
  "code": 400,
  "response_code": 400,
  "response_time_ms": 5
}

Antwortcodes

Code	Beschreibung
200 Success	Anfrage erfolgreich verarbeitet.
400 Bad Request	Eingabevalidierung fehlgeschlagen.
401 Unauthorized	Fehlender / falscher API-Schlüssel.
403 Forbidden	Schlüssel inaktiv oder nicht erlaubt.
429 Rate Limit	Zu viele Anfragen.
500 Server Error	Unerwarteter Fehler.

URL Screenshot

screenshot-capture 0.0500 credits

Method

URL

Authentication

API Key

Parameters

API Key

body · string · required

URL

body · string · required

Viewport Width

body · string

Viewport Height

body · string

Full Page

body · string

Retina

body · string

Device

body · string

Format

body · string

Quality

body · string

Delay

body · string

Timeout

body · string

Selector

body · string

Click Selectors

body · string

Blur Selectors

body · string

Remove Selectors

body · string

Block Ads

body · string

Block Cookies

body · string

Block Chat

body · string

Block Tracking

body · string

Dark Mode

body · string

Inject CSS

body · string

Inject JS

body · string

User Agent

body · string

Headers

body · string

Thumbnail Width

body · string

Watermark

body · string

Async

body · string

Return Base64

body · string

Webhook URL

body · string

Code Samples

Response

Status: —

Headers

Body

HTML Screenshot

POST https://link.yeb.to/v1/screenshot/capture-html

Render custom HTML/CSS into a screenshot. Ideal for generating images from templates, invoices, social media cards, or any custom markup. No external URL needed.

Parameter	Typ	Erf.	Beschreibung
`api_key`	string	ja	Your API key
`html`	string	ja	HTML content to render (max 500 KB)
`viewport_width`	integer	opt.	Viewport width (320-3840, default: 800)
`viewport_height`	integer	opt.	Viewport height (200-2160, default: 600)
`full_page`	boolean	opt.	Capture full scrollable page
`format`	string	opt.	`png` (default) \| `jpg` \| `webp`
`quality`	integer	opt.	JPG/WebP quality 1-100 (default: 80)
`transparent_bg`	boolean	opt.	Transparent background (PNG only)
`selector`	string	opt.	CSS selector to capture specific element
`dark_mode`	boolean	opt.	Emulate dark mode
`inject_css`	string	opt.	Additional CSS to inject
`thumbnail_width`	integer	opt.	Generate thumbnail (50-800px)
`async`	boolean	opt.	Queue job and return immediately
`return_base64`	boolean	opt.	Include base64 image in response

Anfragebeispiele

# Render custom HTML
curl -s -X POST "https://link.yeb.to/v1/screenshot/capture-html" \
  -H "X-API-Key: YOUR_KEY" \
  -d "html=<h1 style='color:blue'>Hello World</h1>&format=png"

# Social card with transparent background
curl -s -X POST "https://link.yeb.to/v1/screenshot/capture-html" \
  -H "X-API-Key: YOUR_KEY" \
  -d "html=<div class='card'>...</div>&transparent_bg=true&viewport_width=1200&viewport_height=630"

API-Integrationen

curl -s -X POST "https://link.yeb.to/v1/screenshot/capture-html" \
  -H "X-API-Key: YOUR_KEY" \
  -d "html=<html><body><h1>Hello</h1></body></html>&format=png&transparent_bg=true"

use Illuminate\Support\Facades\Http;

$html = view('emails.invoice', $data)->render();

$response = Http::asForm()->post('https://link.yeb.to/v1/screenshot/capture-html', [
    'api_key'        => config('services.yeb.key'),
    'html'           => $html,
    'viewport_width' => 800,
    'viewport_height'=> 600,
    'format'         => 'png',
]);

$data = $response->json();
// $data['url'] => screenshot URL

$ch = curl_init('https://link.yeb.to/v1/screenshot/capture-html');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query([
    'api_key'        => 'YOUR_KEY',
    'html'           => '<h1>Hello World</h1>',
    'format'         => 'png',
    'transparent_bg' => true,
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);

const params = new URLSearchParams({
  api_key: 'YOUR_KEY',
  html: '<div style="padding:20px"><h1>Hello</h1></div>',
  format: 'png',
  transparent_bg: 'true'
});

const res = await fetch('https://link.yeb.to/v1/screenshot/capture-html', {
  method: 'POST',
  headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
  body: params.toString()
});
const data = await res.json();
console.log(data.url);

import requests

r = requests.post('https://link.yeb.to/v1/screenshot/capture-html', data={
    'api_key': 'YOUR_KEY',
    'html': '<h1 style="color:red">Hello World</h1>',
    'format': 'png',
    'transparent_bg': True,
})
data = r.json()
print(data['url'])

Response Example

{
  "success": true,
  "job_id": 12346,
  "url": "https://cdn.yeb.to/.../ss_abc.png",
  "thumbnail_url": "https://cdn.yeb.to/.../thumb.jpg",
  "width": 800,
  "height": 600,
  "format": "png",
  "file_size": 54321,
  "response_code": 200,
  "response_time_ms": 1230
}

{
  "error": "The html field is required.",
  "code": 400,
  "response_code": 400,
  "response_time_ms": 3
}

Antwortcodes

Code	Beschreibung
200 Success	Anfrage erfolgreich verarbeitet.
400 Bad Request	Eingabevalidierung fehlgeschlagen.
401 Unauthorized	Fehlender / falscher API-Schlüssel.
403 Forbidden	Schlüssel inaktiv oder nicht erlaubt.
429 Rate Limit	Zu viele Anfragen.
500 Server Error	Unerwarteter Fehler.

HTML Screenshot

screenshot-capture-html 0.0300 credits

Method

URL

Authentication

API Key

Parameters

API Key

body · string · required

HTML

body · string · required

Viewport Width

body · string

Viewport Height

body · string

Format

body · string

Quality

body · string

Transparent BG

body · string

Selector

body · string

Dark Mode

body · string

Inject CSS

body · string

Thumbnail Width

body · string

Async

body · string

Return Base64

body · string

Code Samples

Response

Status: —

Headers

Body

PDF Generation

POST https://link.yeb.to/v1/screenshot/capture-pdf

Generate a PDF from any URL or HTML content. Supports page format, orientation, custom margins, headers/footers, and background printing.

Parameter	Typ	Erf.	Beschreibung
`api_key`	string	ja	Your API key
`url`	string	ja	URL to convert to PDF (or use `html`)
`html`	string	opt.	HTML content (alternative to `url`)
`pdf_format`	string	opt.	`A4` (default) \| `A3` \| `Letter` \| `Legal`
`pdf_orientation`	string	opt.	`portrait` (default) \| `landscape`
`pdf_margins`	object	opt.	`{top, right, bottom, left}` in mm
`pdf_print_background`	boolean	opt.	Print background colors/images (default: true)
`pdf_header`	string	opt.	Custom header HTML template
`pdf_footer`	string	opt.	Custom footer HTML (use `.pageNumber`, `.totalPages`)
`viewport_width`	integer	opt.	Viewport width for rendering (default: 1920)
`delay_ms`	integer	opt.	Wait before capture in ms (0-30000)
`timeout_ms`	integer	opt.	Navigation timeout (default: 30000)
`block_ads`	boolean	opt.	Block ad networks
`block_cookie_banners`	boolean	opt.	Remove cookie consent banners
`inject_css`	string	opt.	Custom CSS to inject
`async`	boolean	opt.	Queue job and return immediately
`webhook_url`	string	opt.	Webhook URL for completion notification

Anfragebeispiele

# Basic PDF from URL
curl -s -X POST "https://link.yeb.to/v1/screenshot/capture-pdf" \
  -H "X-API-Key: YOUR_KEY" \
  -d "url=https://example.com&pdf_format=A4"

# Landscape PDF with custom margins and footer
curl -s -X POST "https://link.yeb.to/v1/screenshot/capture-pdf" \
  -H "X-API-Key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/report","pdf_format":"A4","pdf_orientation":"landscape","pdf_margins":{"top":"20mm","right":"15mm","bottom":"20mm","left":"15mm"},"pdf_footer":"<div style=\"text-align:center;font-size:10px\">Page <span class=\"pageNumber\"></span></div>"}'

API-Integrationen

curl -s -X POST "https://link.yeb.to/v1/screenshot/capture-pdf" \
  -H "X-API-Key: YOUR_KEY" \
  -d "url=https://example.com/report&pdf_format=A4&pdf_orientation=portrait&pdf_print_background=true"

use Illuminate\Support\Facades\Http;

$response = Http::asForm()->post('https://link.yeb.to/v1/screenshot/capture-pdf', [
    'api_key'              => config('services.yeb.key'),
    'url'                  => 'https://example.com/invoice',
    'pdf_format'           => 'A4',
    'pdf_orientation'      => 'portrait',
    'pdf_print_background' => true,
    'pdf_margins'          => ['top' => '20mm', 'bottom' => '20mm'],
]);

$data = $response->json();
// $data['url'] => PDF download URL

$ch = curl_init('https://link.yeb.to/v1/screenshot/capture-pdf');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query([
    'api_key'              => 'YOUR_KEY',
    'url'                  => 'https://example.com/invoice',
    'pdf_format'           => 'A4',
    'pdf_print_background' => true,
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);

const res = await fetch('https://link.yeb.to/v1/screenshot/capture-pdf', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_KEY',
    url: 'https://example.com/invoice',
    pdf_format: 'A4',
    pdf_print_background: true,
    pdf_margins: { top: '20mm', bottom: '20mm' }
  })
});
const data = await res.json();
console.log(data.url);

import requests

r = requests.post('https://link.yeb.to/v1/screenshot/capture-pdf', json={
    'api_key': 'YOUR_KEY',
    'url': 'https://example.com/invoice',
    'pdf_format': 'A4',
    'pdf_orientation': 'portrait',
    'pdf_print_background': True,
    'pdf_margins': {'top': '20mm', 'bottom': '20mm'},
})
data = r.json()
print(data['url'])

Response Example

{
  "success": true,
  "job_id": 12347,
  "url": "https://cdn.yeb.to/.../doc_abc.pdf",
  "format": "pdf",
  "file_size": 385210,
  "pages": 3,
  "response_code": 200,
  "response_time_ms": 4120
}

{
  "error": "Invalid pdf_format. Allowed: A4, A3, Letter, Legal.",
  "code": 400,
  "response_code": 400,
  "response_time_ms": 4
}

Antwortcodes

Code	Beschreibung
200 Success	Anfrage erfolgreich verarbeitet.
400 Bad Request	Eingabevalidierung fehlgeschlagen.
401 Unauthorized	Fehlender / falscher API-Schlüssel.
403 Forbidden	Schlüssel inaktiv oder nicht erlaubt.
429 Rate Limit	Zu viele Anfragen.
500 Server Error	Unerwarteter Fehler.

PDF Generation

screenshot-capture-pdf 0.1000 credits

Method

URL

Authentication

API Key

Parameters

API Key

body · string · required

URL

body · string

HTML

body · string

PDF Format

body · string

Orientation

body · string

Margins

body · string

Print Background

body · string

Header

body · string

Footer

body · string

Delay

body · string

Block Ads

body · string

Inject CSS

body · string

Async

body · string

Webhook URL

body · string

Code Samples

Response

Status: —

Headers

Body

Scrolling Video / GIF

POST https://link.yeb.to/v1/screenshot/capture-video

Generate a scrolling video or animated GIF of a webpage. The browser automatically scrolls through the page content, capturing each frame. Supports MP4, WebM, and GIF formats.

Parameter	Typ	Erf.	Beschreibung
`api_key`	string	ja	Your API key
`url`	string	ja	URL to capture
`format`	string	opt.	`mp4` (default) \| `webm` \| `gif`
`viewport_width`	integer	opt.	Viewport width (default: 1280)
`viewport_height`	integer	opt.	Viewport height (default: 720)
`scroll_speed`	string	opt.	`slow` \| `normal` (default) \| `fast`
`video_duration_ms`	integer	opt.	Max duration in ms (default: 10000, max: 60000)
`video_fps`	integer	opt.	Frames per second (default: 30)
`scroll_back`	boolean	opt.	Scroll back to top at end
`delay_ms`	integer	opt.	Wait before capture begins
`block_ads`	boolean	opt.	Block ad networks
`block_cookie_banners`	boolean	opt.	Remove cookie consent banners
`device`	string	opt.	Device preset (overrides viewport)
`async`	boolean	opt.	Queue job (recommended for videos)
`webhook_url`	string	opt.	Webhook URL for completion

Anfragebeispiele

# Scrolling MP4 video
curl -s -X POST "https://link.yeb.to/v1/screenshot/capture-video" \
  -H "X-API-Key: YOUR_KEY" \
  -d "url=https://example.com&format=mp4&scroll_speed=normal&async=true"

# Animated GIF (shorter)
curl -s -X POST "https://link.yeb.to/v1/screenshot/capture-video" \
  -H "X-API-Key: YOUR_KEY" \
  -d "url=https://example.com&format=gif&video_duration_ms=5000&video_fps=15"

API-Integrationen

curl -s -X POST "https://link.yeb.to/v1/screenshot/capture-video" \
  -H "X-API-Key: YOUR_KEY" \
  -d "url=https://example.com&format=mp4&scroll_speed=normal&async=true"

const res = await fetch('https://link.yeb.to/v1/screenshot/capture-video', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_KEY',
    url: 'https://example.com',
    format: 'mp4',
    scroll_speed: 'normal',
    video_fps: 30,
    async: true
  })
});
const { job_id } = await res.json();
// Poll /status with job_id

import requests, time

r = requests.post('https://link.yeb.to/v1/screenshot/capture-video', data={
    'api_key': 'YOUR_KEY',
    'url': 'https://example.com',
    'format': 'mp4',
    'scroll_speed': 'normal',
    'async': True,
})
job_id = r.json()['job_id']

# Poll for completion
while True:
    s = requests.post('https://link.yeb.to/v1/screenshot/status',
        data={'api_key': 'YOUR_KEY', 'job_id': job_id})
    if s.json()['status'] == 'completed':
        print(s.json()['url'])
        break
    time.sleep(2)

Response Example

{
  "success": true,
  "job_id": 12348,
  "status": "queued",
  "message": "Video capture job queued",
  "response_code": 200
}

{
  "success": true,
  "job_id": 12348,
  "url": "https://cdn.yeb.to/.../vid_abc.mp4",
  "format": "mp4",
  "file_size": 2456789,
  "duration_ms": 10000,
  "frame_count": 300,
  "response_code": 200,
  "response_time_ms": 15400
}

{
  "error": "Video duration exceeds maximum (60000 ms).",
  "code": 400,
  "response_code": 400,
  "response_time_ms": 5
}

Video capture is resource-intensive. Use async=true and poll via /status or set a webhook_url.

Antwortcodes

Code	Beschreibung
200 Success	Anfrage erfolgreich verarbeitet.
400 Bad Request	Eingabevalidierung fehlgeschlagen.
401 Unauthorized	Fehlender / falscher API-Schlüssel.
403 Forbidden	Schlüssel inaktiv oder nicht erlaubt.
429 Rate Limit	Zu viele Anfragen.
500 Server Error	Unerwarteter Fehler.

Scrolling Video / GIF

screenshot-capture-video 0.5000 credits

Method

URL

Authentication

API Key

Parameters

API Key

body · string · required

URL

body · string · required

Format

body · string

Viewport Width

body · string

Viewport Height

body · string

Scroll Speed

body · string

Duration

body · string

FPS

body · string

Scroll Back

body · string

Device

body · string

Block Ads

body · string

Block Cookies

body · string

Async

body · string

Webhook URL

body · string

Code Samples

Response

Status: —

Headers

Body

Bulk Screenshots

POST https://link.yeb.to/v1/screenshot/bulk
POST https://link.yeb.to/v1/screenshot/bulk-status

Capture screenshots of multiple URLs in a single request (up to 50). Each URL is processed in parallel. Use bulk-status to poll progress or set a webhook_url.

Bulk Create

Parameter	Typ	Erf.	Beschreibung
`api_key`	string	ja	Your API key
`urls`	array	ja	Array of URL objects (max 50). Each: `{url, format?, viewport_width?, device?}`
`default_settings`	object	opt.	Default settings applied to all URLs
`webhook_url`	string	opt.	Webhook URL when all items complete

Bulk Status

Parameter	Typ	Erf.	Beschreibung
`api_key`	string	ja	Your API key
`bulk_job_id`	integer	ja	Bulk job ID from the create response

Anfragebeispiele

# Create bulk job
curl -s -X POST "https://link.yeb.to/v1/screenshot/bulk" \
  -H "X-API-Key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"urls":[{"url":"https://site1.com"},{"url":"https://site2.com"},{"url":"https://site3.com"}],"default_settings":{"block_ads":true,"format":"png"}}'

# Check bulk status
curl -s -X POST "https://link.yeb.to/v1/screenshot/bulk-status" \
  -H "X-API-Key: YOUR_KEY" \
  -d "bulk_job_id=789"

API-Integrationen

const res = await fetch('https://link.yeb.to/v1/screenshot/bulk', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_KEY',
    urls: [
      { url: 'https://site1.com', format: 'png' },
      { url: 'https://site2.com', device: 'iphone-15' },
    ],
    default_settings: { block_ads: true }
  })
});
const { bulk_job_id } = await res.json();

// Poll status
const status = await fetch('https://link.yeb.to/v1/screenshot/bulk-status', {
  method: 'POST',
  headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
  body: `api_key=YOUR_KEY&bulk_job_id=${bulk_job_id}`
}).then(r => r.json());

import requests, time

# Create bulk job
r = requests.post('https://link.yeb.to/v1/screenshot/bulk', json={
    'api_key': 'YOUR_KEY',
    'urls': [
        {'url': 'https://site1.com'},
        {'url': 'https://site2.com'},
        {'url': 'https://site3.com'},
    ],
    'default_settings': {'block_ads': True, 'format': 'png'},
})
bulk_id = r.json()['bulk_job_id']

# Poll until done
while True:
    s = requests.post('https://link.yeb.to/v1/screenshot/bulk-status',
        data={'api_key': 'YOUR_KEY', 'bulk_job_id': bulk_id})
    data = s.json()
    if data['status'] == 'completed':
        for item in data['items']:
            print(item['url'], item['screenshot_url'])
        break
    time.sleep(3)

use Illuminate\Support\Facades\Http;

$response = Http::post('https://link.yeb.to/v1/screenshot/bulk', [
    'api_key' => config('services.yeb.key'),
    'urls' => [
        ['url' => 'https://site1.com', 'format' => 'png'],
        ['url' => 'https://site2.com', 'device' => 'iphone-15'],
    ],
    'default_settings' => ['block_ads' => true],
]);

$bulkJobId = $response->json('bulk_job_id');

Response Examples

{
  "success": true,
  "bulk_job_id": 789,
  "status": "processing",
  "total_urls": 3,
  "message": "Bulk job created",
  "response_code": 200
}

{
  "success": true,
  "bulk_job_id": 789,
  "status": "completed",
  "total": 3,
  "completed": 3,
  "failed": 0,
  "items": [
    {
      "url": "https://site1.com",
      "status": "completed",
      "screenshot_url": "https://cdn.yeb.to/.../ss_1.png"
    },
    {
      "url": "https://site2.com",
      "status": "completed",
      "screenshot_url": "https://cdn.yeb.to/.../ss_2.png"
    }
  ],
  "response_code": 200
}

{
  "error": "Maximum 50 URLs allowed per bulk request.",
  "code": 400,
  "response_code": 400,
  "response_time_ms": 4
}

Antwortcodes

Code	Beschreibung
200 Success	Anfrage erfolgreich verarbeitet.
400 Bad Request	Eingabevalidierung fehlgeschlagen.
401 Unauthorized	Fehlender / falscher API-Schlüssel.
403 Forbidden	Schlüssel inaktiv oder nicht erlaubt.
429 Rate Limit	Zu viele Anfragen.
500 Server Error	Unerwarteter Fehler.

Bulk Screenshots

screenshot-bulk 0.0400 credits

Method

URL

Authentication

API Key

Parameters

API Key

body · string · required

URLs

body · string · required

Default Settings

body · string

Webhook URL

body · string

Code Samples

Response

Status: —

Headers

Body

Scheduled Screenshots

POST https://link.yeb.to/v1/screenshot/schedule-create
POST https://link.yeb.to/v1/screenshot/schedule-update
POST https://link.yeb.to/v1/screenshot/schedule-delete
POST https://link.yeb.to/v1/screenshot/schedule-list
POST https://link.yeb.to/v1/screenshot/schedule-run

Create recurring screenshot schedules with cron expressions. Supports automatic visual change detection with configurable thresholds and email notifications when changes exceed the threshold.

Create Schedule

Parameter	Typ	Erf.	Beschreibung
`api_key`	string	ja	Your API key
`name`	string	ja	Schedule name (max 255 chars)
`url`	string	ja	URL to capture on schedule
`cron_expression`	string	ja	Cron expression (e.g. `0 9 * * *` = daily 9 AM)
`timezone`	string	opt.	IANA timezone (default: UTC)
`screenshot_settings`	object	opt.	Screenshot settings (viewport, format, blocking, etc.)
`detect_changes`	boolean	opt.	Enable visual change detection
`change_threshold`	number	opt.	Change threshold % (default: 1.0)
`notify_on_change`	boolean	opt.	Send email when changes detected
`notify_email`	string	opt.	Email for change notifications

Update / Delete / Run

Parameter	Typ	Erf.	Beschreibung
`api_key`	string	ja	Your API key
`schedule_id`	integer	ja	Schedule ID
`is_active`	boolean	opt.	Pause/resume schedule (update only)

Anfragebeispiele

# Create daily schedule with change detection
curl -s -X POST "https://link.yeb.to/v1/screenshot/schedule-create" \
  -H "X-API-Key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Daily Homepage Check","url":"https://mysite.com","cron_expression":"0 9 * * *","timezone":"Europe/Sofia","detect_changes":true,"change_threshold":5.0,"notify_on_change":true,"notify_email":"[email protected]","screenshot_settings":{"full_page":true,"block_ads":true}}'

# List all schedules
curl -s -X POST "https://link.yeb.to/v1/screenshot/schedule-list" \
  -H "X-API-Key: YOUR_KEY"

# Trigger manual run
curl -s -X POST "https://link.yeb.to/v1/screenshot/schedule-run" \
  -H "X-API-Key: YOUR_KEY" \
  -d "schedule_id=123"

Cron Expression Reference

Expression	Description
`/5 * * *`	Every 5 minutes
`0 * * * *`	Every hour
`0 9 * * *`	Daily at 9:00 AM
`0 9 * * 1-5`	Weekdays at 9:00 AM
`0 0 * * 0`	Weekly (Sunday midnight)
`0 0 1 * *`	Monthly (1st at midnight)

Response Examples

{
  "success": true,
  "schedule_id": 123,
  "name": "Daily Homepage Check",
  "cron_expression": "0 9 * * *",
  "next_run_at": "2026-02-07T09:00:00Z",
  "is_active": true,
  "response_code": 200
}

{
  "success": true,
  "schedules": [
    {
      "id": 123,
      "name": "Daily Homepage Check",
      "url": "https://mysite.com",
      "cron_expression": "0 9 * * *",
      "is_active": true,
      "last_run_at": "2026-02-06T09:00:00Z",
      "next_run_at": "2026-02-07T09:00:00Z",
      "run_count": 45,
      "detect_changes": true
    }
  ],
  "response_code": 200
}

{
  "error": "Invalid cron expression.",
  "code": 400,
  "response_code": 400,
  "response_time_ms": 3
}

Antwortcodes

Code	Beschreibung
200 Success	Anfrage erfolgreich verarbeitet.
400 Bad Request	Eingabevalidierung fehlgeschlagen.
401 Unauthorized	Fehlender / falscher API-Schlüssel.
403 Forbidden	Schlüssel inaktiv oder nicht erlaubt.
429 Rate Limit	Zu viele Anfragen.
500 Server Error	Unerwarteter Fehler.

Scheduled Screenshots

screenshot-schedule-create 0.1000 credits

Method

URL

Authentication

API Key

Parameters

API Key

body · string · required

Name

body · string · required

URL

body · string · required

Cron Expression

body · string · required

Timezone

body · string

Settings

body · string

Detect Changes

body · string

Threshold

body · string

Notify

body · string

Code Samples

Response

Status: —

Headers

Body

Visual Diff

POST https://link.yeb.to/v1/screenshot/diff
POST https://link.yeb.to/v1/screenshot/diff-status

Compare two screenshots pixel-by-pixel. Returns a diff image highlighting changed regions, the difference percentage, changed pixel count, and bounding boxes of changed areas.

Create Diff

Parameter	Typ	Erf.	Beschreibung
`api_key`	string	ja	Your API key
`job_a_id`	integer	ja	First screenshot job ID (before)
`job_b_id`	integer	ja	Second screenshot job ID (after)
`webhook_url`	string	opt.	Webhook URL for completion

Diff Status

Parameter	Typ	Erf.	Beschreibung
`api_key`	string	ja	Your API key
`diff_id`	integer	ja	Diff ID from the create response

Anfragebeispiele

# Compare two screenshots
curl -s -X POST "https://link.yeb.to/v1/screenshot/diff" \
  -H "X-API-Key: YOUR_KEY" \
  -d "job_a_id=12345&job_b_id=12346"

# Check diff status
curl -s -X POST "https://link.yeb.to/v1/screenshot/diff-status" \
  -H "X-API-Key: YOUR_KEY" \
  -d "diff_id=567"

API-Integrationen

// Take two screenshots, then compare
const shot1 = await fetch('https://link.yeb.to/v1/screenshot/capture', {
  method: 'POST',
  headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
  body: 'api_key=YOUR_KEY&url=https://site.com&format=png'
}).then(r => r.json());

// ... some time later, take second screenshot ...

const diff = await fetch('https://link.yeb.to/v1/screenshot/diff', {
  method: 'POST',
  headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
  body: `api_key=YOUR_KEY&job_a_id=${shot1.job_id}&job_b_id=${shot2.job_id}`
}).then(r => r.json());

console.log(`${diff.difference_percent}% changed`);
console.log(diff.diff_image_url);

import requests

r = requests.post('https://link.yeb.to/v1/screenshot/diff', data={
    'api_key': 'YOUR_KEY',
    'job_a_id': 12345,
    'job_b_id': 12346,
})
data = r.json()
print(f"Difference: {data['difference_percent']}%")
print(f"Changed pixels: {data['changed_pixels']}")
print(f"Diff image: {data['diff_image_url']}")

$ch = curl_init('https://link.yeb.to/v1/screenshot/diff');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query([
    'api_key'  => 'YOUR_KEY',
    'job_a_id' => 12345,
    'job_b_id' => 12346,
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);

echo "Difference: {$result['difference_percent']}%";

Response Example

{
  "success": true,
  "diff_id": 567,
  "status": "completed",
  "difference_percent": 3.45,
  "changed_pixels": 15234,
  "diff_image_url": "https://cdn.yeb.to/.../diff-567.png",
  "diff_regions": [
    {
      "x": 100,
      "y": 200,
      "width": 300,
      "height": 150
    }
  ],
  "response_code": 200
}

{
  "error": "Both screenshots must be image format (png/jpg/webp).",
  "code": 400,
  "response_code": 400,
  "response_time_ms": 5
}

Antwortcodes

Code	Beschreibung
200 Success	Anfrage erfolgreich verarbeitet.
400 Bad Request	Eingabevalidierung fehlgeschlagen.
401 Unauthorized	Fehlender / falscher API-Schlüssel.
403 Forbidden	Schlüssel inaktiv oder nicht erlaubt.
429 Rate Limit	Zu viele Anfragen.
500 Server Error	Unerwarteter Fehler.

Visual Diff

screenshot-diff 0.1000 credits

Method

URL

Authentication

API Key

Parameters

API Key

body · string · required

Job A ID

body · string · required

Job B ID

body · string · required

Webhook URL

body · string

Code Samples

Response

Status: —

Headers

Body

Job Status & Download

POST https://link.yeb.to/v1/screenshot/status
POST https://link.yeb.to/v1/screenshot/download

Check the status of any screenshot job (single, bulk, video). The /status endpoint returns the current state, output URL, progress, and metadata. The /download endpoint returns the raw file. Both endpoints are free (0 credits).

Job Status

Parameter	Typ	Erf.	Beschreibung
`api_key`	string	ja	Your API key
`job_id`	integer	ja	Screenshot job ID

Download File

Parameter	Typ	Erf.	Beschreibung
`api_key`	string	ja	Your API key
`job_id`	integer	ja	Screenshot job ID

Anfragebeispiele

# Check job status
curl -s -X POST "https://link.yeb.to/v1/screenshot/status" \
  -H "X-API-Key: YOUR_KEY" \
  -d "job_id=12345"

# Download screenshot file
curl -s -X POST "https://link.yeb.to/v1/screenshot/download" \
  -H "X-API-Key: YOUR_KEY" \
  -d "job_id=12345" -o screenshot.png

Async Polling Pattern

// 1. Start async capture
const { job_id } = await startCapture({ url: '...', async: true });

// 2. Poll until done
let result;
do {
  await new Promise(r => setTimeout(r, 2000)); // wait 2s
  result = await checkStatus(job_id);
} while (['pending', 'queued', 'capturing', 'processing'].includes(result.status));

// 3. Use the result
if (result.status === 'completed') {
  console.log('Screenshot URL:', result.url);
}

Response Examples

{
  "success": true,
  "job_id": 12345,
  "status": "completed",
  "url": "https://cdn.yeb.to/.../ss_abc.png",
  "thumbnail_url": "https://cdn.yeb.to/.../thumb.jpg",
  "width": 1920,
  "height": 1080,
  "format": "png",
  "file_size": 245678,
  "progress": 100,
  "created_at": "2026-02-06T12:00:00Z",
  "completed_at": "2026-02-06T12:00:03Z",
  "response_code": 200
}

{
  "success": true,
  "job_id": 12345,
  "status": "capturing",
  "progress": 45,
  "message": "Capturing screenshot...",
  "response_code": 200
}

{
  "success": true,
  "job_id": 12345,
  "status": "failed",
  "error": "Navigation timeout exceeded (30000 ms)",
  "response_code": 200
}

Free endpoint — Status checks cost 0 credits.

Antwortcodes

Code	Beschreibung
200 Success	Anfrage erfolgreich verarbeitet.
400 Bad Request	Eingabevalidierung fehlgeschlagen.
401 Unauthorized	Fehlender / falscher API-Schlüssel.
403 Forbidden	Schlüssel inaktiv oder nicht erlaubt.
429 Rate Limit	Zu viele Anfragen.
500 Server Error	Unerwarteter Fehler.

Job Status

screenshot-status 0.0000 credits

Method

URL

Authentication

API Key

Parameters

API Key

body · string · required

Job ID

body · string · required

Code Samples

Response

Status: —

Headers

Body

Performance Metrics

POST https://link.yeb.to/v1/screenshot/metrics

Capture Core Web Vitals and performance metrics for any URL. Returns LCP, FCP, CLS, FID, TTI, and resource loading statistics. Use alongside screenshots for performance monitoring.

Parameter	Typ	Erf.	Beschreibung
`api_key`	string	ja	Your API key
`url`	string	ja	URL to measure (or use `job_id`)
`job_id`	integer	opt.	Existing job ID (returns cached metrics if available)
`device`	string	opt.	Device preset for emulation
`viewport_width`	integer	opt.	Viewport width (default: 1920)

Anfragebeispiele

# Measure page performance
curl -s -X POST "https://link.yeb.to/v1/screenshot/metrics" \
  -H "X-API-Key: YOUR_KEY" \
  -d "url=https://example.com"

# Mobile performance test
curl -s -X POST "https://link.yeb.to/v1/screenshot/metrics" \
  -H "X-API-Key: YOUR_KEY" \
  -d "url=https://example.com&device=iphone-15"

Metrics Reference

Metric	Description	Good
`lcp`	Largest Contentful Paint (ms)	< 2500ms
`fcp`	First Contentful Paint (ms)	< 1800ms
`cls`	Cumulative Layout Shift	< 0.1
`fid`	First Input Delay (ms)	< 100ms
`tti`	Time to Interactive (ms)	< 3800ms
`total_blocking_time`	Total Blocking Time (ms)	< 200ms

Response Example

{
  "success": true,
  "url": "https://example.com",
  "metrics": {
    "lcp": 1234,
    "fcp": 567,
    "cls": 0.05,
    "fid": 12,
    "tti": 2345,
    "total_blocking_time": 89,
    "dom_content_loaded": 890,
    "load_event": 1456,
    "resources": {
      "total": 45,
      "total_size": 2456789,
      "by_type": {
        "script": 12,
        "stylesheet": 5,
        "image": 18,
        "font": 4,
        "other": 6
      }
    }
  },
  "response_code": 200
}

{
  "error": "URL or job_id is required.",
  "code": 400,
  "response_code": 400,
  "response_time_ms": 3
}

Antwortcodes

Code	Beschreibung
200 Success	Anfrage erfolgreich verarbeitet.
400 Bad Request	Eingabevalidierung fehlgeschlagen.
401 Unauthorized	Fehlender / falscher API-Schlüssel.
403 Forbidden	Schlüssel inaktiv oder nicht erlaubt.
429 Rate Limit	Zu viele Anfragen.
500 Server Error	Unerwarteter Fehler.

Performance Metrics

screenshot-metrics 0.0500 credits

Method

URL

Authentication

API Key

Parameters

API Key

body · string · required

Job ID

body · string · required

Code Samples

Response

Status: —

Headers

Body

OCR & Text Extraction

POST https://link.yeb.to/v1/screenshot/ocr
POST https://link.yeb.to/v1/screenshot/extract-html
POST https://link.yeb.to/v1/screenshot/extract-text

Extract text from screenshots using OCR (Tesseract), or extract the DOM HTML / visible text directly from the page. OCR supports 11 languages with word-level bounding boxes.

OCR (from screenshot image)

Parameter	Typ	Erf.	Beschreibung
`api_key`	string	ja	Your API key
`job_id`	integer	ja	Completed screenshot job ID
`language`	string	opt.	OCR language (default: `eng`)

Extract HTML / Text (from page DOM)

Parameter	Typ	Erf.	Beschreibung
`api_key`	string	ja	Your API key
`job_id`	integer	ja	Completed screenshot job ID

Supported OCR Languages

eng — English
bul — Bulgarian
deu — German
fra — French

spa — Spanish
ita — Italian
por — Portuguese
rus — Russian

jpn — Japanese
kor — Korean
chi_sim — Chinese (Simplified)

Anfragebeispiele

# Extract text from screenshot via OCR
curl -s -X POST "https://link.yeb.to/v1/screenshot/ocr" \
  -H "X-API-Key: YOUR_KEY" \
  -d "job_id=12345&language=eng"

# Extract page HTML
curl -s -X POST "https://link.yeb.to/v1/screenshot/extract-html" \
  -H "X-API-Key: YOUR_KEY" \
  -d "job_id=12345"

# Extract visible text
curl -s -X POST "https://link.yeb.to/v1/screenshot/extract-text" \
  -H "X-API-Key: YOUR_KEY" \
  -d "job_id=12345"

Response Examples

{
  "success": true,
  "text": "Welcome to Example.com\nThis is a sample page...",
  "confidence": 0.95,
  "language": "eng",
  "blocks": [
    {
      "text": "Welcome",
      "confidence": 0.98,
      "bbox": {
        "x": 10, "y": 10,
        "width": 200, "height": 30
      }
    }
  ],
  "response_code": 200
}

{
  "success": true,
  "html": "<!DOCTYPE html>\n<html>...",
  "size": 45678,
  "response_code": 200
}

{
  "success": true,
  "text": "Welcome to Example.com\n\nThis is a sample page with content...",
  "word_count": 156,
  "response_code": 200
}

Antwortcodes

Code	Beschreibung
200 Success	Anfrage erfolgreich verarbeitet.
400 Bad Request	Eingabevalidierung fehlgeschlagen.
401 Unauthorized	Fehlender / falscher API-Schlüssel.
403 Forbidden	Schlüssel inaktiv oder nicht erlaubt.
429 Rate Limit	Zu viele Anfragen.
500 Server Error	Unerwarteter Fehler.

OCR Text Extraction

screenshot-ocr 0.2000 credits

Method

URL

Authentication

API Key

Parameters

API Key

body · string · required

Job ID

body · string · required

Language

body · string

Code Samples

Response

Status: —

Headers

Body

Device Presets

POST https://link.yeb.to/v1/screenshot/devices

List all available device presets. Use the device parameter in capture endpoints to automatically set viewport dimensions, pixel density, and user agent. This endpoint is free (0 credits).

Parameter	Typ	Erf.	Beschreibung
`api_key`	string	ja	Your API key
`category`	string	opt.	Filter by category: `mobile`, `tablet`, `desktop`

Anfragebeispiele

# List all devices
curl -s -X POST "https://link.yeb.to/v1/screenshot/devices" \
  -H "X-API-Key: YOUR_KEY"

Available Devices

Mobile

iphone-15-pro-max 430x932 @3x
iphone-15-pro 393x852 @3x
iphone-15 393x852 @3x
iphone-14 390x844 @3x
iphone-se 375x667 @2x
pixel-8-pro 412x915 @3.5x
pixel-8 412x915 @2.6x
galaxy-s24-ultra 412x915 @3.5x
galaxy-s24 360x780 @3x

Tablet

ipad-pro-12.9 1024x1366 @2x
ipad-pro-11 834x1194 @2x
ipad-air 820x1180 @2x
ipad-mini 768x1024 @2x
galaxy-tab-s9 800x1280 @2x

Desktop

desktop-1080p 1920x1080
desktop-1440p 2560x1440
desktop-4k 3840x2160
macbook-pro-16 1728x1117 @2x
macbook-air-15 1710x1112 @2x

Usage Example

# iPhone 15 screenshot
curl -s -X POST \
  "https://link.yeb.to/v1/screenshot/capture" \
  -H "X-API-Key: YOUR_KEY" \
  -d "url=https://example.com\
&device=iphone-15"

# iPad Pro screenshot
curl -s -X POST \
  "https://link.yeb.to/v1/screenshot/capture" \
  -H "X-API-Key: YOUR_KEY" \
  -d "url=https://example.com\
&device=ipad-pro-12.9"

Response Example

{
  "success": true,
  "devices": {
    "mobile": [
      {
        "id": "iphone-15-pro-max",
        "name": "iPhone 15 Pro Max",
        "width": 430,
        "height": 932,
        "scale": 3,
        "user_agent": "Mozilla/5.0 (iPhone...)"
      },
      {
        "id": "iphone-15",
        "name": "iPhone 15",
        "width": 393,
        "height": 852,
        "scale": 3
      }
    ],
    "tablet": [
      {
        "id": "ipad-pro-12.9",
        "name": "iPad Pro 12.9",
        "width": 1024,
        "height": 1366,
        "scale": 2
      }
    ],
    "desktop": [
      {
        "id": "desktop-1080p",
        "name": "Desktop 1080p",
        "width": 1920,
        "height": 1080,
        "scale": 1
      }
    ]
  },
  "response_code": 200
}

Free endpoint — Device list costs 0 credits.

Antwortcodes

Code	Beschreibung
200 Success	Anfrage erfolgreich verarbeitet.
400 Bad Request	Eingabevalidierung fehlgeschlagen.
401 Unauthorized	Fehlender / falscher API-Schlüssel.
403 Forbidden	Schlüssel inaktiv oder nicht erlaubt.
429 Rate Limit	Zu viele Anfragen.
500 Server Error	Unerwarteter Fehler.

Device Presets

screenshot-devices 0.0000 credits

Method

URL

Authentication

API Key

Parameters

API Key

body · string · required

Code Samples

Response

Status: —

Headers

Body

Screenshot API — Practical Guide

A comprehensive guide to the Screenshot API: capture URLs and HTML as images or PDFs; process bulk batches; schedule recurring captures with visual change detection; and compare screenshots with pixel-level diffs.

Last updated: 07 Mär 2026, 11:51 API Version: v1 Burst: 20 req/s Latency: 4164.3 ms Cost: 0.05 credits/req

#What the Screenshot API does

The Screenshot API turns any URL or HTML into a high-quality image or PDF. It handles viewport emulation, device presets, ad/cookie blocking, CSS/JS injection, watermarks, and more — so you don't have to manage browser infrastructure yourself.

20+ device presets — iPhone, iPad, Pixel, Galaxy, MacBook, desktop resolutions.
Sync & async modes — get results immediately or queue jobs and poll for status.
Visual monitoring — schedule captures and get email alerts when pages change visually.
Webhooks — receive POST notifications when async jobs complete.

#Endpoints & actions

Endpoint	Description
`capture`	URL screenshot (PNG/JPG/WebP) with device emulation, blocking, watermarks.
`capture-html`	Render custom HTML as an image.
`capture-pdf`	Generate PDF from URL or HTML with page settings.
`bulk`	Capture multiple URLs (up to 50) in one request.
`schedule-*`	Create/update/delete/list/run scheduled captures.
`diff`	Pixel-level visual comparison between two screenshots.
`metrics`	Core Web Vitals (LCP, FCP, CLS, TTI).
`status` / `download`	Check job status or download the output file.
`devices`	List all available device presets.

#Quick start examples

#Basic screenshot

curl -s -X POST "https://link.yeb.to/v1/screenshot/capture" \
  -H "X-API-Key: YOUR_KEY" \
  -d "url=https://example.com&format=png"

#Mobile device screenshot

curl -s -X POST "https://link.yeb.to/v1/screenshot/capture" \
  -H "X-API-Key: YOUR_KEY" \
  -d "url=https://example.com&device=iphone-15&full_page=true"

#Clean capture with blocking

curl -s -X POST "https://link.yeb.to/v1/screenshot/capture" \
  -H "X-API-Key: YOUR_KEY" \
  -d "url=https://news-site.com&block_ads=true&block_cookie_banners=true&block_chat_widgets=true&block_tracking=true"

#Async capture with webhook

curl -s -X POST "https://link.yeb.to/v1/screenshot/capture" \
  -H "X-API-Key: YOUR_KEY" \
  -d "url=https://example.com&async=true&webhook_url=https://yoursite.com/webhook"

# Response: {"success":true,"job_id":12345,"status":"queued"}
# Your webhook will receive a POST when the job completes.

#Key parameters explained

#Viewport & device

viewport_width / viewport_height — Set exact dimensions (320-3840 x 200-2160).
device — Use a preset like iphone-15 to auto-set viewport, pixel density, and user agent. Overrides manual viewport settings.
full_page — Capture the entire scrollable page, not just the visible viewport. Adds 0.03 credits.
retina — Render at 2x pixel density for sharp images. Adds 0.03 credits.

#Blocking options

block_ads — Blocks requests to known ad networks (Google Ads, DoubleClick, etc.).
block_cookie_banners — Removes common cookie consent overlays (OneTrust, CookieBot, etc.).
block_chat_widgets — Hides Intercom, Drift, Zendesk, and other chat widgets.
block_tracking — Blocks analytics and tracking scripts (Google Analytics, Facebook Pixel, etc.).

#Element targeting

selector — Capture only a specific CSS element (e.g. #hero-section).
click_selectors — Click elements before capture (accept cookies, close popups).
blur_selectors — Apply CSS blur to sensitive content.
remove_selectors — Remove elements entirely from the DOM.

#Output format

Images: png (default, lossless), jpg (smaller), webp (best compression).
Documents: pdf — with page format, orientation, margins, headers/footers.
quality — 1-100 for JPG/WebP (default: 80). Higher = larger file, better quality.
thumbnail_width — Auto-generate a thumbnail (50-800px wide).

#Async mode & webhooks

For heavy operations (bulk jobs, PDF generation), use async=true to queue the job. You have two options to get the result:

Polling: Call /status with the job_id every 2-5 seconds until status is completed or failed.
Webhook: Set webhook_url and your server will receive a POST with the full result when the job finishes. Includes retry logic (3 attempts).

// Webhook payload example
{
  "event": "screenshot.completed",
  "job_id": 12345,
  "status": "completed",
  "url": "https://cdn.yeb.to/.../screenshot.png",
  "file_size": 245678,
  "timestamp": "2026-02-06T12:00:03Z"
}

#Bulk screenshot processing

Send up to 50 URLs in a single /bulk request. Each URL can have individual settings, plus you can set default_settings applied to all. URLs are processed in parallel.

curl -s -X POST "https://link.yeb.to/v1/screenshot/bulk" \
  -H "X-API-Key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "urls": [
      {"url": "https://site1.com", "device": "iphone-15"},
      {"url": "https://site2.com", "format": "jpg", "quality": 90},
      {"url": "https://site3.com"}
    ],
    "default_settings": {
      "block_ads": true,
      "full_page": true
    }
  }'

#Scheduled captures & visual monitoring

Create automated schedules to capture pages at any frequency. Enable change detection to compare each capture with the previous one. When the visual difference exceeds your threshold, you get an email alert.

curl -s -X POST "https://link.yeb.to/v1/screenshot/schedule-create" \
  -H "X-API-Key: YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Daily Homepage Check",
    "url": "https://mysite.com",
    "cron_expression": "daily",
    "timezone": "Europe/Sofia",
    "detect_changes": true,
    "change_threshold": 5.0,
    "notify_on_change": true,
    "notify_email": "[email protected]",
    "screenshot_settings": {
      "full_page": true,
      "block_ads": true
    }
  }'

#Visual diff comparison

Compare any two completed screenshot jobs. The API generates a diff image highlighting changed pixels in red, and returns the difference percentage and bounding boxes of changed regions.

difference_percent — 0.00 means identical, 100.00 means completely different.
diff_regions — Array of {x, y, width, height} bounding boxes for changed areas.
diff_image_url — A PNG overlay showing changes in red against a dimmed background.

#Credit pricing breakdown

Each action has a base credit cost. Modifiers like full_page, retina, and 4K viewports add to the base. Check the endpoint documentation for exact pricing. Status, device list, and schedule list endpoints are free.

#Troubleshooting & tips

Timeouts: Increase timeout_ms for slow pages (max 60000). Use delay_ms to wait for lazy-loaded content.
Blank screenshots: Some SPAs need delay_ms=2000 or more. Try lazy_load=true for infinite scroll pages.
Cookie walls: Use click_selectors=["#accept-cookies"] to auto-accept consent dialogs before capture.
Large pages: Full-page captures of very long pages may take 10+ seconds. Use async=true for reliability.
Watermarks: Add text watermarks via the watermark parameter with custom position and opacity.
Rate limits: Default burst is 10 req/s. For bulk operations, use the /bulk endpoint instead of parallel single requests.

#API Changelog

2026-02-06

First public v1 release of Screenshot API with capture, capture-html, capture-pdf, bulk, schedule, diff, metrics, status, download, and devices endpoints.

Häufig gestellte Fragen

Sie können Screenshots als PNG, JPG oder WebP erfassen. Die PDF-Generierung unterstützt A4, A3, Letter und Legal mit benutzerdefinierten Rändern, Kopf- und Fußzeilen.

Wenn full_page aktiviert ist, scrollt der Browser zum Seitenende und erfasst die gesamte Dokumenthöhe. Für Seiten mit verzögert geladenem Inhalt kombinieren Sie mit lazy_load=true, damit Bilder und Elemente beim Scrollen ausgelöst werden.

Ja. Übergeben Sie eine Gerätevoreinstellung (z.B. iphone-15, ipad-pro-12.9, galaxy-s24-ultra) und die API setzt automatisch den korrekten Viewport, die Pixeldichte und den User Agent. Verwenden Sie den /devices-Endpoint für eine Liste aller Voreinstellungen.

Sie können Werbung, Cookie-Zustimmungsbanner, Chat-Widgets, Tracking-Skripte, JavaScript, CSS, Bilder, Medien und Schriftarten blockieren. Sie können auch benutzerdefinierte URL-Muster angeben, um bestimmte Ressourcen zu blockieren.

Eine einzelne Massenanfrage akzeptiert bis zu 50 URLs. Jede URL wird parallel verarbeitet und Sie können den bulk-status-Endpoint abfragen oder einen Webhook einrichten, um benachrichtigt zu werden, wenn alle Erfassungen abgeschlossen sind.

Erstellen Sie einen Zeitplan mit einer Frequenz (stündlich, täglich, wöchentlich usw.). Die API führt die Erfassung automatisch aus und kann aufeinanderfolgende Läufe vergleichen, um visuelle Änderungen über einem konfigurierbaren Schwellenwert zu erkennen.

Der Diff-Endpoint vergleicht zwei Screenshots Pixel für Pixel und gibt den Differenzprozentsatz, die Anzahl geänderter Pixel, betroffene Bereiche und ein hervorgehobenes Diff-Bild zurück. Kombinieren Sie mit Zeitplänen für automatisiertes visuelles Regressionsmonitoring.

Jede Aktion hat einen Basis-Credit-Preis. Modifikatoren wie full_page, retina und 4K werden zum Basispreis hinzuaddiert. Status-, Gerätelisten- und Zeitplanlisten-Endpoints sind kostenlos. Genaue Werte finden Sie in der Endpoint-Dokumentation.

Standardmäßig laufen Erfassungen synchron und geben das Ergebnis direkt zurück. Setzen Sie async=true, um den Job in die Warteschlange zu stellen und sofort eine job_id zu erhalten. Fragen Sie den /status-Endpoint ab oder geben Sie eine webhook_url an, um benachrichtigt zu werden, wenn die Erfassung bereit ist.

Ja. Jede Anfrage, auch solche mit Fehlern, verbraucht Credits. Ihre Credits sind an die Anzahl der Anfragen gebunden, unabhängig von Erfolg oder Misserfolg. Wenn der Fehler eindeutig auf ein Plattformproblem unsererseits zurückzuführen ist, stellen wir die betroffenen Credits wieder her (keine Barerstattung).

Kontaktieren Sie uns unter [email protected]. Wir nehmen Feedback ernst—wenn Ihr Fehlerbericht oder Ihre Funktionsanfrage sinnvoll ist, können wir die API schnell korrigieren oder verbessern und Ihnen 50 kostenlose Credits als Dankeschön gewähren.

Es hängt von der API und manchmal sogar vom Endpoint ab. Einige Endpoints nutzen Daten aus externen Quellen, die strengere Limits haben können. Wir setzen auch Limits durch, um Missbrauch zu verhindern und unsere Plattform stabil zu halten. Prüfen Sie die Dokumentation für das spezifische Limit jedes Endpoints.

Wir arbeiten mit einem Creditsystem. Credits sind vorausbezahlte, nicht erstattungsfähige Einheiten, die Sie für API-Aufrufe und Tools ausgeben. Credits werden nach dem FIFO-Prinzip (älteste zuerst) verbraucht und sind 12 Monate ab Kaufdatum gültig. Das Dashboard zeigt jedes Kaufdatum und dessen Ablauf an.

Ja. Alle gekauften Credits (einschließlich Teilguthaben) sind 12 Monate ab Kauf gültig. Ungenutzte Credits verfallen automatisch und werden am Ende der Gültigkeitsdauer dauerhaft gelöscht. Verfallene Credits können nicht wiederhergestellt oder in Bargeld oder anderen Wert umgewandelt werden. Übergangsregel: Vor dem 22. Sep. 2025 gekaufte Credits gelten als am 22. Sep. 2025 gekauft und verfallen am 22. Sep. 2026 (sofern beim Kauf kein früherer Ablauf angegeben wurde).

Ja—innerhalb ihrer Gültigkeitsdauer. Ungenutzte Credits bleiben verfügbar und werden von Monat zu Monat übertragen, bis sie 12 Monate nach dem Kauf verfallen.

Credits sind nicht erstattungsfähig. Kaufen Sie nur, was Sie brauchen—Sie können jederzeit nachladen. Wenn ein plattformseitiger Fehler eine fehlgeschlagene Abbuchung verursacht, können wir die betroffenen Credits nach Prüfung wiederherstellen. Keine Barerstattung.

Preise werden in Credits angegeben, nicht in Dollar. Jeder Endpoint hat seine eigenen Kosten—siehe das Abzeichen „Credits / Anfrage" oben. Sie wissen immer genau, was Sie ausgeben.

← Zurück zu den APIs

Erwerben Sie Guthaben, um Premium-Inhalte und -Funktionen freizuschalten

Kundentyp

Rechnungsland

API / Endpunkt

Währung

Anzahl der Anfragen