Serp
Google Local Finder SERP API provides top search engine results specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
post/v3/serp/google/local_finder/task_post
Request
- Base URL: https://api.dataforseo.com
- URL: https://api.dataforseo.com/v3/serp/google/local_finder/task_post
- Auth: HTTP basic
Request body
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><br><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/{{low_se_name}}/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/{{low_se_name}}/languages</code><p>example:<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>10</code><p>max value: <code>350</code><br><strong>your account will be billed per each SERP containing up to 10 results;</strong><br>setting depth above 10 may result in additional charges if the search engine returns more than 10 results respectively;<br><p>If the specified depth is higher than the number of results in the response, the difference will be refunded to your account balance automatically<br>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-local-finder-serp-api" target="_blank" rel="noopener noreferrer">Pricing</a> page.
priorityinteger nullable
<p><em>task priority</em><p>optional field<p>can take the following values:<p>1 – normal execution priority (set by default)<p>2 – high execution priority</p><br>You will be additionally charged for the tasks with high execution priority.<p>The cost can be calculated on the <a title="Pricing" href="https://dataforseo.com/pricing/serp/google-local-finder-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>
pingback_urlstring nullable
<p><em>notification URL of a completed task</em><p>optional field<p>when a task is completed we will notify you by GET request sent to the URL you have specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/pingscript?id=$id</code><p><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>
postback_urlstring nullable
<p><em>URL for sending task results</em><p>optional field<p>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<p>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<p>example:<p><code>http://your-server.com/postbackscript?id=$id</code><p><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><p><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded;<p>i.a., the <code>#</code> character will be encoded into <code>%23</code></p><br><p>learn more on our <a href="https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api" target="_blank" rel="noopener noreferrer">Help Center</a></p>
postback_datastring
<p><em>postback_url datatype</em><p><strong>required field if you specify <code>postback_url</code></strong><p>corresponds to the function you used for setting a task<p>possible values:<p><code>advanced</code>, <code>html</code></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/{{low_se_name}}/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/{{low_se_name}}/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>
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>9z</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>: 4z<p>the maximum value for <em>"zoom"</em>: 18z<p>example:<p><code class="long-string">52.6178549,-155.352142,18z</code></p>
Example request
[
{
"language_code": "en",
"location_code": 2840,
"keyword": "local nail services"
}
]Response
Successful operation
versionstring nullable
the current version of the API
status_codeinteger nullable
general status code you can find the full list of the response codes here
status_messagestring nullable
general informational message you can find the full list of general informational messages here
timestring nullable
total execution time, seconds
costnumber double nullable
total tasks cost, USD
tasks_countinteger nullable
the number of tasks in the tasks array
tasks_errorinteger nullable
the number of tasks in the tasks array returned with an error
Changes
- warning
removed the request property
///// - warning
removed the request property
/////
- warning
- breaking
the
////////////response's property type changed fromstringtoobjectfor status
- breaking