Python SDK

Script Snapshot Site into batch jobs, QA pipelines, and automation flows

Use the official Python SDK when you want a clean client for screenshot capture, webpage analysis, compare workflows, and local asset downloads without managing raw HTTP payloads.

snapshot-site-sdk
Official package
Python
Scripts, pipelines, services
Download assets
Save returned files locally
Install:pip install snapshot-site-sdk
Auth:SNAPSHOT_SITE_API_KEY=ss_live_xxx
Python workflow
Python workflow
Good fits
Content QA pipelines and recurring monitoring jobs
Archive, compliance, and documentation snapshots
Internal automation scripts that need screenshot, compare, and analyze
Python services that want a cleaner client than raw HTTP

SDK overview

The Python SDK is built for teams running scheduled, scriptable workflows. It keeps integrations small and makes it easy to save or process outputs after capture.

1

Designed for batch and automation work

Use it in scheduled scripts, worker jobs, QA pipelines, and internal tooling.

2

One client for screenshot, analyze, and compare

The same client object can cover all major Snapshot Site workflows.

3

Easy local asset handling

You can save images and outputs locally without writing custom download plumbing.

4

Good fit for recurring operational jobs

Python teams can plug it into cron jobs, data workflows, or review pipelines quickly.

Quick start

Install, authenticate, run jobs

1

Install `snapshot-site-sdk`

2

Set or inject your Snapshot Site API key

3

Instantiate `SnapshotSiteClient`

4

Run screenshot, analyze, compare, or local download workflows

Code examples

Screenshot

Minimal screenshot example

Capture a page with a lightweight Python client.

from snapshot_site import SnapshotSiteClient

client = SnapshotSiteClient(api_key="ss_live_xxx")

result = client.screenshot({
    "url": "https://snapshot-site.com/pricing",
    "width": 1440,
    "format": "png",
    "fullSize": True,
    "hideCookie": True,
})

print(result.get("link"))
Analyze

Analyze example

Run webpage analysis from the same Python client.

result = client.analyze({
    "url": "https://snapshot-site.com",
    "width": 1440,
    "fullSize": True,
    "enableSummary": True,
    "enableQuality": True,
})

print(result)
Compare

Compare and download assets

Compare two states and save returned outputs locally.

result = client.compare({
    "before": {
        "url": "https://snapshot-site.com/pricing",
        "width": 1440,
        "fullSize": True,
        "hideCookie": True,
    },
    "after": {
        "url": "https://staging.snapshot-site.com/pricing",
        "width": 1440,
        "fullSize": True,
        "hideCookie": True,
    },
    "threshold": 0.1,
})

client.download_to(result, "pricing.png")