Serpapi | Composio Docs

Overview

SLUG: SERPAPI

Description

SerpApi provides a real-time API for structured search engine results, allowing developers to scrape, parse, and analyze SERP data for SEO and research

Authentication Details

API Key

generic_api_key

stringRequired

Connecting to Serpapi

Create an auth config

Use the dashboard to create an auth config for the Serpapi toolkit. This allows you to connect multiple Serpapi accounts to Composio for agents to use.

Select App

Navigate to Serpapi.

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Serpapi Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1 from composio import Composio
2 
3 # Replace these with your actual values
4 serpapi_auth_config_id = "ac_YOUR_SERPAPI_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/app
6 
7 composio = Composio()
8 
9 def authenticate_toolkit(user_id: str, auth_config_id: str):
10     # Replace this with a method to retrieve an API key from the user.
11     # Or supply your own.
12     user_api_key = input("[!] Enter API key")
13 
14     connection_request = composio.connected_accounts.initiate(
15         user_id=user_id,
16         auth_config_id=auth_config_id,
17         config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18     )
19 
20     # API Key authentication is immediate - no redirect needed
21     print(f"Successfully connected Serpapi for user {user_id}")
22     print(f"Connection status: {connection_request.status}")
23     
24     return connection_request.id
25 
26 
27 connection_id = authenticate_toolkit(user_id, serpapi_auth_config_id)
28 
29 # You can verify the connection using:
30 connected_account = composio.connected_accounts.get(connection_id)
31 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Serpapi toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

SERPAPI_BAIDU_SEARCH

Tool Name: Search Baidu with Query

Description

Search Baidu (Chinese search engine) and retrieve search results. Requires a search query string in the 'q' parameter. Returns organic search results, answer boxes, and pagination info in JSON format.

Action Parameters

async

device

Defaults to desktop

gpc

no_cache

output

Defaults to json

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_BING_MAPS

Tool Name: Bing Maps Search

Description

Tool to scrape Bing Maps results using SerpApi. Use when you need to find local businesses, places, or get detailed location information including addresses, phone numbers, ratings, reviews, and more. Supports searching by query or specific place ID.

Action Parameters

count

first

no_cache

place_id

stringRequired

setlang

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_BING_SEARCH

Tool Name: Bing Search

Description

Retrieve Bing Search Engine Results. Supports parameters for query, location, language, and device.

Action Parameters

location

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_DUCK_DUCK_GO_LIGHT_SEARCH

Tool Name: DuckDuckGo Light Search

Description

Tool to access the world's fastest DuckDuckGo Search API via SerpApi. Scrapes DuckDuckGo search results in JSON format with critical data for faster response times, without extra-rich results. Use when you need quick DuckDuckGo search results with essential information. Supports location-based searches, date filtering, and pagination (15 results per page).

Action Parameters

async

next_page_token

no_cache

output

stringRequired

zero_trace

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_DUCK_DUCK_GO_MAPS

Tool Name: DuckDuckGo Maps search

Description

Scrapes DuckDuckGo Maps results via SerpApi. Use when searching for location-based information like businesses, restaurants, or services in a specific geographic area. Returns structured data including ratings, reviews, addresses, operating hours, and contact information.

Action Parameters

bbox

lat

lon

stringRequired

strict_bbox

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_DUCK_DUCK_GO_SEARCH

Tool Name: DuckDuckGo search

Description

Performs a DuckDuckGo search via SerpApi to retrieve SERP data, including organic results, ads, and structured information.

Action Parameters

query

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_EBAY_SEARCH

Tool Name: eBay Search

Description

Retrieve eBay Search Results. Supports parameters like nkw (query), location, etc. Returns product SERP data in JSON format.

Action Parameters

device

Defaults to desktop

ebay_buyer_country

ebay_domain

ebay_marketplace_id

location

nkw

stringRequired

num

page

safe

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_EVENT_SEARCH

Tool Name: Search Google Events

Description

Searches for events (e.g., concerts, festivals, conferences) by query, retrieving structured data from Google's event search results via the SerpApi Google Events engine.

Action Parameters

query

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_FINANCE_SEARCH

Tool Name: Search finance

Description

Retrieves structured financial information (e.g., company data, stock details, market trends, news) from Google Finance via SERP API based on a query.

Action Parameters

query

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_GET_AVAILABLE_LOCATION_OPTIONS_FOR_GOOGLE_SEARCHES

Tool Name: Get Location Options

Description

Tool to get available location options for Google searches. Returns location names, codes, and identifiers that can be used in the location parameter. Use when you need to find valid location values for search queries.

Action Parameters

limit

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_GOOGLE_DOMAINS_LIST

Tool Name: Google Domains List

Description

Retrieve the list of supported Google domains for search queries.

