Menu
Docs/API Changelog

API Changelog

v1.6.0 — March 29, 2026

Architecture:

  • Unified page-navigator module — all browser navigation, stealth, ad/tracker blocking, cookie banner hiding, chat widget hiding, media emulation, and CF detection consolidated into a single page-navigator.ts module. Every tool and API endpoint now uses the same shared functions (createContext, navigateTo, applyModifications) instead of duplicating logic.
  • Dedicated stealth module (stealth.ts) — stealth patches extracted into a standalone module, applied uniformly across all endpoints.
  • Proxy pool (proxy-pool.ts) — centralized proxy management with static residential IP support, default proxy for CF bypass, and per-country routing.

New features:

  • URL → PDF (POST /v1/pdf with url param) — navigate a real browser to any URL and generate a multi-page PDF. Supports dark mode, stealth, cookie/chat blocking, custom CSS/JS, delay, and all page-navigator options. Growth+ plan.
  • Screenshot: element selector (selector) — capture a specific DOM element instead of the full viewport.
  • Screenshot: scroll position (scroll_y) — scroll to a Y offset before capture for mid-page screenshots.
  • Screenshot: image resize (image_width, image_height) — resize the output image after capture.
  • Screenshot: transparent background (omit_background) — capture with transparent background for PNG/WebP.
  • Screenshot: hover (hover) — hover over a CSS selector before capture to trigger hover states.
  • Screenshot: media emulation (media_type, reduced_motion) — emulate print media or reduced motion.
  • Screenshot: device scale (device_scale_factor, viewport_landscape) — custom DPI and landscape mode.
  • Blocking: cookie banners (block_cookie_banners) — hide cookie consent dialogs via CSS injection.
  • Blocking: chat widgets (block_chats) — hide Intercom, Drift, Crisp, Tawk, Zendesk, etc.
  • Blocking: trackers (block_trackers) — block Google Analytics, Hotjar, Mixpanel, Segment, and 15+ more.
  • Video API expansion — added fps, click, hover, css, js, wait_for, device, user_agent, viewport_landscape, blocking params, and country/proxy support.
  • Site Audit expansion — added dark_mode, device, delay, wait_for, block_cookie_banners, block_chats, proxy, country.
  • Batch expansion — added retina, viewport_landscape, stealth, device, delay, wait_for, wait_until, css, hide_selectors, scroll_y, proxy, and all blocking params.
  • Country codes expanded to 12: US, GB, DE, FR, NL, AU, CA, BR, IN, JP, SG, KR.

Playground:

  • Batch form — expanded with retina, landscape, stealth, device presets, delay, wait_until, and all blocking toggles.
  • PDF form — new "URL → PDF" mode alongside Template and Custom HTML.
  • Screenshot form — all new parameters exposed in collapsible Advanced section.
  • Video form — full parameter coverage with blocking section and device presets.
  • Site Audit form — device, delay, wait_for, blocking, proxy, country fields.
  • Code generator — updated to include all new parameters in generated snippets.

Documentation:

  • Updated parameter tables for Screenshot, Video, Site Audit, and Batch API docs with all new parameters and examples.

v1.5.0 — March 28, 2026

New features:

  • PDF screenshots (format: pdf) — capture any URL as a full A4 PDF document. Growth+ plan required.
  • Batch screenshots (POST /v1/batch) — capture screenshots of multiple URLs in a single request. Returns base64-encoded images with per-URL success/error status. Growth+ plan required.
  • Async screenshots (POST /v1/async/screenshot) — enqueue a screenshot job and receive the result via webhook callback. Returns immediately with a job_id and 202 Accepted. Growth+ plan required.
  • Screenshot diff (POST /v1/diff) — compare two screenshots (by URL or base64 images) pixel-by-pixel. Returns diff_percent, diff_pixels, and a diff image. Growth+ plan required.
  • Sitemap crawl (POST /v1/sitemap/crawl) — fetch a sitemap XML, extract page URLs, and capture screenshots of each page. Supports sitemap indexes. Business+ plan required.

v1.4.1 — March 28, 2026

