google-sr

google-sr 🔍

Simple & Fast Package for scraping Google search results without the need for an API key. 🚀

• View documentation here

• Come chat with us on our discord

Features ✨

• Simple & Fast ⚡️ *
• Well tested 🔄
• Well documented 📚
• TypeScript compatible 🧑‍💻
• No API key is needed 🔑
• Wide variety of search result types supported 🌴

Install 📦

To get started, you can install google-sr using your preferred package manager:

# npm

npm install google-sr

# pnpm 

pnpm add google-sr

# yarn

yarn add google-sr

Usage

You can easily perform a single-page search like this:

import { search, ResultTypes } from 'google-sr';

// using await/async
const searchResults = await search({ 
    query: 'nodejs', 
    safeMode: false, 
    filterResults: [ResultTypes.SearchResult] 
});

// will return a []
console.log(searchResults);
// should log: true
console.log(searchResults[0].type === ResultTypes.SearchResult)

• Read about the returned types here

• More detailed examples & usage can be found here

By default only ResultTypes.SearchResult are returned, use the filterResults option to configure it

• Additional examples can be found in tests and apps directory

Disclaimer

This is not sponsored, supported, or affiliated with Google Inc.

Unlike the conventional recommendation of using the Google API, this module scrapes the Google search result page (which might potentially infringe upon Google's terms of service).

The source code within this repository is intended solely for educational purposes.

The author (typicalninja) & contributors takes no responsibility for any issues that arise from misuse, such as IP blocking by Google. Your discretion in usage is advised.

Related projects 🥂

• google-that - CLI wrapper around google-sr
• google-sr-selectors - Selectors for google search results used by google-sr

Tests

Tests are written using mocha and can be run by using the test script.

Weekly tests a executed using a github action to ensure compatibility

Project uses pnpm as its package manager

pnpm run test

Support & Bug Reporting 🛠️🐞

Make sure you are on the latest version before creating bug reports

Support and bug reporting both can be done on github issues

License

This repository and the code inside it is licensed under the Apache-2.0 License. Read LICENSE for more information.