Installations

npm install open-graph-scraper-lite

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS, ESM

Min. Node Version

>=16.0.0

Node Version

18.18.0

NPM Version

9.8.1 Pull Requests

Open

0

Total

5

Closed

2

Merged

3

Issues

Open

0

Total

7

Closed

7

Releases

Unable to fetch releases

Languages

1

TypeScript

TypeScript (100%)

Developer

jshemas

Download Statistics

Total Downloads

73,284

Last Day

149

Last Week

789

Last Month

4,191

Last Year

57,083

GitHub Statistics

MIT License

31 Stars

28 Commits

8 Forks

1 Watchers

1 Branches

2 Contributors

Updated on May 05, 2025

Bundle Size

484.88 kB

Minified

150.93 kB

Minified + Gzipped

Bundlephobia

Maintainers

1

View All 2 Contributors

Package Meta Information

Latest Version

2.1.0

Package Id

open-graph-scraper-lite@2.1.0

Unpacked Size

124.86 kB

Size

15.16 kB

File Count

29

NPM Version

9.8.1

Node Version

18.18.0

Published on

Jul 15, 2024

Total Downloads

Cumulative downloads

Total Downloads

73,284

Last Day

-6.9%

149

Compared to previous day

Last Week

-22.7%

789

Compared to previous week

Last Month

-32.9%

4,191

Compared to previous month

Last Year

1,403.8%

57,083

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

3

chardet cheerio validator

Dev Dependencies

18

@snyk/protect @types/mocha @types/node @types/validator @typescript-eslint/eslint-plugin @typescript-eslint/parser chai eslint eslint-config-airbnb-base eslint-config-airbnb-typescript eslint-plugin-import eslint-plugin-mocha eslint-plugin-promise mocha nyc sinon ts-mocha typescript

openGraphScraperLite

A simple javascript module for scraping Open Graph and Twitter Card info from given HTML. For Node.js usage, we recommend open-graph-scraper by the same people and can do HTTP requests.

Installation

1npm install open-graph-scraper-lite --save

Usage

1const ogs = require('open-graph-scraper');
2const options = {
3  html: `<html><head>
4  <link rel="icon" type="image/png" href="https://bar.com/foo.png" />
5  <meta charset="utf-8" />
6  <meta property="og:description" name="og:description" content="html description example" />
7  <meta property="og:image" name="og:image" content="https://www.foo.com/bar.jpg" />
8  <meta property="og:title" name="og:title" content="foobar" />
9  <meta property="og:type" name="og:type" content="website" />
10  </head></html>`
11};
12ogs(options)
13  .then((data) => {
14    const { result } = data;
15    console.log('result:', result);
16  })

Results JSON

1result: {
2  ogDescription: 'html description example',
3  ogTitle: 'foobar',
4  ogType: 'website',
5  ogImage: [ { url: 'https://www.foo.com/bar.jpg', type: 'jpg' } ],
6  favicon: 'https://bar.com/foo.png',
7  charset: 'utf-8',
8  success: true
9}

Options

Name	Info	Default Value
html	You can pass in an HTML string to run ogs on it. (use without options.url)	x
onlyGetOpenGraphInfo	Only fetch open graph info and don't fall back on anything else.	false
customMetaTags	Here you can define custom meta tags you want to scrape.	[]

Custom Meta Tag Example

1const ogs = require('open-graph-scraper');
2const options = {
3  html: `<html><head>
4  <link rel="icon" type="image/png" href="https://bar.com/foo.png" />
5  <meta charset="utf-8" />
6  <meta property="og:description" name="og:description" content="html description example" />
7  <meta property="og:image" name="og:image" content="https://www.foo.com/bar.jpg" />
8  <meta property="og:title" name="og:title" content="foobar" />
9  <meta property="og:type" name="og:type" content="website" />
10  <meta name="hostname" content="github.com">
11  </head></html>`,
12  customMetaTags: [{
13    multiple: false, // is there more than one of these tags on a page (normally this is false)
14    property: 'hostname', // meta tag name/property attribute
15    fieldName: 'hostnameMetaTag', // name of the result variable
16  }],
17};
18ogs(options)
19  .then((data) => {
20    const { result } = data;
21    console.log('hostnameMetaTag:', result.customMetaTags.hostnameMetaTag); // hostnameMetaTag: github.com
22  })

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

6

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

3.4

/10

Last Scanned on 2025-05-05

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More