Skip to main content

Python client for screenshotbase.com API

Project description

screenshotbase-python

Python client for the screenshotbase.com API.

This SDK wraps the public endpoints and supports authentication via apikey header (default) or apikey query parameter.

Installation

pip install screenshotbase

Quickstart

from screenshotbase.client import Client
import os

client = Client(api_key=os.environ.get("SCREENSHOTBASE_API_KEY"))

# Status
print(client.status())

# Render screenshot
print(client.render({
    "url": "https://example.com",
    "full_page": True,
    "viewport": "1366x768",
    "format": "png",
}))

Authentication

Header (default) vs query parameter auth:

client = Client(api_key="your_api_key")
client_qs = Client(api_key="your_api_key", auth_in_query=True)

API

  • status() → API availability and quota
  • render(params) → website screenshot render. Example params: { "url": "https://example.com", "viewport": "1366x768", "full_page": True, "format": "png" }

For full parameters, see docs: https://screenshotbase.com/docs/

License

MIT

Project details


Download files

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

Source Distribution

screenshotbase-0.1.1.tar.gz (2.9 kB view details)

Uploaded Source

Built Distribution

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

screenshotbase-0.1.1-py3-none-any.whl (3.1 kB view details)

Uploaded Python 3

File details

Details for the file screenshotbase-0.1.1.tar.gz.

File metadata

  • Download URL: screenshotbase-0.1.1.tar.gz
  • Upload date:
  • Size: 2.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.10

File hashes

Hashes for screenshotbase-0.1.1.tar.gz
Algorithm Hash digest
SHA256 2e01af5dfcdccf658aa2af6db8b9997ff572d41291982172a8622ee29aa54c87
MD5 0af757efd02c9bbd9bddb3e3d0ce3f34
BLAKE2b-256 1a6144c54228116e319033ad280c8132b4110a233af0d3e6c5655008abb45f73

See more details on using hashes here.

File details

Details for the file screenshotbase-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: screenshotbase-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 3.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.10

File hashes

Hashes for screenshotbase-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a72add7f215997f23ac3e06b0415c4f7c88ed4eaa659bd9266e88d5d811a82b4
MD5 58014c1ddbf76f1d88530ab65bbff344
BLAKE2b-256 d241e67030291a39c57b647363e84e91653ddd6619219027d88f35856dddce43

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page