SerpApi

Parámetros de entrada

• fstring

  Defines the originating search type. (e.g., "8" is a normal search, "3" is from the suggestion list, and "1" is a related search.

• qstringObligatorio

  Defines the search query, including all Baidu search operators (e.g., `inurl:`, `site:`, `intitle:`, etc.).

• bsstring

  Defines the previous search query.

• ctstring

  Defines which language to restrict results. Available options: "1" (All languages), "2" (Simplified Chinese), "3" (Traditional Chinese).

• oqstring

  Defines the original search query when navigated from a related search.

• pninteger

  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.).

• q5string

  Similar to using `inurl:` or `intitle:`. (e.g., "1" to search by page title, "2" to search by web address.).

• q6string

  Similar to using `site:`. (e.g., `q6=serpapi.com` to search for results only from the domain `serpapi.com`)

• rninteger

  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.

• gpcstring

  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.).

• asyncboolean

  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.

• devicestring

  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).

• outputstring

  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_cacheboolean

  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.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• qstringObligatorio

  The search query string.

• glstring

  Parameter defines the country to use for the search. It's a two-letter country code. (e.g., us for the United States, gb for United Kingdom, or fr for France). Head to the Google countries page for a full list of supported Google countries.

• hlstring

  Parameter defines the language to use for the 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.

• locationstring

  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".

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• querystringObligatorio

  Search term or phrase for the DuckDuckGo search.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• glstring

  Country code for the search results. Head to the Google countries page for a list of supported countries.

• hlstring

  Language for the search results. Head to the Google languages page for a list of supported languages.

• nkwstringObligatorio

  The search query (keywords). This is a required parameter.

• numinteger

  Number of results per page. (e.g., 10 (default) or 20).

• pageinteger

  Page number for pagination. Starts at 0.

• safestring

  Safe search option (e.g., active to filter adult content).

• devicestring

  Device type to simulate (e.g., desktop, mobile, tablet).

• locationstring

  The location for the search. Defines the location from where the search is performed.

• ebay_domainstring

  The specific eBay domain to search (e.g., ebay.com, ebay.co.uk).

• ebay_buyer_countrystring

  The country for which the results should be tailored.

• ebay_marketplace_idstring

  The eBay marketplace ID.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• querystringObligatorio

  Search query for events, specifying the topic, type, or name.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• querystringObligatorio

  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').

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• qstringObligatorio

  Parameter defines the query you want to search.

• glstring

  Parameter defines the country to use for the Google search. It's a two-letter country code.

• hlstring

  Parameter defines the language to use for the Google Jobs search. It's a two-letter language code.

• udsstring

  Parameter enables to filter search. It's a string provided by Google as a filter.

• lradinteger

  Defines search radius in kilometers. Does not strictly limit the radius.

• uulestring

  Parameter is the Google encoded location you want to use for the search. uule and location parameters can't be used together.

• chipsstring

  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.

• ltypeinteger

  Parameter will filter the results by work from home. Set to 1 for work from home jobs.

• enginestring

  Set parameter to google_jobs to use the Google Jobs API engine.

• outputstring

  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.

• locationstring

  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_cacheboolean

  Parameter will force SerpApi to fetch the Google Jobs results even if a cached version is already present.

• async_reqboolean

  Parameter defines the way you want to submit your search to SerpApi.

• zero_traceboolean

  Enterprise only. Parameter enables ZeroTrace mode. It can be set to false (default) or true.

• google_domainstring

  Parameter defines the Google domain to use. It defaults to google.com.

• next_page_tokenstring

  Parameter defines the next page token. It is used for retrieving the next page of results. Up to 10 results are returned per page.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• qstringObligatorio

  Parameter defines the query you want to search. You can use anything that you would use in a regular Google search.

• glstring

  Parameter defines the country to use for the Google search. It's a two-letter country code. Example: "us" for United States.

• hlstring

  Parameter defines the language to use for the Google search. It's a two-letter language code. Example: "en" for English.

