---
canonical_url: "https://docs.composio.dev/toolkits/serper"
markdown_url: "https://docs.composio.dev/toolkits/serper.md"
product: "platform"
version: null
last_updated: null
---

# Serper

Serper provides real-time Google search results, place data, autocomplete suggestions, and webpage extraction through a structured API.

- **Category:** web search & research
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 15
- **Triggers:** 0
- **Slug:** `SERPER`
- **Version:** 20261014_01
- **Instant:** Supported on the latest version. Support varies by tool.

## Tools

### Batch Search the Web

**Slug:** `SERPER_BATCH_SEARCH_WEB`

Run 1-10 independent first-page Google web searches in one native Serper request. Each query consumes one credit for 1-10 requested results or two credits for 11-100 requested results, and result envelopes preserve input order. Use SERPER_SEARCH_WEB separately when page continuation is needed.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per credit (1 credit/query for 1-10 results; 2 credits/query for 11-100; 1-10 queries/batch)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `queries` | array | Yes | Independent first-page web searches to run in one native batch (1-10). Each item consumes 1 credit for 1-10 requested results or 2 credits for 11-100 requested results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Search Suggestions

**Slug:** `SERPER_GET_SEARCH_SUGGESTIONS`

Return Google autocomplete suggestions for a partial search query without running a full search.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per credit used for search suggestions

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Partial search query to complete. |
| `location` | string | No | Canonical location from SERPER_LIST_LOCATIONS used to localize suggestions. |
| `country_code` | string | No | Two-letter lowercase country code for suggestions. |
| `language_code` | string | No | Two-letter lowercase language code for suggestions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Locations

**Slug:** `SERPER_LIST_LOCATIONS`

Find canonical Serper location names and country codes for localizing search requests; this lookup consumes no search credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of matching locations to return (1-100). |
| `query` | string | No | Case-insensitive location prefix or term; omit to list locations from the start of the catalog. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Place Reviews

**Slug:** `SERPER_LIST_PLACE_REVIEWS`

