Tool ID:
dataforseo_serp_google_organic_live_advancedRun this action
Use the TypeScript SDK for one call. Usectx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'dataforseo_serp_google_organic_live_advanced',
{
"keyword": "software companies hiring engineers"
},
);
console.log(result.toolResponse.raw);
CLI
deepline tools execute dataforseo_serp_google_organic_live_advanced --input '{
"keyword": "software companies hiring engineers"
}' --json
Example response
The SDK returns this shape atresult.toolResponse.raw. The example values illustrate the response.
{
"version": "example",
"status_code": 123,
"status_message": "example",
"time": "example",
"tasks_count": 123,
"tasks_error": 123,
"tasks": [
{}
]
}
deepline describe dataforseo_serp_google_organic_live_advanced --json for the latest machine-readable contract.
Input reference
Live SERP provides real-time data on top search engine results for the specified keyword, search engine, and location. This endpoint will supply a complete overview of featured snippets and other extra elements of SERPs.| Name | Type | Required | Default | Details |
|---|---|---|---|---|
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:’, ‘definition:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, 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 optional field if you 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: 10 max value: 200 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. |
payload.device | string | No | — | device type optional field return results for a specific device type can take the values: desktop , mobile default value: desktop |
payload.load_async_ai_overview | boolean | No | — | load asynchronous ai overview optional field set to true to obtain ai_overview items is SERPs even if they are loaded asynchronously. if set to false , you will only obtain ai_overview items from cache. default value: false Note: you will be charged extra $0.002 for using this parameter. if the element is absent or contains “asynchronous_ai_overview”: false , all extra charges will be returned to your account balance |
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 optional field if you 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.stop_crawl_on_match | array | No | — | 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 See the live schema for the complete constraint. |
payload.match_type | string | No | — | 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 |
payload.match_value | string | No | — | 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-*“ |
payload.max_crawl_pages | integer | No | — | page crawl limit optional field number of search results pages to crawl max value: 100 Note: you will be charged for each page crawled (10 organic results per page). learn more about pricing on our Pricing page. Note#2: the max_crawl_pages and depth parameters complement each other. learn more at our help center |
payload.search_param | string | No | — | additional parameters of the search query optional field get the list of available parameters and additional details here |
payload.remove_from_url | array | No | — | remove specific parameters from URLs optional field using this field, you can specify up to 10 parameters to remove from URLs in the result example: “remove_from_url”: [“srsltid”] Note: if the target field is specified, the specified URL parameters will be removed before the search |
payload.people_also_ask_click_depth | integer | No | — | clicks on the corresponding element optional field specify the click depth on the people_also_ask element to get additional people_also_ask_element items. Note your account will be billed $0.00015 extra for each click. if the element is absent or we perform fewer clicks than you specified, all extra charges will be returned to your account balance possible values: from 1 to 4 |
payload.group_organic_results | boolean | No | — | display related results optional field if set to true , the related_result element in the response will be provided as a snippet of its parent organic result. if set to false , the related_result element will be provided as a separate organic result. default value: true |
payload.calculate_rectangles | boolean | No | — | calcualte 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: you will be charged extra $0.002 for using this parameter |
payload.browser_screen_width | integer | No | — | browser screen width optional field you can set a custom browser screen width to calculate pixel rankings for a particular device. can be specified within the following range: 240-9999 . by default, the parameter is set to: 1920 for desktop . 360 for mobile on android . 375 for mobile on iOS . Note: to use this parameter, set calculate_rectangles to true |
payload.browser_screen_height | integer | No | — | browser screen height optional field you can set a custom browser screen height to calculate pixel rankings for a particular device. can be specified within the following range: 240-9999 . by default, the parameter is set to: 1080 for desktop . 640 for mobile on android . 812 for mobile on iOS . Note: to use this parameter, set calculate_rectangles to true |
payload.browser_screen_resolution_ratio | integer | No | — | browser screen resolution ratio optional field you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device. can be specified within the following range: 0.5-3 . by default, the parameter is set to: 1 for desktop . 3 for mobile on android . 3 for mobile on iOS . Note: to use this parameter, set calculate_rectangles to true |
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://www.google.co.uk/search?q=%20rank%20tracker%20api&hl=en&gl=GB&uule=w+CAIQIFISCXXeIa8LoNhHEZkq1d1aOpZS |
payload.location_coordinate | string | No | — | GPS coordinates of a location optional field if you 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,radius” format the maximum number of decimal digits for “latitude” and “longitude” : 7 the minimum value for “radius” : 199 (mm) the maximum value for “radius” : 199999 (mm) example: 53.476225,-2.243572,200 |
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.target | string | No | — | target domain, subdomain, or webpage to get results for optional field a domain or a subdomain should be specified without https:// and www. note that the results of target -specific tasks will only include SERP elements that contain a url string. You can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results. examples: example.com - returns results for the website’s home page with URLs, such as https://example.com , or https://www.example.com/ , or See the live schema for the complete constraint. |
payload.target_search_mode | string | No | — | target matching mode optional field to enable this parameter, stop_crawl_on_match must also be enabled defines how the crawl should stop when multiple targets are specified in stop_crawl_on_match possible values: all , any all – the crawl stops only when all specified targets are found any – the crawl stops when any single target is found default value: any learn more about this parameter on our Help Center |
payload.find_targets_in | array | No | — | SERP element types to check for targets optional field to enable this parameter, stop_crawl_on_match must also be enabled specifies which SERP element types should be checked for target matches if not specified, all first-level elements with url and domain fields are checked for targets possible values: organic , paid , local_pack , featured_snippet , events , google_flights , images , jobs , knowledge_graph , local_service , map , scholarly_articles , third_party_reviews , twitter Note: cannot See the live schema for the complete constraint. |
payload.ignore_targets_in | array | No | — | SERP element types to exclude from target search optional field to enable this parameter, stop_crawl_on_match must also be enabled specifies which SERP element types should be excluded when searching for target matches possible values: organic , paid , local_pack , featured_snippet , events , google_flights , images , jobs , knowledge_graph , local_service , map , scholarly_articles , third_party_reviews , twitter Note: cannot contain the same element types as find_targets_in example: See the live schema for the complete constraint. |
This input schema is too large for an inline display. Read the complete live contract with
deepline describe dataforseo_serp_google_organic_live_advanced --json.Output reference
Top-level response envelope for dataforseo_serp_google_organic_live_advanced.| Name | Type | Required | Default | Details |
|---|---|---|---|---|
result.version | string | Yes | — | the current version of the API |
result.status_code | integer | Yes | — | general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions |
result.status_message | string | Yes | — | general informational message you can find the full list of general informational messages here |
result.time | string | Yes | — | execution time, seconds |
result.tasks_count | integer | Yes | — | the number of tasks in the tasks array |
result.tasks_error | integer | Yes | — | the number of tasks in the tasks array returned with an error |
result.tasks | array | Yes | — | array of tasks |
Deepline cost
- Pricing model:
provider_usage(provider usage). - Estimated Deepline credits:
0.03per pricing unit.