Scrape and parse search engine results using SerpApi with Browser support
npm install @subho57/serpapiThis is fork of the original
serpapi/serpapi-javascript
repository with support for modern browsers and Node >= 18. If using Node >= 7,
please use the original repository.
Scrape and parse search engine results using SerpApi. Get
search results from Google, Bing, Baidu, Yandex, Yahoo, Home Depot, eBay and
more.
| 🪧 Coming from google-search-results-nodejs?
Check out the migration document to find out how to upgrade. |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
- Supports Node.js 18.x and newer.
- Refer to this example for help.
``bash`
npm install @subho57/serpapi
`js`
const { getJson } = require("@subho57/serpapi");
getJson({
engine: "google",
api_key: API_KEY, // Get your API_KEY from https://serpapi.com/manage-api-key
q: "coffee",
location: "Austin, Texas",
}, (json) => {
console.log(json["organic_results"]);
});
- Refer to this example for help.
You will need to add "type": "module" to your package.json:
`js`
{
"type": "module",
// rest of package.json
}
`js`
import { getJson } from "@subho57/serpapi";
const response = await getJson({
engine: "google",
api_key: API_KEY, // Get your API_KEY from https://serpapi.com/manage-api-key
q: "coffee",
location: "Austin, Texas",
});
console.log(response);
- Import directly from deno.land.
- Usage is otherwise the same as above.
- Refer to this example for help.
`ts`
import { getJson } from "https://deno.land/x/serpapi/mod.ts";
- TypeScript support.
- Works out-of-the-box with
Node.js and
Deno.
- Promises and async/await support.
- Callbacks support.
- Examples in JavaScript/TypeScript on Node.js/Deno using ESM/CommonJS, and more.
- Pagination support.
- (Planned) More error classes.
You can declare a global api_key and timeout value by modifying the config
object. is defined in milliseconds and defaults to 60 seconds.
All functions, other than getLocations, accepts an optional api_key andtimeout that will take precedence over the values defined in config.
getLocations doesn't require an API key.
`js
import { config, getJson } from "@subho57/serpapi";
config.api_key = API_KEY;
config.timeout = 60000;
await getJson({ engine: "google", q: "coffee" }); // uses the API key defined in the config
await getJson({ engine: "google", api_key: API_KEY_2, q: "coffee" }); // API_KEY_2 will be used
`
Search engines handle pagination in several different ways. Some rely on an
"offset" value to return results starting from a specific index, while some
others rely on the typical notion of a "page". These are often combined with a
"size" value to define how many results are returned in a search.
This module helps you handle pagination easily. After receiving search results
from getJson, simply call the next() method on the returned object tonext()
retrieve the next page of results. If there is no method, then either
pagination is not supported for the search engine or there are no more pages to
be retrieved.
`js`
const page1 = await getJson({ engine: "google", q: "coffee", start: 15 });
const page2 = await page1.next?.();
You may pass in the engine's supported pagination parameters as per normal. In
the above example, the first page contains the 15th to the 24th result while the
second page contains the 25th to the 34th result.
Note that if you set no_cache to true, all subsequent next() calls will
not return cached results.
Refer to the getJson definition below for more examples.
#### Table of Contents
- getJson
- Parameters
- Examples
- getHtml
- Parameters
- Examples
- getJsonBySearchId
- Parameters
- Examples
- getHtmlBySearchId
- Parameters
- Examples
- getAccount
- Parameters
- Examples
- getLocations
- Parameters
- Examples
Get a JSON response based on search parameters.
- Accepts an optional callback.
- Get the next page of results by calling the .next() method on the returned
response object.
#### Parameters
- parameters
object
search query parameters for the engine
- fn? optional callback
#### Examples
`javascript
// single call (async/await)
const json = await getJson({ engine: "google", api_key: API_KEY, q: "coffee" });
// single call (callback)
getJson({ engine: "google", api_key: API_KEY, q: "coffee" }, console.log);
`
`javascript`
// pagination (async/await)
const page1 = await getJson({ engine: "google", q: "coffee", start: 15 });
const page2 = await page1.next?.();
`javascript`
// pagination (callback)
getJson({ engine: "google", q: "coffee", start: 15 }, (page1) => {
page1.next?.((page2) => {
console.log(page2);
});
});
`javascript`
// pagination loop (async/await)
const organicResults = [];
let page = await getJson({ engine: "google", api_key: API_KEY, q: "coffee" });
while (page) {
organicResults.push(...page.organic_results);
if (organicResults.length >= 30) break;
page = await page.next?.();
}
`javascript`
// pagination loop (callback)
const organicResults = [];
getJson({ engine: "google", api_key: API_KEY, q: "coffee" }, (page) => {
organicResults.push(...page.organic_results);
if (organicResults.length < 30 && page.next) {
page.next();
}
});
Get a HTML response based on search parameters.
- Accepts an optional callback.
- Responds with a JSON string if the search request hasn't completed.
#### Parameters
- parameters
object
search query parameters for the engine
- fn? optional callback
#### Examples
`javascript
// async/await
const html = await getHtml({ engine: "google", api_key: API_KEY, q: "coffee" });
// callback
getHtml({ engine: "google", api_key: API_KEY, q: "coffee" }, console.log);
`
Get a JSON response given a search ID.
- This search ID can be obtained from the search_metadata.id key in theasync
response.
- Typically used together with the parameter.
- Accepts an optional callback.
#### Parameters
- searchId
string
search ID
-
object
(optional, default )
- parameters.api_key
string?
API key
-
number?
timeout in milliseconds
- fn? optional callback
#### Examples
`javascript
const response = await getJson({
engine: "google",
api_key: API_KEY,
async: true,
q: "coffee",
});
const { id } = response.search_metadata;
await delay(1000); // wait for the request to be processed.
// async/await
const json = await getJsonBySearchId(id, { api_key: API_KEY });
// callback
getJsonBySearchId(id, { api_key: API_KEY }, console.log);
`
Get a HTML response given a search ID.
- This search ID can be obtained from the search_metadata.id key in theasync
response.
- Typically used together with the parameter.
- Accepts an optional callback.
- Responds with a JSON if the search request hasn't completed.
#### Parameters
- searchId
string
search ID
-
object
(optional, default )
- parameters.api_key
string?
API key
-
number?
timeout in milliseconds
- fn? optional callback
#### Examples
`javascript
const response = await getJson({
engine: "google",
api_key: API_KEY,
async: true,
q: "coffee",
});
const { id } = response.search_metadata;
await delay(1000); // wait for the request to be processed.
// async/await
const html = await getHtmlBySearchId(id, { api_key: API_KEY });
// callback
getHtmlBySearchId(id, { api_key: API_KEY }, console.log);
`
Get account information of an API key.
#### Parameters
- parameters
object
(optional, default )
- parameters.api_key
string?
API key
-
number?
timeout in milliseconds
- fn? optional callback
#### Examples
`javascript
// async/await
const info = await getAccount({ api_key: API_KEY });
// callback
getAccount({ api_key: API_KEY }, console.log);
`
Get supported locations. Does not require an API key.
#### Parameters
- parameters
object
(optional, default )
- parameters.q
string?
query for a location
-
number?
limit on number of locations returned
-
number?
timeout in milliseconds
- fn? optional callback
#### Examples
`javascript
// async/await
const locations = await getLocations({ limit: 3 });
// callback
getLocations({ limit: 3 }, console.log);
``