payload.keyword | string | Yes | — | keyword required field you can specify up to 700 characters in the keyword field all %## will be decoded (plus character ’+’ will be decoded to a space character) if you need to use the ”%” character for your keyword , please specify it as “%25”; if you need to use the “+” character for your keyword , please specify it as “%2B”; if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, See the live schema for the complete constraint. |
payload.location_code | integer | No | — | search engine location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/locations example: 2840 |
payload.language_code | string | No | — | search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages example: en |
payload.depth | integer | No | — | parsing depth optional field number of results in SERP default value: 100 max value: 700 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results ; The cost can be calculated on the Pricing page. |
payload.device | string | No | — | device type optional field return results for a specific device type can take the values: desktop , mobile default value: desktop note: for mobile device, only 20 results are returned for every SERP |
payload.location_name | string | No | — | full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom |
payload.language_name | string | No | — | full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/languages example: English |
payload.os | string | No | — | device operating system optional field if you specify desktop in the device field, choose from the following values: windows , macos default value: windows if you specify mobile in the device field, choose from the following values: android , ios default value: android |
payload.tag | string | No | — | user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response |
payload.max_crawl_pages | integer | No | — | page crawl limit optional field number of search results pages to crawl max value: 100 Note: the max_crawl_pages and depth parameters complement each other; learn more at our help center |
payload.url | string | No | — | direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: https://google.com/maps/search/pizza/@37.09024,-95.712891,4z |
payload.location_coordinate | string | No | — | GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude,longitude,zoom” format if “zoom” is not specified, 17z will be applied as a default value the maximum number of decimal digits for “latitude” and “longitude” : 7 the minimum value for “zoom” : 3z the maximum value for “zoom” : 21z example: See the live schema for the complete constraint. |
payload.se_domain | string | No | — | search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: google.co.uk , google.com.au , google.de , etc. |
payload.search_this_area | boolean | No | — | show results from the displayed area optional field can take the values: true , false default value: true if set to false , the search_this_area mode will be turned off Note: if the search_this_area mode is turned off, Google Maps listings might contain results beyond the displayed area |
payload.search_places | boolean | No | — | search places mode optional field the search places mode allows to obtain Google Maps results on a certain place (e.g., Apple Store in New York) however, due to the pecularities of our data mining algorithm, this mode might interfere with some local-intent queries - and display results for a location that is different from that specified in the request; to prevent this interference and obtain correct results for keywords with local intent you may set this parameter to false ; default value: true See the live schema for the complete constraint. |