pageMetaScraper is a library to scrape metadata from any page. It scrapes Open Graph metadata, regular HTML metadata and uses text and images from the page as well as images from several image search apis as fallback.

Install

Install with NPM:

npm i --save page-meta-scraper

Install with Yarn:

yarn add page-meta-scraper

Usage

import pageMetaScraper from 'page-meta-scraper'

const url = 'https://example.com'

const metadata = await pageMetaScraper.scrape(url)

// {
//   title: 'page title',
//   description: 'page description',
//   favicon: 'https://example.com/favicon.png',
//   imageUrls: ['https://example.com/page-image.jpg'],
// }

Fallback image APIs

Since some pages don't show any images, ContextualWeb Image Search API and Unsplash Image API can be used as fallback strategies. Both strategies have to be configured and keywords have to be provided to search for images:

import pageMetaScraper from 'page-meta-scraper'

pageMetaScraper.configure({
  useFallbackImages: true,
  imageFallbackStrategies: ['contextualweb', 'unsplash'],

  unsplashBaseUrl: 'URL',
  unsplashClientId: 'URL',
  xRapidapiHost: 'HOST',
  xRapidapiKey: 'KEY',
})

const url = 'https://example.com'
const keywords = ['example', 'key', 'words']

const metadata = await pageMetaScraper.scrape(url, keywords)

The fallback images can also be used by themself:

import pageMetaScraper from 'page-meta-scraper'

pageMetaScraper.configure({
  useFallbackImages: true,
  imageFallbackStrategies: ['contextualweb', 'unsplash'],

  unsplashBaseUrl: '',
  unsplashClientId: '',
  xRapidapiHost: '',
  xRapidapiKey: '',
})

const keywords = ['example', 'key', 'words']

const imageUrls = await pageMetaScraper.fallbackImages(keywords)

ContextualWeb Image Search API

If you want to use the ContextualWeb Image Search API as a fallback strategy you have to provide xRapidapiHost, xRapidapiKey and imageSearchBaseUrl in the config.

Unsplash Image API

If you want to use the Unsplash Image API as a fallback strategy you have to provide unsplashBaseUrl and unsplashClientId in the config.

License

The npm package is available as open source under the terms of the MIT License.