Serpapi Python API Docs | dltHub

Build a Serpapi-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.

Last updated:

SerpApi is a hosted search API service that returns structured JSON results for multiple search engines (Google, Google Maps, DuckDuckGo, Google Play, Google Scholar, etc.). The REST API base URL is https://serpapi.com and All requests require an api_key provided as a request parameter (api_key)..

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Serpapi data in under 10 minutes.


What data can I load from Serpapi?

Here are some of the endpoints you can load from Serpapi:

ResourceEndpointMethodData selectorDescription
google_searchsearch?engine=googleGETorganic_resultsGoogle web search results (organic, ads, knowledge graph, images, news, etc.)
google_mapssearch?engine=google_mapsGETlocal_resultsGoogle Maps / Places search results (local pack, place results)
duckduckgo_searchsearch?engine=duckduckgoGETresultsDuckDuckGo search results in structured JSON
google_scholarsearch?engine=google_scholarGETorganic_resultsGoogle Scholar search results
google_playsearch?engine=google_playGETappsGoogle Play / Play Store search and app details results
search_archivesearch-archiveGETsearchesRetrieve previously‑run async searches (Searches Archive API)

How do I authenticate with the Serpapi API?

Authentication is done via the api_key query parameter (api_key=YOUR_KEY) on each request; results and playground examples show api_key as a required parameter.

1. Get your credentials

  1. Create an account at https://serpapi.com/ or sign in.
  2. Open the dashboard (https://serpapi.com/account) where your private API key appears.
  3. Copy the value labeled API Key / Private Key and use it as the api_key request parameter.

2. Add them to .dlt/secrets.toml

[sources.serpapi_source] api_key = "your_serpapi_api_key_here"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.


How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

dlt ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Serpapi API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

python serpapi_pipeline.py

If everything is configured correctly, you'll see output like this:

Pipeline serpapi_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset serpapi_data The duckdb destination used duckdb:/serpapi.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

dlt pipeline serpapi_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.


Python pipeline example

This example loads google_search and google_maps from the Serpapi API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def serpapi_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://serpapi.com", "auth": { "type": "api_key", "api_key": api_key, }, }, "resources": [ {"name": "google_search", "endpoint": {"path": "search?engine=google", "data_selector": "organic_results"}}, {"name": "google_maps", "endpoint": {"path": "search?engine=google_maps", "data_selector": "local_results"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="serpapi_pipeline", destination="duckdb", dataset_name="serpapi_data", ) load_info = pipeline.run(serpapi_source()) print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.


How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

import dlt data = dlt.pipeline("serpapi_pipeline").dataset() sessions_df = data.google_search.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM serpapi_data.google_search LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("serpapi_pipeline").dataset() data.google_search.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.


What destinations can I load Serpapi data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

DestinationExample value
DuckDB (local, default)"duckdb"
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.


Troubleshooting

Authentication failures

If requests return an error about missing or invalid api_key, confirm the api_key query parameter is present (api_key=YOUR_KEY) and matches the key shown in your SerpApi dashboard.

Rate limiting and plan limits

SerpApi enforces usage limits per plan; exceeding quota returns rate limit or billing‑related error messages. Check your dashboard usage and upgrade plan if needed.

Async / pagination and Search Archive

Long‑running or async searches require using async=true and retrieving results later from the Searches Archive API (/search-archive) using the returned search ID; check search_metadata.status and search_metadata.id in responses.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.


Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

  • data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
  • dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install

Was this page helpful?

Community Hub

Need more dlt context for Serpapi?

Request dlt skills, commands, AGENT.md files, and AI-native context.