# SerpApi SerpApi provides a real-time API for structured search engine results, allowing developers to scrape, parse, and analyze SERP data for SEO and research - **Category:** analytics - **Auth:** API_KEY - **Composio Managed App Available?** N/A - **Tools:** 48 - **Triggers:** 0 - **Slug:** `SERPAPI` - **Version:** 20260316_00 ## Tools ### Search Baidu with Query **Slug:** `SERPAPI_BAIDU_SEARCH` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `f` | string | No | Defines the originating search type. (e.g., "8" is a normal search, "3" is from the suggestion list, and "1" is a related search. | | `q` | string | Yes | Defines the search query, including all Baidu search operators (e.g., `inurl:`, `site:`, `intitle:`, etc.). | | `bs` | string | No | Defines the previous search query. | | `ct` | string | No | Defines which language to restrict results. Available options: "1" (All languages), "2" (Simplified Chinese), "3" (Traditional Chinese). | | `oq` | string | No | Defines the original search query when navigated from a related search. | | `pn` | integer | No | Defines the result offset. It skips the given number of results. It's used for pagination. (e.g., 0 (default) is the first page of results, 10 is the 2nd page of results, 20 is the 3rd page of results, etc.). Must be a non-negative integer. | | `q5` | string | No | Similar to using `inurl:` or `intitle:`. (e.g., "1" to search by page title, "2" to search by web address.). | | `q6` | string | No | Similar to using `site:`. (e.g., `q6=serpapi.com` to search for results only from the domain `serpapi.com`) | | `rn` | integer | No | Parameter defines the maximum number of results to return, limited to 50. (e.g., 10 (default) returns 10 results, 30 returns 30 results, and 50 returns 50 results). This parameter is only available for desktop and tablet searches. Must be between 1 and 50. | | `gpc` | string | No | Parameter defines the time period for results. (e.g., `stf=1749303572,1749908372\|stftype=1` only returns results from the past 7 days. First integer within the parameter, `1749303572` is Unix Timestamp for 7 days ago. Second integer, `1749908372` is Unix Timestamp for now.). | | `async` | boolean | No | Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. async should not be used on accounts with Ludicrous Speed enabled. | | `device` | string | No | Parameter defines the device to use to get the results. It can be set to "desktop" (default) to use a regular browser, "tablet" to use a tablet browser (currently using iPads), or "mobile" to use a mobile browser (currently using iPhones). | | `output` | string | No | Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved. | | `no_cache` | boolean | No | Parameter will force SerpApi to fetch the Baidu results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together. | #### 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 | ### Bing Maps Search **Slug:** `SERPAPI_BING_MAPS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | Yes | Search query for Bing Maps (e.g., 'coffee', 'restaurants', 'hotels near Times Square'). Use specific location queries for better results. | | `cp` | string | No | GPS coordinates formatted as 'latitude~longitude' (e.g., '40.7455096~-74.0083012'). Specifies the center point for the search area. | | `count` | integer | No | Number of results per page (maximum 30). Controls how many results are returned. | | `first` | integer | No | Result offset for pagination (defaults to 0). Used to retrieve subsequent pages of results. | | `setlang` | string | No | 2-character ISO 3166-1 language code for localization (e.g., 'us', 'de', 'gb'). Sets the language for results. | | `no_cache` | boolean | No | Set to true to bypass cached results and force a fresh API call. | | `place_id` | string | No | Unique reference identifier for a specific location. Can be used independently of the q parameter to retrieve details about a specific place. | #### 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 | ### Bing Search **Slug:** `SERPAPI_BING_SEARCH` Retrieve Bing Search Engine Results via SerpAPI (requires active SerpAPI connection; if unavailable, use COMPOSIO_SEARCH_WEB or COMPOSIO_SEARCH_NEWS). Consumes SerpAPI credits per call; throttle to ~1–2 calls/second and apply exponential backoff on HTTP 429. Supports query, location, language, and device parameters. Set `location`, `mkt`, or `cc` explicitly when local relevance matters — result ranking is highly sensitive to localization. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | Yes | The search query string. | | `cc` | string | No | Parameter defines the country to search from. It follows the 2-character ISO_3166-1 format. Example: 'us' for United States, 'de' for Germany, 'gb' for United Kingdom. | | `mkt` | string | No | The market where the results come from (e.g., 'en-US'). Format: language code-country code (case insensitive). Example: 'en-US' for English in United States, 'de-DE' for German in Germany, 'fr-FR' for French in France. | | `first` | integer | No | Controls pagination offset. Defaults to 1. | | `device` | string | No | Defines the device to use to get the results. Can be 'desktop' (default), 'tablet', or 'mobile'. | | `filters` | string | No | Enables complex filtering such as filtering by date range. Exact values can be constructed by using Bing search and copying the filters query parameter. | | `location` | string | No | Defines the location to use for the search. It can be a city, a state, a country, or a zip code. Uses a canonicalized name for the location. Example: "Austin, Texas, United States". | | `safeSearch` | string | No | Filtering levels for adult content. Can be 'Off', 'Moderate', or 'Strict'. | #### 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 | ### DuckDuckGo Light Search **Slug:** `SERPAPI_DUCK_DUCK_GO_LIGHT_SEARCH` 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). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | Yes | Search query for DuckDuckGo. Maximum 500 characters. Supports DuckDuckGo search syntax including inurl:, site:, intitle:, etc. | | `df` | string | No | Date-based result filtering. Use 'd' (day), 'w' (week), 'm' (month), 'y' (year), or custom range format 'YYYY-MM-DD..YYYY-MM-DD'. | | `kl` | string | No | Region code in country-language format (e.g., 'us-en', NOT 'en-us'). Format: [country-code]-[language-code]. Examples: 'us-en' (US English), 'uk-en' (UK English), 'fr-fr' (France French), 'ca-en' (Canada English), 'ca-fr' (Canada French). | | `async` | boolean | No | Submit search asynchronously. Default: false. Incompatible with Ludicrous Speed tier. Should not be used with no_cache parameter. | | `output` | string | No | Response format: 'json' (default) or 'html'. | | `no_cache` | boolean | No | Force fresh results, bypassing cache. Default: false. Cache duration is 1 hour. Should not be used with async parameter. | | `zero_trace` | boolean | No | Enterprise feature to skip storing search data. Default: false. Requires enterprise account. | | `next_page_token` | string | No | Pagination token for retrieving subsequent pages. Returns 15 results per page. Obtain from previous response's serpapi_pagination object. | #### 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 | ### DuckDuckGo Maps search **Slug:** `SERPAPI_DUCK_DUCK_GO_MAPS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | Yes | Search query for DuckDuckGo Maps (e.g., 'Coffee', 'Italian restaurants', 'Hotels'). | | `lat` | number | No | GPS latitude coordinate for the search center point. Must be used together with lon parameter. Cannot be used together with bbox parameter. | | `lon` | number | No | GPS longitude coordinate for the search center point. Must be used together with lat parameter. Cannot be used together with bbox parameter. | | `bbox` | string | No | Bounding box coordinates formatted as 'latitude_tl,longitude_tl,latitude_br,longitude_br' where tl=top-left and br=bottom-right. Cannot be used together with lat/lon parameters. Use this to constrain search results to a specific geographic area. | | `strict_bbox` | integer | No | Controls strict bounding box adherence. Set to 1 (default/strict) to limit results strictly within the bbox, or 0 (off) to allow results outside the bbox boundaries. Only relevant when bbox parameter is used. | #### 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 | ### DuckDuckGo search **Slug:** `SERPAPI_DUCK_DUCK_GO_SEARCH` Performs a DuckDuckGo search via SerpApi to retrieve SERP data, including organic results, ads, and structured information. Requires a valid SerpApi connection configured in Composio. Results may be localized by region by default. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Search term or phrase for the DuckDuckGo search. | #### 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 | ### eBay Search **Slug:** `SERPAPI_EBAY_SEARCH` Retrieve eBay Search Results via SerpApi (requires active SerpApi connected account). Supports parameters like nkw (query), location, etc. Returns product SERP data in JSON format. Listing prices and fees may be incomplete or inconsistent; verify total cost on the source page before comparing results. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `gl` | string | No | Country code for the search results. | | `hl` | string | No | Language for the search results. | | `nkw` | string | Yes | The search query (keywords). This is a required parameter. | | `num` | integer | No | Number of results per page. Valid options: 25, 50 (default), 100, 200. | | `page` | integer | No | Page number for pagination. Starts at 1. | | `device` | string | No | Device type to simulate (e.g., desktop, mobile, tablet). | | `location` | string | No | The location for the search. Defines the location from where the search is performed. | | `ebay_domain` | string | No | The specific eBay domain to search (e.g., ebay.com, ebay.co.uk). | | `ebay_buyer_country` | string | No | The country for which the results should be tailored. | | `ebay_marketplace_id` | string | No | The eBay marketplace ID (e.g., EBAY-US, EBAY-GB, EBAY-DE). | #### 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 Google Events **Slug:** `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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Search query for events, specifying the topic, type, or name. | #### 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 finance **Slug:** `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. Requires active SerpApi credentials. Empty results for delisted, illiquid, or newly listed assets are valid 'no data' responses. High query volumes may trigger HTTP 429 rate limits; apply backoff on retries. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | The financial search query. This can be a company name, stock ticker symbol (e.g., 'AAPL', 'GOOG'), or a broader financial topic (e.g., 'US stock market trends', 'latest fintech news'). Prefer exchange-prefixed ticker symbols (e.g., 'NASDAQ:AAPL') over company names alone — name-only queries may return empty or generic results, and common names can match multiple entities, leading to misattributed data. | #### 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 Location Options **Slug:** `SERPAPI_GET_AVAILABLE_LOCATION_OPTIONS_FOR_GOOGLE_SEARCHES` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | No | Restricts your search to locations that contain the supplied string. For example, 'Austin' will find 'Austin, TX', 'The University of Texas at Austin', etc. If not provided, returns general location options. | | `limit` | integer | No | Limits the number of locations returned. Must be between 1 and 10. If not specified, returns all matching locations up to the maximum of 10. | #### 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 Facebook profile information **Slug:** `SERPAPI_GET_FACEBOOK_PROFILE` Tool to retrieve public information from a Facebook profile or page using SerpAPI. Use when you need to fetch profile details, bio, photos, followers, ratings, or contact information. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `no_cache` | boolean | No | Force SerpAPI to fetch fresh results instead of returning cached data. Set to true to bypass cache and get the most up-to-date information. | | `profile_id` | string | Yes | Facebook Profile ID or username to retrieve information for. Can be a numeric ID (e.g., '100080376596424') or a username (e.g., 'Meta'). This is the unique identifier for the Facebook profile or page. | #### 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 Google About This Result **Slug:** `SERPAPI_GET_GOOGLE_ABOUT_THIS_RESULT` Tool to get Google 'About this result' information for a website. Use when you need detailed information about a specific URL including company details, social profiles, web citations, and reviews. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | Yes | URL of the website to get information about, formatted as 'About ' (e.g., 'About https://www.starbucks.com/') | | `async` | boolean | No | Submit search asynchronously (true) or wait for results (false, default). Defaults to false. | | `engine` | string | No | Must be set to 'google_about_this_result' to use this engine. | | `output` | string | No | Output format: json (default) or html. When html is used, raw_html_content will be populated instead of structured results. | | `no_cache` | boolean | No | Force SerpApi to fetch fresh results even if a cached version is already present. | | `google_domain` | string | No | Google domain to use for the search. Defaults to google.com. | #### 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 Google Hotels Autocomplete **Slug:** `SERPAPI_GET_GOOGLE_HOTELS_AUTOCOMPLETE_SUGGESTIONS` Tool to get autocomplete suggestions for Google Hotels destination searches. Use when users need to search for hotel destinations, properties, or locations before performing a full hotel search. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | Yes | Search query for destination autocomplete (e.g., 'New York', 'Paris hotels', 'Bali resorts'). The API returns matching hotel destinations, properties, and location suggestions. | | `gl` | string | No | Country code to use for the autocomplete search. It's a two-letter country code (e.g., 'us' for United States, 'uk' for United Kingdom, 'fr' for France). Default is 'us'. | | `hl` | string | No | Language code for the autocomplete results. It's a two-letter language code (e.g., 'en' for English, 'es' for Spanish, 'fr' for French). Default is 'en'. | | `async` | boolean | No | Submit search asynchronously and retrieve results later via Searches Archive API. Set to true for async mode. | | `currency` | string | No | Currency code for pricing information (e.g., 'USD', 'EUR', 'GBP'). Default is 'USD'. | | `no_cache` | boolean | No | Forces SerpAPI to fetch fresh results even if a cached version exists. Set to true to bypass cache. | #### 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 Google Images Related Content **Slug:** `SERPAPI_GET_GOOGLE_IMAGES_RELATED_CONTENT` Get related content for a specific Google Images result. Requires a related_content_id obtained from a Google Images search. Use when you need to find similar images or related visual content for a particular image. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | No | Search query that matches the original Google Images search. Recommended to provide for better results. | | `gl` | string | No | Country code for the search results. Uses two-letter country codes. | | `hl` | string | No | Language code for the search results. Uses two-letter language codes. | | `async` | boolean | No | Submit the search asynchronously and retrieve results later via Search Archive API. Set to true for async mode, false for synchronous (default). | | `output` | string | No | Response format: 'json' (default) for structured JSON results, or 'html' for raw HTML content. | | `no_cache` | boolean | No | Force fresh results by bypassing the SerpApi cache. Set to true to always fetch new results. | | `related_content_id` | string | Yes | Unique ID for retrieving the Related Content of an image. This ID is obtained from the Google Images API response (from the 'related_content_id' field of an image result). | #### 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 Google Patent Details **Slug:** `SERPAPI_GET_GOOGLE_PATENT_DETAILS` Tool to retrieve detailed information about a specific patent or scholar document from Google Patents via SerpApi. Use when you need patent details, claims, citations, inventors, assignees, legal events, or scholar publication information. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `async` | boolean | No | Submit search asynchronously and retrieve results later via Search Archive API. Defaults to false. | | `output` | string | No | Output format. Only 'json' is supported. | | `no_cache` | boolean | No | Force SerpApi to fetch fresh results even if cached version exists. Cache expires after 1 hour. Defaults to false. | | `patent_id` | string | Yes | The ID of the patent or scholar document to retrieve. Use format 'patent//' for patents (country code optional, e.g., 'patent/US11734097B1/en' or 'patent/US11734097B1') or 'scholar/' for scholar documents. | #### 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 Archive **Slug:** `SERPAPI_GET_SEARCH_ARCHIVE` Tool to retrieve results from a previous async search using its search ID. Use when you need to fetch results from searches submitted with async=true. Searches can be retrieved up to 31 days after completion. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `search_id` | string | Yes | The ID of the search to retrieve. This is returned from a previous async search (when async=true parameter was used). The search_id can be found in the search_metadata.id field of the async search response. | #### 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 | ### Google Domains List **Slug:** `SERPAPI_GOOGLE_DOMAINS_LIST` Retrieve the list of supported Google domains for search queries. #### 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 | ### Google Forums Search **Slug:** `SERPAPI_GOOGLE_FORUMS_SEARCH` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | Yes | Parameter defines the query you want to search in Google Forums. | | `gl` | string | No | Parameter defines the country to use for the Google Forums search. It's a two-letter country code. | | `hl` | string | No | Parameter defines the language to use for the Google Forums search interface. It's a two-letter language code. | | `nfpr` | integer | No | Parameter defines whether to exclude results from an auto-corrected query that is spelled wrong. Set to 0 to exclude auto-corrected results, 1 to include them. | | `uule` | string | No | Parameter is the Google encoded location you want to use for the search. uule and location parameters can't be used together. | | `start` | integer | No | Parameter defines the result offset for pagination. It skips the given number of results. It's used for pagination. | | `device` | string | No | Parameter defines the device type to use for the search. Options are: desktop (default), tablet, or mobile. | | `engine` | string | No | Set parameter to google_forums to use the Google Forums API engine. | | `filter` | integer | No | Parameter defines whether to enable or disable the similar/omitted results filter. Set to 0 to disable, 1 to enable. | | `output` | string | No | Parameter defines the final output you want. It can be set to json (default) to get a structured JSON of the results, or html to get the raw html retrieved. | | `location` | string | No | Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Cannot be used with uule parameter. | | `no_cache` | boolean | No | Parameter will force SerpApi to fetch the Google Forums results even if a cached version is already present. Defaults to false. | | `async_req` | boolean | No | Parameter defines the way you want to submit your search to SerpApi. Set to true for asynchronous submission. Defaults to false. | | `zero_trace` | boolean | No | Enterprise only. Parameter enables ZeroTrace mode. It can be set to false (default) or true. | | `json_restrictor` | string | No | Parameter allows you to restrict specific output fields in the JSON response. | #### 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 | ### Google Jobs Search **Slug:** `SERPAPI_GOOGLE_JOBS_SEARCH` Retrieve Google Jobs Search Results via SerpApi. Returns job SERP data in JSON; key attributes like `work_from_home`, `posted_at`, `salary`, and `schedule_type` are nested under `detected_extensions` per job object and are often absent — treat as optional. Results may include stale postings; verify recency via `detected_extensions.posted_at`. Supports pagination, location filtering, and remote-job filtering. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | Yes | Parameter defines the query you want to search. | | `gl` | string | No | Parameter defines the country to use for the Google search. It's a two-letter country code. | | `hl` | string | No | Parameter defines the language to use for the Google Jobs search. It's a two-letter language code. | | `uds` | string | No | Parameter enables to filter search. It's a string provided by Google as a filter. | | `lrad` | integer | No | Defines search radius in kilometers. Does not strictly limit the radius. | | `uule` | string | No | Parameter is the Google encoded location you want to use for the search. uule and location parameters can't be used together. Note: the resolved `location_used` in the response may differ from `location_requested`. | | `chips` | string | No | Parameter defines additional query conditions. Top of a job search page contains elements called chips, its values are extracted in order to be passed to chips parameter. | | `ltype` | integer | No | Parameter will filter the results by work from home. Set to 1 for work from home jobs. | | `engine` | string | No | Set parameter to google_jobs to use the Google Jobs API engine. | | `output` | string | No | Parameter defines the final output you want. It can be set to json (default) to get a structured JSON of the results, or html to get the raw html retrieved. | | `location` | string | No | Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. It is recommended to specify location at the city level in order to simulate a real user’s search. | | `no_cache` | boolean | No | Parameter will force SerpApi to fetch the Google Jobs results even if a cached version is already present. | | `async_req` | boolean | No | Parameter defines the way you want to submit your search to SerpApi. | | `zero_trace` | boolean | No | Enterprise only. Parameter enables ZeroTrace mode. It can be set to false (default) or true. | | `google_domain` | string | No | Parameter defines the Google domain to use. It defaults to google.com. | | `next_page_token` | string | No | Parameter defines the next page token. It is used for retrieving the next page of results. Up to 10 results are returned per page. | #### 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 | ### Google Lens search **Slug:** `SERPAPI_GOOGLE_LENS_SEARCH` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | No | Optional search query to refine results. Works with 'all', 'visual_matches', or 'products' types. | | `hl` | string | No | Two-letter language code for localized results (e.g., 'en', 'es', 'fr', 'de'). | | `url` | string | Yes | The URL of an image to perform Google Lens visual search. Must be a publicly accessible image URL. | | `type` | string ("all" | "products" | "exact_matches" | "visual_matches") | No | Search type to filter results. Options: 'all' (default), 'products' (shopping results), 'exact_matches' (identical images), 'visual_matches' (similar images). | | `country` | string | No | Two-letter country code for localized results (e.g., 'us', 'uk', 'ca'). | #### 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 | ### Google Light Search **Slug:** `SERPAPI_GOOGLE_LIGHT_SEARCH` Retrieve Google Light Search Results via SerpApi. Requires an active SerpApi connection. Supports q, location, gl, hl, and other SERP parameters. Returns lightweight JSON SERP data; results are in organic_results (handle missing/empty gracefully). Snippets are shallow — follow citation URLs with BROWSER_TOOL_FETCH_WEBPAGE for full content. Rate limit: HTTP 429 under heavy use; keep to ~1–2 requests/sec with exponential backoff on retry. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | Yes | Parameter defines the query you want to search. You can use anything that you would use in a regular Google search. | | `gl` | string | No | Parameter defines the country to use for the Google search. It's a two-letter country code. Example: "us" for United States. | | `hl` | string | No | Parameter defines the language to use for the Google search. It's a two-letter language code. Example: "en" for English. | | `lr` | string | No | Parameter defines one or multiple languages to limit the search to. Example: "lang_fr\|lang_de" for French or German. | | `num` | integer | No | Parameter defines the maximum number of results to return. (e.g., `10` (default) returns 10 results, `40` returns 40 results, and `100` returns 100 results). Maximum value is `100`. | | `nfpr` | string | No | Parameter defines the exclusion of results from an auto-corrected query when the original query is spelled wrong. It can be set to `1` to exclude results or `0` to include them. Defaults to `0`. | | `safe` | string | No | Parameter defines the level of filtering for adult content. It can be set to `active` or `off`. `active` is the highest level of filtering. `off` turns off filtering. Defaults to `off`. | | `uule` | string | No | Parameter is the Google encoded location you want to use for the search. Example: "w+CAIQICIHVG9yb250bw==" for Toronto. | | `start` | integer | No | Parameter defines the result offset. It skips the given number of results. It's used for pagination. (e.g., `0` (default) is the first page of results, `10` is the 2nd page of results, `20` is the 3rd page of results, etc.). | | `device` | string | No | Parameter defines the device to use to get the results. It can be set to `desktop`, `tablet`, or `mobile`. Defaults to `desktop`. | | `engine` | string | No | Set parameter to `google_light` to use the Google Light API engine. | | `filter` | string | No | Parameter defines if the filters for 'Similar Results' and 'Omitted Results' are on or off. It can be set to `0` to turn off filtering or `1` to turn on filtering. Defaults to `1`. | | `output` | string | No | Parameter defines the final output format. It can be set to 'json' (default) to get structured JSON results, or 'html' to get raw HTML retrieved from Google. When 'html' is used, the response will contain raw_html_content instead of structured search results. | | `location` | string | No | Parameter defines from where you want the search to originate. Example: "Austin, Texas, United States". | | `no_cache` | boolean | No | Parameter will force SerpApi to fetch the Google Light results even if a cached version is already present. | | `zero_trace` | boolean | No | Enterprise only. Parameter enables ZeroTrace mode. It can be set to `true` to enable ZeroTrace or `false` to disable it. Defaults to `false`. | | `async_param` | boolean | No | Parameter defines the way you want to submit your search to SerpApi. It can be set to `true` to run the search asynchronously or `false` to run it synchronously. Defaults to `false`. | | `google_domain` | string | No | Parameter defines the Google domain to use. It defaults to `google.com`. | #### 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 | ### Google Maps Posts **Slug:** `SERPAPI_GOOGLE_MAPS_POSTS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data_id` | string | Yes | The Google Maps data ID for the business location. This is required to identify which business's posts to retrieve. Format: '0x89c258e28c304997:0xfcafe4e7ce35ee8c' | | `no_cache` | boolean | No | Force fresh results by bypassing cached data. Default is false. Note: Cached results don't consume monthly search quotas. | | `next_page_token` | string | No | Token for pagination to retrieve subsequent result pages. Each page contains 10 posts. Use the token from serpapi_pagination in the previous response. | #### 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 | ### Google maps search **Slug:** `SERPAPI_GOOGLE_MAPS_SEARCH` Performs a Google Maps search via SERP API. Takes a query, optionally using specific GPS coordinates and pagination, returning structured location data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | Yes | Search query for Google Maps (e.g., 'coffee shops', 'restaurants near Central Park'). | | `ll` | string | No | GPS coordinates for the search, formatted as '@latitude,longitude,zoom_level'. Required when using pagination (start parameter). If unspecified and start is not provided, search may be less geographically specific or use a default location. Results are strictly viewport-bound to the area defined by the coordinates and zoom level; adjust coordinates and paginate via `start` to cover adjacent areas. | | `start` | integer | No | Starting result index for pagination, used to get subsequent pages of results. When start is provided, ll parameter becomes required. For the first page, omit start (or use start=0 only if ll is also provided). | #### 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 | ### Google Play Product Search **Slug:** `SERPAPI_GOOGLE_PLAY_PRODUCT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `gl` | string | No | Two-letter country code for localization. Defaults to 'us'. | | `hl` | string | No | Two-letter language code for localization. Defaults to 'en'. | | `num` | integer | No | Maximum number of reviews per search. Max 199, default 40. | | `async` | boolean | No | Submit search asynchronously. Defaults to false. | | `store` | string ("apps" | "movies" | "tv" | "books" | "audiobooks") | Yes | Store type: 'apps', 'movies', 'tv', 'books', or 'audiobooks'. | | `engine` | string | No | Set parameter to `google_play_product` to use the Google Play Product API engine. | | `output` | string ("json" | "html") | No | Response format: 'json' (default) or 'html'. | | `rating` | integer ("1" | "2" | "3" | "4" | "5") | No | Filter reviews by star rating (1-5). | | `sort_by` | integer ("1" | "2" | "3") | No | Sort reviews: 1 (relevant), 2 (newest), 3 (rating). | | `no_cache` | boolean | No | Bypass cache and force fresh results. Defaults to false. | | `platform` | string ("phone" | "tablet" | "watch" | "chromebook" | "tv") | No | Filter reviews by device type: 'phone', 'tablet', 'watch', 'chromebook', or 'tv'. | | `season_id` | string | No | Season ID when store is 'tv'. Only applicable for TV store. | | `product_id` | string | Yes | Product ID to query (e.g., 'com.google.android.youtube' for apps). | | `all_reviews` | boolean | No | Retrieve all reviews (true/false). Set to true to fetch all available reviews. | | `next_page_token` | string | No | Pagination token for retrieving additional 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 | ### Google Scholar Author Profile **Slug:** `SERPAPI_GOOGLE_SCHOLAR_AUTHOR` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `hl` | string | No | Two-letter language code for the interface language (e.g., 'en' for English, 'es' for Spanish). | | `num` | integer | No | Number of results per page. Maximum 100, defaults to 20. | | `sort` | string | No | Sort articles by 'title' or 'pubdate'. Default is by citation count. | | `start` | integer | No | Result offset for pagination. Defaults to 0. | | `view_op` | string | No | View specific sections. Use 'view_citation' to view a specific citation or 'list_colleagues' to list colleagues. | | `no_cache` | boolean | No | Force fresh results, ignoring cached data. Set to true to bypass cache. | | `author_id` | string | Yes | Unique identifier of the author from Google Scholar. Required to fetch the author's profile. | | `citation_id` | string | No | Required when view_op='view_citation'. Unique identifier for the specific citation to view. | #### 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 | ### Google Scholar Cite **Slug:** `SERPAPI_GOOGLE_SCHOLAR_CITE` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | Yes | The ID of an individual Google Scholar organic search result. This is required to fetch citation information for a specific paper. | | `hl` | string | No | Two-letter language code for localization (e.g., 'en' for English, 'es' for Spanish, 'fr' for French). | | `no_cache` | boolean | No | Force fresh results, ignoring cached data. Set to true to bypass cache (cache expires after 1 hour). | #### 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 | ### Google Videos Light Search **Slug:** `SERPAPI_GOOGLE_VIDEOS_LIGHT` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | Yes | Search query for Google Videos. Supports advanced operators like inurl:, site:, intitle:. | | `gl` | string | No | Two-letter country code to define the country for the search. | | `hl` | string | No | Two-letter language code to define the language for the search interface. | | `lr` | string | No | Language restrictions using lang_{code} format, delimited by pipe \|. | | `tbs` | string | No | Advanced search parameters for filtering by video duration, upload date, quality, or source. | | `nfpr` | integer | No | Exclude auto-corrected results. Set to 1 to exclude, 0 to include. Defaults to 0. | | `safe` | string | No | Adult content filter. Set to 'active' to filter adult content or 'off' to disable. | | `uule` | string | No | Google-encoded location parameter. Cannot be used with location parameter. | | `start` | integer | No | Result offset for pagination. Use 0 for page 1, 10 for page 2, etc. | | `device` | string | No | Device type for the search. Options: desktop (default), tablet, mobile. | | `engine` | string | No | Set parameter to google_videos_light to use the Google Videos Light API engine. | | `filter` | integer | No | Control Similar Results filter. Set to 1 to enable (default), 0 to disable. | | `output` | string | No | Output format. Set to json (default) for structured JSON or html for raw HTML. | | `location` | string | No | Geographic location for the search origin. Recommended to specify at city level. Cannot be used with uule parameter. | | `no_cache` | boolean | No | Force fresh results even if cached version exists. Defaults to false. | | `async_req` | boolean | No | Enable asynchronous submission mode. Defaults to false (maintains connection). | | `zero_trace` | boolean | No | Enterprise only. Enable ZeroTrace mode. Defaults to false. | | `google_domain` | string | No | Google domain to use for the search. Defaults to google.com. | | `json_restrictor` | string | No | Restrict specific output fields in the JSON response for smaller payload size. | #### 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 | ### Hotel Search **Slug:** `SERPAPI_HOTEL_SEARCH` Retrieve Google Hotel Search Results. Supports parameters like q (query), location, etc. Returns hotel SERP data in JSON format. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | Yes | Parameter defines the search query. You can use anything that you would use in a regular Google Hotels search. | | `gl` | string | No | Parameter defines the country to use for the Google Hotels search. It's a two-letter country code. (e.g., us for the United States, uk for United Kingdom, or fr for France) | | `hl` | string | No | Parameter defines the language to use for the Google Hotels search. It's a two-letter language code. (e.g., en for English, es for Spanish, or fr for French). | | `async` | boolean | No | Parameter defines the way you want to submit your search to SerpApi. | | `adults` | integer | No | Parameter defines the number of adults. Default to 2. | | `output` | string | No | Parameter defines the final output you want. It can be set to json (default) to get a structured JSON of the results, or html to get the raw html retrieved. | | `rating` | integer | No | Parameter is used for filtering the results to certain rating. | | `sort_by` | string | No | Parameter is used for sorting the results. Default is sort by Relevance. | | `bedrooms` | integer | No | Parameter defines the minimum number of bedrooms. Default to 0. | | `children` | integer | No | Parameter defines the number of children. Default to 0. | | `currency` | string | No | Parameter defines the currency of the returned prices. Default to USD. | | `no_cache` | boolean | No | Parameter will force SerpApi to fetch the Google Hotels results even if a cached version is already present. | | `amenities` | string | No | Parameter defines to include only results that offer specified amenities. | | `bathrooms` | integer | No | Parameter defines the minimum number of bathrooms. Default to 0. | | `max_price` | integer | No | Parameter defines the upper bound of price range. | | `min_price` | integer | No | Parameter defines the lower bound of price range. | | `zero_trace` | boolean | No | Enterprise only. Parameter enables ZeroTrace mode. | | `check_in_date` | string | Yes | Parameter defines the check-in date. The format is YYYY-MM-DD. | | `children_ages` | string | No | Parameter defines the ages of children. The age range is from 1 to 17, with children who haven't reached 1 year old being considered as 1. | | `eco_certified` | boolean | No | Parameter defines to show results that are eco certified. | | `check_out_date` | string | Yes | Parameter defines the check-out date. The format is YYYY-MM-DD. | | `property_token` | string | No | Parameter is used to get property details which consists of name, address, phone, prices, nearby places, and etc. | | `property_types` | string | No | Parameter defines to include only certain type of property in the results. | | `special_offers` | boolean | No | Parameter defines to show results that have special offers. | | `next_page_token` | string | No | Parameter defines the next page token. It is used for retrieving the next page results. | | `vacation_rentals` | boolean | No | Parameter defines to search for Vacation Rentals results. Default search is for Hotels. | | `free_cancellation` | boolean | No | Parameter defines to show results that offer free cancellation. | #### 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 | ### Image search **Slug:** `SERPAPI_IMAGE_SEARCH` Searches Google Images via SERP API for a given query, returning structured image results. Requires a valid SerpAPI authenticated connection. The number of results can be controlled using the 'num' parameter (1-100). If not specified, it defaults to 20 results. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `num` | integer | No | Number of image results to return. Defaults to 20 if not specified. Google typically returns up to 100 results. | | `query` | string | Yes | Query to find images; be specific about the topic or subject. Avoid single-word or vague queries; combine subject, style, context, and audience details for precise 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 | ### Naver Search **Slug:** `SERPAPI_NAVER_SEARCH` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `num` | integer | No | Maximum results per page (1-100, default 50). Only available for Images API. Use when limiting image search results. | | `page` | integer | No | Page number (starts at 1). Automatically calculates the start parameter. Use for easier pagination instead of manually calculating start offset. | | `async` | boolean | No | Submit search asynchronously when true. Retrieve results later via Search Archive API. Cannot be used with no_cache or on accounts with Ludicrous Speed enabled. | | `query` | string | Yes | Search query string supporting operators like NOT, OR, site:, filetype:, near:, ip:, loc:, feed:. Use when searching Naver for Korean web results and content. | | `start` | integer | No | Results offset for pagination. Defaults to 1. Formula: (page * 10) - 9 for most searches; (page * 15) - 29 for web results. Use when fetching subsequent pages. | | `where` | string | No | Search category to use. Options: 'nexearch' (integrated search, default), 'web', 'video', 'news', 'image'. Use 'nexearch' for comprehensive results or specify category for targeted searches. | | `device` | string | No | Device type to simulate. Options: 'desktop' (default), 'tablet', or 'mobile'. Use to get device-specific search results. | | `output` | string | No | Output format. Options: 'json' (default, structured data) or 'html' (raw HTML). Use json for programmatic access. | | `period` | string | No | Time period filter. Options: 'all' (default), '1h', '1d', '1w', '1m', '3m', '6m', '1y', or custom format 'fromYYYYMMDDtoYYYYMMDD'. Use when searching for recent content. | | `sort_by` | string | No | Sort order for results. Options: 'r' (relevance, default) or 'dd' (latest/date descending). Use 'dd' when freshness matters. | | `no_cache` | boolean | No | Force fresh results when true, bypassing 1-hour cache. Cached searches are free. Set to true only when latest data is critical. Cannot be used with async parameter. | #### 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 for news articles **Slug:** `SERPAPI_NEWS_SEARCH` Searches Google News (via SerpApi, `tbm=nws`) for articles matching a query; precise key-phrase queries yield best results. Auth is handled via SerpApi connection — do not pass api_key as a parameter. Results returned under `news_results` field (~10 items/page). Rate-limited: throttle to ~1 req/s; HTTP 429 on bursts — apply exponential backoff (1s, 2s, 4s). Covers news content only; pair with SERPAPI_SEARCH for broader web sources. Headlines/snippets only — use EXA_GET_CONTENTS_ACTION for full article text. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Search query for finding relevant news articles. Overly long or overly specific queries may return empty results; simplify to key phrases and split multi-concept searches into separate queries. | #### 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 | ### OpenTable Reviews Search **Slug:** `SERPAPI_OPEN_TABLE_REVIEWS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number for pagination (1-based indexing). | | `async` | boolean | No | Submit search asynchronously. Defaults to false. | | `output` | string ("json" | "html") | No | Response format: 'json' (default) or 'html'. | | `no_cache` | boolean | No | Force fresh results by bypassing cache. Defaults to false. | | `place_id` | string | Yes | OpenTable restaurant ID (e.g., 'central-park-boathouse-new-york-2'). Found in the OpenTable URL after /r/. | | `zero_trace` | boolean | No | Enterprise feature to skip storing search data. Defaults to false. | | `json_restrictor` | string | No | Restrict output fields for smaller responses (e.g., 'reviews'). | | `open_table_domain` | string | No | OpenTable domain to use. Defaults to 'www.opentable.com'. | #### 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 | ### Google Play Search **Slug:** `SERPAPI_PLAY_SEARCH` Retrieve Google Play Store Search Results. Supports parameters like q (query), gl, hl, etc. Returns app SERP data in JSON format. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | No | Parameter defines the query you want to search in Google Play Apps Store. | | `hl` | string | No | Parameter defines the language to use for the Google Play search. It's a two-letter language code. (e.g., `en` (default) for English, `es` for Spanish, or `fr` for French). | | `age` | string | No | Parameter defines age subcategory. age works, and should only be used with apps_category=FAMILY (Kids Apps) | | `chart` | string | No | Parameter is used for showing top charts. It can return up to `50` results. | | `store` | string | No | Parameter defines the country to use for the Google Play search. It's a two-letter country code. (e.g., `us` (default) for the United States, `uk` for United Kingdom, or `fr` for France). | | `engine` | string | No | Set parameter to `google_play` to use the Google Play API engine. | | `output` | string | No | Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved. | | `no_cache` | boolean | No | Parameter will force SerpApi to fetch the Google Play results even if a cached version is already present. | | `async_param` | boolean | No | Parameter defines the way you want to submit your search to SerpApi. | | `store_device` | string | No | Parameter defines the device for sorting results. This parameter cannot be used with apps_category or q parameters. | | `apps_category` | string | No | Parameter defines the apps store category. | | `see_more_token` | string | No | Parameter defines the see more token used for retrieving the pagination results from individual sections. | | `next_page_token` | string | No | Parameter defines the next page token. It is used for retrieving the next page results. | | `section_page_token` | string | No | Parameter defines the section page token used for retrieving the pagination results from individual sections. | #### 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 Google Scholar **Slug:** `SERPAPI_SCHOLAR_SEARCH` Searches Google Scholar via SerpApi for academic literature, papers, articles, and citations based on a query. Response results may include `inline_links.cited_by` and `resources` (PDF links), but these fields are not guaranteed; check for their existence and type before accessing. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | The search query for Google Scholar. This can be an academic topic, paper title, author name, or specific keywords. | #### 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 | ### Serp API search **Slug:** `SERPAPI_SEARCH` Performs a real-time Google search via the SerpAPI connection (must be active; if unavailable, use COMPOSIO_SEARCH_WEB or other COMPOSIO_SEARCH_* tools). Returns ~10 organic results per page nested under results.organic_results — not a flat list; handle missing/empty arrays. Paginate via start offset or serpapi_pagination.next; max num=100; stop when domains plateau to avoid quota exhaustion. Rate-limited: throttle to 1–2 req/s; HTTP 429 on bursts — apply exponential backoff (1s, 2s, 4s). Derive result rank from array index (absolute rank = start + index; no explicit rank field). Lacks date-bound controls — embed recency terms in query or use SERPAPI_NEWS_SEARCH for time-sensitive queries. Results may include ads and sponsored content; prefer authoritative domains. Use vertical tools (SERPAPI_IMAGE_SEARCH, SERPAPI_NEWS_SEARCH, SERPAPI_YOU_TUBE_SEARCH, SERPAPI_GOOGLE_JOBS_SEARCH) for specialized query types. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | User's search query; should be a clear, concise question or keyword phrase. | #### 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 Apple App Store **Slug:** `SERPAPI_SEARCH_APPLE_APP_STORE` Tool to search Apple App Store for iOS and Mac apps. Returns app details including ratings, reviews, descriptions, and developer information. Use when you need to find apps on the Apple App Store or get information about specific apps. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `term` | string | Yes | Search query term for Apple App Store apps. | | `async` | boolean | No | Submit search asynchronously. | | `device` | string | No | Device type to filter results: 'desktop', 'tablet', or 'mobile'. | | `country` | string | No | Country code for the search (e.g., 'us', 'uk', 'fr'). | | `language` | string | No | Language code for the search (e.g., 'en-us', 'fr-fr', 'es-es'). | | `no_cache` | boolean | No | Force fresh results, bypassing cache. | | `property` | string | No | Search property. Set to 'developer' to search by developer name. | | `category_id` | string | No | Filter by category ID (e.g., '6014' for Games). | #### 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 | ### Google Images Light Search **Slug:** `SERPAPI_SEARCH_GOOGLE_IMAGES_LIGHT` Tool to scrape Google Images results using SerpApi's Google Images Light API. Use when you need fast image search with thumbnails, titles, sources, and original image URLs from Google Images. This lightweight version provides faster response times compared to the full Google Images API. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | Yes | Search query for Google Images. Supports Google search operators like inurl:, site:, intitle:. | | `gl` | string | No | Two-letter country code to define the country for the search. | | `hl` | string | No | Two-letter language code to define the language for the search interface. | | `imgar` | string | No | Aspect ratio filter. Options: s (square), t (tall), w (wide), xw (extra wide). | | `imgsz` | string | No | Image size filter. Options: l (large), m (medium), i (icon), etc. | | `start` | integer | No | Result offset for pagination. Must be between 0 and 999. | | `device` | string | No | Device type for the search. Options: desktop (default), tablet, mobile. | | `engine` | string | No | Set parameter to google_images_light to use the Google Images Light API engine. | | `end_date` | string | No | End date for filtering images by upload date. Format: YYYYMMDD. | | `location` | string | No | Geographic location for the search origin. Specify at city level for best results. | | `start_date` | string | No | Start date for filtering images by upload date. Format: YYYYMMDD. | | `image_color` | string | No | Color filter for images. Options: bw (black and white), red, blue, green, yellow, orange, pink, white, gray, black, teal, brown. | | `period_unit` | string | No | Time period unit for filtering by upload date. Options: s (second), n (minute), h (hour), d (day), w (week), m (month), y (year). Must be used with period_value. | | `period_value` | integer | No | Time period value to use with period_unit. Specifies how many units back to search. | | `google_domain` | string | No | Google domain to use for the search. Defaults to google.com. | #### 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 Google Local Services **Slug:** `SERPAPI_SEARCH_GOOGLE_LOCAL_SERVICES` Search Google Local Services for service providers like electricians, plumbers, HVAC technicians, and more. Use when you need to find local service professionals with Google's guaranteed badge and verified business information. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | Yes | Parameter defines the service you want to search for (e.g., 'electrician', 'plumber', 'hvac repair'). | | `hl` | string | No | Parameter defines the language to use for the search. It's a two-letter language code (e.g., 'en' for English, 'es' for Spanish, 'fr' for French). | | `bid` | string | No | Unique business identifier. Used together with cid and pid parameters to identify a specific business. | | `cid` | string | No | Unique business place ID from API response. Used to get details for a specific business. | | `pid` | string | No | Unique place identifier. Used together with cid and bid parameters to identify a specific business. | | `async` | boolean | No | Parameter defines the way you want to submit your search to SerpApi. Set to true to submit the search asynchronously. | | `output` | string | No | Parameter defines the final output format. Can be set to 'json' (default) to get structured JSON results, or 'html' to get raw HTML. | | `data_cid` | string | Yes | Google customer identifier for location. This is a unique identifier that specifies the geographic area for the search. | | `job_type` | string | No | Parameter defines the service subcategory or specific job type within the main service category (e.g., 'restore_power' for electrician searches). | | `no_cache` | boolean | No | Parameter will force SerpApi to fetch the Google Local Services results even if a cached version is already present. Set to true to get fresh results. | | `zero_trace` | boolean | No | Enterprise only. Parameter enables ZeroTrace mode to skip storing search metadata. Set to true to enable. | | `json_restrictor` | string | No | Parameter restricts the output fields to reduce response size. Specify field paths to include in the response. | #### 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 Yelp businesses **Slug:** `SERPAPI_SEARCH_YELP` Tool to search Yelp for businesses and places using SerpApi. Returns business listings with ratings, reviews, hours, contact information, and location details. Use when you need to find local businesses, restaurants, services, or read customer reviews. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `attrs` | string | No | Attribute filters to refine search (e.g., 'HotAndNew' for new businesses, 'Deals' for businesses with offers). Can be comma-separated for multiple filters. | | `start` | integer | No | Result offset for pagination. Use to fetch additional results beyond the first page. Each page typically contains 10 results. | | `sortby` | string ("recommended" | "rating" | "review_count") | No | Sort order for results. 'recommended' shows Yelp's recommended matches, 'rating' shows highest-rated first, 'review_count' shows most-reviewed first. | | `find_loc` | string | Yes | Location to search in (e.g., 'San Francisco, CA', 'New York, NY', '10001'). Can be a city, state, address, or ZIP code. | | `no_cache` | boolean | No | Set to true to force fresh results from Yelp, bypassing SerpApi's cache. Useful when you need real-time data. | | `find_desc` | string | Yes | Search query describing what to find (e.g., 'pizza', 'coffee shop', 'italian restaurant'). This is the business type or service you're looking for. | | `yelp_domain` | string | No | Yelp domain to search on (e.g., 'yelp.com' for US, 'yelp.ca' for Canada, 'yelp.co.uk' for UK). Defaults to yelp.com if not specified. | #### 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 | ### Shopping search **Slug:** `SERPAPI_SHOPPING_SEARCH` Searches Google Shopping via SerpAPI for a specific product, returning structured listings in results.shopping_results. Requires an active SerpAPI connection. Response fields such as rating, review_count, extracted_price, and extracted_old_price may be absent; null-check before ranking or computing discounts. Discount percentages in listings may reflect aggregate promotional claims, not per-item pricing. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Product or item to search for on Google Shopping. | #### 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 | ### Google Trends search **Slug:** `SERPAPI_TRENDS_SEARCH` Fetches Google Trends data; returns relative 0–100 interest indices (not absolute volumes) meaningful only when comparing queries within the same request. The `query`'s format (single/multiple terms) must comply with the selected `data_type`. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Search query/queries for Google Trends (use comma for multiple). Format (single vs. multiple terms) is dictated by `data_type`. | | `data_type` | string | No | Specifies Google Trends search type, dictating `query` format (single term or comma-separated multiple terms). Options: - `TIMESERIES`: Interest over time; single/multiple queries. - `GEO_MAP`: Regional comparison; multiple queries. - `GEO_MAP_0`: Regional interest; single query. - `RELATED_TOPICS`: Related topics; single query. - `RELATED_QUERIES`: Related queries; single query. | #### 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 | ### Walmart Product Reviews **Slug:** `SERPAPI_WALMART_PRODUCT_REVIEWS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number for pagination. Starts at 1. Use this to retrieve additional pages of reviews. | | `sort` | string ("relevancy" | "helpful" | "submission-desc" | "submission-asc" | "rating-desc" | "rating-asc") | No | Sort order for reviews. Options: 'relevancy' (default), 'helpful' (most helpful first), 'submission-desc' (newest first), 'submission-asc' (oldest first), 'rating-desc' (highest rating first), 'rating-asc' (lowest rating first). | | `async` | boolean | No | Set to true for asynchronous search submission. When true, the search is queued and returns immediately with a search_id for later retrieval. Defaults to false. | | `output` | string ("json" | "html") | No | Response format: 'json' (default, structured data) or 'html' (raw HTML response). | | `rating` | integer ("1" | "2" | "3" | "4" | "5") | No | Filter reviews by star rating. Must be an integer between 1 and 5. | | `no_cache` | boolean | No | Set to true to bypass cached results and force fresh data. Defaults to false. Note: Using this may increase response time and count against your SerpApi quota. | | `product_id` | string | Yes | Unique Walmart product identifier (us_item_id) to retrieve reviews for. This is the unique identifier for a specific Walmart product. | #### 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 | ### Walmart Search **Slug:** `SERPAPI_WALMART_SEARCH` Retrieve Walmart Search Results. Supports parameters like query, location, store ID, etc. Returns product SERP data in JSON format. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | Yes | The search query term or phrase. | | `page` | integer | No | Page number for pagination. Starts at 1. | | `sort` | string | No | Sorting option for results. Available options: best_match, best_seller, price_low, price_high, rating_high, new. | | `type` | string | No | Defines the type of search. Can be 'search', 'deals', 'store', 'question'. Default is 'search'. | | `location` | string | No | Defines the location to use for the search. It can be a city, region, or country. Uses a canonicalized name from the SerpApi locations API. | | `store_id` | string | No | Store ID to filter results. Can be found using the Walmart Store Finder API. | | `max_price` | number | No | Maximum price filter. | | `min_price` | number | No | Minimum price filter. | | `min_rating` | number | No | Minimum rating filter (1-5). | #### 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 | ### Yahoo Search **Slug:** `SERPAPI_YAHOO_SEARCH` Retrieve Yahoo! Search Engine Results. Supports query, location, language, and device parameters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `b` | integer | No | Parameter defines the result offset. It skips the given number of results. It's used for pagination. | | `d` | string | No | Parameter specifies the destination for related topics. | | `p` | string | Yes | Parameter defines the search query. You can use anything that you would use in a regular Yahoo! search. | | `vc` | string | No | Parameter defines the country to use for the Yahoo! search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France) | | `vf` | string | No | `all formats` or specific file format like `pdf` or `txt`. | | `vl` | string | No | Parameter defines language to limit the search to. It uses `lang_{two-letter language code}` to specify languages. | | `vm` | string | No | Parameter defines the level of filtering for adult content. Strict: `r`, Moderate: `i`, Off: `p` | | `vs` | string | No | Filter results by top-level domains separated by ','. (e.g., `.com,.org`) | | `fr2` | string | No | Parameter is responsible for rendering positions and expansions for some elements. | | `device` | string | No | Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser, or `mobile` to use a mobile browser. | | `output` | string | No | Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved. | | `no_cache` | boolean | No | Parameter will force SerpApi to fetch the Yahoo! results even if a cached version is already present. | | `yahoo_domain` | string | No | Parameter defines the Yahoo! domain to use. It defaults to `search.yahoo.com`. If specified domain is allowed, it will be prepended to the domain (e.g., `fr.search.yahoo.com`). | | `async_request` | boolean | No | Parameter defines the way you want to submit your search to SerpApi. | #### 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 | ### Yahoo Videos Search **Slug:** `SERPAPI_YAHOO_VIDEOS` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `b` | integer | No | Parameter defines the result offset for pagination. It skips the given number of results. | | `p` | string | Yes | Parameter defines the search query. You can use anything that you would use in a regular Yahoo! Videos search. | | `durs` | string | No | Parameter filters results by video duration. Options: 'short' (under 5 minutes), 'medium' (5-20 minutes), 'long' (over 20 minutes). | | `vage` | string | No | Parameter filters results by upload date. Options: 'day' (past 24 hours), 'week' (past week), 'month' (past month), 'year' (past year). | | `vres` | string | No | Parameter filters results by video resolution. Options: '360p', '480p', '720p', '1080p'. | | `async` | boolean | No | Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. | | `vsite` | string | No | Parameter filters results by video source platform. Options: 'youtube', 'dailymotion', 'vimeo', 'mtv', 'cbsnews', 'foxnews', 'cnn', 'msn'. | | `device` | string | No | Parameter defines the device to use to get the results. It can be set to `desktop` (default), `tablet`, or `mobile`. | | `output` | string | No | Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved. | | `no_cache` | boolean | No | Parameter will force SerpApi to fetch the Yahoo! Videos results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. | | `zero_trace` | boolean | No | Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. | | `yahoo_domain` | string | No | Parameter defines the Yahoo! domain to use. It defaults to `search.yahoo.com`. | #### 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 | ### Yandex Images Search **Slug:** `SERPAPI_YANDEX_IMAGES_SEARCH` 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `p` | integer | No | Page number (starts at 0, returns up to 30 results per page). | | `tab` | string | No | Tab to use for reverse image search - about or similar. | | `url` | string | No | Image URL for reverse image search. | | `crop` | string | No | Crop coordinates for reverse search (format: left;top;right;bottom, values 0-1). | | `site` | string | No | Filter by source domain (e.g., www.shutterstock.com). | | `text` | string | Yes | Search query - anything you would use in regular Yandex Images search. | | `async` | boolean | No | Set to true for asynchronous submission. | | `color` | string | No | Color filter - color, gray, red, orange, yellow, cyan, green, blue, violet, white, or black. | | `width` | integer | No | Image width in pixels; must be used with height parameter. | | `height` | integer | No | Image height in pixels; must be used with width parameter. | | `output` | string | No | Response format - json (default) or html. | | `recent` | boolean | No | Shows images from the last 7 days when set to true. | | `crop_id` | string | No | Filter by specific image section (Yandex-hosted images only). | | `no_cache` | boolean | No | Set to true to bypass cached results. | | `file_type` | string | No | Image format - jpg, png, or gifan. | | `image_type` | string | No | Image type - photo, clipart, lineart, demotivator, or face. | | `zero_trace` | boolean | No | Enterprise feature for privacy mode. | | `orientation` | string | No | Image orientation - horizontal, vertical, or square. | | `yandex_domain` | string | No | Yandex Images domain to use for the search (default: yandex.com). | #### 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 | ### Yandex Search **Slug:** `SERPAPI_YANDEX_SEARCH` Retrieve Yandex Search Results. Supports parameters like text (query), location, etc. Returns SERP data in JSON format. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `p` | integer | No | Defines the page number for pagination. Starts from 0. | | `num` | integer | No | Defines the number of results to return per page. Maps to 'groups_on_page' in Yandex API. Default is 20. | | `lang` | string | No | Defines the language to use for the search. (e.g., 'ru' for Russian, 'en' for English). | | `text` | string | Yes | The search query string. | | `location` | string | No | Defines the location to use for the search. It can be a city name, a region, or a country. SerpApi will convert this to the appropriate Yandex location code. | | `yandex_domain` | string | No | Defines the Yandex domain to use. Defaults to yandex.com. | #### 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 | ### YouTube Search **Slug:** `SERPAPI_YOU_TUBE_SEARCH` Retrieve YouTube Search Results. Supports parameters like search_query, location, etc. Returns video SERP data in JSON format. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `gl` | string | No | Parameter defines the country to use for the Google search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France). Head to the Google countries page for a full list of supported Google countries. | | `hl` | string | No | Parameter defines the language to use for the Youtube search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Google languages page for a full list of supported Google languages. | | `sp` | string | No | Parameter can be used for pagination. Youtube uses continous pagination and the next page token can be found in the SerpApi JSON response serpapi_pagination -> next_page_token and pagination -> next_page_token fields. Parameter can also be used to filter the search results by Upload date (CAI%3D), 4K (EgJwAQ%3D%3D), etc. It can also be used for forcing the exact search query spelling by setting the sp value to QgIIAQ%3D%3D. Pagination tokens can expire; limit pagination depth to 3–5 pages. | | `async` | boolean | No | Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together. | | `output` | string | No | Parameter defines the final output you want. It can be set to json (default) to get a structured `JSON` of the results, or `html` to get the raw html retrieved. | | `no_cache` | boolean | No | Parameter will force SerpApi to fetch the YouTube results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. no_cache and async parameters should not be used together. | | `zero_trace` | boolean | No | Enterprise only. Parameter enables ZeroTrace mode. It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult. | | `search_query` | string | Yes | Parameter defines the search query. You can use anything that you would use in a regular YouTube search. | #### 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 |