• lrstring

  Parameter defines one or multiple languages to limit the search to. Example: "lang_fr|lang_de" for French or German.

• numinteger

  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`.

• nfprstring

  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`.

• safestring

  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`.

• uulestring

  Parameter is the Google encoded location you want to use for the search. Example: "w+CAIQICIHVG9yb250bw==" for Toronto.

• startinteger

  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.).

• devicestring

  Parameter defines the device to use to get the results. It can be set to `desktop`, `tablet`, or `mobile`. Defaults to `desktop`.

• enginestring

  Set parameter to `google_light` to use the Google Light API engine.

• filterstring

  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`.

• outputstring

  Parameter defines the final output you want. It can be set to `json` (default) or `html`.

• locationstring

  Parameter defines from where you want the search to originate. Example: "Austin, Texas, United States".

• no_cacheboolean

  Parameter will force SerpApi to fetch the Google Light results even if a cached version is already present.

• zero_traceboolean

  Enterprise only. Parameter enables ZeroTrace mode. It can be set to `true` to enable ZeroTrace or `false` to disable it. Defaults to `false`.

• async_paramboolean

  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_domainstring

  Parameter defines the Google domain to use. It defaults to `google.com`.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• qstringObligatorio

  Search query for Google Maps (e.g., 'coffee shops', 'restaurants near Central Park').

• llstring

  GPS coordinates for the search, formatted as '@latitude,longitude,zoom_level'. If unspecified, search may be less geographically specific or use a default location.

• startinteger

  Starting result index for pagination, used to get subsequent pages of results.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• qstringObligatorio

  Parameter defines the search query. You can use anything that you would use in a regular Google Hotels search.

• glstring

  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)

• hlstring

  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).

• asyncboolean

  Parameter defines the way you want to submit your search to SerpApi.

• adultsinteger

  Parameter defines the number of adults. Default to 2.

• outputstring

  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.

• ratinginteger

  Parameter is used for filtering the results to certain rating.

• sort_bystring

  Parameter is used for sorting the results. Default is sort by Relevance.

• bedroomsinteger

  Parameter defines the minimum number of bedrooms. Default to 0.

• childreninteger

  Parameter defines the number of children. Default to 0.

• currencystring

  Parameter defines the currency of the returned prices. Default to USD.

• no_cacheboolean

  Parameter will force SerpApi to fetch the Google Hotels results even if a cached version is already present.

• amenitiesstring

  Parameter defines to include only results that offer specified amenities.

• bathroomsinteger

  Parameter defines the minimum number of bathrooms. Default to 0.

• max_priceinteger

  Parameter defines the upper bound of price range.

• min_priceinteger

  Parameter defines the lower bound of price range.

• zero_traceboolean

  Enterprise only. Parameter enables ZeroTrace mode.

• check_in_datestringObligatorio

  Parameter defines the check-in date. The format is YYYY-MM-DD.

• children_agesstring

  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_certifiedboolean

  Parameter defines to show results that are eco certified.

• check_out_datestringObligatorio

  Parameter defines the check-out date. The format is YYYY-MM-DD.

• property_tokenstring

  Parameter is used to get property details which consists of name, address, phone, prices, nearby places, and etc.

• property_typesstring

  Parameter defines to include only certain type of property in the results.

• special_offersboolean

  Parameter defines to show results that have special offers.

• next_page_tokenstring

  Parameter defines the next page token. It is used for retrieving the next page results.

• vacation_rentalsboolean

  Parameter defines to search for Vacation Rentals results. Default search is for Hotels.

• free_cancellationboolean

  Parameter defines to show results that offer free cancellation.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• querystringObligatorio

  Query to find images; be specific about the topic or subject.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• qstring

  Parameter restricts your search to locations that contain the supplied string. (e.g., Austin will find 'Austin, TX', 'The University of Texas at Austin', 'Rochester, MN-Mason City, IA-Austin, MN,United States', etc.)

