google-search-results-python

To switch between different Google services (like Images, News, or Shopping), you must set the tbm (to be matched) parameter in your search request. If no tbm parameter is provided, the library performs a regular Google search.

Supported tbm values include:

• isch: Google Images API
• nws: Google News API
• shop: Google Shopping API

Other Google services are generally supported out of the box by passing their respective identifiers to the tbm field.

# Example conceptual usage
params = {
    "q": "search query",
    "tbm": "isch"
}
# This would trigger a Google Images search

You can provide your API key in two ways:

1. Globally: Set it on the GoogleSearch class to apply to all instances.
2. Per Search: Pass it directly in the parameters dictionary for a specific query.

# Global setting
GoogleSearch.SERP_API_KEY = "Your Private Key"

# Per-search setting
query = GoogleSearch({"q": "coffee", "serp_api_key": "Your Private Key"})

To perform a Google search, import the GoogleSearch class from serpapi. Initialize it with a dictionary containing your search parameters (such as q for query and location) and your api_key. Call .get_dict() to execute the search and retrieve the results as a Python dictionary.

from serpapi import GoogleSearch
search = GoogleSearch({"q": "coffee", "location": "Austin,Texas", "api_key": "secretKey"})
result = search.get_dict()

Install the SerpApi Python package using pip. This package is compatible with Python 3.7+.

pip install google-search-results

WARNING

This package is being deprecated in favor of serpapi-python. It is recommended to migrate to the newer implementation to ensure continued support and access to the latest features.

Note that current documentation and examples on serpapi.com are written for this legacy package and are not yet compatible with the new library.

The GoogleSearch object provides several methods to access the results:

• get_dict(): Returns results as a Python Dictionary.
• get_json(): Returns results as a JSON string (use the json package to parse).
• get_object(): Returns results as a dynamic Python object, allowing attribute-style access (e.g., result.organic_results).
• get_html(): Returns the search results formatted as raw HTML.

# parse results as python Dictionary
dict_results = search.get_dict()

# as JSON using json package
json_results = search.get_json()

# as dynamic Python object
object_result = search.get_object()

# search format return as raw html
html_results = search.get_html()

The get_location method allows you to find canonical names and metadata for specific locations. This is useful for building localized searches.

from serpapi import GoogleSearch
search = GoogleSearch({})
# Returns a list of matching locations
location_list = search.get_location("Austin", 3)
print(location_list)

The SerpApiClient class provides a generic interface to interact with any search engine supported by SerpApi (e.g., Google, Bing, Baidu, etc.) by specifying the engine parameter.

from serpapi import SerpApiClient

query = {"q": "Coffee", "location": "Austin,Texas", "engine": "google"}
search = SerpApiClient(query)
data = search.get_dict()

SerpApi caches search results temporarily. You can retrieve a previous search for free using its search_id found in the search_metadata of the original result.

from serpapi import GoogleSearch

# 1. Perform a search and get the ID
search = GoogleSearch({"q": "Coffee", "location": "Austin,Texas"})
search_result = search.get_dict()
search_id = search_result.get("search_metadata").get("id")

# 2. Retrieve the archived result using the ID
archived_search_result = GoogleSearch({}).get_search_archive(search_id, 'json')
print(archived_search_result.get("search_metadata").get("id"))