1.0.0 • Published 3 years ago

webshotapi v1.0.0

Weekly downloads
8
License
MIT
Repository
github
Last release
3 years ago

WebShotApi.com API client for NodeJS

Take screenshot and save image in JPG, PNG, PDF. You can also extract selectors for all HTML elements with coordinates and css styles after browser rendering. In our api you can create project and send all you urls to queue. Our server will do all the work for you

Full documentation about our api you can find in this website Website screenshot API DOCS

Installation

Use the package manager NPM to install our client in nodejs.

npm install webshotapi

API KEY

Api key you can generate after register. https://webshotapi.com/dashboard/api/

Usage

Take screenshot and save jpg to file

const webshotapi = require('webshotapi');

//Image download
const TOKEN = "YOUR TOKEN HERE";
(async()=>{
    try{
        const client = new Webshotapi(TOKEN);
        const result = await client.screenshot_jpg('https://www.example.com', {
            remove_modals:1,
            'width': 1920,
            'no_cache': 1
        });
        
        #save screenshot to file
        await result.save('/tmp/screenshot_test.jpg');
    }catch(e){
        console.log("Error", e);
    }
})();

Take screenshot and save PDF to file

You can covert your html page to invoice in PDF.

const webshotapi = require('webshotapi');

//Image download
const TOKEN = "YOUR TOKEN HERE";
(async()=>{
    try{
        const client = new Webshotapi(TOKEN);
        const result = await client.screenshot_pdf('https://www.example.com', {
            remove_modals:1,
            'width': 1920,
            'no_cache': 1
        });
        
        #save screenshot to file
        await result.save('/tmp/screenshot_test.pdf');
    }catch(e){
        console.log("Error", e);
    }
})();

Extract words map and HTML elements with css styles after rendering

Unique software to extract all selectors for HTML elements from website with css styles after browser rendering. Additionally you can extract all words with position (x,y,width, height, offset from previous word). Thank that you can build words map of website.

Sample script:

const webshotapi = require('webshotapi');

//Image download
const TOKEN = "YOUR TOKEN HERE";
(async()=>{
    try{
        const client = new Webshotapi(TOKEN);
        const result = await client.extract('https://www.example.com', {
            "remove_modals": 1,
            "ads": 1,
            "width": 1680,
            "height": 960,
            "extract_selectors": 1,
            "extract_words": 1,
            "extract_style": 1,
            "extract_text": 1,
            "extract_html": 1,
        });
        
        //get json data
        let data = result.json();
        
        //show result data
        console.log(data);

        //save data to file
        result.save('/tmp/test.json');
    }catch(e){
        console.log("Error", e);
    }

Results

{
  "selectors": [
    {
      "xpath": "/html/body",
      "x": 1212,
      "y": 17,
      "w": 117,
      "h": 25,
      "style": {
        "visibility": "visible",
        "display": "inline",
        "fontWeight": "400",
        "backgroundImage": "none",
        "cursor": "pointer",
        "fontSize": "22px",
        "color": "rgb(255, 255, 255)",
        "position": "static",
        "textDecoration": "none solid rgb(255, 255, 255)",
        "text-decoration-line": "none",
        "backgroundColor": "rgba(0, 0, 0, 0)"
      },
      "class": ".col-12 col-sm-12",
      "id": "#price",
      "itemprop": "price"
    }
  ],
  "words": [
    {
      "xpath": "/html/body/div[1]/div[2]/div/div[2]/ul/li[5]/a",
      "word": "Welcome",
      "position": {
        "x": 434.8,
        "y": 343.4,
        "w": 434,
        "h": 43
      },
      "word_index": 2,
      "offset": 14
    }
  ],
  "html": "<!doctype html><html lang='en' dir='ltr'><head><base hr...",
  "text": "Welcome in our page\nToday is Monday...",
  "screenshot_url": "https://api.webshotapi.com/v1/screenshot/?token=....&width=1920&height=960",
  "status_code": 200
}

API docs

Full documentation about our api you can find in this website API DOCS

About our service

License

MIT