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. |
---|
npm install serpapi
import { getJson } from "serpapi";
const response = await getJson("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.
import { getJson } from "https://deno.land/x/serpapi/mod.ts";
- TypeScript types such as supported parameters and function argument types.
- Works out-of-the-box with Node.js and Deno.
- Promises and async/await support.
- (Planned) Pagination support.
- (Planned) More examples.
- (Planned) More error classes.
You can declare a global api_key
and timeout
value by modifying the config
object. timeout
is defined in milliseconds and defaults to 60 seconds.
All functions, other than getLocations
that doesn't require an API key,
accepts an optional api_key
and timeout
that will take precedence over the
values defined in config
.
import { config, getJson } from "serpapi";
config.api_key = API_KEY;
config.timeout = 60000;
await getJson("google", { q: "coffee" }); // uses the API key defined in the config
await getJson("google", { api_key: API_KEY_2, q: "coffee" }); // API_KEY_2 will be used
Get a JSON response based on search parameters.
- Accepts an optional callback.
engine
string engine nameparameters
object search query parameters for the enginecallback
fn? optional callback
// async/await
const json = await getJson("google", { api_key: API_KEY, q: "coffee" });
// callback
getJson("google", { api_key: API_KEY, q: "coffee" }, console.log);
Get a HTML response based on search parameters.
- Accepts an optional callback.
- Responds with a JSON string if the search request hasn't completed.
engine
string engine nameparameters
object search query parameters for the enginecallback
fn? optional callback
// async/await
const html = await getHtml("google", { api_key: API_KEY, q: "coffee" });
// callback
getHtml("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 the response. - Typically used together with the
async
parameter. - Accepts an optional callback.
const response = await getJson("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 the response. - Typically used together with the
async
parameter. - Accepts an optional callback.
- Responds with a JSON if the search request hasn't completed.
const response = await getJson("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. https://serpapi.com/account-api
-
parameters
object (optional, default{}
) -
callback
fn? optional callback
// 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. https://serpapi.com/locations-api
-
parameters
object (optional, default{}
) -
callback
fn? optional callback
// async/await
const locations = await getLocations({ limit: 3 });
// callback
getLocations({ limit: 3 }, console.log);