6.0.0 • Published 5 years ago

@datafire/browshot v6.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/browshot

Client library for Browshot API

Installation and Usage

npm install --save @datafire/browshot
let browshot = require('@datafire/browshot').create({
  apiKeyQuery: ""
});

.then(data => {
  console.log(data);
});

Description

Take screenshots of any website in real time

Actions

GetAccountInfo

Get information about your account.

browshot.GetAccountInfo({}, context)

Input

  • input object
    • details integer: level of information returned

Output

CreateBatch

Get hundreds or thousands of screenshots from a text file. You can use this API call or the dashboard. Unlike the other API calls, you must issue a POST request with the Content-Type "multipart/form-data" in order to upload the text file. The text file must contain the list of URLs to request, 1 URL per line. Failed screenshots will be tried up to 3 times before giving up.

browshot.CreateBatch({
  "instance_id": 0
}, context)

Input

  • input object
    • instance_id required integer: instance ID to use
    • file string, object: text file to use
      • content string
      • encoding string (values: ascii, utf8, utf16le, base64, binary, hex)
      • contentType string
      • filename string
    • size string (values: screen, page): screenshots size - "screen" (default) or "page"
    • name string: name of the batch
    • width integer: thumbnail width.
    • height integer: thumbnail height
    • delay integer: number of seconds to wait after the page has loaded. This is used to let JavaScript run longer before taking the screenshot. Use delay=0 to take screenshots faster.
    • flash_delay integer: number of seconds to wait after the page has loaded if Flash elements are present. Use flash_delay=0 to take screenshots faster.
    • screen_width integer: width of the browser window. For desktop browsers only.
    • screen_height integer: height of the browser window. For desktop browsers only. (Note: full-page screenshots can have a height of up to 15,000px)
    • priority integer: assign priority to the screenshot (for private instances only)
    • referer string: use a custom referrer header - paid screenshots only
    • post_data string: send a POST requests with post_data, useful for filling out forms - paid screenshots only
    • cookie string: set a cookie for the URL requested (see Custom POST Data, Referer and Cookie) Cookies should be separated by a ; - paid screenshots only
    • script string: URL of javascript file to execute after the page load event
    • details integer: level of information available with screenshot/info
    • html integer: saves the HTML of the rendered page which can be retrieved by the API call screenshot/html. This feature costs 1 credit per screenshot.
    • max_wait integer: maximum number of seconds to wait before triggering the PageLoad event. Note that delay will still be used. (default: 0 = disabled)
    • headers string: any custom HTTP headers. (Not supported with Internet Explorer)
    • format string (values: png, jpeg): image as PNG or JPEG
    • hosting string (values: s3): hosting option - s3 or browshot
    • hosting_height integer: maximum height of the thumbnail to host
    • hosting_width integer: maximum height of the thumbnail to host
    • hosting_scale number: scale of the thumbnail to host
    • hosting_bucket string: S3 bucket to upload the screenshot or thumbnail (required for S3)
    • hosting_file string: file name to use (for S3 only)
    • hosting_headers string: list of headers to add to the S3 object (for S3 only)

Output

GetBatchInfo

Get the status of a batch requested through the API or through the dashboard.

browshot.GetBatchInfo({
  "id": 0
}, context)

Input

  • input object
    • id required integer: batch ID

Output

GetBrowserInfo

Get information about a browser.

browshot.GetBrowserInfo({
  "id": 0
}, context)

Input

  • input object
    • id required integer: browser ID

Output

GetBrowsersInfo

Get all browsers.

browshot.GetBrowsersInfo(null, context)

Input

This action has no parameters

Output

GetInstanceInfo

Get information about an instance.

browshot.GetInstanceInfo({
  "id": 0
}, context)

Input

  • input object
    • id required integer: instance ID

Output

GetInstancesInfo

Get all instances.

browshot.GetInstancesInfo(null, context)

Input

This action has no parameters

Output

CreateScreenshot

Screenshots requests to private and shared instances require a positive balance.

IMPORTANT: Remember that you can only do 100 free screenshots per month. To used a premium instance, use instance_id=65 for example.

browshot.CreateScreenshot({
  "url": "",
  "instance_id": 0
}, context)