Improvements:

  • Extract endpoint (GET /v1/extract) — added to OpenAPI spec. Extract page metadata, OG tags, Twitter Card tags, and favicons from any URL using a real browser. Docs →
  • Country parameter (country) — specify a two-letter country code for proxy geolocation (e.g. US, GB, DE). Growth+ plan required. Added to OpenAPI spec and all SDKs.
  • Feature gating — consistent plan requirement checks for retina, full_page, webp_format, custom_js, custom_css, stealth, proxy, and country. Error responses now include required_plan field.
  • Error handling — X-Error-Message header on all error responses. Error messages saved to request logs. Site Audit validation returns details array consistent with global handler.
  • Request tracing — requestId propagated through screenshotter, design extractor, and OG renderer for end-to-end log correlation.
  • Usage dashboard — fixed empty page for team members. Anniversary-based billing period. Added site-audit and extract to breakdown chart. usageDaily table now populated via upsert.
  • Structured logging — web app webhook handlers, billing, and dashboard routes now use structured JSON logging in production.
  • OpenAPI cleanup — removed /v1/monitors endpoints (monitors are managed via the dashboard, not the public API).

v1.4.0 — March 27, 2026

New endpoints:

  • Site Audit (POST /v1/site-audit) — Extract design tokens from any website: color palette, fonts with weights, heading hierarchy, tech stack detection (14+ frameworks), page metadata, and accessibility overview. Output as JSON, PNG site-book visual card, or A4 PDF report. Starter+ plan. Docs →
  • Website Monitoring — Automated scheduled screenshots with pixel-level visual diff comparison. Set check intervals from 15 min (Enterprise) to weekly. Get email + webhook notifications when changes exceed your threshold. Managed via dashboard. Docs →

Monitoring features:

  • Visual diff detection — pixel-by-pixel comparison using pixelmatch. Four view modes: before, after, side-by-side, diff overlay.
  • Golden baseline — pin a reference screenshot to compare against instead of the previous run.
  • Load time alerts — get notified when page load time exceeds a threshold (ms).
  • HTTP status change alerts — get notified when a page's HTTP status code changes (e.g. 200 → 500).
  • Public status pages — share a read-only monitor status page with a unique URL, no login required. Shows uptime %, screenshot timeline, current state.
  • Maintenance windows — schedule recurring time windows (e.g. deploy hours) to suppress false-positive notifications.
  • Snapshot export — download full monitor history as CSV, JSON, or PDF report.
  • Auto-disable — monitors that fail 5 consecutive times are automatically paused with an email notification.
  • Plan limits: Free 0, Starter 3 monitors / 24h / 7d retention, Growth 10 / 6h / 30d, Business 50 / 1h / 90d, Enterprise unlimited / 15min / 1y.

API documentation & integrations:

  • OpenAPI 3.0.3 spec — full specification at api.snapsharp.dev/openapi.json. Docs →
  • Interactive API Reference — dark-themed Swagger UI at /api-docs.
  • Postman Collection — downloadable at /postman-collection.json, pre-configured with variables and auth.
  • ChatGPT GPT Action — import the OpenAPI spec to let ChatGPT take screenshots for you.
  • Claude / Anthropic manifest — tool manifest at /.well-known/anthropic-manifest.json.
  • Cursor MCP — plugin manifest at /.well-known/ai-plugin.json.
  • RapidAPI — marketplace listing with dedicated spec at /openapi-rapidapi.json.
  • n8n, Zapier, Make guides — step-by-step integration instructions. Docs →

New webhook event:

  • monitor.changed — fired when a monitored page changes beyond the diff threshold.

Free developer tools:

  • Site Audit Tool — extract design tokens from any URL, 3 requests/day, no sign-up required.

Dashboard improvements:

  • Site audit history page — view and manage saved audit results.
  • Monitor dashboard — timeline thumbnails, side-by-side diff viewer, snapshot detail pages.
  • Monitor settings — interval, threshold, hide selectors, device presets, alerting, public status page, maintenance windows, golden baseline.