• limitinteger

  Parameter limits the number of locations returned. (e.g., 5 will return only 5 locations. Maximum is 10.)

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• querystringObligatorio

  Search query for finding relevant news articles.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• qstring

  Parameter defines the query you want to search in Google Play Apps Store.

• hlstring

  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).

• agestring

  Parameter defines age subcategory. age works, and should only be used with apps_category=FAMILY (Kids Apps)

• chartstring

  Parameter is used for showing top charts. It can return up to `50` results.

• storestring

  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).

• enginestring

  Set parameter to `google_play` to use the Google Play API engine.

• outputstring

  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_cacheboolean

  Parameter will force SerpApi to fetch the Google Play results even if a cached version is already present.

• async_paramboolean

  Parameter defines the way you want to submit your search to SerpApi.

• store_devicestring

  Parameter defines the device for sorting results. This parameter cannot be used with apps_category or q parameters.

• apps_categorystring

  Parameter defines the apps store category.

• see_more_tokenstring

  Parameter defines the see more token used for retrieving the pagination results from individual sections.

• next_page_tokenstring

  Parameter defines the next page token. It is used for retrieving the next page results.

• section_page_tokenstring

  Parameter defines the section page token used for retrieving the pagination results from individual sections.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• querystringObligatorio

  The search query for Google Scholar. This can be an academic topic, paper title, author name, or specific keywords.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• querystringObligatorio

  User's search query; should be a clear, concise question or keyword phrase.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• querystringObligatorio

  Product or item to search for on Google Shopping.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• querystringObligatorio

  Search query/queries for Google Trends (use comma for multiple). Format (single vs. multiple terms) is dictated by `data_type`.

• data_typestring

  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.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• qstringObligatorio

  The search query term or phrase.

• pageinteger

  Page number for pagination. Starts at 1.

• sortstring

  Sorting option for results. Available options: best_match, best_seller, price_low, price_high, rating_high, newest.

• typestring

  Defines the type of search. Can be 'search', 'deals', 'store', 'question'. Default is 'search'.

• locationstring

  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_idstring

  Store ID to filter results. Can be found using the Walmart Store Finder API.

• max_pricenumber

  Maximum price filter.

• min_pricenumber

  Minimum price filter.

• min_ratingnumber

  Minimum rating filter (1-5).

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• binteger

  Parameter defines the result offset. It skips the given number of results. It's used for pagination.

• dstring

  Parameter specifies the destination for related topics.

• pstringObligatorio

  Parameter defines the search query. You can use anything that you would use in a regular Yahoo! search.

• vcstring

  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)

• vfstring

  `all formats` or specific file format like `pdf` or `txt`.

• vlstring

  Parameter defines language to limit the search to. It uses `lang_{two-letter language code}` to specify languages.

• vmstring

  Parameter defines the level of filtering for adult content. Strict: `r`, Moderate: `i`, Off: `p`

• vsstring

  Filter results by top-level domains separated by ','. (e.g., `.com,.org`)

• fr2string

  Parameter is responsible for rendering positions and expansions for some elements.

• devicestring

  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.

• outputstring

  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_cacheboolean

  Parameter will force SerpApi to fetch the Yahoo! results even if a cached version is already present.

• yahoo_domainstring

  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_requestboolean

  Parameter defines the way you want to submit your search to SerpApi.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• numinteger

  Defines the number of results to return per page. (e.g., 10, 20, 30, 50).

• langstring

  Defines the language to use for the search. (e.g., 'ru' for Russian, 'en' for English).

• textstringObligatorio

  The search query string.

• locationstring

  Defines the location to use for the search. It can be a city name, a region, or a country. Uses Yandex's location codes if available.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• glstring

  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.

• hlstring

  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.

• spstring

  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.

• asyncboolean

  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.

• outputstring

  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_cacheboolean

  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_traceboolean

  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_querystringObligatorio

  Parameter defines the search query. You can use anything that you would use in a regular YouTube search.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not