DataForSEO: Dataforseo Labs Google Serp Competitors Live

Find the domains ranking in Google for given keywords, with their rankings, estimated traffic and visibility.

Tool ID: dataforseo_dataforseo_labs_google_serp_competitors_live

Run this action

Use the TypeScript SDK for one call. Use ctx.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_dataforseo_labs_google_serp_competitors_live',
  {
    "keywords": [
      "software companies hiring engineers"
    ]
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute dataforseo_dataforseo_labs_google_serp_competitors_live --input '{
  "keywords": [
    "software companies hiring engineers"
  ]
}' --json

Example response

The SDK returns this shape at result.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": [
    {}
  ]
}

Use deepline describe dataforseo_dataforseo_labs_google_serp_competitors_live --json for the latest machine-readable contract.

Input reference

This endpoint will provide you with a list of domains ranking for the keywords you specify. You will also get SERP rankings, rating, estimated traffic volume, and visibility values the provided domains gain from the specified keywords.

Name	Type	Required	Default	Details
`payload.keywords`	`array`	Yes	—	keywords array required field the results will be based on the keywords you specify in this array UTF-8 encoding. The keywords will be converted to lowercase format. You can specify the maximum of 200 keywords learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
`payload.location_name`	`string`	No	—	full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with location_name parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom
`payload.location_code`	`integer`	No	—	unique location identifier required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: 2840
`payload.language_name`	`string`	No	—	full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English
`payload.language_code`	`string`	No	—	unique language identifier required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en
`payload.include_subdomains`	`boolean`	No	—	indicates if the subdomains will be included in the search optional field if set to false , the subdomains will be ignored default value: true
`payload.item_types`	`array`	No	—	search results type indicates type of search results included in the response optional field possible values: [“organic”, “paid”, “featured_snippet”, “local_pack”] default value: [“organic”, “paid”]
`payload.limit`	`integer`	No	—	the maximum number of returned domains optional field default value: 100 maximum value: 1000
`payload.offset`	`integer`	No	—	offset in the results array of returned domains optional field default value: 0 if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains
`payload.filters`	`array`	No	—	array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and , or between the conditions the following operators are supported: regex , not_regex , < , <= , > , >= , = , <> , in , not_in , match , not_match , ilike , not_ilike , like , not_like you can use the % operator with like and not_like , as well as ilike and not_ilike to match any string of zero or more characters example: See the live schema for the complete constraint.
`payload.order_by`	`array`	No	—	results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc - results will be sorted in the ascending order desc - results will be sorted in the descending order the comma is used as a separator example: [“avg_position,asc”] default rule: [“rating,desc”] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: See the live schema for the complete constraint.
`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

Output reference

Top-level response envelope for dataforseo_dataforseo_labs_google_serp_competitors_live.

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.02 per pricing unit.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation