tiny-web-search

Google Custom Search API

npm i tiny-web-search

You need the Custom Search API key and to create a Search Engine.

https://developers.google.com/custom-search/v1/overview

https://programmablesearchengine.google.com/about/

Usage

const WebSearch = require('tiny-web-search')

const google = new WebSearch()

const results = await google.search('Who created the US dollar?')
const results2 = await google.search(results.query, { start: results.nextPage })

// => { query, items, nextPage }

/* items[0] => {
  title: 'Money 101 Quiz | MyCreditUnion.gov',
  link: 'https://mycreditunion.gov/learning-resources/learning-tools/money-101-quiz',
  snippet: 'The United States $5 dollar bill, first issued in the 1962 features the 16th ...',
  metatags: {
    author: null,
    og: {
      description: 'How well do you know the faces on dollars and coins? Take the quiz now and find out!',
      type: 'page',
      image: 'https://mycreditunion.gov/sites/default/files/2024-10/dollars-coins.jpg',
      imageAlt: null
    },
    twitter: { creator: null },
    article: { author: null, publishedTime: '2024-10-24' }
  }
} */

API

google = new WebSearch([options])

Create a new WebSearch instance.

Options:

{
  key: process.env.GOOGLE_CUSTOM_SEARCH_KEY,
  cx: process.env.GOOGLE_SEARCH_ENGINE_ID
}

results = await google.search(query[, options])

Search in the internet by query.

Options:

{
  start: 1 // Limited by 10 results, so next page is 11
}

Returns: { query, items, nextPage }.

License

MIT