Input

  • input object
    • url required string: URL of the page to get a screenshot for
    • instance_id required integer: instance ID to use
    • size string (values: screen, page): screenshot size - "screen" (default) or "page"
    • cache integer: use a previous screenshot (same URL, same instance) if it was done within <cache_value> seconds. The default value is 24hours. Specify cache=0 if you want a new screenshot.
    • delay integer: number of seconds to wait after the page has loaded. This is used to let JavaScript run longer before taking the screenshot. Use delay=0 to take screenshots faster.
    • flash_delay integer: number of seconds to wait after the page has loaded if Flash elements are present. Use flash_delay=0 to take screenshots faster.
    • screen_width integer: width of the browser window. For desktop browsers only.
    • screen_height integer: height of the browser window. For desktop browsers only. (Note: full-page screenshots can have a height of up to 15,000px)
    • priority integer: assign priority to the screenshot (for private instances only)
    • referer string: use a custom referrer header - paid screenshots only
    • post_data string: send a POST requests with post_data, useful for filling out forms - paid screenshots only
    • cookie string: set a cookie for the URL requested (see Custom POST Data, Referer and Cookie) Cookies should be separated by a ; - paid screenshots only
    • script string: URL of javascript file to execute after the page load event
    • details integer: level of information available with screenshot/info
    • html integer: saves the HTML of the rendered page which can be retrieved by the API call screenshot/html. This feature costs 1 credit per screenshot.
    • max_wait integer: maximum number of seconds to wait before triggering the PageLoad event. Note that delay will still be used. (default: 0 = disabled)
    • headers string: any custom HTTP headers. (Not supported with Internet Explorer)
    • shots integer: take multiple screenshots of the same page. This costs 1 additional credit for every 2 additional screenshots.
    • shot_interval integer: number of seconds between 2 screenshots
    • hosting string (values: s3, browshot): hosting option - s3 or browshot
    • hosting_height integer: maximum height of the thumbnail to host
    • hosting_width integer: maximum height of the thumbnail to host
    • hosting_scale number: scale of the thumbnail to host
    • hosting_bucket string: S3 bucket to upload the screenshot or thumbnail (required for S3)
    • hosting_file string: file name to use (for S3 only)
    • hosting_headers string: list of headers to add to the S3 object (for S3 only)

Output

DeleteScreenshot

You can delete details of your screenshots to remove any confidential information.

browshot.DeleteScreenshot({
  "id": 0
}, context)

Input

  • input object
    • id required integer: screenshot ID
    • data string: data to remove. You can specify multiple of them (separated by a ,): image (image files), url (url requested), metadata (time added, time finished, post data, cookie and referer used for the screenshot), all (all data and files)

Output

HostScreenshot

You can host screenshots and thumbnails on your own S3 account or on Browshot.

browshot.HostScreenshot({
  "id": 0,
  "hosting": ""
}, context)

Input

  • input object
    • id required integer: screenshot ID
    • hosting required string (values: s3, browshot): hosting option: s3 or browshot
    • width integer: width of the thumbnail
    • height integer: height of the thumbnail
    • scale number: scale of the thumbnail
    • bucket string: S3 bucket to upload the screenshot or thumbnail - required with hosting=s3
    • file string: file name to use - optional, used with hosting=s3
    • headers string: HTTP headers to add to your S3 object - optional, used with hosting=s3

Output

GetHTML

Retrieve the HTML code of the rendered page. This API call should be used when html=1 was specified in the screenshot request.

browshot.GetHTML({
  "id": 0
}, context)

Input

  • input object
    • id required integer: screenshot ID

Output

Output schema unknown

GetScreenshotInfo

Once a screenshot has been requested, its status must be checked until it is either "error" or "finished".

browshot.GetScreenshotInfo({
  "id": 0
}, context)

Input

  • input object
    • id required integer: screenshot ID received from /api/v1/screenshot/create
    • details integer: level of details about the screenshot and the page

Output

GetMultipleScreenshotsInfo

Get information about the last 100 screenshots requested.

browshot.GetMultipleScreenshotsInfo({}, context)

Input

  • input object
    • limit integer: maximum number of screenshots' information to return
    • status string (values: error, finished, in_process): get list of screenshot in a given status (error, finished, in_process)

Output

CreateMultipleScreenshots

Request multiple screenshots in one API call. The API call accepts all the parameters supported by screenshot/create. You can specify up to 10 URLs and 10 instances for a total of 100 screenshots in one API call.

browshot.CreateMultipleScreenshots({
  "url": "",
  "instance_id": 0
}, context)

