search

get

https://app.scrapein.app/api/v1/google/

Allows your to scrape the results from Google Search via our ScrapeIN service.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Endpoint: The /google/ API endpoint allows you to GET the results of your Google Search query.
Authentication: API-KEY. Use your API-KEY for authentication.
Output format: html, json, csv

Results: Click "200" at the bottom of the page in the Responses block to see the JSON structure of a successful response. See more about the results here.

Support

If you have any questions about authentication or API usage, please contact our support team at [email protected].

Query Params

string

required

Defaults to iphone

Used to define the search query you want to perform. You can use any keyword or phrase that you would use in a regular Google search. For example, you can use the inurl: parameter to search for pages with a specific URL in them, the site: parameter to search within a particular website, or the intitle: parameter to search for pages with a specific title.

location

string

The location parameter specifies the geographic location where the search query is performed. You can input any location as free-text, but if you select one of ScrapeIN's predefined locations, the google_domain, gl and and hl parameters will be automatically adjusted to match the country, language, and domain of the selected location. Please note that this automatic behavior can be turned off using the location_auto parameter.

output

string

enum

Defaults to json

The output parameter helps you get the data you want in an organized way, which is easy to work with. By default, you get the data in a structured JSON format. You can also get the actual content of the webpage in an organized HTML format by using html. Or you can choose to get the data in a CSV format by setting the parameter to csv.

Allowed:

raw

string

This parameter allows you to specify whether you want to receive only raw data from the Google SERP API. When set to true, the request will be processed exclusively for raw data through the raw data balance when the balance is positive. If these conditions are not met, the request will not be processed for raw data.

num

string

enum

Defaults to 10

Determines the number of results to show per page, used in combination with the page parameter for pagination. Maximum number of search results per request is 100.

Allowed:

device

string

enum

Defaults to desktop

Specifies the device to emulate when making the request to get search results. The device parameter can be set to desktop (default) to emulate a regular desktop web browser, tablet to emulate a tablet browser (and the tablet_type parameter can be used to choose the type of tablet device), or mobile to emulate a mobile browser (and the mobile_type parameter can be used to choose the type of mobile device).

Allowed:

mobile_type

string

enum

This parameter is applicable when device=mobile and specifies the type of mobile device to use for getting results. It can be set to iphone for an iPhone mobile device or android for an Android mobile device.

Allowed:

tablet_type

string

enum

This parameter is applicable when device=tablet and determines the type of tablet device used to retrieve the results. It can be set to ipad for an iPad device, or android for an Android tablet device.

Allowed:

location_auto

boolean

The location_auto parameter is used to control whether the google_domain, gl and hl parameters are automatically updated when using a predefined location from the Location API. The default value is true, which enables this behavior, while false disables it.

uule

string

The uule parameter is a customizable parameter that can be passed through to Google. When using the location parameter, ScrapeIN generates the uule parameter automatically. However, you can directly specify a uule to overwrite the automatically generated one.

google_domain

string

enum

Defaults to google.com

Specifies the domain of Google to execute the search query on. A complete list of supported values for the google_domain parameter can be viewed here. The default value is google.com.

string

enum

The gl parameter is used to specify the Google country to be used in the search query. Check out the list of supported values for gl here. The default value for gl is set to us.

string

enum

Defaults to en

The hl parameter is responsible for determining the Google user interface language for the returned results. Check out the list of supported values for hl here. The default value for hl is set to en.

string

enum

The lr parameter is used to limit the search results to websites that contain a specific language. You can find the full list of supported lr values here.

string

enum

The cr parameter tells Google to restrict the results to websites in the specified country. Check out the list of supported cr values here.

time_period

string

enum

The parameter time_period is used to determine the time period for the results displayed. It can be set to predefined values such as last_hour, last_day (for the last 24 hours), last_week (for the last 7 days), last_month, last_year, or custom. When using custom, the parameters time_period_min and/or time_period_max must also be specified to define the custom time period.

Allowed:

time_period_min

date

The time_period_min parameter determines the minimum (i.e., 'from') time to use when time_period is set to custom. It should be in the format of MM/DD/YYYY, for example, for December 31, 2022, time_period_min=12/31/2022.

