node package manager

open-graph-scraper

Node.js scraper service for Open Graph info

openGraphScraper

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

npm install open-graph-scraper
var ogs = require('open-graph-scraper');
var options = {'url': 'http://ogp.me/'};
ogs(options, function (err, results) {
console.log('err:', err); // 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);
});

You can also set a timeout flag like... Example four seconds:

var ogs = require('open-graph-scraper');
var options = {'url': 'http://ogp.me/', 'timeout': 4000};
ogs(options, function (err, results) {
console.log('err:', err); // 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);
});

Note: By default if page dose not have something like a og:title tag it will try and look for it in other places and return that. If you truely only want open graph info you can use the option onlyGetOpenGraphInfo and set it to true. In addition, this will also scrape twitter info!

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 eample 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
}

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/

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

make test