keyword | string | 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” learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article |
location_name | string | full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code 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/seznam/locations example:
London,England,United Kingdom |
location_code | integer | search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name 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/seznam/locations example:
2840 |
language_name | string | 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/seznam/languages example:
Czech |
language_code | string | 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/seznam/languages example:
csn |
url | string | 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. |
priority | integer | task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page. |
depth | integer | parsing depth optional field number of results in SERP default value: 10; maximum value: 500; Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page. |
max_crawl_pages | integer | page crawl limit optional field number of search results pages to crawl default value: 1 max value: 10 Note: the max_crawl_pages and depth parameters complement each other; learn more at our help center |
device | string | device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop |
os | string | 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 |
se_domain | string | search engine domain optional field we choose the relevant search engine domain automatically however, you can set a custom search engine domain in this field example:
search.seznam.cz |
search_param | string | additional parameters of the search query optional field |
calculate_rectangles | boolean | calculate pixel rankings for SERP elements in advanced results optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; Visit Help Center to learn more>> by default, the parameter is set to false Note: if set to true, the charge per task will be multiplied by 2 |
stop_crawl_on_match | array | array of targets to stop crawling optional field specified as an array of target objects each target object consists of one match_type field and one match_value field you can specify up to 10 target objects in this array if specified, the response will contain SERP results up to and including the specified match_value; example:
"stop_crawl_on_match":[{"match_value":"dataforseo.com","match_type":"with_subdomains"}] learn more about this parameter on our Help Center Your account will be billed for every SERP crawled until the conditions you specified in this array are met |
match_value | string | target domain, subdomain, or wildcard value required field if stop_crawl_on_match is specified specify a target domain, subdomain, or wildcard value; Note: domain or subdomain must be specified without a request protocol; example: "match_value": "dataforseo.com",
"match_value": "/blog/post-*" |
match_type | string | target match type required field if stop_crawl_on_match is specified type of match for the match_value possible values:
domain – specific domain or subdomain
with_subdomains – main domain and subdomains
wildcard – wildcard pattern |
tag | string | 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 |
postback_url | string | URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example:
http://your-server.com/postbackscript?id=$id
http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center |
postback_data | string | postback_url datatype required field if you specify postback_url corresponds to the function you used for setting a task possible values:
regular, advanced, html |
pingback_url | string | notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example:
http://your-server.com/pingscript?id=$id
http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center |