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-python

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.0.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.0-py3-none-any.whl (3.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: screenshotbase-0.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 03a00d825da3e1815ba7b12f24f30e688a18b340fe2363d3037bdacc9da5209c
MD5 5db37757742feb7e0ff0b567435432c8
BLAKE2b-256 a1046d123578974deb40b269580161108d78860ce0a78c9786e308e1c83de041

See more details on using hashes here.

File details

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

File metadata

  • Download URL: screenshotbase-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.0 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7c45e036d35dc39824c3b07e68f7482ca7414db4b42631c92938ffd26233d8ca
MD5 da45989f5744df58ebede0612c9e0824
BLAKE2b-256 2e7215c24a965c4f448ddb5f1a4ecad1975ac70de5aa866ae5a4c6f2396b1107

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