Usage • Documentation • Disclaimer • Mirror

Features

• No API key needed
• First-class TypeScript support
• Works in Node.js, Bun, and Deno
• Modular result parsers

Install

Not supported in browser environments.

npm install google-sr
# Or with pnpm/yarn or https://bun.sh
pnpm add google-sr
yarn add google-sr
bun add google-sr
# we also provide builds on https://jsr.io/@typical/google-sr/
npx jsr add @typical/google-sr

CommonJS / ESM Notice

Currently this package provides both CommonJS (CJS) and ES Modules (ESM) builds.

Starting in version 7.x (subject to change), we plan to publish ESM-only releases and remove the CJS build.
As a result, you will no longer be able to use require() to import this package; you must use import instead.
(If you’re on Node.js v20 or later, you can still use require() with ESM modules natively. See release note)

Note: This only affects Node.js users. Runtimes like Bun and Deno already support ESM natively.

See this gist and our GitHub discussion for migration help.

Usage

google-sr is modular, use only the parsers relevant to your search. Here’s a simple example:

import { search, OrganicResult, TranslateResult, ResultTypes } from "google-sr";

const results = await search({
  query: "translate hello to japanese",
  parsers: [TranslateResult, OrganicResult],
});

console.log(results[0].type === ResultTypes.TranslateResult); // true
console.log(results);

Output Example

[
  {
    type: 'TRANSLATE',
    sourceLanguage: 'English (detected)',
    translationLanguage: 'Japanese',
    sourceText: 'hello',
    translatedText: 'こんにちは'
  },
  {
    type: 'ORGANIC',
    link: '...',
    description: "Konnichiwa – ...",
    title: '18 ...'
  }
]

More examples available at: apps/examples

Links

• API Documentation
• GitHub Repository
• Codeberg Mirror
• NPM Package
• Discord

Tests

Tests use vitest. Run:

pnpm run test

Disclaimer

This project is not sponsored, endorsed, or affiliated with Google in any way.

This repository is provided "as is" without warranty of any kind and is intended solely for educational and research purposes. The authors and contributors assume no responsibility for any issues, damages, or losses that may arise from its use.

By using this project, you acknowledge that you are solely responsible for complying with applicable laws and platform Terms of Service. Use at your own discretion and risk.

License

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

Like the project? Star it on GitHub ★