v1.3.0 — March 25, 2026

New features:

  • Stealth Mode (stealth=true, Growth+) — Bypass bot-detection systems. Patches navigator.webdriver, canvas fingerprint, WebGL, audio context, plugin list, and 3 more markers. Pass Cloudflare, DataDome, PerimeterX. Docs →
  • Custom Proxy (proxy=http://..., Growth+) — Route page requests through any HTTP/SOCKS5 proxy. Capture geo-restricted content from any region. BYO proxy model. Docs →
  • Outbound Webhooks — Subscribe to screenshot.completed, screenshot.failed, usage.threshold.80, usage.threshold.100 events. Payloads are HMAC-SHA256 signed. Automatic retry with exponential backoff (30s → 5min → 1h, max 3 attempts). Docs →
  • Team Management (Growth+) — Invite team members by email. Roles: admin (full access) and viewer (read-only). Members share the owner's API keys and usage data. Limits: Growth 3, Business 10, Enterprise unlimited. Docs →
  • IP Whitelist — Restrict API key usage to specific IP addresses or CIDR ranges. If configured, requests from non-whitelisted IPs are rejected with 403. Docs →
  • Default Parameters — Set default screenshot parameters (format, dimensions, dark mode, etc.) that apply to every request unless overridden. Docs →
  • Custom OG Templates (Growth+) — Design your own OG image templates with HTML/CSS using the built-in editor. Use {{variable}} placeholders, then generate images via the same OG Image API. Docs →
  • Contact Form — /contact page for support and sales inquiries, rate limited to 3/hour per IP.

Dashboard improvements:

  • Usage CSV export — download raw usage data from the Usage page
  • Webhook delivery history with status codes and response bodies
  • Team member management UI with invite/accept/role-change flows
  • IP whitelist management with notes per entry

v1.2.0 — March 20, 2026

New features:

  • Official SDKs for 5 languages: Node.js/TypeScript, Python, Go, PHP, Ruby. All SDKs cover screenshots, OG images, HTML-to-image, templates, and usage. Docs →
  • CLI tool (snapsharp-cli) — capture screenshots, generate OG images, check usage, and run CI/CD checks from the terminal. Docs →
  • stealth and proxy parameter stubs added to API schema (full implementation released in v1.3.0).

Free developer tools:

Comparison pages:

v1.1.0 — March 15, 2026

Improvements:

  • webp added as a supported output format for screenshots (Starter+).
  • URL auto-normalization: bare domains like example.com are automatically prefixed with https://.
  • hide_selectors presets in the Playground: cookie banners, popups, chat widgets — one-click.
  • JSON-LD structured data added to all public pages for better SEO rich results.
  • Use case pages: Website Monitoring, PDF Thumbnails, OG Images, Social Cards.

v1.0.0 — March 10, 2026

Initial public release.

Endpoints:

  • GET /v1/screenshot — URL → PNG/JPEG/WebP screenshot
  • POST /v1/screenshot — same, with JSON body
  • POST /v1/og-image — OG image from template
  • POST /v1/html-to-image — HTML string → image
  • GET /v1/templates — list available OG templates
  • GET /v1/usage — usage statistics
  • GET /health — health check
  • GET /status — detailed system status

Features:

  • 5 built-in OG image templates (blog-post, social-card, product-card, github-readme, quote-card)
  • Redis caching with configurable TTL (default 1h, max 24h)
  • 9 device presets (iPhone 14, iPhone 14 Pro, iPhone 15 Pro Max, Pixel 7, Galaxy S23, iPad Pro 12.9, MacBook Pro 14, Desktop 1080p, Desktop 1440p)
  • Dark mode emulation
  • Ad & cookie banner blocking (Starter+)
  • CSS injection (Starter+) / JS injection (Growth+)
  • Per-key rate limiting + monthly quotas
  • Request logging and usage analytics
  • Interactive API Playground with code generation in 6 languages
  • Dashboard with usage charts, request logs, and API key management

The API uses semantic versioning. Breaking changes will be announced with a new major version and a migration guide.

← Integrations
API Changelog