Socket
Socket
Sign inDemoInstall

screenshotscloud

Package Overview
Dependencies
1
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    screenshotscloud

ScreenshotsCloud node.js screenshot generator


Version published
Weekly downloads
7
increased by133.33%
Maintainers
1
Created
Weekly downloads
 

Readme

Source

Build Status

ScreenshotsCloud

Perfect Screenshots Anywhere

Get high quality real browser screenshots in seconds using our reliable CDN backed API service.

Get an API Key to start using this fast screenshot API service at ScreenshotsCloud.

Requirements

Tested against node.js 4+

Installation

Install via npm

npm install screenshotscloud

or yarn

yarn add screenshotscloud

Once installed you can generate screenshot urls as follows:

const ScreenshotsCloud = require('screenshotscloud');

const SCREENSHOTSCLOUD_KEY = 'baf30192-54e1-4610-a89e-5e9c03a6b5dc';
const SCREENSHOTSCLOUD_SECRET = 'OGUYJcZd69WsYIc3EtedU9NCRBBoewTWD5ONZNwlqVrMVroM7P';

const screenshotscloud = ScreenshotsCloud(SCREENSHOTSCLOUD_KEY, SCREENSHOTSCLOUD_SECRET);

const screenshotUrl = screenshotscloud.screenshotUrl({
	"url": "openai.com/research",
	"width": 800
});

Parameters

These are the options you can use to customize your screenshot.

ParameterDefaultDescription
urlRequired. The website address that you want to take a screenshot of.
browserfastestWhich browser to run the request on. chrome for Google Chrome, firefox for Mozilla Firefox, fastest to run the request on both browsers and return the request from the browser which renders the screenshot fastest. Defaults to fastest.
width1920Width of the thumbnail. This option is only valid for png or jpg format options.
viewport_width1920Width of the browser viewport this is the actual width of the page before we resize it for the thumbnail.
viewport_height(1320)Height of the browser viewport, if you do not give this parameter we will calculate it for you based on viewport_width in 16:10 ratio.
full_pagefalseCapture a full length screenshot of the requested page. If the format is pdf this option will always be true.
formatpngOutput the screenshot as a PNG (png), JPEG (jpg) image or PDF (pdf).
quality95 (if format=jpg)Set the jpeg quality of the screenshot if jpeg is set as the format.
delay250Amount of time to wait in milliseconds before taking a screenshot of the page after it is fully loaded. Maximum 60000 (1 minute), minimum 100.
cache_time2592000Amount of time in seconds to wait before taking a fresh screenshot for the same request. Maximum 2592000 (30 days), minimum 1.
forcefalseForce a new screenshot to be taken with no cache.
user_agentRecent Firefox or Chrome User AgentSet the user agent this screenshot will identify as. Useful for identifying as a mobile or tablet browser or to identify as a specific browser if the website pretends it needs Internet Explorer.
trimfalseTrim the excess space around the resulting screenshot using the most top left pixel color, useful for SVG's.
languageenAccept-Language header customization for websites that support it, set ja for Japanese, de for German etc.
cookieSemi colon separated list of cookies e.g. fruit=apple; drink=tea
disable_javascriptfalseDon't execute javascript on this page. Forces browser=firefox.
disable_imagesfalseDon't download images on this page. Forces browser=firefox.
timeout300000Amount of time in milliseconds to wait before taking the screenshot anyway. Maximum 300000 (5 minutes).
mobilefalseShortcut to set pixel_ratio, user_agent, viewport_width, viewport_height and width to that of the latest iPhone.
pixel_ratio1Multiplier that sets the pixel density of the page relative to the resolution, useful for taking retina screenshots (2).
click_selectorAccepts valid DOM selector (#wantedselector). Rendered screenshot will only display contents of DOM selector.
wait_selectorAccepts valid DOM selector (.valid_selector > .another_class). We will not take the screenshot until .valid_selector appears on this screen and is not display:none; or timeout is reached.
clip_selectorAccepts valid DOM selector (e.g. .valid_selector:not(div)). Rendered screenshot will only display contents of DOM selector. This option is only valid for png or jpg format options.
hover_selectorAccepts valid DOM selector (e.g. #wantedselector). Mouse will be hovered over the first instance of the selector you specify. Forces browser=chrome.

More documentation about this package and other language implementations can be found at https://screenshots.cloud/documentation.

Support

Contact us at support@brushd.com if you have any issues or questions about this package.

Other implementations

Need an implementation for another language?

LanguageAddress
C#https://github.com/ScreenshotsCloud/screenshotscloud-cs
Javahttps://github.com/ScreenshotsCloud/screenshotscloud-java
Node.jshttps://github.com/ScreenshotsCloud/screenshotscloud-node
PHPhttps://github.com/ScreenshotsCloud/screenshotscloud-php
Pythonhttps://github.com/ScreenshotsCloud/screenshotscloud-python
Rubyhttps://github.com/ScreenshotsCloud/screenshotscloud-ruby
ColdFusionhttps://github.com/ScreenshotsCloud/screenshotscloud-coldfusion
Shell Scripthttps://github.com/ScreenshotsCloud/screenshotscloud-sh

ScreenshotsCloud is made by Brushd https://brushd.com/

Keywords

FAQs

Last updated on 26 Sep 2018

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc