Serpapi | Composio Docs

Overview

Enum

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

apikey

stringRequired

Actions

SERPAPI_BAIDU_SEARCH

Baidu search

Action Parameters

async

boolean

string

device

stringDefaults to desktop

string

gpc

string

no_cache

boolean

string

output

stringDefaults to json

integer

stringRequired

string

integer

Action Response

data

object

error

successful

boolean

SERPAPI_BING_SEARCH

Retrieve bing search engine results. supports parameters for query, location, language, and device.

Action Parameters

string

location

string

stringRequired

Action Response

data

object

error

successful

boolean

SERPAPI_DUCK_DUCK_GO_SEARCH

Performs a duckduckgo search via serpapi to retrieve serp data, including organic results, ads, and structured information.

Action Parameters

query

stringRequired

Action Response

data

object

error

successful

boolean

SERPAPI_EBAY_SEARCH

Retrieve ebay search results. supports parameters like  nkw (query), location, etc. returns product serp data in json format.

Action Parameters

_nkw

stringRequired

device

stringDefaults to desktop

ebay_buyer_country

string

ebay_domain

string

ebay_marketplace_id

string

location

string

num

integer

page

integer

safe

string

Action Response

data

object

error

successful

boolean

SERPAPI_EVENT_SEARCH

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

object

error

successful

boolean

SERPAPI_FINANCE_SEARCH

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

object

error

successful

boolean

SERPAPI_GOOGLE_DOMAINS_LIST

Retrieve the list of supported google domains for search queries.

Action Parameters

Action Response

data

object

error

successful

boolean

SERPAPI_GOOGLE_JOBS_SEARCH

Retrieve google jobs search results. supports parameters like q (query), location, etc. returns job serp data in json format.

Action Parameters

async_req

boolean

chips

string

engine

stringDefaults to google_jobs

string

google_domain

string

location

string

lrad

integer

ltype

integer

next_page_token

string

no_cache

boolean

output

string

stringRequired

uds

string

uule

string

zero_trace

boolean

Action Response

data

object

error

successful

boolean

SERPAPI_GOOGLE_LIGHT_SEARCH

Retrieve google light search results. supports parameters like q (query), location, etc. returns lightweight serp data in json format.

Action Parameters

async_param

boolean

device

string

engine

stringDefaults to google_light

filter

string

google_domain

string

location

string

nfpr

string

no_cache

boolean

num

integer

output

string

stringRequired

safe

string

start

integer

uule

string

zero_trace

boolean

Action Response

data

object

error

successful

boolean

SERPAPI_GOOGLE_MAPS_SEARCH

Performs a google maps search via serp api for a given query, optionally using specific gps coordinates and pagination, returning structured location data.

Action Parameters

string

stringRequired

start

integer

Action Response

data

object

error

successful

boolean

SERPAPI_HOTEL_SEARCH

Retrieve google hotel search results. supports parameters like q (query), location, etc. returns hotel serp data in json format.

Action Parameters

adults

integer

amenities

string

async

boolean

bathrooms

integer

bedrooms

integer

check_in_date

stringRequired

check_out_date

stringRequired

children

integer

children_ages

string

currency

string

eco_certified

boolean

free_cancellation

boolean

string

max_price

integer

min_price

integer

next_page_token

string

no_cache

boolean

output

string

property_token

string

property_types

string

stringRequired

rating

integer

sort_by

string

special_offers

boolean

vacation_rentals

boolean

zero_trace

boolean

Action Response

data

object

error

successful

boolean

SERPAPI_IMAGE_SEARCH

Searches google images via serp api for a given query, returning structured image results.

Action Parameters

query

stringRequired

Action Response

data

object

error

successful

boolean

SERPAPI_LOCATIONS_LIST

List locations

Action Parameters

limit

integer

string

Action Response

data

object

error

successful

boolean

SERPAPI_NEWS_SEARCH

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

object

error

successful

boolean

SERPAPI_PLAY_SEARCH

Retrieve google play store search results. supports parameters like q (query), gl, hl, etc. returns app serp data in json format.

Action Parameters

age

string

apps_category

string

async_param

boolean

chart

string

engine

stringDefaults to google_play

string

next_page_token

string

no_cache

boolean

output

stringDefaults to json

string

section_page_token

string

see_more_token

string

store

stringDefaults to us

store_device

string

Action Response

data

object

error

successful

boolean

SERPAPI_SCHOLAR_SEARCH

Searches google scholar via serpapi for academic literature, papers, articles, and citations based on a query.

Action Parameters

query

stringRequired

Action Response

data

object

error

successful

boolean

SERPAPI_SEARCH

Performs a real-time google search via the serp api for a non-empty query.

Action Parameters

query

stringRequired

Action Response

data

object

error

successful

boolean

SERPAPI_SHOPPING_SEARCH

Searches google shopping for a specific product or item to retrieve structured product listings.

Action Parameters

query

stringRequired

Action Response

data

object

error

successful

boolean

SERPAPI_TRENDS_SEARCH

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

stringDefaults to TIMESERIES

query

stringRequired

Action Response

data

object

error

successful

boolean

SERPAPI_WALMART_SEARCH

Retrieve walmart search results. supports parameters like query, location, store id, etc. returns product serp data in json format.

Action Parameters

location

string

max_price

number

min_price

number

min_rating

number

page

integer

stringRequired

sort

string

store_id

string

type

string

Action Response

data

object

error

successful

boolean

SERPAPI_YAHOO_SEARCH

Retrieve yahoo! search engine results. supports query, location, language, and device parameters.

Action Parameters

async_request

boolean

integer

string

device

stringDefaults to desktop

fr2

string

no_cache

boolean

output

stringDefaults to json

stringRequired

string

yahoo_domain

string

Action Response

data

object

error

successful

boolean

SERPAPI_YANDEX_SEARCH

Retrieve yandex search results. supports parameters like text (query), location, etc. returns serp data in json format.

Action Parameters

lang

string

location

string

num

integer

text

stringRequired

Action Response

data

object

error

successful

boolean

SERPAPI_YOU_TUBE_SEARCH

Retrieve youtube search results. supports parameters like search query, location, etc. returns video serp data in json format.

Action Parameters

async

boolean

string

no_cache

boolean

output

stringDefaults to json

search_query

stringRequired

string

zero_trace

boolean

Action Response

data

object

error

successful

boolean