Action Parameters

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_GOOGLE_FORUMS_SEARCH

Tool Name: Google Forums Search

Description

Tool to scrape forum results from Google's Forums Platform using SerpApi. Use when you need to search forum discussions, get forum titles, dates, links, answers with voting data, and related searches.

Action Parameters

async_req

device

engine

stringDefaults to google_forums

filter

json_restrictor

location

nfpr

no_cache

output

stringRequired

start

uule

zero_trace

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_GOOGLE_JOBS_SEARCH

Tool Name: Google Jobs Search

Description

Retrieve Google Jobs Search Results. Supports parameters like q (query), location, etc. Returns job SERP data in JSON format.

Action Parameters

async_req

chips

engine

stringDefaults to google_jobs

google_domain

location

lrad

ltype

next_page_token

no_cache

output

stringRequired

uds

uule

zero_trace

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_GOOGLE_LENS_SEARCH

Tool Name: Google Lens search

Description

Performs reverse image search using Google Lens to find visually similar images, products, and related content. Use when you need to identify objects, find similar products, or get information about images. Requires a publicly accessible image URL.

Action Parameters

country

type

url

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_GOOGLE_LIGHT_SEARCH

Tool Name: Google Light Search

Description

Retrieve Google Light Search Results. Supports parameters like q (query), location, etc. Returns lightweight SERP data in JSON format.

Action Parameters

async_param

device

engine

stringDefaults to google_light

filter

google_domain

location

nfpr

no_cache

num

output

stringRequired

safe

start

uule

zero_trace

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_GOOGLE_MAPS_POSTS

Tool Name: Google Maps Posts

Description

Scrapes Google Maps Posts for a business location via SerpApi. Extracts local posts published by business owners including titles, descriptions, links, images, and publication dates. Returns 10 posts per page with pagination support.

Action Parameters

data_id

stringRequired

next_page_token

no_cache

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_GOOGLE_MAPS_SEARCH

Tool Name: Google maps search

Description

Performs a Google Maps search via SERP API. Takes a query, optionally using specific GPS coordinates and pagination, returning structured location data.

Action Parameters

string

stringRequired

start

integer

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_GOOGLE_PLAY_PRODUCT

Tool Name: Google Play Product Search

Description

Tool to retrieve detailed Google Play product information using SerpApi. Supports apps, movies, TV shows, audiobooks, and books. Use when you need product details, ratings, reviews, or media for Google Play Store items.

Action Parameters

all_reviews

async

engine

stringDefaults to google_play_product

next_page_token

no_cache

num

output

Defaults to json

platform

product_id

stringRequired

rating

season_id

sort_by

store

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_GOOGLE_SCHOLAR_AUTHOR

Tool Name: Google Scholar Author Profile

Description

Scrapes full Google Scholar Author page including articles, citations, metrics, and co-authors. Use when you need detailed information about a specific researcher's publications and academic profile.

Action Parameters

author_id

stringRequired

citation_id

no_cache

num

sort

start

view_op

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_GOOGLE_SCHOLAR_CITE

Tool Name: Google Scholar Cite

Description

Scrapes full Google Scholar Citations with multiple citation formats. Retrieves MLA, APA, Chicago, Harvard, and Vancouver style citations along with download links for BibTeX, EndNote, RefMan, and RefWorks. Use when you need formatted citations for a specific research paper identified by its Google Scholar ID.

Action Parameters

no_cache

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_GOOGLE_VIDEOS_LIGHT

Tool Name: Google Videos Light Search

Description

Tool to scrape Google Videos results using SerpApi's ultra-fast Google Videos Light API. Use when you need video titles, links, thumbnails, snippets, upload dates, and durations from Google Videos search. This lighter version excludes rich results for faster response times.

Action Parameters

async_req

device

engine

stringDefaults to google_videos_light

filter

google_domain

json_restrictor

location

nfpr

no_cache

output

stringRequired

safe

start

tbs

uule

zero_trace

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_HOTEL_SEARCH

Tool Name: Hotel Search

Description

Retrieve Google Hotel Search Results. Supports parameters like q (query), location, etc. Returns hotel SERP data in JSON format.

Action Parameters

adults

amenities

async

bathrooms

bedrooms

check_in_date

stringRequired

check_out_date

stringRequired

children

children_ages

currency

eco_certified

free_cancellation

max_price

min_price

next_page_token

no_cache

output

property_token

property_types

stringRequired

rating

sort_by

special_offers

vacation_rentals

zero_trace

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_IMAGE_SEARCH

Tool Name: Image search

Description

Searches Google Images via SERP API for a given query, returning structured image results. The number of results can be controlled using the 'num' parameter (1-100). If not specified, it defaults to 20 results.

Action Parameters

num

Defaults to 20