time_period_max

date

The time_period_max parameter determines the maximum (i.e., 'to') time to use when time_period is set to custom. It should also be in the format of MM/DD/YYYY, for example, for December 31, 2022, time_period_max=12/31/2022.

nfpr

string

enum

Determines whether to exclude auto-corrected results (set to 1) or include them (set to 0, default).

Allowed:

safe

string

enum

Determines if "Safe Search" is enabled (set to active) or disabled (set to off, default).

Allowed:

filter

string

enum

Determines if the filters for "Similar Results" and "Omitted Results" are enabled (set to 1, default) or disabled (set to 0).

Allowed:

sort_by

string

enum

Determines how results are sorted, valid values are relevance or date. When sort_by is set to date, the show_duplicates parameter can be used.

Allowed:

show_duplicates

boolean

Determines whether duplicates are shown in the search results. Must be used with the sort_by parameter when set to date. Valid values are true or false, default is false.

exclude_if_modified

boolean

Determines whether Search Results are excluded when Google modifies the original query. Set to true to exclude or false (default) to include Search Results when Google modifies the original query.

page

int32

Determines the page of results to return (default is 1), used with the num parameter for pagination.

max_page

int32

Used to get multiple pages of results in one request, the API will paginate through pages automatically and concatenate the results into one response. See the Pagination for more information.

include_fields

string

Allows you to specify the JSON field names you want to include in the response JSON object as a comma-separated list. You can use dot notation to specify the field names - for instance, setting include_fields=pagination will only include the pagination property in the JSON response. The include_fields parameter is useful when you only want certain fields to be included in the JSON response returned by the API.

exclude_fields

string

Used to exclude certain fields from the JSON object returned by the API. You can specify the names of the fields to be excluded in dot notation as a comma-separated list. For example, exclude_fields=pagination would remove the pagination property from the response JSON. If there are particular fields you don't want to be included in the API's JSON response, use exclude_fields.

include_html

boolean

Specifies if the response should include raw HTML, which may increase its size. The option to include HTML can be true or false (the default), with the latter being the default.

include_answer_box

boolean

This parameter determines whether to include the answer box (sometimes called the "featured snippet") in the organic_results array and treat it as the first result.

include_advertiser_info

boolean

Retrieve the "advertiser info" for ads by setting include_advertiser_info=true. This will give you the company name of the company running the ad. Note that requesting advertiser info consumes 2 credits (instead of the normal 1 credit) as additional internal requests are required.

flatten_results

boolean

This parameter can be set to either true or false. When set to true, ScrapeIN flattens the inline videos, inline images, inline tweets, top stories, and local results, and displays them inline with the organic results. This is useful if you want a simplified list of all the results shown for an organic web search, irrespective of the type of result. When flatten_results is set to true, a new property type is added to each item in the organic_results array indicating the type of result (e.g. ad, inline_tweets).

skip_on_incident

string

enum

This parameter allows you to control the API's behavior when it encounters a parsing incident. You can choose to have the API skip serving the request entirely when a degraded or major parsing incident is detected (value: all), or only skip the request when a "major" parsing incident is detected (value: major_only). If your system is making unsupervised requests to the API, using skip_on_incident can be a useful way to handle incidents gracefully.

Allowed:

hide_base64_images

boolean

This parameter instructs the API to exclude Base64 images from the response. When SERP pages contain Base64-encoded images, including them in the response can significantly increase its size. Therefore, excluding these images can be beneficial in reducing the response size.

string

This parameter allows you to send a custom cookie string with your request. The cookie string should be URL-encoded and will be sent in the cookie HTTP header made by the platform.

tbs

string

Sets a specific string to be added to the Google tbs parameter in the underlying query. Normally generated automatically by the API, but can be set explicitly as well.

knowledge_graph_id

string

The knowledge_graph_id request parameter sets the kgmid Google parameter. You can use this to prompt a specific knowledge graph to show in the results. For example, knowledge_graph_id=/m/04zpv.

url

string

Specifies the URL to be scraped instead of using the q parameter to perform a search query. The url parameter must be URL-encoded.

Responses

Support

200200

400400