keywordstring
<p><em>keyword</em><p><strong>required field</strong><p>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> field<p>all %## will be decoded (plus character '+' will be decoded to a space character)<p>if you need to use the "%" character for your <code>keyword</code>, please specify it as "%25";<p>if you need to use the “+” character for your <code>keyword</code>, please specify it as “%2B”;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href="https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis" rel="noopener noreferrer" target="_blank">Help Center article</a></p>
location_codeinteger
<p><em>search engine location code</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engines with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">2840</code></p>
language_codestring
<p><em>search engine language code</em><p><strong>required field if you don't specify</strong> <code>language_name</code><p><strong>if you use this field, you don't need to specify <code>language_name</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><em><p></em>example:<em><p></em><code class="long-string">en</code></p>
depthinteger nullable
<p><em>parsing depth</em><p>optional field<p>number of results in SERP<p>default value: <code>100</code><p>max value: <code>700</code></p><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong><p>Setting depth above 100 may result in additional charges <a href="https://dataforseo.com/help-center/how-many-results-scraped" rel="noopener noreferrer" target="_blank">if the search engine returns more than 100 results</a>;<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-maps-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
devicestring nullable
<p><em>device type</em><p>optional field<p>return results for a specific device type<p>can take the values:<code>desktop</code>, <code>mobile</code><p>default value: <code>desktop</code><p><strong>note:</strong> for <code>mobile</code> device, only 20 results are returned for every SERP</p>
location_namestring
<p><em>full name of search engine location</em><p><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><p><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><p>you can receive the list of available locations of the search engine with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/locations</code><p>example:<p><code class="long-string">London,England,United Kingdom</code></p>
language_namestring
<p><em>full name of search engine language</em><p><strong>required field if you don't specify</strong> <code>language_code</code><p><strong>if you use this field, you don't need to specify <code>language_code</code></strong><p>you can receive the list of available languages of the search engine with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/serp/google/languages</code><p>example:<p><code class="long-string">English</code></p>
osstring nullable
<p><em>device operating system</em><p>optional field<p>if you specify <code>desktop</code> in the <code>device</code> field, choose from the following values: <code>windows</code>, <code>macos</code><p>default value: <code>windows</code><p>if you specify <code>mobile</code> in the <code>device</code> field, choose from the following values: <code>android</code>, <code>ios</code><p>default value: <code>android</code></p>
tagstring nullable
<p><em>user-defined task identifier</em><p>optional field<p><em>the character limit is 255</em><p>you can use this parameter to identify the task and match it with the result<p>you will find the specified <code>tag</code> value in the <code>data</code> object of the response</p>
max_crawl_pagesinteger nullable
<p><em>page crawl limit</em><p>optional field<p>number of search results pages to crawl<p>max value: <code>100</code><p><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<p>learn more at <a href="https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work" rel="noopener noreferrer" target="_blank">our help center</a></p>
urlstring nullable
<p><em>direct URL of the search query</em><p>optional field<p>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.<p>example:<p><code class="long-string">https://google.com/maps/search/pizza/@37.09024,-95.712891,4z</code></p><br><strong>Note:</strong> the following search engine parameters are not supported and will be automatically unset if specified in the URL: <code>allinanchor:</code>, <code>allintext:</code>, <code>allintitle:</code>, <code>allinurl:</code>, <code>cache:</code>, <code>define:</code>, <code>definition:</code>, <code>filetype:</code>, <code>id:</code>, <code>inanchor:</code>, <code>info:</code>, <code>intext:</code>, <code>intitle:</code>, <code>inurl:</code>, <code>link:</code>, <code>site:</code>.
location_coordinatestring
<p><em>GPS coordinates of a location</em><p><strong>required field if you don't specify</strong> <code>location_name</code> or <code>location_code</code><p><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><p><code>location_coordinate</code> parameter should be specified in the <em>"latitude,longitude,zoom"</em> format<p>if <em>"zoom"</em> is not specified, <em>17z</em> will be applied as a default value<p>the maximum number of decimal digits for <em>"latitude"</em> and <em>"longitude"</em>: 7<p>the minimum value for <em>"zoom"</em>: 3z<p>the maximum value for <em>"zoom"</em>: 21z<p>example:<p><code class="long-string">52.6178549,-155.352142,20z</code></p>
se_domainstring nullable
<p><em>search engine domain</em><p>optional field<p>we choose the relevant search engine domain automatically according to the location and language you specify<p>however, you can set a custom search engine domain in this field<p>example:<p><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.</p>
search_this_areaboolean nullable
<p><em>show results from the displayed area</em><p>optional field<p>can take the values:<code>true</code>, <code>false</code><p>default value: <code>true</code></p><br><p>if set to <code>false</code>, the <code>search_this_area</code> mode will be turned off</p><br><p><strong>Note:</strong> if the <code>search_this_area</code> mode is turned off, Google Maps listings might contain results beyond the displayed area</p>
search_placesboolean nullable
<p><em>search places mode</em><p>optional field<p>the search places mode allows to obtain Google Maps results on a certain place (e.g., Apple Store in New York)<p>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;<p>to prevent this interference and obtain correct results for keywords with local intent you may set this parameter to <code>false</code>;</p><br><p>default value: <code>true</code><p><strong>Note:</strong> if the <code>search_places</code> mode is turned off and no results were found in the search area, the <code>results</code> array will be empty</p>