query

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_LOCATIONS_LIST

Tool Name: List Locations

Description

List Locations

Action Parameters

limit

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_NAVER_SEARCH

Tool Name: Naver Search

Description

Tool to search Naver (South Korea's leading search engine) for Korean web results and content. Use when searching for Korean-language content, news, videos, images, or shopping results. Supports various search categories and filtering options including time periods and sorting.

Action Parameters

async

device

Defaults to desktop

no_cache

num

output

Defaults to json

page

period

query

stringRequired

sort_by

start

where

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_NEWS_SEARCH

Tool Name: Search for news articles

Description

Searches Google News (via SerpApi, using the `tbm=nws` parameter) for articles matching a query; precise queries yield best results.

Action Parameters

query

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_OPEN_TABLE_REVIEWS

Tool Name: OpenTable Reviews Search

Description

Tool to scrape OpenTable restaurant reviews using SerpApi. Retrieves user reviews, ratings, restaurant responses, images, and AI-generated summaries. Use when you need detailed review data for OpenTable restaurants.

Action Parameters

async

json_restrictor

no_cache

open_table_domain

output

page

place_id

stringRequired

zero_trace

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_PLAY_SEARCH

Tool Name: Google Play Search

Description

Retrieve Google Play Store Search Results. Supports parameters like q (query), gl, hl, etc. Returns app SERP data in JSON format.

Action Parameters

age

apps_category

async_param

chart

engine

stringDefaults to google_play

next_page_token

no_cache

output

Defaults to json

section_page_token

see_more_token

store

stringDefaults to us

store_device

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_SCHOLAR_SEARCH

Tool Name: Search Google Scholar

Description

Searches Google Scholar via SerpApi for academic literature, papers, articles, and citations based on a query.

Action Parameters

query

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_SEARCH

Tool Name: Serp API search

Description

Performs a real-time Google search via the SERP API for a non-empty query.

Action Parameters

query

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_SHOPPING_SEARCH

Tool Name: Shopping search

Description

Searches Google Shopping for a specific product or item to retrieve structured product listings.

Action Parameters

query

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_TRENDS_SEARCH

Tool Name: Google Trends search

Description

Fetches Google Trends data; the `query`'s format (single/multiple terms) must comply with the selected `data_type` (see its field description for details).

Action Parameters

data_type

Defaults to TIMESERIES

query

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_WALMART_PRODUCT_REVIEWS

Tool Name: Walmart Product Reviews

Description

Tool to scrape full Walmart product reviews using SerpApi's Walmart Product Reviews API. Retrieves ratings, review text, user information, and helpful votes for a specific product. Use when you need detailed customer feedback and sentiment analysis for Walmart products.

Action Parameters

async

no_cache

output

Defaults to json

page

product_id

stringRequired

rating

sort

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_WALMART_SEARCH

Tool Name: Walmart Search

Description

Retrieve Walmart Search Results. Supports parameters like query, location, store ID, etc. Returns product SERP data in JSON format.

Action Parameters

location

max_price

min_price

min_rating

page

stringRequired

sort

store_id

type

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_YAHOO_SEARCH

Tool Name: Yahoo Search

Description

Retrieve Yahoo! Search Engine Results. Supports query, location, language, and device parameters.

Action Parameters

async_request

device

Defaults to desktop

fr2

no_cache

output

Defaults to json

stringRequired

yahoo_domain

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_YAHOO_VIDEOS

Tool Name: Yahoo Videos Search

Description

Scrape Yahoo! Videos results with position, title, thumbnail, link, preview, source, duration, date and more. Use when you need to search for video content on Yahoo! Videos.

Action Parameters

async

device

durs

no_cache

output

Defaults to json

stringRequired

vage

vres

vsite

yahoo_domain

zero_trace

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_YANDEX_IMAGES_SEARCH

Tool Name: Yandex Images Search

Description

Tool to search Yandex Images for image results with advanced filters. Use when searching for images on Yandex with filters like size, color, type, or performing reverse image search.

Action Parameters

async

color

crop

crop_id

file_type

height

image_type

no_cache

orientation

output

recent

site

tab

text

stringRequired

url

width

yandex_domain

zero_trace

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_YANDEX_SEARCH

Tool Name: Yandex Search

Description

Retrieve Yandex Search Results. Supports parameters like text (query), location, etc. Returns SERP data in JSON format.

Action Parameters

lang

location

num

text

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

SERPAPI_YOU_TUBE_SEARCH

Tool Name: YouTube Search

Description

Retrieve YouTube Search Results. Supports parameters like search_query, location, etc. Returns video SERP data in JSON format.

Action Parameters

async

no_cache

output

Defaults to json

search_query

stringRequired

zero_trace

Action Response

data

objectRequired

error

successful

booleanRequired