Input

  • input object
    • url required string: URL of the page to get a screenshot for. You can specify multiple url parameters (up to 10).
    • instance_id required integer: instance ID to use. You can specify multiple instance_id parameters (up to 10).
    • size string (values: screen, page): screenshot size - "screen" (default) or "page"
    • cache integer: use a previous screenshot (same URL, same instance) if it was done within <cache_value> seconds. The default value is 24hours. Specify cache=0 if you want a new screenshot.
    • delay integer: number of seconds to wait after the page has loaded. This is used to let JavaScript run longer before taking the screenshot. Use delay=0 to take screenshots faster.
    • flash_delay integer: number of seconds to wait after the page has loaded if Flash elements are present. Use flash_delay=0 to take screenshots faster.
    • screen_width integer: width of the browser window. For desktop browsers only.
    • screen_height integer: height of the browser window. For desktop browsers only. (Note: full-page screenshots can have a height of up to 15,000px)
    • priority integer: assign priority to the screenshot (for private instances only)
    • referer string: use a custom referrer header - paid screenshots only
    • post_data string: send a POST requests with post_data, useful for filling out forms - paid screenshots only
    • cookie string: set a cookie for the URL requested (see Custom POST Data, Referer and Cookie) Cookies should be separated by a ; - paid screenshots only
    • script string: URL of javascript file to execute after the page load event
    • details integer: level of information available with screenshot/info
    • html integer: saves the HTML of the rendered page which can be retrieved by the API call screenshot/html. This feature costs 1 credit per screenshot.
    • max_wait integer: maximum number of seconds to wait before triggering the PageLoad event. Note that delay will still be used. (default: 0 = disabled)
    • headers string: any custom HTTP headers. (Not supported with Internet Explorer)
    • hosting string (values: s3, browshot): hosting option - s3 or browshot
    • hosting_height integer: maximum height of the thumbnail to host
    • hosting_width integer: maximum height of the thumbnail to host
    • hosting_scale number: scale of the thumbnail to host
    • hosting_bucket string: S3 bucket to upload the screenshot or thumbnail (required for S3)
    • hosting_file string: file name to use (for S3 only)
    • hosting_headers string: list of headers to add to the S3 object (for S3 only)

Output

SearchScreenshot

Search for screenshots of a specific URL.

browshot.SearchScreenshot({
  "url": ""
}, context)

Input

  • input object
    • url required string: look for a string matching the URL requested
    • limit integer: maximum number of screenshots' information to return
    • status string (values: error, finished, in_process): get list of screenshot in a given status (error, finished, in_process)

Output

ShareScreenshot

You can make your screenshots public, add notes, and share it with your friends and colleagues. Only screenshots which are successfully completed can be shared.n the thumbnail. You can take a 1024x768 screenshot, crop it to 768x768, and get it scaled down to 300x300.

browshot.ShareScreenshot({
  "id": 0
}, context)

Input

  • input object
    • id required integer: screenshot ID
    • note string: note to add on the sharing page

Output

GetThumbnail

Unlike the other API calls, this API sends back the thumbnail as a PNG file, not JSON. The HTTP response code indicates whether the screenshot was successful (200), or incomplete (404) or failed (404). If the screenshot failed or is not finished, a default image "Not found" is sent.

You can crop your screenshots. The crop is done first, then the thumbnail. You can take a 1024x768 screenshot, crop it to 768x768, and get it scaled down to 300x300.

browshot.GetThumbnail({
  "id": 0
}, context)

Input

  • input object
    • id required integer: screenshot ID
    • width integer: width of the thumbnail
    • height integer: height of the thumbnail
    • scale number: scale of the thumbnail
    • zoom integer: zoom 1 to 100 percent
    • ratio string (values: fit, fill): Use fit to keep the original page ration, and fill to get a thumbnail for the exact width and height. specified. If you provide both width and height, you need to specify the ratio: fit to keep the original width/height ratio (the thumbnail might be smaller than the specified width and height), or fill to crop the image if necessary.
    • left integer: left edge of the area to be cropped
    • right integer: right edge of the area to be cropped
    • top integer: top edge of the area to be cropped
    • bottom integer: bottom edge of the area to be cropped
    • format string (values: png, jpeg): image as PNG or JPEG
    • shot integer: get the second or third screenshot if multiple screenshots were requested
    • quality integer: JPEG quality factor (for JPEG thumbnails only)

Output

Output schema unknown

Definitions

