Urlbox API Documentation (zakutynsky) | RapidAPI

Urlbox

FREE
By zakutynsky
Updated 9 months ago
Video, Images
5.1/10
Popularity Score
391ms
Latency
100%
Success Rate

Urlbox API Documentation

Automate screenshots of any website.

View API Details
POSTgetScreenshot
POSTgetScreenshot

Generate screenshot from url.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
apiSecretCREDENTIALS
REQUIREDYour actual urlbox API secret which you can get by registering for an account.
urlSTRING
REQUIREDThe URL of the website you want to screenshot.
formatSELECT
REQUIREDShould be one of either png or jpg depending on which format you want the resulting image
apiKeyCREDENTIALS
REQUIREDYour actual urlbox API key which you can get by registering for an account.
Optional Parameters
heightNUMBER
OPTIONALViewport height of the browser in pixels. Default: 1024.
acceptLangSTRING
OPTIONALSets an Accept-Language header on requests to the target URL. Default: en-US.
thumbWidthNUMBER
OPTIONALWidth in pixels of the generated thumbnail, leave off for full-size screenshot.
retinaBOOLEAN
OPTIONALTake a 'retina' or high definition screenshot equivalent to setting a device pixel ratio of 2.0 or @2x. Please note that retina screenshots will be double the normal dimensions and will normally take slightly longer to process due to the much bigger image size. Default: false
waitForSTRING
OPTIONALWaits for the element specified by this selector to be visible on the page before taking a screenshot.
clickSTRING
OPTIONALElement selector that is clicked before taking a screenshot e.g. #clickme would click the element with id=`clickme`.
forceBOOLEAN
OPTIONALTake a fresh screenshot instead of getting a cached version. Default: false
cookieSTRING
OPTIONALSet a cookie value before taking a screenshot. E.g. OptIn=true. Can be set multiple times to set more than one cookie.
highlightfgSTRING
OPTIONALText color of the highlighted word. Default: white
qualityNUMBER
OPTIONALJPEG only - image quality of resulting screenshot (0-100). Default: 80
fullPageBOOLEAN
OPTIONALAmount of time to wait in milliseconds for the website at url to respond. Default: false
hideSelectorSTRING
OPTIONALHides all elements that match the element selector by setting their style to `display:none !important;`. Useful for hiding popups.
useS3BOOLEAN
OPTIONALSave the screenshot directly to the S3 bucket configured on your account. Default: false
bgColorSTRING
OPTIONALHex code or css color string. Some websites don't set a body background colour, and will show up as transparent backgrounds with PNG or black when using JPG. Use this setting to set a background colour. If the website explicitly sets a transparent background on the html or body elements, this setting will be overridden.
cropWidthNUMBER
OPTIONALCrop the width of the screenshot to this size in pixels.
disableJsBOOLEAN
OPTIONALTurn off javascript on target url to prevent popups. Default: false
hoverSTRING
OPTIONALElement selector that is hovered before taking a screenshot e.g. #hoverme would hover over the element with id=`hoverme`.
highlightSTRING
OPTIONALWord to highlight on the page before capturing a screenshot.
ttlNUMBER
OPTIONALShort for 'time to live'. Number of seconds to keep a screenshot in the cache. Note the default is also the maximum value for this option. Default: 2592000
transparentBOOLEAN
OPTIONALIf a website has no background color set, the image will have a transparent background (PNG only). Default: false
flashBOOLEAN
OPTIONALEnable the flash plugin for flash using websites. Default: false
widthNUMBER
OPTIONALViewport width of the browser in pixels. Default: 1280.
authorizationSTRING
OPTIONALSets an Authorization header on requests to the target URL.
highlightbgSTRING
OPTIONALText color of the highlighted word. Default: red
timeoutNUMBER
OPTIONALAmount of time to wait in milliseconds for the website at url to respond. Default: 30000
delayNUMBER
OPTIONALAmount of time to wait in milliseconds before urlbox takes the screenshot.
s3PathBOOLEAN
OPTIONALThe s3 path to save the screenshot to in your S3 bucket.
userAgentSTRING
OPTIONALUser-Agent string used to emulate a particular client.
selectorSTRING
OPTIONALTake a screenshot of the element that matches this selector.
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication