Skip to main content
Module

x/serpapi/docs/migrating_from_google_search_results_nodejs.md

Scrape and parse search engine results using SerpApi.
serpapi/serpapi-javascript
Go to Latest
File

Migrating from google-search-results-nodejs

The google-search-results-nodejs npm package is being deprecated in favor of the serpapi npm package. It will still be available via npm, but will not receive feature updates. The following are the differences to better help you migrate over to the serpapi npm package.

Changed

  • Use functions rather than classes to access SerpApi. The engine parameter is used to specify the target search engine.

    // ❌ Previous way.
import { GoogleSearch } from "google-search-results-nodejs";
const engine = new GoogleSearch(API_KEY);
engine.json(...);

// ✅ New way, import and use functions directly.
import { getJson } from "serpapi";
getJson("google", { api_key: API_KEY, ... })

  • The search_archive method is replaced by getJsonBySearchId and getHtmlBySearchId.

    // ❌ Previous way, only supported JSON output.
engine.search_archive(searchId, console.log);

// ✅ New way, use `getJsonBySearchId`.
getJsonBySearchId(searchId, { api_key: API_KEY }, console.log);

// ✅ New way, use `getHtmlBySearchId` if you want the HTML result.
getHtmlBySearchId(searchId, { api_key: API_KEY }, console.log);

  • The account and location methods are now getAccount and getLocations. The q and limit parameters for getLocations are now optional.

    // ❌ Previous way, was part of the engine class.
engine.account(console.log);
engine.location("Austin", 5, console.log);

// ✅ New way, functions not tied to a class.
import { getAccount, getLocations } from "serpapi";
getAccount({ api_key: API_KEY }, console.log);
getLocations({ q: "Austin" }, console.log);

Removed

  • The buildUrl, execute and search methods are removed. Use getJson and getHtml functions instead.
  • The SerpApiSearch class is removed as a public class.
  • Dropped support for Node.js 16.13 and below. This module supports Node.js 16.14 and above.

Fixed

  • Setting the api_key parameter to null works for unmetered queries.
    // ❌ Previously, error is thrown when api_key is undefined or null.
const engine = new GoogleSearch();
engine.json({ q: "coffee", api_key: undefined });

// ✅ Now, no error is thrown when api_key is null
getJson("google", { q: "coffee", api_key: null });

Added

  • TypeScript types for supported parameters.
  • First-class Promises support.
    const json = await getJson("google", { q: "coffee" });
  • config object to configure global api_key and timeout values.
    import { config } from "serpapi";
config.api_key = "new_api_key";
config.timeout = 20000; // 20 seconds
  • Error classes (MissingApiKeyError and InvalidTimeoutError).
    getJson("google", { api_key: "" }); // Throws `MissingApiKeyError`
getAccount({ api_key: API_KEY, timeout: 0 }); // Throws `InvalidTimeoutError`