Account

  • Account object
    • balance required integer: number of credits left on your account
    • browsers array: list of custom browsers as returned by /api/v1/browser/list
    • free_screenshots_left required integer: number of free screenshots available for the current month
    • hosting_browshot required integer: 1 is your account is authorized to request hosting on Browshot, 0 otherwise (default)
    • instances array: list of private instances as returned by /api/v1/instance/list
    • private_instances required integer: 1 is your account is authorized to create and use private instances, 0 otherwise (default)
    • screenshots array: list of 10 latest screenshots requests as returned by /api/v1/screenshot/list

AccountError

  • AccountError object
    • error string: description of the problem that occurred
    • status string: status of the request - error

Batch

  • Batch object
    • count integer: number of unique URLs in the batch
    • failed integer: number of screenshots failed
    • finished integer: time of batch completed (UNIX timestamp)
    • id integer: batch ID
    • processed integer: number of screenshots finishe
    • started integer: time of processing (UNIX timestamp)
    • status string (values: in_queue, processing, finished, error): status of the request - "in_queue", "processing", "finished", "error"
    • urls array: URLs to download the batch
      • items string

BatchError

  • BatchError object
    • error string: description of the problem that occurred
    • status string: status of the request - "in_queue", "processing", "finished", "error"

Browser

  • Browser object
    • flash integer: Flash support: 1 if enabled, 0 if disabled
    • id integer: browser ID
    • javascript integer: JavaScript support: 1 if enabled, 0 if disabled
    • mobile integer: Mobile browser: 1 if true, 0 if false
    • name string: browser name and version: Firefox 45, etc.

BrowserError

  • BrowserError object
    • error string: description of the problem that occurred
    • status string: status of the request - error

BrowserList

  • BrowserList object
    • default integer

Instance

  • Instance object
    • browser Browser
    • country string: instance's country of origin
    • height integer: screen height in pixels
    • id integer: instance ID (required to requests screenshots)
    • load number: instance load:
    • screenshot_cost integer: number of credits for each screenshot
    • type string (values: public, shared, private): public, shared or private
    • width integer: screen width in pixels

InstanceError

  • InstanceError object
    • error string: description of the problem that occurred
    • status string: status of the request - error

InstanceList

Screenshot

  • Screenshot object
    • cookie string: custom cookie used (see Custom POST Data, Referer and Cookie)
    • cost integer: number of credits spent for the screenshot
    • delay integer: number of seconds to wait after page load
    • details integer: level of details about the screenshot and the page
    • error string: description of the problem that occurred
    • final_url string: URL of the screenshot (redirections can occur)
    • flash_delay integer: number of seconds to wait after page load if Flash elements are present
    • height integer: screenshot height
    • id required integer: screenshot ID
    • instance_id required integer: instance ID used for the screenshot
    • post_data string: POST data sent (see Custom POST Data, Referer and Cookie)
    • priority integer: priority given to the screenshot: high (1) to low (3)
    • referer string: custom referrer used (see Custom POST Data, Referer and Cookie)
    • scale number: image scale. Always 1 for desktop browsers; mobiles may change the scale (zoom in or zoom out) to fit the page on the screen
    • script string: URL of optional javascript file executed after the page load event
    • shared_url string: if the screenshot was shared, show the public URL
    • size string (values: screen, page): screenshot size requested
    • status required string (values: in_queue, processing, finished, error): status of the request: "in_queue", "processing", "finished", "error"
    • url required string: original URL requested
    • width integer: screenshot width

ScreenshotError

  • ScreenshotError object
    • cost number: number of credits taken
    • error string: description of the problem that occurred
    • priority number: priority given to the screenshot - high (1) to low (3)
    • status string: status of the request - "in_queue", "processing", "finished", "error"

ScreenshotHost

  • ScreenshotHost object
    • id integer: screenshot ID
    • status string (values: error, ok, in_queue): status of the request: "error", "ok" or "in_queue"
    • url string: URL to the hosted screenshot or thumbnail

ScreenshotInfoError

  • ScreenshotInfoError object
    • error string: description of the problem that occurred
    • id integer: screenshot ID
    • status string: status of the request - "in_queue", "processing", "finished", "error"

ScreenshotList

  • ScreenshotList object
    • default number

ScreenshotShort

  • ScreenshotShort object
    • id integer: screenshot ID
    • status string (values: ok, error): status of the request
datafire
@infinitebrahmanuniverse/nolb-_datafire_b@everything-registry/sub-chunk-221
6.0.0

5 years ago

5.0.0

7 years ago

4.0.0

7 years ago

3.0.0

8 years ago

2.0.3

8 years ago

2.0.2

8 years ago

2.0.1

8 years ago

2.0.0

8 years ago