SerpApi Python Client

1.0.2 · active · verified Tue Apr 14

The official Python client for SerpApi.com, allowing users to access structured search results from various engines like Google, Bing, Baidu, and more. Currently at version 1.0.2, the library is actively maintained with frequent updates and bug fixes, reflecting continuous development and responsiveness to API changes.

Warnings

breaking The `serpapi` package (current official client) is distinct from the older `google-search-results` package, which sometimes used `from serpapi import GoogleSearch`. Code written for the legacy package will not work directly with the new `serpapi` client.
Fix: Migrate your import and usage pattern. Replace `from serpapi import GoogleSearch` with `from serpapi import Client` and instantiate `Client(api_key=...)` directly, then use `client.search(...)`.
gotcha Incorrect API key handling (hardcoding or not setting environment variable) is a common cause of `Unauthorized` (401) or `Bad Request` (400) errors.
Fix: Always set your `SERPAPI_KEY` as an environment variable (e.g., `export SERPAPI_KEY='your_key'`) and access it via `os.environ.get('SERPAPI_KEY')` or pass it directly when initializing `Client(api_key='your_key')`. Avoid hardcoding in source control.
breaking Version 1.0.0 removed the 'redundant engine' parameter for Google searches and changed `yield_pages` to start from the first page, potentially altering expected behavior or requiring adjustments for pagination logic.
Fix: Review code interacting with Google search parameters and pagination logic if upgrading from versions prior to 1.0.0. The `engine` parameter may still be specified but its internal handling or default behavior changed. Ensure pagination starts at the correct point if `yield_pages` is used.
gotcha Prior to v1.0.0, `serpapi.HTTPError` instances might have been missing essential status code and error messages, making debugging API request failures difficult.
Fix: Upgrade to `serpapi` version 1.0.0 or higher to ensure `serpapi.HTTPError` provides full details, including `status_code` and `message`, for more robust error handling.

Install

pip install serpapi Install SerpApi

Imports

Client
```
from serpapi import Client
```
GoogleSearch
```
from google_search_results import GoogleSearch
```
The `GoogleSearch` class is part of the legacy `google-search-results` package (also sometimes imported as `serpapi`), not the current `serpapi` client library. Use `serpapi.Client` instead for the recommended package.

Quickstart

This example demonstrates how to perform a Google search using the `serpapi.Client`. It fetches results for 'Coffee' in Austin, Texas, and prints the title of the first organic result. The API key is securely retrieved from an environment variable.

import os
from serpapi import Client

# Ensure SERPAPI_KEY is set as an environment variable
# Example (bash): export SERPAPI_KEY='your_private_api_key'
api_key = os.environ.get('SERPAPI_KEY', '')

if not api_key:
    print("Error: SERPAPI_KEY environment variable not set.")
else:
    client = Client(api_key=api_key)
    try:
        results = client.search({
            "engine": "google",
            "q": "Coffee",
            "location": "Austin, Texas, United States",
            "hl": "en",
            "gl": "us"
        })
        print(results.get("organic_results", [])[0].get("title"))
    except Exception as e:
        print(f"An error occurred: {e}")

view raw JSON →