Skip to main content

snapWONDERS Python SDK

snapWONDERS — Expose what's hidden. Hide what's yours.

snapwonders — Python client for the snapWONDERS API

The official Python client for the snapWONDERS API: steganography, forensic media analysis, and format conversion. The client wraps the resumable TUS upload and the session → job → poll → download choreography so that a whole job is a couple of lines.

All the snapWONDERS API services are available over the Clearnet / Web and Dark Web Tor and I2P.

Status. Published — pip install snapwonders (0.1.2).

See it in action

Hide a secret image inside a cover — the stego output looks pixel-identical, but carries the hidden file, recoverable only with the password:

Secret (hidden inside) Cover (input) Stego output (carries the secret)
secret cover stego

The full walkthrough — steganography, forensic analysis (with a real graded result), and conversion — is in examples/WALKTHROUGH.md.

Installation and setup

snapWONDERS API key

You will need a snapWONDERS API key before you can get started:

  • Sign up and create an account at snapWONDERS sign-up. If you wish to create an account via Tor or I2P then you can do so by accessing snapWONDERS through the Tor or I2P portals. For the dark web links visit browsing safely.
  • Under your account settings, generate an API key. New keys start with sw_. It is sent as the X-Api-Key header on every request — keep it secret.

Install the package

pip install snapwonders

Quickstart

from snapwonders import Client

client = Client(api_key="sw_your_key_here")   # base_url defaults to https://snapwonders.com
print(client.status())                          # no key needed for status

# Hide a secret inside a cover image (the last file is the cover).
job = client.stego.hide(["secret.png", "cover.jpg"], password="Str0ng!Pass")
for result in job.results():
    result.download("out/")                     # "out/" is a directory — the server filename is kept

# Reveal it again.
job = client.stego.reveal("out/cover-share.avif", password="Str0ng!Pass")
job.results()[0].download("recovered/")

client.analyse (forensic analysis) and client.convert (media conversion) follow the same shape — one call in, results out:

# Forensic analysis — grade each file A–F, collect the overlay assets it produced.
job = client.analyse.run(["photo.jpg"], face_detection=True)
for item in job.results():
    print(item.filename, item.grade, item.face_count)
    for asset in item.assets:        # ELA map, face overlay, …
        asset.download("out/")

# Convert media — the image format key is `image_format` (jpeg/png/webp/avif/heic/jxl).
job = client.convert.run(["photo.png"], image_format="webp")
job.results()[0].download("out/")

Prefer to drive each stage yourself? The step-by-step surface is public too: create_sessionupload(path, step=…)wait_for_uploads()start_job(**opts)wait()results().

Examples

Runnable end-to-end examples live in examples/ — steganography, forensic analysis, and conversion, each a self-contained script with a bundled sample image:

export SNAPWONDERS_API_KEY=sw_your_key_here
python examples/hide_and_reveal.py     # hide a file in an image, then reveal it
python examples/analyse.py             # grade an image A–F + download overlay assets
python examples/convert.py             # JPEG → WebP

See examples/WALKTHROUGH.md for the real input/output images and a live forensic-analysis JSON result, or examples/README.md for how to run them.

Errors

Every failure the SDK raises is a typed subclass of SnapwondersError, so you can branch on the kind of failure rather than inspecting HTTP status codes:

Exception Raised when
AuthError Missing, malformed, unknown, or revoked API key
ProRequiredError A Pro-only option was used on a free account
SessionExpiredError The 24-hour upload session window has passed
RateLimitError Rate limited — carries retry_after when the server supplies it
MaintenanceError snapWONDERS is temporarily unavailable for maintenance — carries retry_after
JobFailedError A job finished as failed — carries the server's reason
UploadError A file could not be uploaded, by whichever method was used
TusUploadError A resumable-upload step failed (subclass of UploadError)
NetworkError The API could not be reached
ApiError Any other non-2xx response

Running the tests

pip install -e ".[dev]"
pytest                       # offline smoke tests — no API key required
# integration tests need SNAPWONDERS_TEST_API_KEY set against the dev API

Documentation

Useful documentation can be found at:

Contact

For security concerns

If you have spotted any security concerns then please reach out via contacting snapWONDERS and set the subject to "SECURITY CONCERNS" and provide the information about your concerns. If you wish to contact via Tor or I2P then you can do so by accessing snapWONDERS through the Tor or I2P portals. For the dark web links visit browsing safely.

For FAQ and questions

It may be that your question is already answered in the FAQ. Be sure to check the FAQ content first. Otherwise you may reach out via contacting snapWONDERS.

For contacting the author

Use this link to contact the author Kenneth Springer.

Licence

MIT — Copyright (c) 2026 Kenneth Springer @ snapWONDERS. See LICENSE.

Scope. The MIT licence covers this client library only. It grants no rights in the snapWONDERS API, service, data, models, or algorithms it communicates with — these are proprietary and remain the property of Kenneth Springer @ snapWONDERS. This library only sends HTTP requests to the API; it contains none of its implementation. Using the API requires a valid API key and is governed by the snapWONDERS Terms of Service.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

snapwonders-0.1.2.tar.gz (6.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

snapwonders-0.1.2-py3-none-any.whl (28.8 kB view details)

Uploaded Python 3

File details

Details for the file snapwonders-0.1.2.tar.gz.

File metadata

  • Download URL: snapwonders-0.1.2.tar.gz
  • Upload date:
  • Size: 6.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for snapwonders-0.1.2.tar.gz
Algorithm Hash digest
SHA256 5624c69dd8f3d5ac1e968212257db3454ab2ac943e489e0e3993d6a3333c6c63
MD5 bcfd36a8154a01f27b5a6cb780e12bc6
BLAKE2b-256 e8f533a0c1ca789cc7a4a427a67c8c2fbe7c3a431f53ae4982fe4cc4f2401a25

See more details on using hashes here.

File details

Details for the file snapwonders-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: snapwonders-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 28.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for snapwonders-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f629477e41a956c70281e9df46e1d8469ebf7344990f4c38540807241bd7e5b4
MD5 bfae1eabcc0e63fe22b0e00c1e32bc2d
BLAKE2b-256 4d5913718548df7a7b5d2d59b1c4ccbb9e28301605677f5a52284cdda1dadf18

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.2 This release

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page