Repository files navigation

Scrape google search results without an API key with javascript/typescript.

google-sr does not support web environments, but it has been tested and confirmed to work on the following runtimes:

• Node.js
• Bun
• Deno

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

npm install google-sr# For pnpm/yarn/bun:pnpm/yarn/bun add google-sr# For Deno, either use the npm: specifier# or import from esm.sh# https://esm.sh/google-sr

This example demonstrates some of the features ofgoogle-sr. For a bare minimum setup, refer to theexamples/basic file.

import{search,OrganicResult,// Import the result types you needDictionaryResult,ResultTypes,// Import to filter results by type}from"google-sr";constqueryResult=awaitsearch({query:"nodejs",// Specify the result types explicitly ([OrganicResult] is the default, but it is recommended to always specify the result type)resultTypes:[OrganicResult,DictionaryResult],// Optional: Customize the request using AxiosRequestConfig (e.g., enabling safe search)requestConfig:{params:{safe:"active",// Enable "safe mode"},},});// will return a SearchResult[]console.log(queryResult);console.log(queryResult[0].type===ResultTypes.OrganicResult);// true

Note: By default, only results of typeResultTypes.OrganicResult are returned. Use theresultTypes option to customize the output.

• Additional examples can be found inapps/examples directory

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 withturborepo and usespnpm workspaces.

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

The source code within this repository is intended solely foreducational & research purposes.The author (typicalninja) & contributors takesNO responsibility for any issues that arise from its use, such as IP blocking by Google. Your discretion in usage is advised.

GSR project has a mirror repository on codebergYou can find ithere

• All issues and discussion are limited to github & discord

Tests are written usingvitest and can be run by using thetest script.

Weekly tests are executed using a github action to ensure compatibility and catch breakage due to google changes

pnpm runtest

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