@everapi/screenshotbase-js

screenshotbase-js: JS Website Screenshot Client

This package is a JavaScript wrapper for screenshotbase.com that aims to make usage of the API as easy as possible in your project.

• Repository: https://github.com/everapihq/screenshotbase-js
• Docs: https://screenshotbase.com

Documentation

• Full API and SDK docs: https://screenshotbase.com
• Get your API key and start for free: https://screenshotbase.com

Installation

npm

npm install --save @everapi/screenshotbase-js

yarn

yarn add @everapi/screenshotbase-js

Import

import Screenshotbase from '@everapi/screenshotbase-js';

or use it directly in a Browser:

<script src="path/to/screenshotbase-js/index.umd.js"></script>

Usage

Initialize the API with your API Key (get one for free at screenshotbase.com):

const client = new Screenshotbase('YOUR-API-KEY');

Afterwards you can make calls to the API like this:

client.status().then(response => {
  console.log(response);
});

client.take({ url: 'https://bbc.com', format: 'png', full_page: true })
  .then(buffer => {
    // handle ArrayBuffer image data
  });

Endpoints accessible with a free account:

• status
• take

Find out more about our endpoints, parameters and response data structure in the docs.

License

The MIT License (MIT). Please see License File for more information.