Return paginated Google reviews for one place identified by Place ID, feature ID, or CID, with optional sorting and topic filtering.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per credit used for place reviews

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cid` | string | No | Google business CID for the place; use exactly one place selector on the first page. |
| `sort` | string ("most_relevant" | "newest" | "highest_rating" | "lowest_rating") | No | Order in which reviews are returned. |
| `cursor` | string | No | Opaque continuation cursor returned by a prior call. It retains the place selector and filters; omit the other inputs when continuing. |
| `place_id` | string | No | Google Place ID for the place; use exactly one place selector on the first page. |
| `topic_id` | string | No | Google-assigned topic ID used to restrict reviews to one topic. |
| `feature_id` | string | No | Google feature ID for the place; use exactly one place selector on the first page. |
| `country_code` | string | No | Two-letter lowercase country code used to localize review results. |
| `language_code` | string | No | Two-letter lowercase language code for review results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Scrape Webpage

**Slug:** `SERPER_SCRAPE_WEBPAGE`

Ask Serper to fetch one webpage and return extracted text, metadata, and optionally markdown, links, images, and videos. Difficult pages may cost 6 or 10 credits instead of 2.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per scrape credit (2, 6, or 10 per page)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | HTTP or HTTPS webpage URL for Serper to fetch. Userinfo, localhost, and non-public literal IP hosts are rejected; DNS names are resolved by Serper. |
| `include_links` | boolean | No | Whether to include links found on the page. |
| `include_images` | boolean | No | Whether to include images found on the page. |
| `include_videos` | boolean | No | Whether to include videos found on the page. |
| `include_markdown` | boolean | No | Whether to include page content converted to Markdown. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Images

**Slug:** `SERPER_SEARCH_IMAGES`

Search Google Images and return one page of source pages, full image URLs, thumbnails, dimensions, and positions. Requesting 100 results costs 2 credits instead of 1.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per image-search credits (100 results use 2 credits)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Image search terms. Required for the first page; a continuation cursor retains the original query. |
| `cursor` | string | No | Opaque continuation cursor returned by a prior call. It retains the original search inputs, so the cursor may be supplied by itself. |
| `location` | string | No | Canonical location from SERPER_LIST_LOCATIONS used to localize results. |
| `autocorrect` | boolean | No | Whether Google may autocorrect the query. |
| `time_filter` | string ("hour" | "day" | "week" | "month" | "year") | No | Restrict images to the selected recent time window. |
| `country_code` | string | No | Two-letter lowercase country code for Google results, such as us or gb. |
| `result_count` | integer ("10" | "100") | No | Requested results per page. Choose 100 only when the larger, 2-credit response is needed. |
| `language_code` | string | No | Two-letter language code for result text, such as en or fr. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search with Google Lens

**Slug:** `SERPER_SEARCH_LENS`

Reverse-search one public image URL with Google Lens and return visual matches. This action accepts no text query, result-count, or pagination input. Each request costs 3 credits and is subject to Serper's account-specific rate limit, advertised at up to 300 requests per second.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `location` | string | No | Canonical location from SERPER_LIST_LOCATIONS used to localize results. |
| `image_url` | string | Yes | Public HTTP or HTTPS URL of the image to reverse-search. Userinfo, localhost-style names, and non-public literal IP hosts are rejected; other DNS names are resolved by Serper. This action accepts an image URL, not a text query. |
| `time_filter` | string ("hour" | "day" | "week" | "month" | "year") | No | Optionally restrict visual matches to the selected recent time window. |
| `country_code` | string | No | Two-letter lowercase country code for Google Lens results. |
| `language_code` | string | No | Two-letter language code for Google Lens result text. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Maps

**Slug:** `SERPER_SEARCH_MAPS`

Search Google Maps by text, Place ID, or CID, optionally constrained to a viewport, and return one page of rich place identifiers and contact details. Each page costs 3 Serper credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per map-search credits (3 per page)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cid` | string | No | Google business CID to resolve directly; provide exactly one first-page selector. |
| `query` | string | No | Place or business search terms; provide exactly one of query, place_id, or cid on the first page. |
| `cursor` | string | No | Opaque continuation cursor returned by a prior call. It retains the search selectors, language, next page, and required map viewport. |
| `place_id` | string | No | Google Place ID to resolve directly; provide exactly one first-page selector. |
| `map_position` | string | No | Optional map viewport in @latitude,longitude,zoomz format with zoom from 3z through 21z. |
| `language_code` | string | No | Two-letter language code for place details, such as en or fr. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search News

**Slug:** `SERPER_SEARCH_NEWS`

Search recent Google News coverage and return one page of article titles, links, sources, publication times, snippets, and images when available.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per credit used for news searches

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | News search terms. Required for the first page; a continuation cursor retains the original query. |
| `cursor` | string | No | Opaque continuation cursor returned by a prior call. Omit for the first page; it retains the original search inputs. |
| `location` | string | No | Canonical location from SERPER_LIST_LOCATIONS used to localize results. |
| `autocorrect` | boolean | No | Whether Google may autocorrect the query. |
| `time_filter` | string ("hour" | "day" | "week" | "month" | "year") | No | Restrict coverage to the selected recent time window. |
| `country_code` | string | No | Two-letter lowercase country code for Google News results. |
| `language_code` | string | No | Two-letter language code for article results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Patents

**Slug:** `SERPER_SEARCH_PATENTS`

Search Google Patents and return typed patent records and figures. Each page costs 1 credit and is subject to the connected Serper account's specific rate limit, up to 300 requests per second.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Patent search terms. Required for the first page; a continuation cursor retains the original query. |
| `cursor` | string | No | Opaque continuation cursor returned by a prior call. Omit it for the first page; it retains all original search inputs. |
| `location` | string | No | Canonical location from SERPER_LIST_LOCATIONS used to localize results. |
| `autocorrect` | boolean | No | Whether Google may autocorrect the patent query. |
| `time_filter` | string ("hour" | "day" | "week" | "month" | "year") | No | Restrict patent results to the selected recent time window. |
| `country_code` | string | No | Two-letter lowercase country code for Google Patents results. |
| `language_code` | string | No | Two-letter language code for patent result text. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Places

**Slug:** `SERPER_SEARCH_PLACES`

