Skip to main content

Web Screenshots is a simple tool for capturing screenshots of web pages. It returns an image screenshot of the web page provided.

Project description

Website Screenshot API

Web Screenshots is a simple tool for capturing screenshots of web pages. It returns an image screenshot of the web page provided.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Website Screenshot API


Installation

pip install apiverve-websitescreenshot

Configuration

Before using the webscreenshots API client, you have to setup your account and obtain your API Key.
You can get it by signing up at https://apiverve.com


Usage

The Website Screenshot API documentation is found here: https://docs.apiverve.com/api/webscreenshots.
You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_websitescreenshot.apiClient import WebscreenshotsAPIClient

# Initialize the client with your APIVerve API key
api = WebscreenshotsAPIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query
query = {  "url": "https://ebay.com/",  "type": "png",  "width": 1024,  "height": 600,  "fullpage": false }
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "width": 1024,
    "height": 600,
    "scaleFactor": 1,
    "imageName": "78bdb087-756b-4107-83e1-82fd40171ed1.png",
    "expires": 1725356395837,
    "url": "https://ebay.com/",
    "downloadURL": "https://storage.googleapis.com/apiverve-helpers.appspot.com/webscreenshots/78bdb087-756b-4107-83e1-82fd40171ed1.png?GoogleAccessId=1089020767582-compute%40developer.gserviceaccount.com&Expires=1725356395&Signature=jqAuoBhrbsSqs61blsFdnXEU35QOanhFnL0FN2d82cDDTXAUWonuRURUjyyhmABe02dVD3sMpvQDh0V39ROFcukPFASdIhr4HdWnKl743JLx03jrW%2FJ2baK3lZCZemPkS%2F61VqcHV1YB5XsxqsDNNkQ8QL8xlzUslHUgjuVKsorDCpBL5iFPSLo0l5DO3wvZ6UudJJP11j1MAnRmWQC7%2FkUBc7AP4akQvm6N7lftFkx8z6%2FptdxBt60w1XR6Ixoy6Vl31tvd6UjyWhjmF8JbujRSRYXmh0vjTNZBp5BX7xUntQUSMXhQf%2Bj3bXq7ZcsfMAAtqonqbzC6SBZgzSu2kA%3D%3D"
  },
  "code": 200
}

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 2024 APIVerve, and Evlar LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Download files

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

Source Distribution

apiverve_websitescreenshot-1.1.5.tar.gz (8.0 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file apiverve_websitescreenshot-1.1.5.tar.gz.

File metadata

File hashes

Hashes for apiverve_websitescreenshot-1.1.5.tar.gz
Algorithm Hash digest
SHA256 c36f5301eda5c79ba801d371f7c2a2e30fcd541cd4c31d8c2184585e03223693
MD5 7b54470001e43279ecb82542b3d0c106
BLAKE2b-256 a2aa11c8e037115239405f82dde16c7192cac75e21399b4f355e5d0fbbcc30b9

See more details on using hashes here.

File details

Details for the file apiverve_websitescreenshot-1.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_websitescreenshot-1.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 35a9f281303cebb77ba822986a60923fd269d72c6c97f5a725e243dcef74c22a
MD5 3c1992f3d08f5918285e11e62dbb62e1
BLAKE2b-256 9d076f5a3592b9b497c73304242c3e1867d3b1e39d7246ccaec02bec0a96a7b6

See more details on using hashes here.

Supported by

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