sharedcount-lite v2.0.1

SharedCount Lite

SharedCount API module for nodejs

SharedCount API documentation: https://www.sharedcount.com/api-docs/getting-started

This software is released under the MIT license. See LICENSE for more details

Download and Installation

From the command line

$ yarn add sharedcount-lite

or

$ npm install sharedcount-lite

Example use

var SharedCount = require('sharedcount');

var sc = new SharedCount({ apikey: 'YOUR_API_KEY' });

const result = await sc.url('www.yahoo.com');

Documentation

Initialize SharedCount object:

var SharedCount = require('sharedcount');
var sc = new SharedCount({
    apiKey: 'YOUR_API_KEY' || process.env.SHAREDCOUNT_API_KEY,
    baseUrl: 'YOUR_BASE_URL' || process.env.SHAREDCOUNT_BASE_URL, // optional
    config: {
        timeout: 30000 // add timeout of 30s, default is 101
    }, // optional, you can pass any parameter that axios http library supports
});

url(url)

Resolve with share counts for a URL.

sc.url('sharedcount.com');

quota()

Resolve with information about your quota allocation for the day.

sc.quota();

usage()

Resolve with historical quota usage information.

sc.usage();

domain_whitelist()

Resolve with a list of domains added to your domain whitelist, and whether the domain whitelist is currently being enforced.

sc.domainWhitelist();

status()

Check to see if the SharedCount API is currently up.

sc.status();