open-graph-scraper

openGraphScraper

A simple node module for scraping Open Graph and Twitter Card info off a site.

Installation

npm install open-graph-scraper

Usage

Callback Example:

const ogs = require('open-graph-scraper');
const options = { url: 'http://ogp.me/' };
ogs(options, (error, results, response) => {
  console.log('error:', error); // This is returns true or false. True if there was a error. The error it self is inside the results object.
  console.log('results:', results); // This contains all of the Open Graph results
  console.log('response:', response); // This contains the HTML of page
});

Promise Example:

const ogs = require('open-graph-scraper');
const options = { url: 'http://ogp.me/' };
ogs(options)
  .then((data) => {
    const { error, result, response } = data;
    console.log('error:', error);  // This is returns true or false. True if there was a error. The error it self is inside the results object.
    console.log('results:', results); // This contains all of the Open Graph results
    console.log('response:', response); // This contains the HTML of page
  })

Results JSON

Check the return for a success flag. If success is set to true, then the url input was valid. Otherwise it will be set to false. The above example will return something like...

{
  data: {
    ogTitle: 'Open Graph protocol',
    ogType: 'website',
    ogUrl: 'http://ogp.me/',
    ogDescription: 'The Open Graph protocol enables any web page to become a rich object in a social graph.',
    ogImage: {
      url: 'http://ogp.me/logo.png',
      width: '300',
      height: '300',
      type: 'image/png'
    }
  },
  success: true
}

Options

Name	Info	Default Value	Required
url	URL of the site.		x
timeout	Timeout of the request	2000 ms
html	You can pass in an HTML string to run ogs on it. (use without options.url)
blacklist	Pass in an array of sites you don't want ogs to run on.	[]
onlyGetOpenGraphInfo	Only fetch open graph info and don't fall back on anything else.	false
ogImageFallback	Fetch other images if no open graph ones are found.	true
decompress	Set the accept-encoding to gzip/deflate	true
followRedirect	Defines if redirect responses should be followed automatically.	true
maxRedirects	Max number of redirects ogs will follow.	10
retry	Number of times ogs will retry the request.	2
encoding	Setting this to null might help with running ogs on non english websites	utf8
peekSize	Sets the peekSize for the request	1024
runChar	Runs charset and icons on the request payload.	false
withCharset	Returns the charset in the ogs payload.	false

Tests

You have to have mocha running. To install it run...

npm install mocha -g

Then you can run the tests by turning on the server and run...

mocha tests/

Make

This will install the all of the dependencies, then run the tests

make test

Changelog

4.0.0 (has breaking changes!)

• Dropping support for any node version under 10
• Open Graph values are no longer nested in a data object.
• Stop using request.js(deprecated) and start using got.js
• Using promises will now send the error/result/response back in one object.
• Options.gzip is now options.decompress
• Options.followAllRedirects is now options.followRedirect
• Drop support for options.jar
• Options.timeout must be a number value
• Updating error messaging
• Updating dependencies