# open-graph-scraper > Node.js scraper module for Open Graph and Twitter Card info Latest version **6.12.0** (published 2026-06-26) · MIT license · 0 weekly downloads ## Install ```sh npm install open-graph-scraper pnpm add open-graph-scraper yarn add open-graph-scraper bun add open-graph-scraper ``` ## Health **Score 70/100 (B)** — status: active. Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score. Warnings: low downloads. ## Facts | | | |---|---| | Version | 6.12.0 | | Published | 2026-06-26 | | First published | 2013-10-31 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Node | >=20.0.0 | | Dependencies | 4 | | Unpacked size | 185.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 753 | | Author | Josh Shemas | | Maintainers | jshemas | | Keywords | app links, dublin core, json ld, meta tags, metadata, og, ogp, ogs, open graph scraper, open graph, opengraph, openGraphScraper, scraper, twitter card, twitter | ## Links - npm: https://www.npmjs.com/package/open-graph-scraper - Repository: https://github.com/jshemas/openGraphScraper - Homepage: https://github.com/jshemas/openGraphScraper#readme - Issues: https://github.com/jshemas/openGraphScraper/issues - npm.io page: https://npm.io/package/open-graph-scraper ## Dependencies (4) - [undici](https://npm.io/package/undici.md) ^7.28.0 - [chardet](https://npm.io/package/chardet.md) ^2.2.0 - [cheerio](https://npm.io/package/cheerio.md) ^1.2.0 - [iconv-lite](https://npm.io/package/iconv-lite.md) ^0.7.2 ## Alternatives - [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads - [log](https://npm.io/package/log.md) — 1.3M weekly downloads - [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads - [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads - [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads ## Recent versions - 6.12.0 (latest) — 2026-06-26 - 6.11.0 — 2025-11-26 - 6.10.0 — 2025-04-21 - 6.9.0 — 2025-01-19 - 6.8.4 — 2025-01-14 - 6.8.3 — 2024-12-04 - 6.8.2 — 2024-09-18 - 6.8.1 — 2024-08-29 - 6.8.0 — 2024-08-17 - 6.7.2 — 2024-08-01 - 6.7.1 — 2024-07-29 - 6.7.0 — 2024-07-22 - 6.6.3 — 2024-07-17 - 6.6.2 — 2024-06-29 - 6.6.1 — 2024-06-26 - … 99 more at https://npm.io/package/open-graph-scraper/versions ## README # openGraphScraper [![Node.js CI](https://github.com/jshemas/openGraphScraper/workflows/Node.js%20CI/badge.svg?branch=master)](https://github.com/jshemas/openGraphScraper/actions?query=branch%3Amaster) [![Known Vulnerabilities](https://snyk.io/test/github/jshemas/openGraphScraper/badge.svg)](https://snyk.io/test/github/jshemas/openGraphScraper) A simple node module(with TypeScript declarations) for scraping Open Graph and Twitter Card and other metadata off a site. Note: `open-graph-scraper` doesn't support browser usage at this time but you can use `open-graph-scraper-lite` if you already have the `HTML` and can't use Node's [Fetch API](https://nodejs.org/dist/latest-v18.x/docs/api/globals.html#fetch). ## Installation ```bash npm install open-graph-scraper --save ``` ## Usage ```javascript const ogs = require('open-graph-scraper'); const options = { url: 'http://ogp.me/' }; ogs(options) .then((data) => { const { error, html, result, response } = data; console.log('error:', error); // This returns true or false. True if there was an error. The error itself is inside the result object. console.log('html:', html); // This contains the HTML of page console.log('result:', result); // This contains all of the Open Graph results console.log('response:', response); // This contains response from the Fetch API }) ``` ## 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... ```javascript { ogTitle: 'Open Graph protocol', ogType: 'website', ogUrl: 'https://ogp.me/', ogDescription: 'The Open Graph protocol enables any web page to become a rich object in a social graph.', ogImage: [ { height: '300', type: 'image/png', url: 'https://ogp.me/logo.png', width: '300' } ], charset: 'utf-8', requestUrl: 'http://ogp.me/', success: true } ``` ## Options | Name | Info | Default Value | Required | |----------------------|-------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|----------| | url | URL of the site. | | x | | html | You can pass in an HTML string to run ogs on it. (use without options.url) | | | | fetchOptions | Options that are used by the Fetch API | {} | | | timeout | Request timeout for Fetch (Default is 10 seconds) | 10 | | | 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. Also accepts an array of properties for which no fallback should be used | false | | | customMetaTags | Here you can define custom meta tags you want to scrape. | [] | | | urlValidatorSettings | Sets the options used by validator.js for testing the URL | [Here](https://github.com/jshemas/openGraphScraper/blob/master/lib/utils.ts#L4-L17) | | | jsonLDOptions | Sets the options used when parsing JSON-LD data | | | Note: `open-graph-scraper` uses the [Fetch API](https://nodejs.org/dist/latest-v18.x/docs/api/globals.html#fetch) for requests and most of [Fetch's options](https://developer.mozilla.org/en-US/docs/Web/API/fetch#options) should work as `open-graph-scraper`'s `fetchOptions` options. ## Types And Import Example ```javascript // example of how to get types import type { SuccessResult } from 'open-graph-scraper/types'; const example: SuccessResult = { result: { ogTitle: 'this is a title' }, error: false, response: {}, html: '' } // import example import ogs from 'open-graph-scraper'; const options = { url: 'http://ogp.me/' }; ogs(options) .then((data) => { const { error, html, result, response } = data; console.log('error:', error); // This returns true or false. True if there was an error. The error itself is inside the result object. console.log('html:', html); // This contains the HTML of page console.log('result:', result); // This contains all of the Open Graph results console.log('response:', response); // This contains response from the Fetch API }); ``` ## Custom Meta Tag Example ```javascript const ogs = require('open-graph-scraper'); const options = { url: 'https://github.com/jshemas/openGraphScraper', customMetaTags: [{ multiple: false, // is there more than one of these tags on a page (normally this is false) property: 'hostname', // meta tag name/property attribute fieldName: 'hostnameMetaTag', // name of the result variable }], }; ogs(options) .then((data) => { const { result } = data; console.log('hostnameMetaTag:', result.customMetaTags.hostnameMetaTag); // hostnameMetaTag: github.com }) ``` ## HTML Example ```javascript const ogs = require('open-graph-scraper'); const options = { html: ` ` }; ogs(options) .then((data) => { const { result } = data; console.log('result:', result); // result: { // ogDescription: 'html description example', // ogTitle: 'foobar', // ogType: 'website', // ogImage: [ { url: 'https://www.foo.com/bar.jpg', type: 'jpg' } ], // favicon: 'https://bar.com/foo.png', // charset: 'utf-8', // success: true // } }) ``` ## User Agent Example The request header is set to [undici](https://github.com/nodejs/undici) by default. Some sites might block this, and changing the `userAgent` might work. If not you can try [using a proxy](https://www.scrapingbee.com/blog/proxy-node-fetch/) for the request and then pass the `html` into `open-graph-scraper`. ```javascript const ogs = require("open-graph-scraper"); const userAgent = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36'; ogs({ url: 'https://www.wikipedia.org/', fetchOptions: { headers: { 'user-agent': userAgent } } }) .then((data) => { const { error, html, result, response } = data; console.log('error:', error); // This returns true or false. True if there was an error. The error itself is inside the result object. console.log('html:', html); // This contains the HTML of page console.log('result:', result); // This contains all of the Open Graph results console.log('response:', response); // This contains response from the Fetch API }) ``` ## JSON-LD Parsing Options Example `throwOnJSONParseError` and `logOnJSONParseError` properties control what happens if `JSON.parse` throws an error when parsing JSON-LD data. If `throwOnJSONParseError` is set to `true`, then the error will be thrown. If `logOnJSONParseError` is set to `true`, then the error will be logged to the console. ```javascript const ogs = require("open-graph-scraper"); const userAgent = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36'; ogs({ url: 'https://www.wikipedia.org/', jsonLDOptions: { throwOnJSONParseError: true } }) .then((data) => { const { error, html, result, response } = data; console.log('error:', error); // This returns true or false. True if there was an error. The error itself is inside the result object. console.log('html:', html); // This contains the HTML of page console.log('result:', result); // This contains all of the Open Graph results console.log('response:', response); // This contains response from the Fetch API }) ``` ## Running the example app Inside the `example` folder contains a simple express app where you can run `npm ci && npm run start` to spin up. Once the app is running, open a web browser and go to `http://localhost:3000/scraper?url=http://ogp.me/` to test it out. There is also a `Dockerfile` if you want to run this example app in a docker container. --- _Source: https://npm.io/package/open-graph-scraper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._