Search Google Places and return one page of local businesses and places. Use this 1-credit text search for place discovery; use SERPER_SEARCH_MAPS for direct Place ID or CID lookup and map-viewport searches. Each request costs 1 Serper credit and is subject to the account-specific rate limit, advertised at up to 300 requests per second.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Place or business search terms. Required for the first page; a continuation cursor retains the original query. |
| `cursor` | string | No | Opaque continuation cursor returned by a prior call. It retains the original search inputs and provider page number. |
| `location` | string | No | Canonical location from SERPER_LIST_LOCATIONS used to localize results. |
| `autocorrect` | boolean | No | Whether Google may autocorrect the query. |
| `time_filter` | string ("hour" | "day" | "week" | "month" | "year") | No | Restrict place results to the selected recent time window. |
| `country_code` | string | No | Two-letter lowercase country code for Google Places results. |
| `language_code` | string | No | Two-letter language code for result text. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Scholar

**Slug:** `SERPER_SEARCH_SCHOLAR`

Search Google Scholar and return one page of academic publications with citation counts, publication metadata, snippets, and PDF links when available.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per credit used for scholar searches

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Academic search terms. Required for the first page; a continuation cursor retains the original query. |
| `cursor` | string | No | Opaque continuation cursor returned by a prior call. Omit for the first page; it retains the original search inputs. |
| `location` | string | No | Canonical location from SERPER_LIST_LOCATIONS used to localize results. |
| `autocorrect` | boolean | No | Whether Google may autocorrect the query. |
| `country_code` | string | No | Two-letter lowercase country code for Google Scholar results. |
| `language_code` | string | No | Two-letter language code for publication results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Shopping

**Slug:** `SERPER_SEARCH_SHOPPING`

Search Google Shopping and return one page of products, prices, merchants, offers, ratings, images, and product IDs. Each page costs 2 credits.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per shopping-search credits (2 per page)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Product search terms. Required for the first page; a continuation cursor retains the original query. |
| `cursor` | string | No | Opaque continuation cursor returned by a prior call. It retains the original search inputs, so the cursor may be supplied by itself. |
| `location` | string | No | Canonical location from SERPER_LIST_LOCATIONS used to localize products and offers. |
| `autocorrect` | boolean | No | Whether Google may autocorrect the query. |
| `country_code` | string | No | Two-letter lowercase country code for Shopping results. |
| `language_code` | string | No | Two-letter language code for Shopping results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Videos

**Slug:** `SERPER_SEARCH_VIDEOS`

Search Google Videos and return one page of titles, source links, thumbnail and video URLs, durations, channels, dates, and positions. Each request/page costs 1 credit and is subject to the account-specific rate limit advertised at up to 300 requests per second.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Video search terms. Required for the first page; a continuation cursor retains the original query. |
| `cursor` | string | No | Opaque continuation cursor returned by a prior call. It retains the original search inputs, so the cursor may be supplied by itself. |
| `location` | string | No | Canonical location from SERPER_LIST_LOCATIONS used to localize results. |
| `autocorrect` | boolean | No | Whether Google may autocorrect the query. |
| `time_filter` | string ("hour" | "day" | "week" | "month" | "year") | No | Restrict videos to the selected recent time window. |
| `country_code` | string | No | Two-letter lowercase country code for Google Video results. |
| `language_code` | string | No | Two-letter language code for video result text. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search the Web

**Slug:** `SERPER_SEARCH_WEB`

Search Google web results and return one page of organic links plus available answer, knowledge, question, related-search, and top-story sections.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per credit used for web searches

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Search terms. Required on the first page; a continuation cursor retains them. |
| `cursor` | string | No | Opaque continuation cursor returned by a prior call. It retains the original search inputs. |
| `location` | string | No | Canonical location from SERPER_LIST_LOCATIONS used to localize results. |
| `autocorrect` | boolean | No | Whether Google may autocorrect the query. |
| `time_filter` | string ("hour" | "day" | "week" | "month" | "year") | No | Restrict results to the selected recent time window. |
| `country_code` | string | No | Two-letter lowercase country code for Google results, such as us or gb. |
| `result_count` | integer | No | Requested number of results for this page (1-100); the provider may return a different count. |
| `language_code` | string | No | Two-letter language code for result text, such as en or fr. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |