SnapAPI/sdk/python
SnapAPI Developer 9290c759da
Some checks failed
Build & Deploy to Staging / Build & Deploy to Staging (push) Has been cancelled
feat: add userAgent parameter for custom User-Agent headers
- Add userAgent?: string to ScreenshotOptions interface
- Implement validation (max 500 chars, no newlines for security)
- Call page.setUserAgent() after page acquisition, before navigation
- Add route handler support for both POST body and GET query
- Add comprehensive test coverage (11 new tests)
- Update OpenAPI documentation with parameter specs and examples
- Update Node.js and Python SDK README examples
- All userAgent tests passing (414 → 425 total tests)

Fixes potential HTTP header injection by rejecting newlines.
Enables custom User-Agent strings for specific browser emulation needs.
2026-03-05 15:10:06 +01:00
..
src/snapapi feat: add darkMode and hideSelectors to Node.js and Python SDKs 2026-03-04 15:07:20 +01:00
tests Add comprehensive tests and docs for darkMode & hideSelectors 2026-03-04 18:04:18 +01:00
pyproject.toml feat: add Node.js and Python SDKs 2026-02-23 14:02:15 +00:00
README.md feat: add userAgent parameter for custom User-Agent headers 2026-03-05 15:10:06 +01:00

SnapAPI Python SDK

Official Python client for SnapAPI — the EU-hosted screenshot API.

Zero dependencies. Uses only Python standard library (urllib).

Installation

pip install snapapi

Quick Start

from snapapi import SnapAPI

snap = SnapAPI("your-api-key")

# Capture a screenshot
screenshot = snap.capture("https://example.com")

with open("screenshot.png", "wb") as f:
    f.write(screenshot)

Usage

Basic Screenshot

png = snap.capture("https://example.com")

With Options

jpg = snap.capture(
    "https://example.com",
    format="jpeg",
    width=1920,
    height=1080,
    quality=90,
)

Full-Page Capture

full = snap.capture(
    "https://example.com/blog",
    full_page=True,
    device_scale=2,  # Retina
)

Mobile Viewport

mobile = snap.capture(
    "https://example.com",
    width=375,
    height=812,
    device_scale=2,
)

Wait for Dynamic Content

screenshot = snap.capture(
    "https://example.com/dashboard",
    wait_for_selector="#chart-loaded",
    wait_until="networkidle2",
)

Dark Mode Capture

# Capture in dark mode (prefers-color-scheme: dark)
dark_screenshot = snap.capture(
    "https://example.com",
    dark_mode=True,
    format="png",
)

Custom User Agent

# Set a custom User-Agent string for the request
screenshot = snap.capture(
    "https://example.com",
    user_agent="Mozilla/5.0 (compatible; SnapAPI/1.0)",
    format="png",
)

Hide Elements Before Capture

# Hide cookie banners, popups, ads
clean_screenshot = snap.capture(
    "https://example.com",
    hide_selectors=[
        ".cookie-banner", 
        ".popup-overlay",
        "#advertisement",
        ".tracking-notice"
    ],
)

# Hide single element
single_hide = snap.capture(
    "https://example.com", 
    hide_selectors=".newsletter-popup",
)

Custom CSS Injection

# Inject custom CSS before capture
styled = snap.capture(
    "https://example.com",
    css='body { background: #1a1a2e !important; color: #eee !important }',
)

# Combine with other options
combined = snap.capture(
    "https://example.com",
    css=".hero { padding: 80px 0 } h1 { font-size: 48px }",
    dark_mode=True,
    hide_selectors=[".cookie-banner"],
)

JavaScript Injection

# Execute custom JavaScript before capture
interactive_screenshot = snap.capture(
    "https://example.com",
    js="""
    // Dismiss modal popup
    document.querySelector('.modal-overlay')?.remove();
    
    // Scroll to specific content
    window.scrollTo(0, 500);
    
    // Click button to reveal content
    document.querySelector('#show-more-btn')?.click();
    
    // Wait for animation to complete
    await new Promise(resolve => setTimeout(resolve, 1000));
    """,
)

# Combine with other options for complex scenarios
complex_capture = snap.capture(
    "https://example.com/app",
    js='document.querySelector(".sidebar").style.display = "none";',
    css="body { zoom: 0.8 }",
    wait_for_selector="#content-loaded",
    hide_selectors=[".ad-banner", ".cookie-notice"],
)

Error Handling

from snapapi import SnapAPI, SnapAPIError

snap = SnapAPI("your-api-key")

try:
    screenshot = snap.capture("https://example.com")
except SnapAPIError as e:
    print(f"API error {e.status}: {e.detail}")

API Reference

SnapAPI(api_key, base_url="https://snapapi.eu", timeout=30)

snap.capture(url, **options) -> bytes

Option Type Default Description
url str URL to capture (required)
format str "png" Output: png, jpeg, webp
width int 1280 Viewport width (3203840)
height int 800 Viewport height (2002160)
full_page bool False Capture full page
quality int 80 JPEG/WebP quality (1100)
wait_for_selector str CSS selector to wait for
device_scale float 1 Device pixel ratio (13)
delay int 0 Extra delay in ms (05000)
wait_until str "domcontentloaded" Load event
dark_mode bool False Emulate prefers-color-scheme: dark
hide_selectors list CSS selectors to hide before capture
css str Custom CSS to inject before capture (max 5000 chars)

snap.health() -> dict

Returns API health status.

EU-Hosted & GDPR Compliant

SnapAPI runs entirely on EU infrastructure (Germany). Your data never leaves the EU.

License

MIT — Cloonar Technologies GmbH