google-sr 🔍

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

Features

• No API key is needed 🔑
• First-party TypeScript support
• Customizable selectors 🔍
• Well tested 🔄
• Supports multiple runtimes

Install 📦

Runtime Support

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 install google-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

Usage

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

import {
  search,
  OrganicResult, // Import the result types you need
  DictionaryResult,
  ResultTypes, // Import to filter results by type
} from "google-sr";

const queryResult = await search({
  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 type ResultTypes.OrganicResult are returned. Use the resultTypes option to customize the output.

• Additional examples can be found in apps/examples directory

Disclaimer

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

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

Links

• API Documentation
• GitHub Repository
• NPM Package
• Discord

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 vitest and can be run by using the test script.

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

pnpm run test

License

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