google-sr 🔍

Easy to use, updated tools for scraping google search results. 🚀

• Documentation can be found here

• API documentation can be found here

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

Monorepo

Welcome to the 📦 monorepo of GSR Project.

🏠 This is the home to google-sr and its related packages & applications.

google-sr

google-sr-selectors

google-that

This monorepo is managed with turborepo and uses pnpm workspaces.

Mirror 🪞

GSR project has a mirror repository on codeberg You can find it here

• All issues and discussion are limited to github & discord

Disclaimer

This is not sponsored, supported, or affiliated with Google Inc. 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.

Tests

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

Weekly tests are executed using a github action to ensure compatibility

This monorepo 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.