AI agents: this page is for people. Read https://agentmarket.fluxapay.xyz/marketplace/apis/dataforseo/skills.md for every endpoint, its price, and how to call it with a FluxA API key (no account with DataForSEO needed).

DataForSEOVerified
DataForSEO SEO and marketing data: live Google, Bing, Yahoo, Baidu, Naver and YouTube SERPs, Google…
DataForSEO SEO and marketing data: live Google, Bing, Yahoo, Baidu, Naver and YouTube SERPs, Google Maps, News, Jobs and Shopping, keyword volumes and ideas, Google Trends, backlinks, domain and competitor analytics, on-page audits, app store data, business reviews (Google, Tripadvisor, Trustpilot), Amazon and Google Shopping products, and AI search (ChatGPT, Claude, Gemini, Perplexity) mentions. POST bodies are a JSON array with one task. Results are capped per call.
Ask your agent, for example
Copy one and give it to Claude Code, Codex or any agent:
Your agent will ask for your FluxA API key.
Endpoints 235All 235 healthy
https://router.fluxapay.xyz/api/dataforseoCopy base URLThis endpoint provides search volume data for your target keywords, reflecting their estimated usage in AI tools. Body: a JSON array with exactly one task object, e.g. [{"language_name": "English", "location_code": 2840, "keywords": ["iphone", "seo"]}]. $0.04 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | keywords required field UTF-8 encoding The maximum number of keywords you can specify: 1000; The maximum number of characters in a single keyword: 250; The keywords will be converted to lowercase format; learn more… e.g. ["iphone", "seo"] |
location_name | string | Optional | 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 their <cod |
location_code | integer | Optional | 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 <co e.g. 2840 |
language_name | string | Optional | full name of the 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 with their language_name</cod e.g. "English" |
language_code | string | Optional | 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 with their language_code by making |
tag | string | Optional | 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 |
Live ChatGPT LLM Responses endpoint allows you to retrieve structured responses from a specific ChatGPT AI model, based on the input parameters. Body: a JSON array with exactly one task object, e.g. [{"system_message": "communicate as if we are in a business meeting", "message_chain": [{"role": "user", "message": "Hello, what\u2019s up?"}, {"role": "ai", "m. $0.09 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
user_prompt | string | Optional | prompt for the AI model required field the question or task you want to send to the AI model; you can specify up to 500 characters in the user_prompt field e.g. "provide information on how relevant the amusement park busi |
model_name | string | Optional | name of the AI model required field model_name consists of the actual model name and version name; if the basic model name is specified, its latest version will be set by default; for example, if gpt-4.1 is specified,… e.g. "gpt-4.1-mini" |
max_output_tokens | integer | Optional | maximum number of tokens in the AI response optional field minimum value for reasoning models (e.g., reasoning is true in the Models endpoint ): 1024 ; minimum valu e.g. 200 |
temperature | number | Optional | randomness of the AI response optional field higher values make output more diverse; lower values make output more focused; minimum value: 0 maximum value: 2 default value: 0.94 Note: not supported in reasoning mo e.g. 0.3 |
top_p | number | Optional | diversity of the AI response optional field controls diversity of the response by limiting token selection; minimum value: 0 maximum value: 1 default value: 0.92 Note: top_p cannot be used together with e.g. 0.5 |
web_search | boolean | Optional | enable web search optional field when enabled, the AI model can access and cite current web information; default value: false ; Note: refer to the Models endpoint e.g. true |
force_web_search | boolean | Optional | force AI agent to use web search optional field to enable this parameter, web_search must also be enabled; when enabled, the AI model is forced to access and cite current web information; default value: false ; Note:… |
web_search_country_iso_code | string | Optional | ISO country code of the location optional field to enable this parameter, web_search must also be enabled; when enabled, the AI model will search the web from the country you specify; Note: not supported in o3-mini ,… e.g. "FR" |
web_search_city | string | Optional | city name of the location optional field Note: not supported in o3-mini , o1-pro , o1 models e.g. "Paris" |
system_message | string | Optional | instructions for the AI behaviour optional field defines the AI's role, tone, or specific behavior you can specify up to 500 characters in the system_message field e.g. "communicate as if we are in a business meeting" |
message_chain | array | Optional | conversation history optional field array of message objects representing previous conversation turns; each object must contain: role string with either user or ai role; message string with message content (max 500… e.g. [{"role": "user", "message": "Hello, what\u2019s up?"}, {"ro |
tag | string | Optional | 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 |
Live ChatGPT LLM Scraper endpoint provides results from ChatGPT searches. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "keyword": "albert einstein"}]. $0.02 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | keyword required field you can specify up to 2000 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 , e.g. "albert einstein" |
location_name | string | Optional | 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… |
location_code | integer | Optional | 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… e.g. 2840 |
language_name | string | Optional | 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… |
language_code | string | Optional | 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… e.g. "en" |
force_web_search | boolean | Optional | force AI agent to use web search optional field when enabled, the AI model is forced to access and cite current web information; default value: false ; Note: even if the parameter is set to true , there is no guarantee… |
tag | string | Optional | 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 |
You will receive the list of locations by this API call. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Required | country |
Live Claude LLM Responses endpoint allows you to retrieve structured responses from a specific Claude model, based on the input parameters. Body: a JSON array with exactly one task object, e.g. [{"system_message": "communicate as if we are in a business meeting", "message_chain": [{"role": "user", "message": "Hello, what\u2019s up?"}, {"role": "ai", "m. $0.08 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
user_prompt | string | Optional | prompt for the AI model required field the question or task you want to send to the AI model; you can specify up to 500 characters in the user_prompt field e.g. "provide information on how relevant the amusement park busi |
model_name | string | Optional | name of the AI model required field allowed names change over time — prefer a currently accepted name such as claude-sonnet-4-5 ; bare aliases ( claude , claude-sonnet , claude-opus ) and some older aliases (including… e.g. "claude-sonnet-4-5" |
max_output_tokens | integer | Optional | maximum number of tokens in the AI response optional field minimum value: 1 ; maximum value: 4096 ; default value: 2048 ; Note: if web_search is set to true or the reasoning model is specified in t e.g. 200 |
temperature | number | Optional | randomness of the AI response optional field higher values make output more diverse; lower values make output more focused; minimum value: 0 maximum value: 1 default value: 0.7 Note: temperature cannot e.g. 0.3 |
top_p | number | Optional | diversity of the AI response optional field controls diversity of the response by limiting token selection; minimum value: 0 maximum value: 1 default value: null Note: top_p cannot be used together with |
web_search | boolean | Optional | enable web search for current information optional field when enabled, the AI model can access and cite current web information; Note: refer to the Models endpoint for a list e.g. true |
force_web_search | boolean | Optional | force AI agent to use web search optional field to enable this parameter, web_search must also be enabled; when enabled, the AI model is forced to access and cite current web information; default value: false ; Note:… |
web_search_country_iso_code | string | Optional | ISO country code of the location used for searching the web optional field possible values:… e.g. "FR" |
web_search_city | string | Optional | city name of the location used for searching the web optional field |
system_message | string | Optional | instructions for the AI behaviour optional field defines the AI's role, tone, or specific behavior; you can specify up to 500 characters in the system_message field e.g. "communicate as if we are in a business meeting" |
message_chain | array | Optional | conversation history optional field array of message objects representing previous conversation turns; each object must contain: role string with either user or ai role; message string with message content (max 500… e.g. [{"role": "user", "message": "Hello, what\u2019s up?"}, {"ro |
use_reasoning | boolean | Optional | enable reasoning for the AI model optional field when enabled, the model will perform reasoning before generating a response refer to the Models endpoint for a list of models t |
tag | string | Optional | 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 |
Live Gemini LLM Responses endpoint allows you to retrieve structured responses from a specific Gemini AI model, based on the input parameters. Body: a JSON array with exactly one task object, e.g. [{"system_message": "communicate as if we are in a business meeting", "message_chain": [{"role": "user", "message": "Hello, what\u2019s up?"}, {"role": "ai", "m. $0.11 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
user_prompt | string | Optional | prompt for the AI model required field the question or task you want to send to the AI model; you can specify up to 500 characters in the user_prompt field e.g. "provide information on how relevant the amusement park busi |
model_name | string | Optional | name of the AI model required field model_name consists of the actual model name and version name; if the basic model name is specified, its latest version will be set by default; for example, if gemini-1.5-pro is… e.g. "gemini-2.5-flash" |
max_output_tokens | integer | Optional | maximum number of tokens in the AI response optional field minimum value: 1 maximum value: 4096 ; default value: 2048 ; Note: if web_search is set to true or the reasoning model is specified in th e.g. 200 |
temperature | number | Optional | randomness of the AI response optional field higher values make output more diverse lower values make output more focused minimum value: 0 maximum value: 2 default value: 1.3 e.g. 0.3 |
top_p | number | Optional | diversity of the AI response optional field controls diversity of the response by limiting token selection minimum value: 0 maximum value: 1 default value: 0.9 e.g. 0.5 |
web_search | boolean | Optional | enable web search for current information optional field when enabled, the AI model can access and cite current web information; Note: refer to the Models endpoint for a list e.g. true |
system_message | string | Optional | instructions for the AI behavior optional field defines the AI's role, tone, or specific behavior you can specify up to 500 characters in the system_message field e.g. "communicate as if we are in a business meeting" |
message_chain | array | Optional | conversation history optional field array of message objects representing previous conversation turns; each object must contain: role string with either user or ai role; message string with message content (max 500… e.g. [{"role": "user", "message": "Hello, what\u2019s up?"}, {"ro |
use_reasoning | boolean | Optional | enable reasoning for the AI model optional field when enabled, the model will perform reasoning before generating a response refer to the Models endpoint for a list of models t |
tag | string | Optional | 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 |
Live Gemini LLM Scraper endpoint provides structured results from Gemini. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "keyword": "albert einstein"}]. $0.02 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | keyword required field you can specify up to 2000 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 , e.g. "albert einstein" |
location_name | string | Optional | 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 y |
location_code | integer | Optional | 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 r e.g. 2840 |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location |
language_name | string | Optional | 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… |
language_code | string | Optional | 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… e.g. "en" |
tag | string | Optional | 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 |
Live LLM Mentions Historical endpoint provides month-by-month historical metrics for mentions matching the AND-combined target filter (one series, not one per brand). Body: a JSON array with exactly one task object, e.g. [{"language_code": "es", "location_code": 2840, "platform": "google", "target": [{"domain": "en.wikipedia.org", "search_filter": "exclude"}, {"keyword": "bmw", . $0.31 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | array | Optional | array of objects containing target entities. Required field. You can specify up to 10 entities (objects) in the target field. One target entity can contain either one domain or one keyword and related parameters. All… e.g. [{"domain": "en.wikipedia.org", "search_filter": "exclude"}, |
date_from | string | Optional | start date of the time range optional field minimal value 2025-08-01 date format "yyyy-mm-dd" |
date_to | string | Optional | end date of the time range optional field Note value specified in date_from cannot exceed the value in date_to date format "yyyy-mm-dd" |
location_name | string | Optional | full name of search location. Optional field. If you use this field, you don't need to specify location_code. Default is United States (location_code 2840). With platform=chat_gpt, only United States is valid; other… |
location_code | integer | Optional | search location code. Optional field. If you use this field, you don't need to specify location_name. Default is 2840 (United States). With platform=chat_gpt, only 2840 is valid; any other code (e.g. 2036) returns task… e.g. 2840 |
language_name | string | Optional | full name of search language optional field if you use this field, you don't need to specify language_code ; if you don't specify this field, the language_code with en value will be used by default; you can receive the… |
language_code | string | Optional | search language code optional field 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… e.g. "es" |
platform | string | Optional | target platform. Optional field. Possible values: chat_gpt, google. When omitted, DataForSEO defaults to google only (not both platforms). chat_gpt data is available for the United States and English only (location… e.g. "google" |
tag | string | Optional | 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 |
Live LLM Mentions Multi-Target Metrics endpoint provides aggregated metrics grouped by targets[].key for 2-10 comparison keys. This is a live rolling window (not monthly history); identical calls can vary. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "platform": "google", "targets": [{"key": "chat_gpt", "target": [{"keyword": "chat gpt"}]}, {"key": "claude", "t. Capped at limit 50. $0.33 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
targets | array | Optional | array of objects containing target entities with aggregation keys. Required field. Between 2 and 10 keyed target sets (else upstream 40501: "The number of 'targets' items must be between 2 and 10."). Each nested target… e.g. [{"key": "chat_gpt", "target": [{"keyword": "chat gpt"}]}, { |
location_name | string | Optional | full name of search location. Optional field. If you use this field, you don't need to specify location_code. Default is United States (location_code 2840). With platform=chat_gpt, only United States is valid; other… |
location_code | integer | Optional | search location code. Optional field. If you use this field, you don't need to specify location_name. Default is 2840 (United States). With platform=chat_gpt, only 2840 is valid; any other code (e.g. 2036) returns task… e.g. 2840 |
language_name | string | Optional | full name of search language optional field if you use this field, you don't need to specify language_code ; if you don't specify this field, the language_code with en value will be used by default; you can receive the… |
language_code | string | Optional | search language code optional field 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… e.g. "en" |
platform | string | Optional | target platform. Optional field. Possible values: chat_gpt, google. When omitted, DataForSEO defaults to google only (not both platforms). chat_gpt data is available for the United States and English only (location… e.g. "google" |
filters | array | Optional | 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: = ,… |
initial_dataset_filters | array | Optional | array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;… e.g. [["ai_search_volume", ">", 10]] |
order_by | array | Optional | 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… |
offset | integer | Optional | offset in the results array of the returned mentions data optional field default value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be… |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: sources_domain search_results_domain minimum value: 1 maximum value:… e.g. 5 |
tag | string | Optional | 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 |
Live LLM Mentions Search endpoint provides mention data and related metrics from AI searches. Body: a JSON array with exactly one task object, e.g. [{"language_name": "English", "location_code": 2840, "target": [{"domain": "dataforseo.com", "search_filter": "exclude"}, {"keyword": "bmw", "search_scope": ["a. Capped at limit 50. $0.33 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | array | Optional | array of objects containing target entities. Required field. You can specify up to 10 entities (objects) in the target field. One target entity can contain either one domain or one keyword and related parameters. All… e.g. [{"domain": "dataforseo.com", "search_filter": "exclude"}, { |
location_name | string | Optional | full name of search location. Optional field. If you use this field, you don't need to specify location_code. Default is United States (location_code 2840). With platform=chat_gpt, only United States is valid; other… |
location_code | integer | Optional | search location code. Optional field. If you use this field, you don't need to specify location_name. Default is 2840 (United States). With platform=chat_gpt, only 2840 is valid; any other code (e.g. 2036) returns task… e.g. 2840 |
language_name | string | Optional | full name of search language optional field if you use this field, you don't need to specify language_code ; if you don't specify this field, the language_code with en value will be used by default; you can receive the… e.g. "English" |
language_code | string | Optional | search language code optional field 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… |
platform | string | Optional | target platform. Optional field. Possible values: chat_gpt, google. When omitted, DataForSEO defaults to google only (not both platforms). chat_gpt data is available for the United States and English only (location… e.g. "google" |
filters | array | Optional | 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: = ,… e.g. [["ai_search_volume", ">", 1000]] |
order_by | array | Optional | 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… e.g. ["ai_search_volume,desc"] |
offset | integer | Optional | offset in the results array of the returned mentions data optional field default value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be… e.g. 0 |
search_after_token | string | Optional | token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 1000 results in a single request; by… |
tag | string | Optional | 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 |
Live LLM Mentions Target Metrics Lite endpoint is the simplified version of the Target Metrics endpoint and provides a simplified view of aggregated LLM mentions for keywords and domains specified in the target array of the request. Body: a JSON array with exactly one task object, e.g. [{"language_code": "es", "location_code": 2840, "platform": "google", "target": [{"domain": "en.wikipedia.org", "search_filter": "exclude"}, {"keyword": "bmw", . Capped at limit 50. $0.32 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | array | Optional | array of objects containing target entities. Required field. You can specify up to 10 entities (objects) in the target field. One target entity can contain either one domain or one keyword and related parameters. All… e.g. [{"domain": "en.wikipedia.org", "search_filter": "exclude"}, |
location_name | string | Optional | full name of search location. Optional field. If you use this field, you don't need to specify location_code. Default is United States (location_code 2840). With platform=chat_gpt, only United States is valid; other… |
location_code | integer | Optional | search location code. Optional field. If you use this field, you don't need to specify location_name. Default is 2840 (United States). With platform=chat_gpt, only 2840 is valid; any other code (e.g. 2036) returns task… e.g. 2840 |
language_name | string | Optional | full name of search language optional field if you use this field, you don't need to specify language_code ; if you don't specify this field, the language_code with en value will be used by default; you can receive the… |
language_code | string | Optional | search language code optional field 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… e.g. "es" |
platform | string | Optional | target platform. Optional field. Possible values: chat_gpt, google. When omitted, DataForSEO defaults to google only (not both platforms). chat_gpt data is available for the United States and English only (location… e.g. "google" |
initial_dataset_filters | array | Optional | array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;… e.g. [["ai_search_volume", ">", 10]] |
order_by | array | Optional | 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… |
offset | integer | Optional | offset in the results array of the returned mentions data optional field default value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be… |
tag | string | Optional | 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 |
Live LLM Mentions Target Metrics endpoint provides aggregated metrics for mentions of the keywords or domains specified in the target array of the request. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "platform": "chat_gpt", "target": [{"domain": "en.wikipedia.org", "search_filter": "exclude"}, {"keyword": "bmw". $0.31 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | array | Optional | array of objects containing target entities. Required field. You can specify up to 10 entities (objects) in the target field. One target entity can contain either one domain or one keyword and related parameters. All… e.g. [{"domain": "en.wikipedia.org", "search_filter": "exclude"}, |
location_name | string | Optional | full name of search location. Optional field. If you use this field, you don't need to specify location_code. Default is United States (location_code 2840). With platform=chat_gpt, only United States is valid; other… |
location_code | integer | Optional | search location code. Optional field. If you use this field, you don't need to specify location_name. Default is 2840 (United States). With platform=chat_gpt, only 2840 is valid; any other code (e.g. 2036) returns task… e.g. 2840 |
language_name | string | Optional | full name of search language optional field if you use this field, you don't need to specify language_code ; if you don't specify this field, the language_code with en value will be used by default; you can receive the… |
language_code | string | Optional | search language code optional field 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… e.g. "en" |
platform | string | Optional | target platform. Optional field. Possible values: chat_gpt, google. When omitted, DataForSEO defaults to google only (not both platforms). chat_gpt data is available for the United States and English only (location… e.g. "chat_gpt" |
initial_dataset_filters | array | Optional | array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;… e.g. [["ai_search_volume", ">", 10]] |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: sources_domain search_results_domain minimum value: 1 maximum value:… e.g. 10 |
tag | string | Optional | 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 |
The Live LLM Mentions Timeseries Delta endpoint provides the difference in historical mentions and AI search volume data between two specified dates. Body: a JSON array with exactly one task object, e.g. [{"language_name": "English", "location_code": 2840, "target": [{"domain": "dataforseo.com", "search_filter": "exclude"}, {"keyword": "bmw", "search_scope": ["a. $0.32 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | array | Optional | array of objects containing target entities. Required field. You can specify up to 10 entities (objects) in the target field. One target entity can contain either one domain or one keyword and related parameters. All… e.g. [{"domain": "dataforseo.com", "search_filter": "exclude"}, { |
date_from | string | Optional | start date of the time range required field minimal value: 2025-08-01 date format: "yyyy-mm-dd" e.g. "2025-08-01" |
date_to | string | Optional | end date of the time range required field Note: the value specified in date_from cannot exceed the value in date_to date format: "yyyy-mm-dd" e.g. "2025-12-01" |
group_range | string | Optional | timeseries delta range required field possible values: day , week , month , year e.g. "month" |
location_name | string | Optional | full name of search location. Optional field. If you use this field, you don't need to specify location_code. Default is United States (location_code 2840). With platform=chat_gpt, only United States is valid; other… |
location_code | integer | Optional | search location code. Optional field. If you use this field, you don't need to specify location_name. Default is 2840 (United States). With platform=chat_gpt, only 2840 is valid; any other code (e.g. 2036) returns task… e.g. 2840 |
language_name | string | Optional | full name of search language optional field if you use this field, you don't need to specify language_code ; if you don't specify this field, the language_code with en value will be used by default; you can receive the… e.g. "English" |
language_code | string | Optional | search language code optional field 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… |
platform | string | Optional | target platform. Optional field. Possible values: chat_gpt, google. When omitted, DataForSEO defaults to google only (not both platforms). chat_gpt data is available for the United States and English only (location… e.g. "google" |
tag | string | Optional | 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 |
This endpoint will provide you with the number of new and lost LLM mentions, as well as ai_search_volume for the domain or keyword specified in the target field. Body: a JSON array with exactly one task object, e.g. [{"language_name": "English", "location_code": 2840, "target": [{"domain": "dataforseo.com", "search_filter": "exclude"}, {"keyword": "serp", "search_scope": [". $0.32 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | array | Optional | array of objects containing target entities. Required field. You can specify up to 10 entities (objects) in the target field. One target entity can contain either one domain or one keyword and related parameters. All… e.g. [{"domain": "dataforseo.com", "search_filter": "exclude"}, { |
date_from | string | Optional | start date of the time range required field minimal value: 2025-08-01 date format: "yyyy-mm-dd" e.g. "2025-08-01" |
date_to | string | Optional | end date of the time range required field Note: the value specified in date_from cannot exceed the value in date_to date format: "yyyy-mm-dd" e.g. "2025-12-01" |
group_range | string | Optional | timeseries range required field possible values: day , week , month , year e.g. "month" |
location_name | string | Optional | full name of search location. Optional field. If you use this field, you don't need to specify location_code. Default is United States (location_code 2840). With platform=chat_gpt, only United States is valid; other… |
location_code | integer | Optional | search location code. Optional field. If you use this field, you don't need to specify location_name. Default is 2840 (United States). With platform=chat_gpt, only 2840 is valid; any other code (e.g. 2036) returns task… e.g. 2840 |
language_name | string | Optional | full name of search language optional field if you use this field, you don't need to specify language_code ; if you don't specify this field, the language_code with en value will be used by default; you can receive the… e.g. "English" |
language_code | string | Optional | search language code optional field 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… |
platform | string | Optional | target platform. Optional field. Possible values: chat_gpt, google. When omitted, DataForSEO defaults to google only (not both platforms). chat_gpt data is available for the United States and English only (location… e.g. "google" |
tag | string | Optional | 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 |
Live LLM Mentions Top Mentioned Brand Categories Lite endpoint is the simplified version of the Top Mentioned Brand Categories endpoint and provides a simplified view of aggregated LLM mentions metrics grouped by the most frequently mentioned brand… Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "platform": "chat_gpt", "target": [{"keyword": "bmw", "search_scope": ["answer"]}, {"keyword": "auto", "search_s. Capped at limit 50. $0.33 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | array | Optional | array of objects containing target entities. Required field. You can specify up to 10 entities (objects) in the target field. One target entity can contain either one domain or one keyword and related parameters. All… e.g. [{"keyword": "bmw", "search_scope": ["answer"]}, {"keyword": |
location_name | string | Optional | full name of search location. Optional field. If you use this field, you don't need to specify location_code. Default is United States (location_code 2840). With platform=chat_gpt, only United States is valid; other… |
location_code | integer | Optional | search location code. Optional field. If you use this field, you don't need to specify location_name. Default is 2840 (United States). With platform=chat_gpt, only 2840 is valid; any other code (e.g. 2036) returns task… e.g. 2840 |
language_name | string | Optional | full name of search language optional field if you use this field, you don't need to specify language_code ; if you don't specify this field, the language_code with en value will be used by default; you can receive the… |
language_code | string | Optional | search language code optional field 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… e.g. "en" |
platform | string | Optional | target platform. Optional field. Possible values: chat_gpt, google. When omitted, DataForSEO defaults to google only (not both platforms). chat_gpt data is available for the United States and English only (location… e.g. "chat_gpt" |
filters | array | Optional | 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: = ,… |
initial_dataset_filters | array | Optional | array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;… e.g. [["ai_search_volume", ">", 10]] |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: sources_domain , search_results_domain , brand_entities_title ,… e.g. 2 |
order_by | array | Optional | 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… |
offset | integer | Optional | offset in the results array of the returned mentions data optional field default value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be… |
include_brand_categories | array | Optional | array of brand categories to include in the response optional field if specified, only the listed brand categories will be returned in the items array example: ["company","insurance"] |
exclude_brand_categories | array | Optional | array of brand categories to exclude from the response optional field if specified, the listed brand categories will be omitted from the items array example: ["company","insurance"] |
tag | string | Optional | 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 |
Live LLM Mentions Top Mentioned Brand Categories endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned brand categories for the specified target. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "platform": "chat_gpt", "target": [{"keyword": "bmw", "search_scope": ["answer"]}, {"keyword": "auto", "search_s. Capped at limit 50. $0.33 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | array | Optional | array of objects containing target entities. Required field. You can specify up to 10 entities (objects) in the target field. One target entity can contain either one domain or one keyword and related parameters. All… e.g. [{"keyword": "bmw", "search_scope": ["answer"]}, {"keyword": |
location_name | string | Optional | full name of search location. Optional field. If you use this field, you don't need to specify location_code. Default is United States (location_code 2840). With platform=chat_gpt, only United States is valid; other… |
location_code | integer | Optional | search location code. Optional field. If you use this field, you don't need to specify location_name. Default is 2840 (United States). With platform=chat_gpt, only 2840 is valid; any other code (e.g. 2036) returns task… e.g. 2840 |
language_name | string | Optional | full name of search language optional field if you use this field, you don't need to specify language_code ; if you don't specify this field, the language_code with en value will be used by default; you can receive the… |
language_code | string | Optional | search language code optional field 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… e.g. "en" |
platform | string | Optional | target platform. Optional field. Possible values: chat_gpt, google. When omitted, DataForSEO defaults to google only (not both platforms). chat_gpt data is available for the United States and English only (location… e.g. "chat_gpt" |
filters | array | Optional | 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: = ,… |
initial_dataset_filters | array | Optional | array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;… e.g. [["ai_search_volume", ">", 10]] |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: sources_domain , search_results_domain , brand_entities_title ,… e.g. 2 |
order_by | array | Optional | 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… |
offset | integer | Optional | offset in the results array of the returned mentions data optional field default value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be… |
include_brand_categories | array | Optional | array of brand_categories to include in the response optional field if specified, only the listed brand categories will be returned in the items array example: "include_brand_categories": ["business"] |
exclude_brand_categories | array | Optional | array of brand categories to exclude from the response optional field if specified, the listed brand categories will be omitted from the items array example: "exclude_brand_categories": ["business"] |
tag | string | Optional | 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 |
Live LLM Mentions Top Mentioned Brands Lite endpoint is the simplified version of the Top Mentioned Brands endpoint and provides a simplified view of aggregated LLM mentions metrics grouped by the most frequently mentioned brands for the specified target. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "platform": "chat_gpt", "target": [{"keyword": "bmw", "search_scope": ["answer"]}, {"keyword": "auto", "search_s. Capped at limit 50. $0.33 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | array | Optional | array of objects containing target entities. Required field. You can specify up to 10 entities (objects) in the target field. One target entity can contain either one domain or one keyword and related parameters. All… e.g. [{"keyword": "bmw", "search_scope": ["answer"]}, {"keyword": |
location_name | string | Optional | full name of search location. Optional field. If you use this field, you don't need to specify location_code. Default is United States (location_code 2840). With platform=chat_gpt, only United States is valid; other… |
location_code | integer | Optional | search location code. Optional field. If you use this field, you don't need to specify location_name. Default is 2840 (United States). With platform=chat_gpt, only 2840 is valid; any other code (e.g. 2036) returns task… e.g. 2840 |
language_name | string | Optional | full name of search language optional field if you use this field, you don't need to specify language_code ; if you don't specify this field, the language_code with en value will be used by default; you can receive the… |
language_code | string | Optional | search language code optional field 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… e.g. "en" |
platform | string | Optional | target platform. Optional field. Possible values: chat_gpt, google. When omitted, DataForSEO defaults to google only (not both platforms). chat_gpt data is available for the United States and English only (location… e.g. "chat_gpt" |
filters | array | Optional | 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: = ,… |
initial_dataset_filters | array | Optional | array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;… e.g. [["ai_search_volume", ">", 10]] |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: sources_domain , search_results_domain , brand_entities_title ,… e.g. 2 |
order_by | array | Optional | 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… |
offset | integer | Optional | offset in the results array of the returned mentions data optional field default value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be… |
include_brands | array | Optional | array of brands to include in the response optional field if specified, only the listed brands will be returned in the items array example: ["BMW","Audi"] |
exclude_brands | array | Optional | array of brands to exclude from the response optional field if specified, the listed brands will be omitted from the items array example: ["BMW","Audi"] |
tag | string | Optional | 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 |
Live LLM Mentions Top Mentioned Brands endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned brands for the specified target. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "platform": "chat_gpt", "target": [{"keyword": "bmw", "search_scope": ["answer"]}, {"keyword": "auto", "search_s. Capped at limit 50. $0.33 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | array | Optional | array of objects containing target entities. Required field. You can specify up to 10 entities (objects) in the target field. One target entity can contain either one domain or one keyword and related parameters. All… e.g. [{"keyword": "bmw", "search_scope": ["answer"]}, {"keyword": |
location_name | string | Optional | full name of search location. Optional field. If you use this field, you don't need to specify location_code. Default is United States (location_code 2840). With platform=chat_gpt, only United States is valid; other… |
location_code | integer | Optional | search location code. Optional field. If you use this field, you don't need to specify location_name. Default is 2840 (United States). With platform=chat_gpt, only 2840 is valid; any other code (e.g. 2036) returns task… e.g. 2840 |
language_name | string | Optional | full name of search language optional field if you use this field, you don't need to specify language_code ; if you don't specify this field, the language_code with en value will be used by default; you can receive the… |
language_code | string | Optional | search language code optional field 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… e.g. "en" |
platform | string | Optional | target platform. Optional field. Possible values: chat_gpt, google. When omitted, DataForSEO defaults to google only (not both platforms). chat_gpt data is available for the United States and English only (location… e.g. "chat_gpt" |
filters | array | Optional | 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: = ,… |
initial_dataset_filters | array | Optional | array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;… e.g. [["ai_search_volume", ">", 10]] |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: sources_domain , search_results_domain , brand_entities_title ,… e.g. 2 |
order_by | array | Optional | 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… |
offset | integer | Optional | offset in the results array of the returned mentions data optional field default value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be… |
include_brands | array | Optional | array of brands to include in the response optional field if specified, only the listed brands will be returned in the items array example: "include_brands": ["Audi"] |
exclude_brands | array | Optional | array of brands to exclude from the response optional field if specified, the listed brands will be omitted from the items array example: "exclude_brands": ["Audi"] |
tag | string | Optional | 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 |
Live LLM Mentions Top Mentioned Domains Lite endpoint is the simplified version of the Top Mentioned Domains endpoint and provides a simplified view of aggregated LLM mentions metrics grouped by the most frequently mentioned domains for the specified target. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "platform": "chat_gpt", "target": [{"keyword": "bmw", "search_scope": ["answer"]}, {"keyword": "auto", "search_s. Capped at limit 50. $0.33 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | array | Optional | array of objects containing target entities. Required field. You can specify up to 10 entities (objects) in the target field. One target entity can contain either one domain or one keyword and related parameters. All… e.g. [{"keyword": "bmw", "search_scope": ["answer"]}, {"keyword": |
location_name | string | Optional | full name of search location. Optional field. If you use this field, you don't need to specify location_code. Default is United States (location_code 2840). With platform=chat_gpt, only United States is valid; other… |
location_code | integer | Optional | search location code. Optional field. If you use this field, you don't need to specify location_name. Default is 2840 (United States). With platform=chat_gpt, only 2840 is valid; any other code (e.g. 2036) returns task… e.g. 2840 |
language_name | string | Optional | full name of search language optional field if you use this field, you don't need to specify language_code ; if you don't specify this field, the language_code with en value will be used by default; you can receive the… |
language_code | string | Optional | search language code optional field 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… e.g. "en" |
platform | string | Optional | target platform. Optional field. Possible values: chat_gpt, google. When omitted, DataForSEO defaults to google only (not both platforms). chat_gpt data is available for the United States and English only (location… e.g. "chat_gpt" |
links_scope | string | Optional | links source scope optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: sources , search_results default value: sources e.g. "sources" |
filters | array | Optional | 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: = ,… |
initial_dataset_filters | array | Optional | array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;… e.g. [["ai_search_volume", ">", 10]] |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: sources_domain , search_results_domain , brand_entities_title ,… e.g. 2 |
order_by | array | Optional | 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… |
offset | integer | Optional | offset in the results array of the returned mentions data optional field default value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be… |
include_domains | array | Optional | array of domains to include in the response optional field if specified, only the listed domains will be returned in the items array example: ["dataforseo.com","seoinsider.com"] |
exclude_domains | array | Optional | array of domains to exclude from the response optional field if specified, the listed domains will be omitted from the items array example: ["google.com","bing.com"] |
tag | string | Optional | 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 |
Live LLM Mentions Top Mentioned Domains endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned domains for the specified target. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "platform": "chat_gpt", "target": [{"keyword": "bmw", "search_scope": ["answer"]}, {"keyword": "auto", "search_s. Capped at limit 50. $0.33 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | array | Optional | array of objects containing target entities. Required field. You can specify up to 10 entities (objects) in the target field. One target entity can contain either one domain or one keyword and related parameters. All… e.g. [{"keyword": "bmw", "search_scope": ["answer"]}, {"keyword": |
location_name | string | Optional | full name of search location. Optional field. If you use this field, you don't need to specify location_code. Default is United States (location_code 2840). With platform=chat_gpt, only United States is valid; other… |
location_code | integer | Optional | search location code. Optional field. If you use this field, you don't need to specify location_name. Default is 2840 (United States). With platform=chat_gpt, only 2840 is valid; any other code (e.g. 2036) returns task… e.g. 2840 |
language_name | string | Optional | full name of search language optional field if you use this field, you don't need to specify language_code ; if you don't specify this field, the language_code with en value will be used by default; you can receive the… |
language_code | string | Optional | search language code optional field 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… e.g. "en" |
platform | string | Optional | target platform. Optional field. Possible values: chat_gpt, google. When omitted, DataForSEO defaults to google only (not both platforms). chat_gpt data is available for the United States and English only (location… e.g. "chat_gpt" |
links_scope | string | Optional | links source scope optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: sources , search_results default value: sources e.g. "sources" |
filters | array | Optional | 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: = ,… |
initial_dataset_filters | array | Optional | array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;… e.g. [["ai_search_volume", ">", 10]] |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: sources_domain , search_results_domain , brand_entities_title ,… e.g. 2 |
order_by | array | Optional | 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… |
offset | integer | Optional | offset in the results array of the returned mentions data optional field default value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be… |
include_domains | array | Optional | array of domains to include in the response optional field if specified, only the listed domains will be returned in the items array example: "include_domains": ["en.wikipedia.org"] |
exclude_domains | array | Optional | array of domains to exclude from the response optional field if specified, the listed domains will be omitted from the items array example: "exclude_domains": ["en.wikipedia.org"] |
tag | string | Optional | 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 |
Live LLM Mentions Top Mentioned Pages Lite endpoint is a simplified version of the Top Mentioned Pages that provides a simplified view of aggregated LLM mentions metrics grouped by the most frequently mentioned pages for the specified target. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "platform": "chat_gpt", "target": [{"keyword": "bmw", "search_scope": ["answer"]}, {"keyword": "auto", "search_s. Capped at limit 50. $0.33 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | array | Optional | array of objects containing target entities. Required field. You can specify up to 10 entities (objects) in the target field. One target entity can contain either one domain or one keyword and related parameters. All… e.g. [{"keyword": "bmw", "search_scope": ["answer"]}, {"keyword": |
location_name | string | Optional | full name of search location. Optional field. If you use this field, you don't need to specify location_code. Default is United States (location_code 2840). With platform=chat_gpt, only United States is valid; other… |
location_code | integer | Optional | search location code. Optional field. If you use this field, you don't need to specify location_name. Default is 2840 (United States). With platform=chat_gpt, only 2840 is valid; any other code (e.g. 2036) returns task… e.g. 2840 |
language_name | string | Optional | full name of search language optional field if you use this field, you don't need to specify language_code ; if you don't specify this field, the language_code with en value will be used by default; you can receive the… |
language_code | string | Optional | search language code optional field 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… e.g. "en" |
platform | string | Optional | target platform. Optional field. Possible values: chat_gpt, google. When omitted, DataForSEO defaults to google only (not both platforms). chat_gpt data is available for the United States and English only (location… e.g. "chat_gpt" |
links_scope | string | Optional | links source scope optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: sources , search_results default value: sources e.g. "sources" |
filters | array | Optional | 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: = ,… |
initial_dataset_filters | array | Optional | array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;… e.g. [["ai_search_volume", ">", 10]] |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: sources_domain , search_results_domain , brand_entities_title ,… e.g. 2 |
order_by | array | Optional | 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… |
offset | integer | Optional | offset in the results array of the returned mentions data optional field default value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be… |
include_pages | array | Optional | array of page URLs to include in the response optional field if specified, only the listed pages will be returned in the items array example: `["https://dataforseo.com/apis/ai-optimization-api/llm-mentions-api",… |
exclude_pages | array | Optional | array of page URLs to exclude from the response optional field if specified, the listed pages will be omitted from the items array example: `["https://dataforseo.com/apis/ai-optimization-api/llm-mentions-api",… |
tag | string | Optional | 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 |
Live LLM Mentions Top Mentioned Pages endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned pages for the specified target. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "platform": "chat_gpt", "target": [{"keyword": "bmw", "search_scope": ["answer"]}, {"keyword": "auto", "search_s. Capped at limit 50. $0.33 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | array | Optional | array of objects containing target entities. Required field. You can specify up to 10 entities (objects) in the target field. One target entity can contain either one domain or one keyword and related parameters. All… e.g. [{"keyword": "bmw", "search_scope": ["answer"]}, {"keyword": |
location_name | string | Optional | full name of search location. Optional field. If you use this field, you don't need to specify location_code. Default is United States (location_code 2840). With platform=chat_gpt, only United States is valid; other… |
location_code | integer | Optional | search location code. Optional field. If you use this field, you don't need to specify location_name. Default is 2840 (United States). With platform=chat_gpt, only 2840 is valid; any other code (e.g. 2036) returns task… e.g. 2840 |
language_name | string | Optional | full name of search language optional field if you use this field, you don't need to specify language_code ; if you don't specify this field, the language_code with en value will be used by default; you can receive the… |
language_code | string | Optional | search language code optional field 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… e.g. "en" |
platform | string | Optional | target platform. Optional field. Possible values: chat_gpt, google. When omitted, DataForSEO defaults to google only (not both platforms). chat_gpt data is available for the United States and English only (location… e.g. "chat_gpt" |
links_scope | string | Optional | links source scope optional field this parameter specifies which links will be used to extract domains and aggregation data possible values: sources , search_results default value: sources e.g. "sources" |
filters | array | Optional | 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: = ,… |
initial_dataset_filters | array | Optional | array of filter expressions applied before aggregation optional field you can use this array to filter expressions applied to the raw mentions database before aggregation to limit the rows contributing to the result;… e.g. [["ai_search_volume", ">", 10]] |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: sources_domain , search_results_domain , brand_entities_title ,… e.g. 2 |
order_by | array | Optional | 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… |
offset | integer | Optional | offset in the results array of the returned mentions data optional field default value: 0 example: if you specify the 10 value, the first ten mentions objects in the results array will be omitted and the data will be… |
include_pages | array | Optional | array of pages to include in the response optional field if specified, only the listed pages will be returned in the items array example: "include_pages": ["https://example.page/"] |
exclude_pages | array | Optional | array of pages to exclude from the response optional field if specified, the listed pages will be omitted from the items array example: "exclude_pages": ["https://example.page/"] |
tag | string | Optional | 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 |
Live Perplexity LLM Responses endpoint allows you to retrieve structured responses from a specific Perplexity AI model, based on the input parameters. Body: a JSON array with exactly one task object, e.g. [{"system_message": "communicate as if we are in a business meeting", "message_chain": [{"role": "user", "message": "Hello, what\u2019s up?"}, {"role": "ai", "m. $0.02 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
user_prompt | string | Optional | prompt for the AI model required field the question or task you want to send to the AI model; you can specify up to 500 characters in the user_prompt field e.g. "provide information on how relevant the amusement park busi |
model_name | string | Optional | name of the AI model required field model_name consists of the actual model name and version name; if the basic model name is specified, its latest version will be set by default; you can receive the list of available… e.g. "sonar" |
max_output_tokens | integer | Optional | maximum number of tokens in the AI response optional field minimum value: 1 maximum value: 4096 ; default value: 2048 ; Note: if the reasoning model is specified in the request, the output token count may exceed the… e.g. 200 |
temperature | number | Optional | randomness of the AI response optional field higher values make output more diverse lower values make output more focused minimum value: 0 maximum value: 1.9 default value: 0.77 e.g. 0.3 |
top_p | number | Optional | diversity of the AI response optional field controls diversity of the response by limiting token selection minimum value: 0 maximum value: 1 default value: 0.9 e.g. 0.5 |
web_search_country_iso_code | string | Optional | country code for web search localization optional field specify the country ISO code to get localized web search results Note: available only for Perplexity Sonar models example: US e.g. "FR" |
system_message | string | Optional | instructions for the AI behavior optional field defines the AI's role, tone, or specific behavior you can specify up to 500 characters in the system_message field e.g. "communicate as if we are in a business meeting" |
message_chain | array | Optional | conversation history optional field array of message objects representing previous conversation turns; each object must contain: role string with either user or ai role; message string with message content (max 500… e.g. [{"role": "user", "message": "Hello, what\u2019s up?"}, {"ro |
tag | string | Optional | 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 |
The result of a task submitted with dataforseo.x.app-data-apple-app-info-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
This endpoint will provide you with information about the App Store application specified in the app_id field of the POST request. Body: a JSON array with exactly one task object, e.g. [{"app_id": "835599320", "location_code": 2840, "language_code": "en"}]. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
app_id | string | Optional | id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320 e.g. "835599320" |
location_name | string | Optional | 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… |
location_code | integer | Optional | 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 engine with… e.g. 2840 |
language_name | string | Optional | 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 with language_name by… |
language_code | string | Optional | 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 with their language_code by… e.g. "en" |
priority | integer | Optional | 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… |
tag | string | Optional | 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 |
The result of a task submitted with dataforseo.x.app-data-apple-app-list-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
This endpoint will provide you with a list of mobile applications published in the top app charts on the App Store platform. Body: a JSON array with exactly one task object, e.g. [{"app_collection": "top_free_ios", "location_code": 2840, "language_code": "en", "depth": 200, "app_category": "games"}]. Capped at depth 10. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
app_collection | string | Optional | app collection required field app collection on App Store from which apps will be collected; you can specify the following values: top_free_ios, top_paid_ios, top_grossing_ios, new_ios, new_free_ios, new_paid_ios e.g. "top_free_ios" |
location_name | string | Optional | 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… |
location_code | integer | Optional | 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 engine with… e.g. 2840 |
language_name | string | Optional | 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 with language_name by… |
language_code | string | Optional | 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 with their language_code by… e.g. "en" |
priority | integer | Optional | 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… |
app_category | string | Optional | application category on the App Store optional field you can filter the results by app category; example: lifestyle; you can review the full list of available categories here or by making a separate request to… e.g. "games" |
tag | string | Optional | 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 |
This endpoint will provide you with a list of apps published on App Store along with additional information: its ID, icon, reviews count, rating, price, and other data. Body: a JSON array with exactly one task object, e.g. [{"title": "vpn", "description": "vpn", "categories": ["Tools"], "order_by": ["item.rating.value,desc"], "filters": [["item.rating.value", ">", 4.5]], "limit": . Capped at limit 50. $1.82 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
categories | array | Optional | app categories optional field the categories you specify are used to search for app listings; you can get the full list of available app listing categories by this link you can specify up to 10 categories e.g. ["Tools"] |
description | string | Optional | keyword in the app’s description optional field keywords that occur in the description of the app; can contain up to 200 characters e.g. "vpn" |
title | string | Optional | keyword in the app’s title optional field keywords that occur in the title of the app; can contain up to 200 characters e.g. "vpn" |
filters | array | Optional | 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:… e.g. [["item.rating.value", ">", 4.5]] |
order_by | array | Optional | 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… e.g. ["item.rating.value,desc"] |
offset | integer | Optional | offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive… |
offset_token | string | Optional | token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by… |
tag | string | Optional | 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 |
The result of a task submitted with dataforseo.x.app-data-apple-app-reviews-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
This endpoint will provide you with reviews published on the App Store platform for the app specified in the app_id field. Body: a JSON array with exactly one task object, e.g. [{"app_id": "835599320", "location_code": 2840, "language_code": "en", "depth": 200}]. Capped at depth 10. $0.02 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
app_id | string | Optional | id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320 e.g. "835599320" |
location_name | string | Optional | 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… |
location_code | integer | Optional | 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 engine with… e.g. 2840 |
language_name | string | Optional | 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 with language_name by… |
language_code | string | Optional | 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 with their language_code by… e.g. "en" |
priority | integer | Optional | 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… |
sort_by | string | Optional | results sorting parameters optional field you can use this field to sort the results; possible types of sorting: most_recent — sort by the most recent reviews; most_helpful — sort by the most relevant reviews; default… |
tag | string | Optional | 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 |
The result of a task submitted with dataforseo.x.app-data-apple-app-searches-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
This endpoint will provide you with a list of apps ranking on the App Store for the specified keyword. Body: a JSON array with exactly one task object, e.g. [{"keyword": "vpn", "location_code": 2840, "language_code": "en", "depth": 200}]. Capped at depth 10. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | 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… e.g. "vpn" |
location_name | string | Optional | 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… |
location_code | integer | Optional | 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 engine with… e.g. 2840 |
language_name | string | Optional | full name of search engine language required field if language_code is not specified if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by… |
language_code | string | Optional | search engine language code required field if language_name is not specified if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by… e.g. "en" |
priority | integer | Optional | 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… |
tag | string | Optional | 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 |
The result of a task submitted with dataforseo.x.app-data-google-app-info-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
This endpoint will provide you with information about the Google Play application specified in the app_id field of the POST request. Body: a JSON array with exactly one task object, e.g. [{"app_id": "org.telegram.messenger", "location_code": 2840, "language_code": "en"}]. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
app_id | string | Optional | id of the app required field ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL… e.g. "org.telegram.messenger" |
location_name | string | Optional | 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… |
location_code | integer | Optional | 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 engine with… e.g. 2840 |
language_name | string | Optional | full name of search engine language required field if language_code is not specified if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by… |
language_code | string | Optional | search engine language code required field if language_name is not specified if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by… e.g. "en" |
priority | integer | Optional | 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… |
tag | string | Optional | 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 |
The result of a task submitted with dataforseo.x.app-data-google-app-list-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
This endpoint will provide you with a list of mobile applications published in the top charts on the Google Play platform. Body: a JSON array with exactly one task object, e.g. [{"app_collection": "topselling_free", "location_code": 2840, "language_code": "en", "depth": 100}]. Capped at depth 10. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
app_collection | string | Optional | app collection required field app collection on Google Play from which apps will be collected; you can specify the following values: featured, topselling_paid, topselling_free, topselling_new_free, topselling_new_paid,… e.g. "topselling_free" |
location_name | string | Optional | 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… |
location_code | integer | Optional | 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 engine with… e.g. 2840 |
language_name | string | Optional | full name of search engine language required field if language_code is not specified if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by… |
language_code | string | Optional | search engine language code required field if language_name is not specified if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by… e.g. "en" |
priority | integer | Optional | 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… |
app_category | string | Optional | application category on Google Play optional field you can filter the results by app category; example: family; you can receive the full list of available categories by making a separate request to… |
age_rating | string | Optional | filter results by age rating optional field you can use this field to filter the results by age rating; possible types of filtering: ages_up_to_5 — return apps approved for children up to 5 years old; ages_6_8 — return… |
tag | string | Optional | 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 |
This endpoint will provide you with a list of apps published on Google Play along with additional information: its ID, icon, reviews count, rating, price, and other data. Body: a JSON array with exactly one task object, e.g. [{"title": "vpn", "description": "vpn", "categories": ["Tools"], "order_by": ["item.installs_count,asc"], "filters": [["item.rating.value", ">", 4.5]], "limit":. Capped at limit 50. $0.35 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
categories | array | Optional | app categories optional field the categories you specify are used to search for app listings; you can get the full list of available app listing categories by this link you can specify up to 10 categories e.g. ["Tools"] |
description | string | Optional | keyword in the app’s description optional field keywords that occur in the description of the app; can contain up to 200 characters e.g. "vpn" |
title | string | Optional | keyword in the app’s title optional field keywords that occur in the title of the app; can contain up to 200 characters e.g. "vpn" |
filters | array | Optional | 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:… e.g. [["item.rating.value", ">", 4.5]] |
order_by | array | Optional | 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… e.g. ["item.installs_count,asc"] |
offset | integer | Optional | offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive… |
offset_token | string | Optional | token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by… |
tag | string | Optional | 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 |
The result of a task submitted with dataforseo.x.app-data-google-app-reviews-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
This endpoint will provide you with reviews published on the Google Play platform for the app specified in the app_id field. Body: a JSON array with exactly one task object, e.g. [{"app_id": "org.telegram.messenger", "location_code": 2840, "language_code": "en", "depth": 150}]. Capped at depth 10. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
app_id | string | Optional | id of the app required field ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: https://play.google.com/store/apps/details?id=org.telegram.messenger e.g. "org.telegram.messenger" |
location_name | string | Optional | 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… |
location_code | integer | Optional | 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 engine with… e.g. 2840 |
language_name | string | Optional | 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 with language_name by… |
language_code | string | Optional | 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 with their language_code by… e.g. "en" |
priority | integer | Optional | 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… |
rating | integer | Optional | filter reviews by rating optional field you can use this field to filter the results; possible types of filtering: 5 — return reviews with five-star rating only; 4 — return reviews with four-star rating only; 3 —… |
sort_by | string | Optional | results sorting parameters optional field you can use this field to sort the results; possible types of sorting: newest — sort by the most recent reviews; most_relevant — sort by the most relevant reviews; default… |
tag | string | Optional | 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 |
The result of a task submitted with dataforseo.x.app-data-google-app-searches-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
This endpoint will provide you with a list of apps ranking on Google Play for the specified keyword. Body: a JSON array with exactly one task object, e.g. [{"keyword": "vpn", "location_code": 2840, "language_code": "en", "depth": 30}]. Capped at depth 10. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | 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… e.g. "vpn" |
location_name | string | Optional | 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… |
location_code | integer | Optional | 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 engine with… e.g. 2840 |
language_name | string | Optional | full name of search engine language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to… |
language_code | string | Optional | search engine language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to… e.g. "en" |
priority | integer | Optional | 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… |
tag | string | Optional | 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 |
By calling this endpoint you will receive the list of Google locations supported in App Data API. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Required | country |
Anchor-text distribution — backlink and referring-domain counts per anchor Body: a JSON array with exactly one task object, e.g. [{"target": "moz.com", "limit": 2}]. Priced per row requested via limit (1-1000, default 100): $0.00018 per row, minimum $0.072. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.00018 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Required | domain/subdomain without scheme or www, or a full page URL e.g. "moz.com" |
limit | integer | Optional | 1-1000; default 100 e.g. 2 |
offset | integer | Optional | default 0 |
internal_list_limit | integer | Optional | max elements per internal breakdown array, 1-1000; default 10 |
backlinks_status_type | string | Optional | all | live | lost; default live |
include_subdomains | boolean | Optional | default true |
filters | array | Optional | filters |
order_by | array | Optional | order_by |
Individual backlinks — source page, anchor, follow status, first seen, page/domain rank Body: a JSON array with exactly one task object, e.g. [{"target": "moz.com", "limit": 2, "mode": "one_per_domain"}]. Priced per row requested via limit (1-1000, default 100): $0.00018 per row, minimum $0.072. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.00018 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Required | domain/subdomain without scheme or www, or a full page URL e.g. "moz.com" |
limit | integer | Optional | 1-1000; default 100. Priced per row, so keep it small e.g. 2 |
offset | integer | Optional | default 0, max 20000; beyond that use search_after_token |
mode | string | Optional | as_is | one_per_domain | one_per_anchor; default as_is |
backlinks_status_type | string | Optional | all | live | lost; default live |
include_subdomains | boolean | Optional | default true |
exclude_internal_backlinks | boolean | Optional | default true |
filters | array | Optional | max 8 conditions |
order_by | array | Optional | max 3 rules, e.g. ["rank,desc"] |
This endpoint will provide you with the number of backlinks pointing to domains, subdomains, and pages specified in the targets array. Body: a JSON array with exactly one task object, e.g. [{"targets": ["forbes.com", "cnn.com", "bbc.com", "yelp.com", "https://www.apple.com/iphone/", "https://ahrefs.com/blog/", "ibm.com", "https://variety.com/", "h. $0.08 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
targets | array | Optional | domains, subdomains or webpages to get the number of backlinks for required field you can set up to 1000 domains, subdomains or webpages the domain or subdomain should be specified without https:// and www. the page… e.g. ["forbes.com", "cnn.com", "bbc.com", "yelp.com", "https://ww |
tag | string | Optional | 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 |
This endpoint will provide you with the number of new and lost backlinks for the domains, subdomains, and pages specified in the targets array. Body: a JSON array with exactly one task object, e.g. [{"targets": ["forbes.com", "cnn.com", "bbc.com", "yelp.com", "https://www.apple.com/iphone/", "https://ahrefs.com/blog/", "ibm.com", "https://variety.com/", "h. $0.08 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
targets | array | Optional | domains, subdomains or webpages to get new & lost backlinks for required field you can set up to 1000 domains, subdomains or webpages the domain or subdomain should be specified without `https://` and `www.` the page… e.g. ["forbes.com", "cnn.com", "bbc.com", "yelp.com", "https://ww |
date_from | string | Optional | starting date of the time range optional field this field indicates the date which will be used as a threshold for new and lost backlinks; the backlinks that appeared in our index after the specified date will be… e.g. "2021-01-01" |
tag | string | Optional | 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 |
This endpoint will provide you with the number of referring domains pointing to the domains, subdomains and pages specified in the targets array. Body: a JSON array with exactly one task object, e.g. [{"targets": ["forbes.com", "cnn.com", "bbc.com", "yelp.com", "https://www.apple.com/iphone/", "https://ahrefs.com/blog/", "ibm.com", "https://variety.com/", "h. $0.08 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
targets | array | Optional | domains, subdomains or webpages to get new & lost referring domains for required field you can set up to 1000 domains, subdomains or webpages the domain or subdomain should be specified without https:// and www. the… e.g. ["forbes.com", "cnn.com", "bbc.com", "yelp.com", "https://ww |
date_from | string | Optional | starting date of the time range optional field this field indicates the date which will be used as a threshold for new and lost referring domains; the referring domains that appeared in our index after the specified… e.g. "2023-09-01" |
tag | string | Optional | 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 |
This endpoint will provide you with a comprehensive overview of backlinks and related data for a bulk of up to 1000 pages, domains, or subdomains. Body: a JSON array with exactly one task object, e.g. [{"targets": ["https://dataforseo.com/solutions", "https://dataforseo.com/about-us"]}]. $0.08 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
targets | array | Optional | domains, subdomains or webpages to get summary data for required field a domain or a subdomain should be specified without https:// and www. a page should be specified with absolute URL (including http:// or https://</co e.g. ["https://dataforseo.com/solutions", "https://dataforseo.com |
include_subdomains | boolean | Optional | indicates if the subdomains of the target will be included in the search optional field if set to false , the subdomains will be ignored default value: true |
rank_scale | string | Optional | defines the scale used for calculating and displaying the rank , domain_from_rank , and page_from_rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000… |
tag | string | Optional | 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 |
Backlink-derived authority rank (0-1000) for up to 1000 domains or pages per call Body: a JSON array with exactly one task object, e.g. [{"targets": ["moz.com"], "rank_scale": "one_hundred"}]. $0.08 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
targets | array | Required | up to 1000 domains/subdomains (no scheme, no www) or full page URLs e.g. ["moz.com"] |
rank_scale | string | Optional | one_hundred (0-100, comparable to Moz DA) | one_thousand (default) |
This endpoint will provide you with the number of referring domains pointing to domains, subdomains, and pages specified in the targets array. Body: a JSON array with exactly one task object, e.g. [{"targets": ["forbes.com", "cnn.com", "bbc.com", "yelp.com", "https://www.apple.com/iphone/", "https://ahrefs.com/blog/", "ibm.com", "https://variety.com/", "h. $0.08 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
targets | array | Optional | domains, subdomains or webpages to get the number of referring domains for required field you can set up to 1000 domains, subdomains or webpages the domain or subdomain should be specified without https:// and www. the… e.g. ["forbes.com", "cnn.com", "bbc.com", "yelp.com", "https://ww |
tag | string | Optional | 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 |
This endpoint will provide you with spam scores of the domains, subdomains, and pages you specified in the targets array. Body: a JSON array with exactly one task object, e.g. [{"targets": ["forbes.com", "cnn.com", "bbc.com", "yelp.com", "https://www.apple.com/iphone/", "https://ahrefs.com/blog/", "ibm.com", "https://variety.com/", "h. $0.08 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
targets | array | Optional | domains, subdomains or webpages to get rank for required field you can set up to 1000 domains, subdomains or webpages the domain or subdomain should be specified without https:// and www. the page should be specified… e.g. ["forbes.com", "cnn.com", "bbc.com", "yelp.com", "https://ww |
tag | string | Optional | 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 |
Domains sharing referring domains with the target, ranked by overlap Body: a JSON array with exactly one task object, e.g. [{"target": "moz.com", "limit": 2}]. Priced per row requested via limit (1-1000, default 100): $0.00018 per row, minimum $0.072. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.00018 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Required | domain/subdomain without scheme or www, or a full page URL e.g. "moz.com" |
limit | integer | Optional | 1-1000; default 100 e.g. 2 |
offset | integer | Optional | default 0 |
exclude_large_domains | boolean | Optional | drop hub domains (facebook.com etc); default true |
main_domain | boolean | Optional | return main domains only; default false |
filters | array | Optional | filters |
order_by | array | Optional | order_by |
This endpoint will provide you with the list of domains pointing to the specified websites. Body: a JSON array with exactly one task object, e.g. [{"targets": {"1": "moz.com", "2": "ahrefs.com"}, "include_subdomains": false, "exclude_targets": ["semrush.com"], "limit": 5, "order_by": ["1.backlinks,desc"],. Priced per row requested via limit (1-1000, default 100): $0.00018 per row, minimum $0.072. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.00018 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
targets | object | Optional | domains, subdomains or webpages to get links for required field you can set up to 20 domains, subdomains or webpages a domain or a subdomain should be specified without https:// and www. a page should be specified with… e.g. {"1": "moz.com", "2": "ahrefs.com"} |
exclude_targets | array | Optional | domains, subdomains or webpages you want to exclude optional field you can specify up to 10 domains, subdomains or webpages if you use this array, results will contain the referring domains that link to targets but… e.g. ["semrush.com"] |
filters | array | Optional | 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:… |
order_by | array | Optional | 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… e.g. ["1.backlinks,desc"] |
offset | integer | Optional | offset in the array of returned results optional field default value: 0 if you specify the 10 value, the first ten backlinks in the results array will be omitted and the data will be provided for the successive backlinks |
limit | integer | Optional | the maximum number of returned results optional field default value: 100 maximum value: 1000 e.g. 5 |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: referring_links_tld referring_links_types referring_links_attributes… |
backlinks_status_type | string | Optional | set what backlinks to return and count optional field you can use this field to choose what backlinks will be returned and used for aggregated metrics for your targets ; possible values: all - all backlinks will be… |
backlinks_filters | array | Optional | filter the backlinks of your target optional field you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target you can filter the backlinks by all… |
include_subdomains | boolean | Optional | indicates if the subdomains of the target will be included in the search optional field if set to false , the subdomains will be ignored default value: true e.g. false |
include_indirect_links | boolean | Optional | indicates if indirect links to the targets will be included in the results optional field if set to true , the results will include data on indirect links pointing to a page that either redirects to a target, or points… |
exclude_internal_backlinks | boolean | Optional | indicates whether the backlinks from subdomains of the target are excluded optional field if set to false , the backlinks from subdomains of the target will be omitted and you won't receive the same domain in the… e.g. true |
intersection_mode | string | Optional | indicates whether to intersect backlinks optional field use this field to intersect or merge results for the specified domains possible values: all , partial all - results are based on all backlinks; partial - results… |
rank_scale | string | Optional | defines the scale used for calculating and displaying the rank , domain_from_rank , and page_from_rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000… |
tag | string | Optional | 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 |
This endpoint will provide you with detailed summary data on all backlinks and related metrics for each page of the target domain or subdomain you specify. Body: a JSON array with exactly one task object, e.g. [{"target": "forbes.com", "limit": 4, "order_by": ["backlinks,desc"]}]. Priced per row requested via limit (1-1000, default 100): $0.00018 per row, minimum $0.072. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.00018 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Optional | domain, subdomain or webpage to get summary data for required field a domain or a subdomain should be specified without https:// and www. a page should be specified with absolute URL (including http:// or https://) e.g. "forbes.com" |
limit | integer | Optional | the maximum number of returned anchors optional field default value: 100 maximum value: 1000 e.g. 4 |
offset | integer | Optional | offset in the results array of returned anchors optional field default value: 0 if you specify the 10 value, the first ten anchors in the results array will be omitted and the data will be provided for the successive… |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: referring_links_tld referring_links_types referring_links_attributes… |
backlinks_status_type | string | Optional | set what backlinks to return and count optional field you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target; possible values: all – all backlinks will be… |
filters | array | Optional | 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:… |
order_by | array | Optional | 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… e.g. ["backlinks,desc"] |
backlinks_filters | array | Optional | filter the backlinks of your target optional field you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target you can filter the backlinks by all… |
include_subdomains | boolean | Optional | indicates if the subdomains of the target domain will be included in the search optional field if set to false, the subdomains will be ignored default value: true |
include_indirect_links | boolean | Optional | indicates if indirect links to the target will be included in the results optional field if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points… |
exclude_internal_backlinks | boolean | Optional | indicates whether the backlinks from subdomains of the target are excluded optional field if set to false, backlinks from the subdomains of the target domain will be ommited and you won’t receive the same domain in the… |
rank_scale | string | Optional | defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000… |
tag | string | Optional | 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 |
This endpoint will provide you with a detailed overview of domain pages with backlink data for each page. Body: a JSON array with exactly one task object, e.g. [{"target": "forbes.com", "limit": 5, "filters": [["page_summary.backlinks", ">", 5], "and", ["page", "like", "%sites%"]]}]. Priced per row requested via limit (1-1000, default 100): $0.00018 per row, minimum $0.072. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.00018 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Optional | domain or subdomain required field a domain or a subdomain should be specified without https:// and www. example: forbes.com e.g. "forbes.com" |
limit | integer | Optional | the maximum number of returned pages optional field default value: 100 maximum value: 1000 e.g. 5 |
offset | integer | Optional | offset in the results array of returned pages optional field default value: 0 if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: referring_links_tld referring_links_types referring_links_attributes… |
backlinks_status_type | string | Optional | set what backlinks to return and count optional field you can use this field to choose what backlinks will be returned and used for aggregated metrics; possible values: all – all backlinks will be returned and counted;… |
filters | array | Optional | 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:… e.g. [["page_summary.backlinks", ">", 5], "and", ["page", "like", |
order_by | array | Optional | 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… |
backlinks_filters | array | Optional | filter the backlinks of your target optional field you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target you can filter the backlinks by all… |
include_subdomains | boolean | Optional | indicates if the subdomains of the target will be included in the search optional field if set to false, the subdomains will be ignored default value: true |
exclude_internal_backlinks | boolean | Optional | indicates if internal backlinks from subdomains to the target will be excluded from the results optional field if set to true, the results will not include data on internal backlinks from subdomains of the same domain… |
rank_scale | string | Optional | defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000… |
tag | string | Optional | 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 |
This endpoint will provide you with historical backlinks data back to the beginning of 2019. Body: a JSON array with exactly one task object, e.g. [{"target": "cnn.com", "date_from": "2020-01-01", "date_to": "2021-01-01"}]. $0.08 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Optional | domain required field a domain should be specified without https:// and www. e.g. "cnn.com" |
date_from | string | Optional | starting date of the time range optional field minimum value 2019-01-01 if you don't specify this field, the minimum value will be used by default date format: "yyyy-mm-dd" example: "2019-01-15" e.g. "2020-01-01" |
date_to | string | Optional | ending date of the time range optional field if you don't specify this field, the today's date will be used by default date format: "yyyy-mm-dd" example: "2019-01-15" e.g. "2021-01-01" |
rank_scale | string | Optional | defines the scale used for calculating and displaying the rank , domain_from_rank , and page_from_rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000… |
tag | string | Optional | 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 |
This endpoint will provide you with the total number of backlinks, domains, and pages our database contains for the moment when you make a request. $0.001 per call.
This endpoint will provide you with the list of referring pages pointing to the specified targets. Body: a JSON array with exactly one task object, e.g. [{"targets": {"1": "football.com", "2": "fifa.com"}, "exclude_targets": ["skysports.com"], "limit": 5, "order_by": ["1.rank,desc"], "filters": [["2.domain_from_. Priced per row requested via limit (1-1000, default 100): $0.00018 per row, minimum $0.072. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.00018 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
targets | object | Optional | domains, subdomains or webpages to get links for required field you can set up to 20 domains, subdomains or webpages a domain or a subdomain should be specified without https:// and www. a page should be specified with… e.g. {"1": "football.com", "2": "fifa.com"} |
exclude_targets | array | Optional | domains, subdomains or webpages you want to exclude optional field you can set up to 10 domains, subdomains or webpages if you use this array, results will contain the referring pages that link to targets but don’t… e.g. ["skysports.com"] |
backlinks_status_type | string | Optional | set what backlinks to return and count optional field you can use this field to choose what backlinks will be returned and used for aggregated metrics for your targets; possible values: all – all backlinks will be… |
filters | array | Optional | 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:… e.g. [["2.domain_from_rank", ">", 400], "and", ["1.dofollow", "=" |
order_by | array | Optional | 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… e.g. ["1.rank,desc"] |
offset | integer | Optional | offset in the results array of the returned backlinks optional field default value: 0 if you specify the 10 value, the first ten backlinks in the results array will be omitted and the data will be provided for the… |
limit | integer | Optional | the maximum number of returned backlinks optional field default value: 100 maximum value: 1000 e.g. 5 |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: attributes domain_from_platform_type default value: 10 maximum value:… |
include_subdomains | boolean | Optional | indicates if the subdomains of the targets will be included in the search optional field if set to false, the subdomains will be ignored default value: true |
include_indirect_links | boolean | Optional | indicates if indirect links to the targets will be included in the results optional field if set to true, the results will include data on indirect links pointing to a page that either redirects to a target, or points… |
exclude_internal_backlinks | boolean | Optional | indicates if internal backlinks from subdomains to the target will be excluded from the results optional field if set to true, the results will not include data on internal backlinks from subdomains of the same domain… |
intersection_mode | string | Optional | indicates whether to intersect backlinks optional field use this field to intersect or merge results for the specified URLs possible values: all, partial all – results are based on all backlinks; partial – results are… |
rank_scale | string | Optional | defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000… |
tag | string | Optional | 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 |
Referring domains linking to a target, with backlink counts, rank and first/last seen Body: a JSON array with exactly one task object, e.g. [{"target": "moz.com", "limit": 2}]. Priced per row requested via limit (1-1000, default 100): $0.00018 per row, minimum $0.072. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.00018 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Required | domain/subdomain without scheme or www, or a full page URL e.g. "moz.com" |
limit | integer | Optional | 1-1000; default 100 e.g. 2 |
offset | integer | Optional | default 0 |
internal_list_limit | integer | Optional | max elements per internal breakdown array, 1-1000; default 10 |
backlinks_status_type | string | Optional | all | live | lost; default live |
include_subdomains | boolean | Optional | default true |
exclude_internal_backlinks | boolean | Optional | default true |
filters | array | Optional | filters |
order_by | array | Optional | order_by |
This endpoint will provide you with a detailed overview of referring IPs and subnets pointing to the target you specify. Body: a JSON array with exactly one task object, e.g. [{"target": "backlinko.com", "network_address_type": "subnet", "limit": 5, "order_by": ["rank,desc"], "exclude_internal_backlinks": true, "backlinks_filters": [. Priced per row requested via limit (1-1000, default 100): $0.00018 per row, minimum $0.072. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.00018 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Optional | domain, subdomain or webpage to get referring networks for required field a domain or a subdomain should be specified without https:// and www. a page should be specified with absolute URL (including http:// or https://) e.g. "backlinko.com" |
network_address_type | string | Optional | indicates the type of network to get data for optional field possible values: ip, subnet default value: ip e.g. "subnet" |
limit | integer | Optional | the maximum number of returned networks optional field default value: 100 maximum value: 1000 e.g. 5 |
offset | integer | Optional | offset in the results array of returned networks 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… |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: referring_links_tld referring_links_types referring_links_attributes… |
backlinks_status_type | string | Optional | set what backlinks to return and count optional field you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target; possible values: all – all backlinks will be… |
filters | array | Optional | 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:… e.g. ["backlinks", ">", 100] |
order_by | array | Optional | 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… e.g. ["rank,desc"] |
backlinks_filters | array | Optional | filter the backlinks of your target optional field you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target you can filter the backlinks by all… e.g. ["dofollow", "=", true] |
include_subdomains | boolean | Optional | indicates if the subdomains of the target will be included in the search optional field if set to false, the subdomains will be ignored default value: true |
include_indirect_links | boolean | Optional | indicates if indirect links to the target will be included in the results optional field if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points… |
exclude_internal_backlinks | boolean | Optional | indicates whether the backlinks from subdomains of the target are excluded optional field if set to false, the backlinks from subdomains of the target will be ommited and you won’t receive the same domain in the… e.g. true |
rank_scale | string | Optional | defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000… |
tag | string | Optional | 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 |
Aggregate backlink profile of a domain or URL — counts, rank, spam score, breakdowns Body: a JSON array with exactly one task object, e.g. [{"target": "moz.com", "internal_list_limit": 10}]. $0.08 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Required | domain/subdomain WITHOUT scheme or www (moz.com); a page needs the full URL e.g. "moz.com" |
include_subdomains | boolean | Optional | default true |
include_indirect_links | boolean | Optional | count redirect/canonical links; default true |
exclude_internal_backlinks | boolean | Optional | default true |
backlinks_status_type | string | Optional | all | live | lost; default live |
internal_list_limit | integer | Optional | max elements per internal breakdown array, 10-1000; default 10 e.g. 10 |
rank_scale | string | Optional | one_hundred | one_thousand; default one_thousand |
backlinks_filters | array | Optional | narrow the backlink set the aggregates are computed over |
This endpoint will provide you with the number of new and lost backlinks and referring domains for the domain specified in the target field. Body: a JSON array with exactly one task object, e.g. [{"target": "dataforseo.com", "date_from": "2026-04-24", "date_to": "2026-06-24", "group_range": "month"}]. $0.08 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Optional | domain to get data for required field a domain should be specified without https:// and www. example: "forbes.com" e.g. "dataforseo.com" |
date_from | string | Optional | starting date of the time range optional field this field indicates the date which will be used as a threshold for new and lost backlinks and referring domains; the backlinks and referring domains that appeared in our… e.g. "2026-04-24" |
date_to | string | Optional | ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default minimum value shouldn’t preceed the date specified in the date_from maximum value: today’s date… e.g. "2026-06-24" |
group_range | string | Optional | time range which will be used to group the results optional field default value: month possible values: day, week, month, year note: for day, we will return items corresponding to all dates between and including… e.g. "month" |
include_subdomains | boolean | Optional | indicates if the subdomains of the target will be included in the search optional field if set to false, the subdomains will be ignored default value: true |
tag | string | Optional | 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 |
This endpoint will provide you with an overview of backlink data for the target domain available during a period between the two indicated dates. Body: a JSON array with exactly one task object, e.g. [{"target": "dataforseo.com", "date_from": "2026-04-24", "date_to": "2026-06-24", "group_range": "month"}]. $0.08 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Optional | domain to get data for required field a domain should be specified without https:// and www. example: "forbes.com" e.g. "dataforseo.com" |
date_from | string | Optional | starting date of the time range optional field this field indicates the date which will be used as a threshold for summary data; minimum value: 2019-01-30 maximum value shouldn’t exceed the date specified in the… e.g. "2026-04-24" |
date_to | string | Optional | ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default minimum value shouldn’t preceed the date specified in the date_from maximum value: today’s date… e.g. "2026-06-24" |
group_range | string | Optional | time range which will be used to group the results optional field default value: month possible values: day, week, month, year note: for day, we will return items corresponding to all dates between and including… e.g. "month" |
include_subdomains | boolean | Optional | indicates if the subdomains of the target will be included in the search optional field if set to false, the subdomains will be ignored default value: true |
rank_scale | string | Optional | defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000… |
tag | string | Optional | 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 |
Business Listings Categories Aggregation endpoint provides results containing information about groups of related categories along with the number of entities in each category. Body: a JSON array with exactly one task object, e.g. [{"categories": ["pizza_restaurant"], "description": "pizza", "title": "pizza", "is_claimed": true, "location_coordinate": "53.476225,-2.243572,10", "initial_da. Capped at limit 50. $0.06 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
categories | array | Optional | business categories optional field the categories you specify are used to search for business listings; if you don't use this field, we will return business listings found in the specified location; you can specify up… e.g. ["pizza_restaurant"] |
description | string | Optional | description of the element in SERP optional field the description of the business entity for which the results are collected; can contain up to 200 characters e.g. "pizza" |
title | string | Optional | title of the element in SERP optional field the name of the business entity for which the results are collected; can contain up to 200 characters e.g. "pizza" |
is_claimed | boolean | Optional | indicates whether the business is verified by its owner on Google Maps optional field e.g. true |
location_coordinate | string | Optional | GPS coordinates of a location optional field location_coordinate parameter should be specified in the "latitude,longitude,radius" format the maximum number of decimal digits for "latitude" and "longitude" : 7 the… e.g. "53.476225,-2.243572,10" |
initial_dataset_filters | array | Optional | 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:… e.g. [["rating.value", ">", 3]] |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the aggregated categories default value: 10 |
offset | integer | Optional | the maximum number of returned businesses optional field |
tag | string | Optional | 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 |
Business Listings Search API provides results containing information about business entities listed on Google Maps in the specified categories. Body: a JSON array with exactly one task object, e.g. [{"categories": ["pizza_restaurant"], "description": "pizza", "title": "pizza", "is_claimed": true, "location_coordinate": "53.476225,-2.243572,10", "order_by":. Capped at limit 50. $0.06 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
categories | array | Optional | business categories optional field the categories you specify are used to search for business listings; if you don't use this field, we will return business listings found in the specified location; you can specify up… e.g. ["pizza_restaurant"] |
description | string | Optional | description of the element in SERP optional field the description of the business entity for which the results are collected; can contain up to 200 characters e.g. "pizza" |
title | string | Optional | title of the element in SERP optional field the name of the business entity for which the results are collected; can contain up to 200 characters e.g. "pizza" |
is_claimed | boolean | Optional | indicates whether the business is verified by its owner on Google Maps optional field e.g. true |
location_coordinate | string | Optional | GPS coordinates of a location optional field location_coordinate parameter should be specified in the "latitude,longitude,radius" format the maximum number of decimal digits for "latitude" and "longitude" : 7 the value… e.g. "53.476225,-2.243572,10" |
filters | array | Optional | 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:… e.g. [["rating.value", ">", 3]] |
order_by | array | Optional | 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… e.g. ["rating.value,desc"] |
offset | integer | Optional | offset in the results array of returned businesses optional field default value: 0 if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the… |
offset_token | string | Optional | token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by… |
tag | string | Optional | 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 |
The result of a task submitted with dataforseo.x.business-data-google-extended-reviews-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
This endpoint provides results from the “Reviews” element of Google SERPs, including not only Google user reviews but also reviews from other reputable sources (e.g., TripAdvisor, Yelp, Trustpilot). Body: a JSON array with exactly one task object, e.g. [{"location_name": "London,England,United Kingdom", "language_name": "english", "cid": "17626775537598922320"}]. Capped at depth 10. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | keyword required field if you don't specify cid or place_id the keyword you specify should indicate the name of the local establishment; you can specify up to 700 characters in the keyword filed; all %## wi |
cid | string | Optional | unique, google-defined id of the business entity required field if you don't specify keyword or place_id example: 194604053573767737 learn more about the identifier in <a… e.g. "17626775537598922320" |
place_id | string | Optional | identifier of the business entity in Google Maps required field if you don't specify keyword or cid example: GhIJQWDl0CIeQUARxks3icF8U8A learn more about the identifier in <a… |
priority | integer | Optional | task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priorityYou will be additionally charged for the tasks with high execution priority. The… |
location_name | string | Optional | 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 y e.g. "London,England,United Kingdom" |
location_code | integer | Optional | 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 r |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don't specify location_name _or location_code if you use this field, you don't need to specify location_name or location_code location_coor |
language_name | string | Optional | 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 with language_name< e.g. "english" |
language_code | string | Optional | 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 with their language_code</c |
tag | string | Optional | 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 |
Google Hotel Info will provide you with structured data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_name": "New York,New York,United States", "hotel_identifier": "CgoI-KWyzenM_MV3EAE"}]. $0.02 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
hotel_identifier | string | Optional | unique hotel identifier required field unique identifier of a hotel entity in Google search; you can obtain the value by making a request to Advanced Google SERP API (enclosed e.g. "CgoI-KWyzenM_MV3EAE" |
location_name | string | Optional | 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 y e.g. "New York,New York,United States" |
location_code | integer | Optional | 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 r |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don't specify location_name _or location_code if you use this field, you don't need to specify location_name or location_code location_coor |
language_name | string | Optional | 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 with language_name< |
language_code | string | Optional | 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 with their language_code</c e.g. "en" |
check_in | string | Optional | check-in date optional field if you don't specify this field, tomorrow's date will be used by default; the value must not be earlier than today's date date format: "yyyy-mm-dd" example: "2019-01-15" |
check_out | string | Optional | check-out date optional field if you don't specify this field, our system will apply the date of two days from now by default; Note: the value cannot be less than or equal to check_in ; the range between check_in and… |
currency | string | Optional | currency optional field example: "USD" |
adults | integer | Optional | number of adults optional field if you don't specify this field, two adults will be used by default example: 1 |
children | array | Optional | number and age of children optional field if you don't specify this field, no children will be included in the search; set the following value if you want to include one 14-years-old child: [14] set the following value… |
load_prices_by_dates | boolean | Optional | load hotel stay prices by dates optional field if you specify this parameter with true , the response will include the prices_by_dates array with hotel stay prices divided by dates if you use this parameter, you will… |
prices_start_date | string | Optional | start date to load prices by dates optional field to use this parameter, you must specify load_prices_by_dates with true if this parameter is not specified, the start date is set to check_in date date format:… |
prices_end_date | string | Optional | end date to load prices by dates optional field to use this parameter, you must specify load_prices_by_dates with true if this parameter is not specified, you will get prices by date for the month date format:… |
prices_date_range | string | Optional | predefined period for retrieving daily price data optional field to use this parameter, you must specify load_prices_by_dates with true if the prices_start_date is not specified, the start date is set to check_in date… |
tag | string | Optional | 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 |
Hotel Searches API provides results containing information about different hotels listed on Google Hotels. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_name": "New York,New York,United States", "keyword": "cheap hotel", "check_in": "2026-08-24", "check_out": "2026-08-25", "cur. Capped at depth 10. $0.02 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | keyword optional field the keyword you specify is used to search for the list of hotels; if you don’t use this field, we will return the list of hotels found in a specified location; you can specify up to 700… e.g. "cheap hotel" |
location_name | string | Optional | 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… e.g. "New York,New York,United States" |
location_code | integer | Optional | 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… |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don’t 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… |
search_this_area | boolean | Optional | show hotels from the displayed area optional field can take the values: true, false default value: true if set to false the search_this_area mode will be turned off Note: if the search_this_area mode is turned off, the… |
language_name | string | Optional | 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 with language_name by… |
language_code | string | Optional | 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 with their language_code by… e.g. "en" |
check_in | string | Optional | check-in date optional field if you don’t specify this field, tomorrow’s date will be used by default; date format: "yyyy-mm-dd" example: "2019-01-15" Note: the value cannot precede the today’s date e.g. "2026-08-24" |
check_out | string | Optional | check-out date optional field if you don’t specify this field, our system will apply the date of two days from now by default; date format: "yyyy-mm-dd" example: "2019-01-15" Note: the value cannot be less than or… e.g. "2026-08-25" |
currency | string | Optional | currency optional field example: "USD" e.g. "USD" |
adults | integer | Optional | number of adults optional field if you don’t specify this field, the default value of 2 will be applied; note that you can specify up to 6 persons including both adults and children example: 1 e.g. 2 |
children | array | Optional | number and age of children optional field if you don’t specify this field, no children will be included in the search; age of child can be from 0 to 17; note that you can specify up to 6 persons including both adults… e.g. ["14"] |
stars | array | Optional | hotel stars optional field set this field to [5] if you want to get the list of 5-star hotels only example: [3,4,5] |
min_rating | number | Optional | minimum rating optional field you can use this field to specify guest rating higher than a certain value example: 2.5 |
sort_by | string | Optional | results sorting parameters optional field you can use this field to sort the results possible types of sorting: relevance – sort by most relevant lowest_price – sort by the lowest price highest_rating – sort by highest… e.g. "highest_rating" |
min_price | integer | Optional | minimum price per night optional field the currency of this value depends on the currency field example: 100 |
max_price | integer | Optional | maximum price per night optional field the currency of this value depends on the currency field example: 600 |
free_cancellation | boolean | Optional | hotels with a free cancellation optional field set this field to true if you want to get the list of hotels with free cancellation of reservations default value: false |
is_vacation_rentals | boolean | Optional | search for vacation rentals optional field set this field to true if you want to get the list of vacation rentals instead of hotels default value: false |
amenities | array | Optional | hotel amenities optional field you can use this field to specify different hotel amenities example: [ "free_parking", "pets_allowed" ] possible values: "air_conditioning", "all_inclusive_available", "bar",… |
tag | string | Optional | 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 e.g. "example" |
You will receive the list of locations by this API call. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Required | country |
Business Data API provides results containing information about specific business entity from Google. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_name": "New York,New York,United States", "keyword": "RustyBrick, Inc."}]. $0.02 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | keyword required field the keyword you specify should indicate the name of the local establishment you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded… e.g. "RustyBrick, Inc." |
location_name | string | Optional | 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… e.g. "New York,New York,United States" |
location_code | integer | Optional | 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… |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don’t 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… |
language_name | string | Optional | 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 with language_name by… |
language_code | string | Optional | 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 with their language_code by… e.g. "en" |
tag | string | Optional | 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 |
The result of a task submitted with dataforseo.x.business-data-google-my-business-updates-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
This endpoints provides the latest updates of a specific business entity from Google SERP. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_name": "New York,New York,United States", "keyword": "RustyBrick, Inc."}]. Capped at depth 10. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | keyword required field the keyword you specify should indicate the name of the local establishment you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded… e.g. "RustyBrick, Inc." |
priority | integer | Optional | 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… |
location_name | string | Optional | 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… e.g. "New York,New York,United States" |
location_code | integer | Optional | 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… |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don’t 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… |
language_name | string | Optional | 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 with language_name by… |
language_code | string | Optional | 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 with their language_code by… e.g. "en" |
tag | string | Optional | 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 |
This endpoint will provide you with a detailed overview of questions and answers associated with a specific business entity listed on Google My Business. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_name": "Los Angeles,California,United States", "keyword": "The Last Bookstore"}]. Capped at depth 10. $0.02 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | keyword required field the keyword you specify should indicate the name of the local establishment you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded… e.g. "The Last Bookstore" |
location_name | string | Optional | 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… e.g. "Los Angeles,California,United States" |
location_code | integer | Optional | 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… |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don’t 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… |
language_name | string | Optional | 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 with language_name by… |
language_code | string | Optional | 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 with their language_code by… e.g. "en" |
tag | string | Optional | 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 |
The result of a task submitted with dataforseo.x.business-data-google-reviews-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
This endpoint provides results from the “Reviews” element of Google SERPs. Body: a JSON array with exactly one task object, e.g. [{"location_name": "London,England,United Kingdom", "language_name": "English", "keyword": "hedonism wines", "depth": 50, "sort_by": "highest_rating"}]. Capped at depth 10. $0.02 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | keyword required field if you don’t specify cid or place_id the keyword you specify should indicate the name of the local establishment; you can specify up to 700 characters in the keyword filed; all %## will be… e.g. "hedonism wines" |
cid | string | Optional | unique, google-defined id of the business entity required field if you don’t specify keyword or place_id example: 194604053573767737 learn more about the identifier in this help center article |
place_id | string | Optional | identifier of the business entity in Google Maps required field if you don’t specify keyword or cid example: GhIJQWDl0CIeQUARxks3icF8U8A learn more about the identifier in this help center article |
priority | integer | Optional | 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… |
location_name | string | Optional | 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… e.g. "London,England,United Kingdom" |
location_code | integer | Optional | 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… |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don’t 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… |
language_name | string | Optional | 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 with language_name by… e.g. "English" |
language_code | string | Optional | 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 with their language_code by… |
sort_by | string | Optional | results sorting parameters optional field you can use this field to sort the results possible types of sorting: newest – sort by newest first highest_rating – sort by highest rating lowest_rating – sort by lowest… e.g. "highest_rating" |
tag | string | Optional | 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 |
Social Media Pinterest API will provide you with data on pins made from the specified URLs. Body: a JSON array with exactly one task object, e.g. [{"targets": ["https://www.simplyrecipes.com/recipes/grilled_salmon_with_cucumber_mango_salsa/", "https://tasty.co/recipe/classic-lasagna", "https://www.allreci. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
targets | array | Optional | target URLs required field target page should be specified with its absolute URL (including http:// or https://) example: https://dataforseo.com/ Note: you can specify 10 targets maximum. You will be charged per earch… e.g. ["https://www.simplyrecipes.com/recipes/grilled_salmon_with_ |
tag | string | Optional | 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 e.g. "some_string_123" |
You will receive the list of locations by this API call. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Required | country |
The result of a task submitted with dataforseo.x.business-data-tripadvisor-reviews-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
This endpoint provides results from the “Reviews” element on the Tripadvisor platform. Body: a JSON array with exactly one task object, e.g. [{"url_path": "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html", "location_code": 1003854, "pingback_url": "https:. Capped at depth 10. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url_path | string | Optional | URL path of the business entity required field if you do not specify keyword URL path to the Tripadvisor page of the business entity; examples:… e.g. "Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_ |
keyword | string | Optional | keyword required field if you do not specify url_path the keyword you specify should indicate a name of an existing business or prominent place on Tripadvisor; you can specify up to 700 characters in the keyword filed;… |
location_name | string | Optional | full name of search engine location required field if you don’t specify location_code or url_path you can receive the list of available locations with location_name by making a separate request to the… |
location_code | integer | Optional | search engine location code required field if you don’t specify location_name or url_path you can receive the list of available locations with location_code by making a separate request to the… e.g. 1003854 |
priority | integer | Optional | 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… |
language_name | string | Optional | full name of search engine language optional field if you use this field, your account will be charged for one extra request you can receive the list of available languages with language_name by making a separate… |
language_code | string | Optional | search engine language code optional field if you use this field, your account will be charged for one extra request you can receive the list of available languages with language_code by making a separate request to… |
ratings | array | Optional | Tripadvisor traveler rating for a place of interest optional field rating based on the written reviews by a traveler after they visited a place. possible values: excellent, very_good, average, poor, terrible you can… |
visit_type | array | Optional | filter by type of travelers who left a review optional field possible values: families, couples, solo, business, friends you can specify several values at once |
months | array | Optional | filter by months when a traveler made a visit optional field possible values: january, february, march, april, may, april, june, july, august, september, october, november, december you can specify several values at once |
search_reviews_keyword | string | Optional | search reviews containing a specified keyword example: dessert |
sort_by | string | Optional | results sorting parameters optional field you can use this field to sort the results; possible types of sorting: most_recent detailed_reviews |
translate_reviews | boolean | Optional | translate reviews according to the URL path optional field if set to true, returned reviews will be translated to the language matching the specified url_path; for example, if url_path contains tripadvisor.it and… |
tag | string | Optional | 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 e.g. "some_string_123" |
The result of a task submitted with dataforseo.x.business-data-tripadvisor-search-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
This endpoint provides a list of business profiles listed on the Tripadvisor platform. Body: a JSON array with exactly one task object, e.g. [{"keyword": "pizza", "location_code": 1003854, "depth": 30}]. Capped at depth 10. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | keyword required field the keyword you specify should indicate a business category, company name, or a prominent place; you can specify up to 700 characters in the keyword filed; all %## will be decoded (plus character… e.g. "pizza" |
location_name | string | Optional | full name of search engine location required field if you don’t specify location_code you can receive the list of available locations with location_name by making a separate request to the… |
location_code | integer | Optional | search engine location code required field if you don’t specify location_name you can receive the list of available locations with location_code by making a separate request to the… e.g. 1003854 |
priority | integer | Optional | 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… |
tag | string | Optional | 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 |
The result of a task submitted with dataforseo.x.business-data-trustpilot-reviews-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
This endpoint provides reviews published on the Trustpilot platform for the local establishment specified in the domain field. Body: a JSON array with exactly one task object, e.g. [{"domain": "www.thepearlsource.com", "depth": 40}]. Capped at depth 10. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
domain | string | Optional | domain of the local establishment required field domain of the local establishment on Trustpilot; you can find the domain in the URL of every business listed on Trustpilot example: www.thepearlsource.com… e.g. "www.thepearlsource.com" |
sort_by | string | Optional | results sorting parameter optional field you can use this field to sort the results; possible sorting parameters: recency — most recent reviews first; relevance — most relevant reviews first; default value: relevance |
priority | integer | Optional | 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… |
tag | string | Optional | 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 |
The result of a task submitted with dataforseo.x.business-data-trustpilot-search-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
This endpoint provides a list of business profiles listed on the Trustpilot platform. Body: a JSON array with exactly one task object, e.g. [{"keyword": "pizza restaurant", "depth": 20}]. Capped at depth 10. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | keyword required field the keyword you specify should indicate a business category or company name; you can specify up to 700 characters in the keyword filed; all %## will be decoded (plus character ‘+’ will be decoded… e.g. "pizza restaurant" |
priority | integer | Optional | 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… |
tag | string | Optional | 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 |
This endpoint will provide you with data on all citations in the target category for the indicated date range. Body: a JSON array with exactly one task object, e.g. [{"category_code": 10994, "search_mode": "as_is", "date_from": "2026-04-24", "date_group": "month"}]. $0.08 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
category_code | integer | Optional | target category code required field to obtain a full list of available categories, refer to the Categories endpoint e.g. 10994 |
page_type | array | Optional | target page types optional field use this parameter to filter the dataset by page types possible values: "ecommerce", "news", "blogs", "message-boards", "organization" |
search_mode | string | Optional | results grouping type optional field possible grouping types: as_is – returns data on all citations for the target category_code one_per_domain – returns data on one citation of the category_code per domain default… e.g. "as_is" |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: top_domains text_categories page_categories countries languages… |
date_from | string | Optional | starting date of the time range required field minimum value: 2022-10-31 date format: "yyyy-mm-dd" example: "2019-01-15" e.g. "2026-04-24" |
date_to | string | Optional | ending date of the time range optional field if you don’t specify this field, today’s date will be used by default date format: "yyyy-mm-dd" example: "2019-01-15" |
date_group | string | Optional | time range which will be used to group the results optional field default value: month possible values: day, week, month e.g. "month" |
initial_dataset_filters | array | Optional | initial dataset filtering parameters optional field initial filtering parameters that apply to fields in the Search endpoint; you can add several filters at once (8 filters maximum) you should set a logical operator… |
rank_scale | string | Optional | defines the scale used for calculating and displaying the rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: one_hundred — rank… |
tag | string | Optional | 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 |
This endpoint will provide you with data on all citations of the target keyword for the indicated date range. Body: a JSON array with exactly one task object, e.g. [{"keyword": "logitech", "search_mode": "as_is", "date_from": "2026-04-24", "date_group": "month"}]. $0.08 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | target keyword required field UTF-8 encoding the keywords will be converted to a lowercase format; Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example: "keyword":… e.g. "logitech" |
keyword_fields | object | Optional | target keyword fields and target keywords optional field use this parameter to filter the dataset by keywords that certain fields should contain; fields you can specify: title, main_title, previous_title, snippet you… |
page_type | array | Optional | target page types optional field use this parameter to filter the dataset by page types possible values: "ecommerce", "news", "blogs", "message-boards", "organization" |
search_mode | string | Optional | results grouping type optional field possible grouping types: as_is – returns data on all citations for the target keyword one_per_domain – returns data on one citation of the keyword per domain default value: as_is e.g. "as_is" |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: top_domains text_categories page_categories countries languages… |
date_from | string | Optional | starting date of the time range required field date format: "yyyy-mm-dd" example: "2019-01-15" e.g. "2026-04-24" |
date_to | string | Optional | ending date of the time range optional field if you don’t specify this field, today’s date will be used by default date format: "yyyy-mm-dd" example: "2019-01-15" |
date_group | string | Optional | time range which will be used to group the results optional field default value: month possible values: day, week, month e.g. "month" |
initial_dataset_filters | array | Optional | initial dataset filtering parameters optional field initial filtering parameters that apply to fields in the Search endpoint; you can add several filters at once (8 filters maximum); you should set a logical operator… |
rank_scale | string | Optional | defines the scale used for calculating and displaying the rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: one_hundred — rank… |
tag | string | Optional | 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 |
This endpoint will provide you with rating distribution data for the keyword and other parameters specified in the request. Body: a JSON array with exactly one task object, e.g. [{"keyword": "logitech", "search_mode": "as_is", "internal_list_limit": 10}]. $0.08 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | target keyword required field UTF-8 encoding the keywords will be converted to a lowercase format; Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example: "keyword":… e.g. "logitech" |
keyword_fields | object | Optional | target keyword fields and target keywords optional field use this parameter to filter the dataset by keywords that certain fields should contain; fields you can specify: title, main_title, previous_title, snippet you… |
page_type | array | Optional | target page types optional field use this parameter to filter the dataset by page types possible values: "ecommerce", "news", "blogs", "message-boards", "organization" |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: top_domains text_categories page_categories countries languages… e.g. 10 |
search_mode | string | Optional | results grouping type optional field possible grouping types: as_is – returns all citations for the target keyword one_per_domain – returns one citation of the keyword per domain default value: as_is e.g. "as_is" |
positive_connotation_threshold | number | Optional | positive connotation threshold optional field specified as the probability index threshold for positive sentiment related to the citation content if you specify this field, connotation_types object in the response will… |
sentiments_connotation_threshold | number | Optional | sentiment connotation threshold optional field specified as the probability index threshold for sentiment connotations related to the citation content if you specify this field, sentiment_connotations object in the… |
initial_dataset_filters | array | Optional | initial dataset filtering parameters optional field initial filtering parameters that apply to fields in the Search endpoint you can add several filters at once (8 filters maximum) you should set a logical operator… |
rank_scale | string | Optional | defines the scale used for calculating and displaying the rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: one_hundred — rank… |
tag | string | Optional | 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 |
This endpoint will provide you with detailed citation data available for the target keyword. Body: a JSON array with exactly one task object, e.g. [{"keyword_fields": {"snippet": "logitech"}, "keyword": "logitech", "page_type": ["ecommerce", "news", "blogs", "message-boards", "organization"], "search_mode". Capped at limit 50. $0.09 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | target keyword required field UTF-8 encoding the keywords will be converted to a lowercase format; Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example: "keyword":… e.g. "logitech" |
keyword_fields | object | Optional | target keyword fields and target keywords optional field use this parameter to filter the dataset by keywords that certain fields should contain; fields you can specify: title, main_title, previous_title, snippet you… e.g. {"snippet": "logitech"} |
page_type | array | Optional | target page types optional field use this parameter to filter the dataset by page types possible values: "ecommerce", "news", "blogs", "message-boards", "organization" e.g. ["ecommerce", "news", "blogs", "message-boards", "organizati |
search_mode | string | Optional | results grouping type optional field possible grouping types: as_is – returns all citations for the target keyword one_per_domain – returns one citation of the keyword per domain default value: as_is e.g. "as_is" |
filters | array | Optional | 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:… e.g. ["main_domain", "=", "reviewfinder.ca"] |
order_by | array | Optional | 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… e.g. ["content_info.sentiment_connotations.anger,desc"] |
offset | integer | Optional | offset in the results array of returned citations optional field default value: 0 if you specify the 10 value, the first ten citations in the results array will be omitted and the data will be provided for the… |
offset_token | string | Optional | offset token for subsequent requests optional field provided in the identical field of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;… |
rank_scale | string | Optional | defines the scale used for calculating and displaying the domain_rank, and url_rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible… |
tag | string | Optional | 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 |
This endpoint will provide you with sentiment analysis data for the citations available for the target keyword. Body: a JSON array with exactly one task object, e.g. [{"keyword": "logitech", "internal_list_limit": 1}]. $0.08 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | target keyword required field UTF-8 encoding the keywords will be converted to a lowercase format; Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example: "keyword":… e.g. "logitech" |
keyword_fields | object | Optional | target keyword fields and target keywords optional field use this parameter to filter the dataset by keywords that certain fields should contain; fields you can specify: title, main_title, previous_title, snippet you… |
page_type | array | Optional | target page types optional field use this parameter to filter the dataset by page types possible values: "ecommerce", "news", "blogs", "message-boards", "organization" |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: top_domains text_categories page_categories countries languages… e.g. 1 |
positive_connotation_threshold | number | Optional | positive connotation threshold optional field specified as the probability index threshold for positive sentiment related to the citation content if you specify this field, connotation_types object in the response will… |
sentiments_connotation_threshold | number | Optional | sentiment connotation threshold optional field specified as the probability index threshold for sentiment connotations related to the citation content if you specify this field, sentiment_connotations object in the… |
initial_dataset_filters | array | Optional | initial dataset filtering parameters optional field initial filtering parameters that apply to fields in the Search endpoint you can add several filters at once (8 filters maximum) you should set a logical operator… |
rank_scale | string | Optional | defines the scale used for calculating and displaying the rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: one_hundred — rank… |
tag | string | Optional | 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 |
This endpoint will provide you with an overview of citation data available for the target keyword. Body: a JSON array with exactly one task object, e.g. [{"keyword": "logitech", "page_type": ["ecommerce", "news", "blogs", "message-boards", "organization"], "internal_list_limit": 8, "positive_connotation_threshol. $0.08 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | target keyword required field UTF-8 encoding the keywords will be converted to a lowercase format; Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; example: "keyword":… e.g. "logitech" |
keyword_fields | object | Optional | target keyword fields and target keywords optional field use this parameter to filter the dataset by keywords that certain fields should contain; fields you can specify: title, main_title, previous_title, snippet you… |
page_type | array | Optional | target page types optional field use this parameter to filter the dataset by page types possible values: "ecommerce", "news", "blogs", "message-boards", "organization" e.g. ["ecommerce", "news", "blogs", "message-boards", "organizati |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: top_domains text_categories page_categories countries languages… e.g. 8 |
positive_connotation_threshold | number | Optional | positive connotation threshold optional field specified as the probability index threshold for positive sentiment related to the citation content if you specify this field, connotation_types object in the response will… e.g. 0.5 |
sentiments_connotation_threshold | number | Optional | sentiment connotation threshold optional field specified as the probability index threshold for sentiment connotations related to the citation content if you specify this field, sentiment_connotations object in the… |
initial_dataset_filters | array | Optional | initial dataset filtering parameters optional field initial filtering parameters that apply to fields in the Search endpoint you can add several filters at once (8 filters maximum) you should set a logical operator… |
rank_scale | string | Optional | defines the scale used for calculating and displaying the rank values optional field you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale possible values: one_hundred — rank… |
tag | string | Optional | 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 |
This endpoint will provide you with search volume values for a maximum of 1,000 keywords in one API request. Body: a JSON array with exactly one task object, e.g. [{"keywords": ["buy laptop", "cheap laptops for sale", "purchase laptop"], "location_code": 2840, "language_code": "en"}]. $0.04 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000; the keywords will be converted to lowercase format learn more about rules and limitations of keyword and… e.g. ["buy laptop", "cheap laptops for sale", "purchase laptop"] |
location_name | string | Optional | full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to… |
location_code | integer | Optional | location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to… e.g. 2840 |
language_name | string | Optional | full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to… |
language_code | string | Optional | language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to… e.g. "en" |
tag | string | Optional | 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 |
This endpoint will provide you with a list of products that intersect with a target asin in Amazon SERPs. Body: a JSON array with exactly one task object, e.g. [{"asin": "019005476X", "location_code": 2840, "language_code": "en"}]. Priced per row requested via limit (1-1000, default 100): $0.000419 per row, minimum $0.06. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000419 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
asin | string | Optional | product ID required field unique product identifier (ASIN) on Amazon; you can receive the asin parameter by making a separate request to the Amazon Products endpoint e.g. "019005476X" |
location_name | string | Optional | full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to… |
location_code | integer | Optional | location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to… e.g. 2840 |
language_name | string | Optional | full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the… |
language_code | string | Optional | language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the… e.g. "en" |
limit | integer | Optional | the maximum number of products in the results array optional field default value: 100; maximum value: 1000 |
filters | array | Optional | 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:… |
order_by | array | Optional | 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… |
offset | integer | Optional | offset in the results array of returned product competitors optional field default value: 0 if you specify the 10 value, the first ten product competitors in the results array will be omitted and the data will be… |
tag | string | Optional | 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 |
This endpoint will provide you with a list of keywords for which the target products intersect in Amazon SERP. Body: a JSON array with exactly one task object, e.g. [{"asins": {"1": "B09172433Z", "2": "B07GBZ4Q68", "3": "B07GCKQD77"}, "language_name": "English", "location_code": 2840}]. Priced per row requested via limit (1-1000, default 100): $0.000396 per row, minimum $0.036. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000396 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
asins | object | Optional | asins of target products required field product IDs of the products for which you need to find keyword intersections; specify the ASINs as in the following example: "asins": { "1": "019005476X", "2": "0190074442" } the… e.g. {"1": "B09172433Z", "2": "B07GBZ4Q68", "3": "B07GCKQD77"} |
location_name | string | Optional | full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to… |
location_code | integer | Optional | location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to… e.g. 2840 |
language_name | string | Optional | full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the… e.g. "English" |
language_code | string | Optional | language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the… |
limit | integer | Optional | the maximum number of products in the results array optional field default value: 100; maximum value: 1000 |
intersection_mode | string | Optional | mode for finding asin intersections optional field possible values: union, intersect; default value: intersect; learn more about the parameter in this help center guide |
filters | array | Optional | 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:… |
order_by | array | Optional | 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… |
offset | integer | Optional | offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive… |
tag | string | Optional | 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 |
This endpoint will provide you with ranking data from organic and paid Amazon SERPs for the target products. Body: a JSON array with exactly one task object, e.g. [{"asins": ["B001TJ3HUG", "B01LW2SL7R"], "language_name": "English", "location_code": 2840}]. $0.04 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
asins | array | Optional | product IDs to compare required field product IDs to receive ranking data for; the maximum number of ASINs you can specify in this array is 1000; you can receive the asin parameter by making a separate request to the… e.g. ["B001TJ3HUG", "B01LW2SL7R"] |
location_name | string | Optional | full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to… |
location_code | integer | Optional | location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to… e.g. 2840 |
language_name | string | Optional | full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the… e.g. "English" |
language_code | string | Optional | language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the… |
tag | string | Optional | 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 |
This endpoint will provide you with a list of keywords the target product ranks for on Amazon. Body: a JSON array with exactly one task object, e.g. [{"asin": "B00R92CL5E", "location_code": 2840, "language_code": "en"}]. Priced per row requested via limit (1-1000, default 100): $0.000406 per row, minimum $0.047. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000406 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
asin | string | Optional | product ID required field unique product identifier (ASIN) on Amazon; you can receive the asin parameter by making a separate request to the Amazon Products endpoint e.g. "B00R92CL5E" |
location_name | string | Optional | full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to… |
location_code | integer | Optional | location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to… e.g. 2840 |
language_name | string | Optional | full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the… |
language_code | string | Optional | language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the… e.g. "en" |
limit | integer | Optional | the maximum number of products in the results array optional field default value: 100; maximum value: 1000 |
ignore_synonyms | boolean | Optional | ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false |
filters | array | Optional | 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:… |
order_by | array | Optional | 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… |
offset | integer | Optional | offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive… |
tag | string | Optional | 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 |
The Related Keywords endpoint provides keywords appearing in the "Related Searches" section on Amazon. Body: a JSON array with exactly one task object, e.g. [{"keyword": "computer mouse", "language_name": "English", "location_code": 2840, "limit": 5, "include_seed_keyword": true}]. Capped at depth 10. Priced per row requested via limit (1-1000, default 100): $0.000396 per row, minimum $0.036. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000396 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | keyword required field UTF-8 encoding the keywords should be specified in the lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article e.g. "computer mouse" |
location_name | string | Optional | 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 their location_name… |
location_code | integer | Optional | location code 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 by making a… e.g. 2840 |
language_name | string | Optional | 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 locations with their language_name… e.g. "English" |
language_code | string | Optional | language code 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 locations with their language_code by making a… |
include_seed_keyword | boolean | Optional | include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false e.g. true |
ignore_synonyms | boolean | Optional | ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false |
limit | integer | Optional | the maximum number of returned keywords optional field default value: 100 maximum value: 1000 e.g. 5 |
offset | integer | Optional | offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive… |
tag | string | Optional | 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 |
This endpoint will provide you with a list of mobile applications that intersect with the target app for its ranking keywords on App Store. Body: a JSON array with exactly one task object, e.g. [{"app_id": "686449807", "language_name": "English", "location_code": 2840, "limit": 10}]. Priced per row requested via limit (1-1000, default 100): $0.000396 per row, minimum $0.036. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000396 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
app_id | string | Optional | id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320 e.g. "686449807" |
location_name | string | Optional | 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 their location_name… |
location_code | integer | Optional | location code 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 by making a… e.g. 2840 |
language_name | string | Optional | 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… e.g. "English" |
language_code | string | Optional | language code 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 by making a… |
filters | array | Optional | 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: , >=,… |
order_by | array | Optional | 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… |
limit | integer | Optional | the maximum number of returned apps optional field default value: 100 maximum value: 1000 e.g. 10 |
offset | integer | Optional | offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords |
tag | string | Optional | 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 |
This endpoint will provide you with a list of keywords for which the mobile applications specified in the app_ids object rank within the same App Store SERP. Body: a JSON array with exactly one task object, e.g. [{"app_ids": {"1": "686449807", "2": "382617920"}, "language_name": "English", "location_code": 2840, "limit": 10}]. Priced per row requested via limit (1-1000, default 100): $0.000396 per row, minimum $0.036. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000396 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
app_ids | object | Optional | ids of the target apps required field IDs of the target mobile applications on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320… e.g. {"1": "686449807", "2": "382617920"} |
location_name | string | Optional | 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 their location_name… |
location_code | integer | Optional | location code 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 by making a… e.g. 2840 |
language_name | string | Optional | 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… e.g. "English" |
language_code | string | Optional | language code 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 by making a… |
filters | array | Optional | 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: , >=,… |
order_by | array | Optional | 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… |
limit | integer | Optional | the maximum number of returned keywords optional field default value: 100 maximum value: 1000 e.g. 10 |
offset | integer | Optional | offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive… |
tag | string | Optional | 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 |
This endpoint will provide you with ranking metrics for up to 1000 App Store applications. Body: a JSON array with exactly one task object, e.g. [{"app_ids": ["686449807", "382617920"], "language_name": "English", "location_code": 2840}]. $0.04 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
app_ids | array | Optional | ids of the apps required field IDs of mobile applications on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is… e.g. ["686449807", "382617920"] |
location_name | string | Optional | 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 their location_name… |
location_code | integer | Optional | location code 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 by making a… e.g. 2840 |
language_name | string | Optional | 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… e.g. "English" |
language_code | string | Optional | language code 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 by making a… |
tag | string | Optional | 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 |
This endpoint will provide you with a list of keywords for which the target app ranks on App Store. Body: a JSON array with exactly one task object, e.g. [{"app_id": "686449807", "language_name": "English", "location_code": 2840, "limit": 10}]. Priced per row requested via limit (1-1000, default 100): $0.000396 per row, minimum $0.036. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000396 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
app_id | string | Optional | id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320 e.g. "686449807" |
location_name | string | Optional | full name of the location; one of location_name | location_code is required (a body with neither returns 40501). This App Store route supports only United States: send location_code 2840 (or location_name "United… |
location_code | integer | Optional | location code; one of location_code | location_name is required (a body with neither returns 40501). This App Store route supports only United States (2840); any other location returns 40501 Invalid Field. e.g. 2840 |
language_name | string | Optional | full name of the language; one of language_name | language_code is required. This App Store route supports only English; any other language returns 40501 Invalid Field. e.g. "English" |
language_code | string | Optional | language code; one of language_code | language_name is required. This App Store route supports only English (en); any other language returns 40501 Invalid Field. |
filters | array | Optional | 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: , >=,… |
order_by | array | Optional | 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… |
limit | integer | Optional | the maximum number of returned keywords optional field default value: 100 maximum value: 1000 e.g. 10 |
offset | integer | Optional | offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive… |
tag | string | Optional | 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 |
This endpoint will provide you with a list of mobile applications that intersect with the target app for its ranking keywords on Google Play. Body: a JSON array with exactly one task object, e.g. [{"app_id": "org.telegram.messenger", "language_name": "English", "location_code": 2840, "limit": 10}]. Priced per row requested via limit (1-1000, default 100): $0.000396 per row, minimum $0.036. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000396 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
app_id | string | Optional | id of the app required field ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL… e.g. "org.telegram.messenger" |
location_name | string | Optional | 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 their location_name… |
location_code | integer | Optional | location code 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 by making a… e.g. 2840 |
language_name | string | Optional | 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… e.g. "English" |
language_code | string | Optional | language code 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 by making a… |
filters | array | Optional | 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: , >=,… |
order_by | array | Optional | 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… |
limit | integer | Optional | the maximum number of returned apps optional field default value: 100 maximum value: 1000 e.g. 10 |
offset | integer | Optional | offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords |
tag | string | Optional | 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 |
This endpoint will provide you with a list of keywords for which the mobile applications specified in the app_ids object rank within the same Google Play SERP. Body: a JSON array with exactly one task object, e.g. [{"app_ids": {"1": "org.telegram.messenger", "2": "com.zhiliaoapp.musically"}, "language_name": "English", "location_code": 2840, "limit": 10}]. Priced per row requested via limit (1-1000, default 100): $0.000396 per row, minimum $0.036. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000396 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
app_ids | object | Optional | ids of the target apps required field IDs of the target mobile applications on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL… e.g. {"1": "org.telegram.messenger", "2": "com.zhiliaoapp.musical |
location_name | string | Optional | 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 their location_name… |
location_code | integer | Optional | location code 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 by making a… e.g. 2840 |
language_name | string | Optional | 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… e.g. "English" |
language_code | string | Optional | language code 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 by making a… |
filters | array | Optional | 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: , >=,… |
order_by | array | Optional | 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… |
limit | integer | Optional | the maximum number of returned keywords optional field default value: 100 maximum value: 1000 e.g. 10 |
offset | integer | Optional | offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive… |
tag | string | Optional | 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 |
By calling this endpoint, you will find obtain a list of dates available for setting in the first_date and second_date fields of the Domain Metrics by Categories endpoint. $0.001 per call.
This endpoint will provide you with ranking metrics for up to 1000 Google Play applications. Body: a JSON array with exactly one task object, e.g. [{"app_ids": ["org.telegram.messenger", "com.zhiliaoapp.musically"], "language_name": "English", "location_code": 2840}]. $0.04 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
app_ids | array | Optional | ids of the app required field IDs of the mobile applications on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL… e.g. ["org.telegram.messenger", "com.zhiliaoapp.musically"] |
location_name | string | Optional | 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 their location_name… |
location_code | integer | Optional | location code 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 by making a… e.g. 2840 |
language_name | string | Optional | 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… e.g. "English" |
language_code | string | Optional | language code 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 by making a… |
tag | string | Optional | 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 |
This endpoint will provide you with the Keyword Difficulty metric for a maximum of 1,000 keywords in one API request. Body: a JSON array with exactly one task object, e.g. [{"location_code": 2840, "language_code": "en", "keywords": ["dentist new york", "pizza brooklyn", "car dealer los angeles"]}]. $0.04 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000 the keywords will be converted to lowercase format learn more about rules and limitations of keyword and… e.g. ["dentist new york", "pizza brooklyn", "car dealer los angel |
location_name | string | Optional | full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to the… |
location_code | integer | Optional | location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to the… e.g. 2840 |
language_name | string | Optional | full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the… |
language_code | string | Optional | language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the… e.g. "en" |
tag | string | Optional | 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 |
This endpoint will provide you with estimated monthly traffic volumes for up to 1,000 domains, subdomains, or webpages. Body: a JSON array with exactly one task object, e.g. [{"targets": ["dataforseo.com", "cnn.com", "forbes.com"], "location_code": 2840, "language_code": "en", "item_types": ["organic", "paid"]}]. $0.04 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
targets | array | Optional | target domains, subdomains, and webpages required field you can specify domains, subdomains, and webpages in this field; domains and subdomains should be specified without https:// and www.; pages should be specified… e.g. ["dataforseo.com", "cnn.com", "forbes.com"] |
location_name | string | Optional | full name of the location if you use this field, you don’t have to specify location_code you can receive the list of available locations with their location_name by making a separate request to the… |
location_code | integer | Optional | location code if you use this field, you don’t have to specify location_name you can receive the list of available locations with their location_code by making a separate request to the… e.g. 2840 |
language_name | string | Optional | full name of the language if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the… |
language_code | string | Optional | language code if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the… e.g. "en" |
item_types | array | Optional | display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from organic, the results will be ordered… e.g. ["organic", "paid"] |
ignore_synonyms | boolean | Optional | ignore highly similar keywords optional field if set to true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false |
tag | string | Optional | 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 |
This endpoint will provide you with Google product or service categories that include keywords the domain ranks for in search. Body: a JSON array with exactly one task object, e.g. [{"target": "dataforseo.com", "language_code": "en", "location_name": "United States", "item_types": ["paid", "organic", "featured_snippet", "local_pack"], "lim. Priced per row requested via limit (1-1000, default 100): $0.000396 per row, minimum $0.036. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000396 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Optional | domain or subdomain required field the domain or subdomain name of the target website the domain or subdomain should be specified without https:// and www. e.g. "dataforseo.com" |
location_name | string | Optional | 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 their location_name… e.g. "United States" |
location_code | integer | Optional | location code 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 by making a… |
language_name | string | Optional | 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… |
language_code | string | Optional | language code 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 by making a… e.g. "en" |
include_subcategories | boolean | Optional | indicates if the subcategories will be included in the search optional field if set to false, the subcategories will be ignored default value: false learn more about the parameter in this help center article |
include_clickstream_data | boolean | Optional | include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution… |
historical_serp_mode | string | Optional | data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return metrics for SERPs in which the specified target currently has ranking results; lost — return… |
item_types | array | Optional | display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from the organic object, the results will… e.g. ["paid", "organic", "featured_snippet", "local_pack"] |
filters | array | Optional | 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:… |
order_by | array | Optional | 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… |
limit | integer | Optional | the maximum number of returned categories optional field default value: 100 maximum value: 1000 e.g. 3 |
offset | integer | Optional | offset in the results array of returned categories optional field default value: 0 if you specify the 10 value, the first ten categories in the results array will be omitted and the data will be provided for the… |
tag | string | Optional | 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 |
This endpoint will provide you with Google product and service categories related for each specified keyword. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "keywords": ["dentist new york", "pizza brooklyn", "car dealer los angeles"]}]. $0.04 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000 the keywords will be converted to lowercase format learn more about rules and limitations of keyword and… e.g. ["dentist new york", "pizza brooklyn", "car dealer los angel |
language_name | string | Optional | full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the… |
language_code | string | Optional | language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the… e.g. "en" |
tag | string | Optional | 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 |
This endpoint will provide you with a full overview of ranking and traffic data of the competitor domains from organic and paid search. Body: a JSON array with exactly one task object, e.g. [{"target": "newmouth.com", "intersecting_domains": ["dentaly.org", "health.com", "trysnow.com"], "language_name": "English", "location_code": 2840, "limit": 3}. Priced per row requested via limit (1-1000, default 100): $0.000396 per row, minimum $0.036. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000396 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Optional | domain required field the domain name of the target website the domain should be specified without https:// and www. you can specify page URL, but the results will be specific to the domain in the specified URL e.g. "newmouth.com" |
location_name | string | Optional | 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 their location_name… |
location_code | integer | Optional | location code 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 by making a… e.g. 2840 |
language_name | string | Optional | 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… e.g. "English" |
language_code | string | Optional | language code 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 by making a… |
item_types | array | Optional | display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from organic, the results will be ordered… |
include_clickstream_data | boolean | Optional | include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution… |
filters | array | Optional | 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:… |
order_by | array | Optional | 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… |
limit | integer | Optional | the maximum number of returned domains optional field default value: 100 maximum value: 1000 e.g. 3 |
offset | integer | Optional | offset in the results array of returned domains optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive… |
max_rank_group | integer | Optional | maximum rank up to which competitors will be considered optional field default value: 100 if you specify 10 here, we will extract competitors from the top 10 Google search results only |
exclude_top_domains | boolean | Optional | indicates whether to exclude world’s largest websites optional field default value: false set to true if you want to get highly-relevant competitors excluding the websites listed below: wikipedia.org pinterest.com… |
exclude_domains | array | Optional | exclude domains from the results optional field use this parameter to exclude specific domains from the results Note: you can specify up to 1000 domains in this array example: "exclude_domains": [ "reddit.com",… |
intersecting_domains | array | Optional | additional domains for improving results accuracy optional field to improve the accuracy of the result, you can specify domains that are known to intersect with the target in SERPs; if you use this array, metrics in… e.g. ["dentaly.org", "health.com", "trysnow.com"] |
ignore_synonyms | boolean | Optional | ignore highly similar keywords optional field if set to true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false |
tag | string | Optional | 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 |
This endpoint will provide you with the keywords for which both specified domains rank within the same SERP. Body: a JSON array with exactly one task object, e.g. [{"target1": "mom.com", "target2": "quora.com", "language_code": "en", "location_code": 2840, "include_serp_info": true, "limit": 3}]. Priced per row requested via limit (1-1000, default 100): $0.000396 per row, minimum $0.036. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000396 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
target1 | string | Optional | domain required field the domain name of the first target website the domain should be specified without https:// and www. e.g. "mom.com" |
target2 | string | Optional | domain required field the domain name of the second target website the domain should be specified without https:// and www. e.g. "quora.com" |
location_name | string | Optional | 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 their location_name… |
location_code | integer | Optional | location code 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 by making a… e.g. 2840 |
language_name | string | Optional | 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… |
language_code | string | Optional | language code 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 by making a… e.g. "en" |
intersections | boolean | Optional | domain intersections in SERP optional field if you set intersections to true, you will get the keywords for which both target domains specified as target1 and target2 have results within the same SERP; the… |
item_types | array | Optional | 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"] |
include_serp_info | boolean | Optional | include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response… e.g. true |
include_clickstream_data | boolean | Optional | include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, clickstream_etv, keyword_info_normalized_with_clickstream,… |
limit | integer | Optional | the maximum number of returned keywords optional field default value: 100 maximum value: 1000 e.g. 3 |
offset | integer | Optional | offset in the items array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive… |
filters | array | Optional | 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:… |
order_by | array | Optional | 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… |
tag | string | Optional | 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 |
This endpoint will provide you with dynamics of change in metrics of domains relevant to the specified product and service categories. Body: a JSON array with exactly one task object, e.g. [{"location_code": 2840, "language_code": "en", "category_codes": ["13418", "11494"], "first_date": "2026-04-24", "second_date": "2026-06-24", "limit": 3}]. Priced per row requested via limit (1-1000, default 100): $0.00073 per row, minimum $0.37. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.00073 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
category_codes | array | Optional | product and service categories required field The maximum number of categories you can specify: 5 you can download the full list of possible categories e.g. ["13418", "11494"] |
first_date | string | Optional | first date of comparison period required field first date for which domain metrics will be provided; date format: "yyyy-mm-dd"; example: "2021-06-01"; the list available dates is available through the available history… e.g. "2026-04-24" |
second_date | string | Optional | second date of comparison period required field second date for which domain metrics will be provided; date format: "yyyy-mm-dd"; example: "2021-10-01"; the list available dates is available through the available… e.g. "2026-06-24" |
location_name | string | Optional | 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 their… |
location_code | integer | Optional | 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… e.g. 2840 |
language_name | string | Optional | 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_code | string | Optional | 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… e.g. "en" |
item_types | array | Optional | display results by item type optional field indicates the type of search results included in the response; Note: if the item_types array contains item types that are different from the organic object, the results will… |
top_categories_count | integer | Optional | number of additional domain categories optional field by using this parameter, you can receive domains relevant to additional categories that are not specified in category_codes above; to learn more about the… |
include_subdomains | boolean | Optional | return subdomains in the API response optional field if false, the API response will contain main_domain only; if true, the API will return main_domain plus its subdomains (if available); default value: true |
etv_min | integer | Optional | minimum current organic ETV of the domain optional field if specified, the API will return only domains with organic_etv greater than the specified value |
etv_max | integer | Optional | maximum current organic ETV of the domain optional field if specified, the API will return only domains with organic_etv lesser than the specified value |
correlate | boolean | Optional | correlate data with previously obtained datasets optional field default value: true; if you use this parameter, our system will correlate data you obtain now with previously obtained datasets; this parameter is… |
limit | integer | Optional | the maximum number of domains in the results array optional field default value: 100; maximum value: 1000 e.g. 3 |
offset | integer | Optional | 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… |
filters | array | Optional | 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:… |
order_by | array | Optional | results sorting rules optional field you can use the same values as in the filters array to sort the results; default rule: ["organic_etv,desc"]; possible sorting types: asc – results will be sorted in ascending order… |
tag | string | Optional | 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… |
This endpoint will provide you with ranking and traffic data from organic and paid search for the specified domain. Body: a JSON array with exactly one task object, e.g. [{"target": "dataforseo.com", "language_name": "English", "location_code": 2840}]. Priced per row requested via limit (1-1000, default 100): $0.000396 per row, minimum $0.037. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000396 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Optional | domain required field the domain name of the target website the domain should be specified without https:// and www. e.g. "dataforseo.com" |
location_name | string | Optional | full name of the location optional field if you use this field, you don’t need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the… |
location_code | integer | Optional | location code optional field if you use this field, you don’t need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the… e.g. 2840 |
language_name | string | Optional | full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the… e.g. "English" |
language_code | string | Optional | language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the… |
ignore_synonyms | boolean | Optional | ignore highly similar keywords optional field if set to true, all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of… |
limit | integer | Optional | the maximum number of returned results for domain optional field default value: 100 maximum value: 1000 |
offset | integer | Optional | offset in the results array of returned items optional field default value: 0 if you specify the 10 value, the first ten items in the results array will be omitted and the data will be provided for the successive items |
tag | string | Optional | 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 |
This endpoint will provide you with historical monthly traffic volumes for up to 1,000 domains collected within the specified time range through October 2020. Body: a JSON array with exactly one task object, e.g. [{"targets": ["dataforseo.com", "cnn.com", "forbes.com"], "location_code": 2840, "language_code": "en", "date_from": "2026-04-24", "date_to": "2026-06-24", "ite. $0.38 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
targets | array | Optional | target domains and subdomains required field you can specify domains and subdomains in this field; domains and subdomains should be specified without https:// and www.; you can set up to 1000 domains or subdomains e.g. ["dataforseo.com", "cnn.com", "forbes.com"] |
location_name | string | Optional | full name of the location if you use this field, you don’t have to specify location_code you can receive the list of available locations with their location_name by making a separate request to the… |
location_code | integer | Optional | location code if you use this field, you don’t have to specify location_name you can receive the list of available locations with their location_code by making a separate request to the… e.g. 2840 |
language_name | string | Optional | full name of the language if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the… |
language_code | string | Optional | language code if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the… e.g. "en" |
date_from | string | Optional | starting date of the time range optional field if you don’t specify this field, the data will be provided for the previous 12 months minimal possible value: 2020-10-01 date format: "yyyy-mm-dd" e.g. "2026-04-24" |
date_to | string | Optional | ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default; date format: "yyyy-mm-dd" example: "2021-04-01" e.g. "2026-06-24" |
ignore_synonyms | boolean | Optional | ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false |
item_types | array | Optional | display results by item type optional field indicates the type of search results included in the response; Note: if the item_types array contains item types that are different from organic, the results will be ordered… e.g. ["organic", "paid"] |
tag | string | Optional | 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 |
This endpoint provides Google historical keyword data for specified keywords, including search volume, cost-per-click, competition values for paid search, monthly searches, and search volume trends. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "keywords": ["iphone"]}]. $0.04 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | keywords required field The maximum number of keywords you can specify: 700 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the specified keywords will be… e.g. ["iphone"] |
location_name | string | Optional | 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 their location_name… |
location_code | integer | Optional | location code 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 by making a… e.g. 2840 |
language_name | string | Optional | 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 locations with their language_name… |
language_code | string | Optional | language code 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 locations with their language_code by making a… e.g. "en" |
tag | string | Optional | 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 |
This endpoint will provide you with historical data on rankings and traffic of the specified domain, such as domain ranking distribution in SERPs and estimated monthly traffic volume for both organic and paid results. Body: a JSON array with exactly one task object, e.g. [{"target": "dataforseo.com", "location_code": 2840, "language_code": "en", "date_from": "2026-04-24", "date_to": "2026-06-24"}]. $0.45 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Optional | domain required field the domain name of the target website the domain should be specified without https:// and www. e.g. "dataforseo.com" |
location_name | string | Optional | 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 their location_name… |
location_code | integer | Optional | location code 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 by making a… e.g. 2840 |
language_name | string | Optional | 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 locations with their language_name… |
language_code | string | Optional | language code 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 locations with their language_code by making a… e.g. "en" |
date_from | string | Optional | starting date of the time range optional field if you don’t specify this field, the data will be provided for the previous 6 months minimal possible value: 2020-10-01 date format: "yyyy-mm-dd" e.g. "2026-04-24" |
date_to | string | Optional | ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default date format: "yyyy-mm-dd" example: "2021-04-01" e.g. "2026-06-24" |
correlate | boolean | Optional | correlate data with previously obtained datasets optional field default value: true if you use this parameter, our system will correlate data you obtain now with previously obtained datasets this parameter is intended… |
ignore_synonyms | boolean | Optional | ignore highly similar keywords optional field if set to true, only data based on core keywords will be returned, data for all highly similar keywords will be excluded; default value: false |
include_clickstream_data | boolean | Optional | include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution… |
tag | string | Optional | 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 |
This endpoint will provide you with Google SERPs collected within the specified time frame. Body: a JSON array with exactly one task object, e.g. [{"keyword": "albert einstein", "location_code": 2840, "language_code": "en", "date_from": "2026-04-24", "date_to": "2026-06-24"}]. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | 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… e.g. "albert einstein" |
date_from | string | Optional | starting date of the time range optional field if you don’t specify this field, the API will return all SERPs collected for 365 days starting from the current datetime value; minimal possible value: 365 days from the… e.g. "2026-04-24" |
date_to | string | Optional | ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default; date format: "yyyy-mm-dd"; example: "2021-09-01" e.g. "2026-06-24" |
location_name | string | Optional | 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 their location_name… |
location_code | integer | Optional | 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… e.g. 2840 |
language_name | string | Optional | 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… |
language_code | string | Optional | 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… e.g. "en" |
tag | string | Optional | 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 |
The Keyword Ideas endpoint provides search terms that are relevant to the product or service categories of the specified keywords. Body: a JSON array with exactly one task object, e.g. [{"keywords": ["phone", "watch"], "location_code": 2840, "language_code": "en", "include_serp_info": true, "limit": 3}]. Priced per row requested via limit (1-1000, default 100): $0.000396 per row, minimum $0.036. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000396 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | keywords required field UTF-8 encoding The maximum number of keywords you can specify: 200. The keywords will be converted to lowercase format learn more about rules and limitations of keyword and keywords fields in… e.g. ["phone", "watch"] |
location_name | string | Optional | 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 their location_name… |
location_code | integer | Optional | 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… e.g. 2840 |
language_name | string | Optional | full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the… |
language_code | string | Optional | language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the… e.g. "en" |
closely_variants | boolean | Optional | search mode optional field if set to true the results will be based on the phrase-match search algorithm if set to false the results will be based on the broad-match search algorithm default value: false |
ignore_synonyms | boolean | Optional | ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false |
include_serp_info | boolean | Optional | include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response… e.g. true |
include_clickstream_data | boolean | Optional | include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and… |
limit | integer | Optional | the maximum number of keywords in the results array optional field default value: 700 maximum value: 1000 e.g. 3 |
offset | integer | Optional | offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive… |
offset_token | string | Optional | offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;… |
filters | array | Optional | 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:… |
order_by | array | Optional | 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… |
tag | string | Optional | 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 |
This endpoint provides Google keyword data for specified keywords. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "include_clickstream_data": true, "include_serp_info": true, "keywords": ["iphone"]}]. $0.08 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | keywords required field The maximum number of keywords you can specify: 700 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the specified keywords will be… e.g. ["iphone"] |
location_name | string | Optional | 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 their location_name… |
location_code | integer | Optional | location code 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 by making a… e.g. 2840 |
language_name | string | Optional | 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 locations with their language_name… |
language_code | string | Optional | language code 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 locations with their language_code by making a… e.g. "en" |
include_serp_info | boolean | Optional | include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response… e.g. true |
include_clickstream_data | boolean | Optional | include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and… e.g. true |
tag | string | Optional | 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 |
The Keyword Suggestions endpoint provides search queries that include the specified seed keyword. Body: a JSON array with exactly one task object, e.g. [{"keyword": "phone", "location_code": 2840, "language_code": "en", "include_serp_info": true, "include_seed_keyword": true, "limit": 1}]. Priced per row requested via limit (1-1000, default 100): $0.000396 per row, minimum $0.036. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000396 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | keyword required field UTF-8 encoding the keywords will be converted to lowercase format; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article e.g. "phone" |
location_name | string | Optional | full name of the location optional field if you use this field, you don’t need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the… |
location_code | integer | Optional | location code optional field if you use this field, you don’t need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the… e.g. 2840 |
language_name | string | Optional | full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the… |
language_code | string | Optional | language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the… e.g. "en" |
include_seed_keyword | boolean | Optional | include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false e.g. true |
include_serp_info | boolean | Optional | include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response… e.g. true |
include_clickstream_data | boolean | Optional | include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and… |
exact_match | boolean | Optional | search for the exact phrase optional field if set to true, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase default value: false |
ignore_synonyms | boolean | Optional | ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false |
filters | array | Optional | 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:… |
order_by | array | Optional | 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… |
limit | integer | Optional | the maximum number of returned keywords optional field default value: 100 maximum value: 1000 e.g. 1 |
offset | integer | Optional | offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive… |
offset_token | string | Optional | offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;… |
tag | string | Optional | 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 |
This endpoint will provide you with a list of keywords for which the target app ranks on Google Play. Body: a JSON array with exactly one task object, e.g. [{"app_id": "org.telegram.messenger", "language_name": "English", "location_code": 2840, "limit": 10}]. Priced per row requested via limit (1-1000, default 100): $0.000396 per row, minimum $0.036. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000396 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
app_id | string | Optional | id of the apps required field ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL… e.g. "org.telegram.messenger" |
location_name | string | Optional | full name of the location; one of location_name | location_code is required (a body with neither returns 40501). This Google Play route supports only United States: send location_code 2840 (or location_name "United… |
location_code | integer | Optional | location code; one of location_code | location_name is required (a body with neither returns 40501). This Google Play route supports only United States (2840); any other location returns 40501 Invalid Field. e.g. 2840 |
language_name | string | Optional | full name of the language; one of language_name | language_code is required. This Google Play route supports only English; any other language returns 40501 Invalid Field. e.g. "English" |
language_code | string | Optional | language code; one of language_code | language_name is required. This Google Play route supports only English (en); any other language returns 40501 Invalid Field. |
filters | array | Optional | 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: , >=,… |
order_by | array | Optional | 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… |
limit | integer | Optional | the maximum number of returned keywords optional field default value: 100 maximum value: 1000 e.g. 10 |
offset | integer | Optional | offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive… |
tag | string | Optional | 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 |
This endpoint will provide you with a list of keywords relevant to the specified product categories. Body: a JSON array with exactly one task object, e.g. [{"category_codes": ["12191", "12193"], "language_name": "English", "location_code": 2840, "include_serp_info": true, "limit": 3}]. Priced per row requested via limit (1-1000, default 100): $0.000396 per row, minimum $0.036. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000396 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
category_codes | array | Optional | product and service categories required field The maximum number of categories you can specify: 20 you can download the full list of possible categories e.g. ["12191", "12193"] |
location_name | string | Optional | 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 their location_name… |
location_code | integer | Optional | 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… e.g. 2840 |
language_name | string | Optional | 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… e.g. "English" |
language_code | string | Optional | 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… |
category_intersection | boolean | Optional | category intersections optional field if set to true, you will get keywords featured in all specified categories; if set to false, you will keywords that are specified in any of the specified categories; default value:… |
include_serp_info | boolean | Optional | include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response… e.g. true |
include_clickstream_data | boolean | Optional | include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and… |
ignore_synonyms | boolean | Optional | ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false |
limit | integer | Optional | the maximum number of keywords in the results array optional field default value: 100 maximum value: 1000 e.g. 3 |
offset | integer | Optional | offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive… |
offset_token | string | Optional | offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;… |
filters | array | Optional | 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:… |
order_by | array | Optional | 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… |
tag | string | Optional | 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 |
The Keywords For Site endpoint will provide you with a list of keywords relevant to the target domain. Body: a JSON array with exactly one task object, e.g. [{"target": "apple.com", "language_code": "en", "location_code": 2840, "include_serp_info": true, "include_subdomains": true, "filters": ["serp_info.se_results_. Priced per row requested via limit (1-1000, default 100): $0.000396 per row, minimum $0.036. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000396 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Optional | target domain required field the domain name of the target website the domain should be specified without https:// e.g. "apple.com" |
location_name | string | Optional | 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 their location_name… |
location_code | integer | Optional | 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… e.g. 2840 |
language_name | string | Optional | full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the… |
language_code | string | Optional | language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the… e.g. "en" |
include_serp_info | boolean | Optional | include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response… e.g. true |
include_subdomains | boolean | Optional | indicates if the subdomains will be included in the search optional field if set to false, the subdomains will be ignored default value: true e.g. true |
include_clickstream_data | boolean | Optional | include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and… |
limit | integer | Optional | the maximum number of keywords in the results array optional field default value: 100 maximum value: 1000 e.g. 3 |
offset | integer | Optional | offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive… |
offset_token | string | Optional | offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;… |
filters | array | Optional | 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:… e.g. ["serp_info.se_results_count", ">", 0] |
order_by | array | Optional | 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… |
tag | string | Optional | 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 |
This endpoint will provide you with the keywords for which specified pages rank within the same SERP. Body: a JSON array with exactly one task object, e.g. [{"pages": {"1": "https://forbes.com", "2": "https://cnn.com/*"}, "language_name": "English", "location_code": 2840, "include_serp_info": true, "limit": 3}]. Priced per row requested via limit (1-1000, default 100): $0.000396 per row, minimum $0.036. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000396 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
pages | object | Optional | target URLs of pages required field you can set up to 20 pages in this object the pages should be specified with absolute URLs (including http:// or https://) example: "pages": { "1":"https://www.apple.com/mac/*",… e.g. {"1": "https://forbes.com", "2": "https://cnn.com/*"} |
exclude_pages | array | Optional | URLs of pages you want to exclude optional field you can set up to 10 pages in this array if you use this array, results will contain the keywords for which URLs from the pages object rank, but URLs from exclude_pages… |
location_name | string | Optional | 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 their location_name… |
location_code | integer | Optional | location code 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 by making a… e.g. 2840 |
language_name | string | Optional | 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… e.g. "English" |
language_code | string | Optional | language code 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 by making a… |
item_types | array | Optional | 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"] |
limit | integer | Optional | the maximum number of returned keywords optional field default value: 100 maximum value: 1000 e.g. 3 |
offset | integer | Optional | offset in the items array of returned keywords optional field default value: 0 if you specify 10 here, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords |
include_subdomains | boolean | Optional | indicates if the subdomains will be included in the search optional field if set to false, the subdomains will be ignored default value: true |
intersection_mode | string | Optional | indicates whether to intersect keywords optional field use this field to intersect or merge results for the specified URLs possible values: union, intersect union – results are based on all keywords any URL from pages… |
include_serp_info | boolean | Optional | include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response… e.g. true |
include_clickstream_data | boolean | Optional | include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, clickstream_etv, keyword_info_normalized_with_clickstream,… |
ignore_synonyms | boolean | Optional | ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false |
filters | array | Optional | 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:… |
order_by | array | Optional | 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… |
tag | string | Optional | 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 |
Keywords a domain or URL ranks for in Google, with position, volume and SERP element Body: a JSON array with exactly one task object, e.g. [{"target": "moz.com", "location_code": 2840, "language_code": "en", "limit": 2}]. Priced per row requested via limit (1-1000, default 100): $0.000395 per row, minimum $0.036. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000395 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Required | domain without scheme or www, or a full page URL e.g. "moz.com" |
location_code | integer | Required | one of location_code | location_name; codes from the Labs locations list (GET /v3/dataforseo_labs/locations_and_languages, free). 2840 = United States. 2076 is Brazil (not Morocco); Morocco is 2504 e.g. 2840 |
language_code | string | Required | one of language_code | language_name; must be a language available for that location (pair from GET /v3/dataforseo_labs/locations_and_languages, free). Invalid Field language_code usually means an unsupported pair —… e.g. "en" |
limit | integer | Optional | 1-1000; default 100 e.g. 2 |
offset | integer | Optional | default 0 |
item_types | array | Optional | SERP element types to count as ranking, e.g. ["organic","paid","featured_snippet"] |
historical_serp_mode | string | Optional | live (default) | lost | all |
load_rank_absolute | boolean | Optional | include absolute SERP position; default false |
filters | array | Optional | max 8 conditions |
order_by | array | Optional | max 3 rules. Flat array of comma-separated "field,direction" strings (asc or desc). Field names match filters. Nested [["field","desc"]] (the filters-array shape) returns 40501 Invalid Field: 'order_by'. e.g. ["keyword_data.keyword_info.search_volume,desc"] |
Related keyword ideas from Google's related-searches graph, with volume, CPC, difficulty Body: a JSON array with exactly one task object, e.g. [{"keyword": "coffee", "location_code": 2840, "language_code": "en", "depth": 1, "limit": 2}]. Capped at depth 10. Priced per row requested via limit (1-1000, default 100): $0.000395 per row, minimum $0.036. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000395 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Required | seed keyword, lowercased by the API e.g. "coffee" |
location_code | integer | Required | one of location_code | location_name; codes from the Labs locations list (GET /v3/dataforseo_labs/locations_and_languages, free). 2840 = United States e.g. 2840 |
language_code | string | Required | one of language_code | language_name; must be a language Labs supports for that location (pairs from GET /v3/dataforseo_labs/locations_and_languages, free). An unsupported pair returns 40501 Invalid Field, e.g. Mexico… e.g. "en" |
limit | integer | Optional | 1-1000; default 100 e.g. 2 |
offset | integer | Optional | default 0 |
include_seed_keyword | boolean | Optional | default false |
include_serp_info | boolean | Optional | attach SERP data per keyword; default false |
include_clickstream_data | boolean | Optional | DOUBLES the cost; default false |
ignore_synonyms | boolean | Optional | drop near-duplicate keywords; default false |
GoogleRelevantPagesLive Body: a JSON array with exactly one task object, e.g. [{"target": "amazon.com", "language_name": "English", "location_code": 2840, "filters": [["metrics.organic.pos_1", "<>", 0], "or", ["metrics.organic.pos_2_3", ". Priced per row requested via limit (1-1000, default 100): $0.000396 per row, minimum $0.036. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000396 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Optional | domain required field the domain name of the target website the domain should be specified without https:// and www. e.g. "amazon.com" |
location_name | string | Optional | full name of the location optional field if you use this field, you don’t need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the… |
location_code | integer | Optional | location code optional field if you use this field, you don’t need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the… e.g. 2840 |
language_name | string | Optional | full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the… e.g. "English" |
language_code | string | Optional | language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the… |
item_types | array | Optional | display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from organic, the results will be ordered… |
include_clickstream_data | boolean | Optional | include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution… |
limit | integer | Optional | the maximum number of returned pages optional field default value: 100 maximum value: 1000 e.g. 3 |
offset | integer | Optional | offset in the results array of returned pages optional field default value: 0 if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages |
historical_serp_mode | string | Optional | data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return metrics for SERPs in which the specified target currently has ranking results; lost — return… |
ignore_synonyms | boolean | Optional | ignore highly similar keywords optional field if set to true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false |
filters | array | Optional | 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:… e.g. [["metrics.organic.pos_1", "<>", 0], "or", ["metrics.organic |
order_by | array | Optional | Optional. Flat array of comma-separated "field,direction" strings (asc or desc). Field names match the filters array. Nested [["field","desc"]] (the filters-array shape) returns task status 40501 Invalid Field:… e.g. ["metrics.organic.etv,desc"] |
tag | string | Optional | 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 |
This endpoint will provide you with search intent data for up to 1,000 keywords. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "keywords": ["login page", "audi a7", "elon musk", "milk store new york"]}]. $0.04 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000; the keywords will be converted to lowercase format learn more about rules and limitations of keyword and… e.g. ["login page", "audi a7", "elon musk", "milk store new york" |
language_name | string | Optional | full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to… |
language_code | string | Optional | language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to… e.g. "en" |
tag | string | Optional | 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 |
This endpoint will provide you with a list of domains ranking for the keywords you specify. Body: a JSON array with exactly one task object, e.g. [{"keywords": ["phone"], "language_name": "English", "location_code": 2840, "item_types": ["organic"], "limit": 5}]. Priced per row requested via limit (1-1000, default 100): $0.000396 per row, minimum $0.036. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000396 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | 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… e.g. ["phone"] |
location_name | string | Optional | 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… |
location_code | integer | Optional | 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… e.g. 2840 |
language_name | string | Optional | 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… e.g. "English" |
language_code | string | Optional | 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… |
include_subdomains | boolean | Optional | indicates if the subdomains will be included in the search optional field if set to false, the subdomains will be ignored default value: true |
item_types | array | Optional | 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"] e.g. ["organic"] |
limit | integer | Optional | the maximum number of returned domains optional field default value: 100 maximum value: 1000 e.g. 5 |
offset | integer | Optional | 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… |
filters | array | Optional | 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:… |
order_by | array | Optional | 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… |
tag | string | Optional | 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 |
This endpoint will provide you with a list of subdomains of the specified domain, along with the ranking distribution across organic and paid search. Body: a JSON array with exactly one task object, e.g. [{"target": "dataforseo.com", "language_name": "English", "location_code": 2840, "filters": [["metrics.organic.pos_1", "<>", 0], "or", ["metrics.organic.pos_2_3. Priced per row requested via limit (1-1000, default 100): $0.000397 per row, minimum $0.038. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000397 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Optional | domain required field the domain name of the target website the domain should be specified without https:// and www. e.g. "dataforseo.com" |
location_name | string | Optional | full name of the location optional field if you use this field, you don’t need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the… |
location_code | integer | Optional | location code optional field if you use this field, you don’t need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the… e.g. 2840 |
language_name | string | Optional | full name of the language optional field if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name by making a separate request to the… e.g. "English" |
language_code | string | Optional | language code optional field if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the… |
item_types | array | Optional | display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from organic, the results will be ordered… |
include_clickstream_data | boolean | Optional | include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution… |
historical_serp_mode | string | Optional | data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return metrics for SERPs in which the specified target currently has ranking results; lost — return… |
ignore_synonyms | boolean | Optional | ignore highly similar keywords optional field if set to true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false |
filters | array | Optional | 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:… e.g. [["metrics.organic.pos_1", "<>", 0], "or", ["metrics.organic |
order_by | array | Optional | 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… |
limit | integer | Optional | the maximum number of returned keywords optional field default value: 100 maximum value: 1000 |
offset | integer | Optional | offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive… |
tag | string | Optional | 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 |
The Top Searches endpoint of DataForSEO Labs API can provide you with over 7 billion keywords from the DataForSEO Keyword Database. Body: a JSON array with exactly one task object, e.g. [{"language_name": "English", "location_code": 2840, "limit": 3}]. Priced per row requested via limit (1-1000, default 100): $0.000396 per row, minimum $0.036. Set limit to the rows you need; you pay for the limit, not the rows returned.
$0.000396 per row; set limit (default 100, max 1000)
| Parameter | Type | Required | What it is |
|---|---|---|---|
location_name | string | Optional | 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 their location_name… |
location_code | integer | Optional | location code 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 by making a… e.g. 2840 |
language_name | string | Optional | 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 locations with their language_name… e.g. "English" |
language_code | string | Optional | language code 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 locations with their language_code by making a… |
include_serp_info | boolean | Optional | include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response… |
include_clickstream_data | boolean | Optional | include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and… |
ignore_synonyms | boolean | Optional | ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false |
filters | array | Optional | 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:… |
order_by | array | Optional | 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… |
tag | string | Optional | 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 |
limit | integer | Optional | the maximum number of returned keywords optional field note: you can get more than 1000 results by using the offset_token provided in the response to each subsequent request default value: 1000 maximum value: 1000 e.g. 3 |
offset | integer | Optional | offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive… |
offset_token | string | Optional | offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;… |
The Aggregation Technologies endpoint will provide you with a list of the most popular technologies websites use alongside the technologies you specify. Body: a JSON array with exactly one task object, e.g. [{"mode": "entry", "technology": "Nginx", "keyword": "WordPress", "filters": [["country_iso_code", "=", "US"], "and", ["domain_rank", ">", 800]], "order_by": [". Capped at limit 50. $0.06 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
group | string | Optional | id of the target technology group required field if you don’t specify technology, category or keyword at least one field (group, category, keyword, technology) must be set you can find the full list of technology group… |
category | string | Optional | id of the target technology category required field if you don’t specify group, keyword or technology at least one field (group, category, keyword, technology) must be set you can find the full list of technology… |
technology | string | Optional | target technology required field if you don’t specify group, keyword or category at least one field (group, category, keyword, technology) must be set you can find the full list of technologies on this page example:… e.g. "Nginx" |
keyword | string | Optional | target keyword in the domain’s meta keywords required field if you don’t specify group, category or technology at least one field (group, category, keyword, technology) must be set UTF-8 encoding example: "seo"learn… e.g. "WordPress" |
mode | string | Optional | search mode optional field possible search mode types: as_is – search for results exactly matching the specified group ids, category ids, or technology names entry – search for results matching a part of the specified… e.g. "entry" |
filters | array | Optional | 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: , >=,… e.g. [["country_iso_code", "=", "US"], "and", ["domain_rank", ">" |
order_by | array | Optional | results sorting rules optional field you can use the following values to sort the results: groups_count, categories_count, technologies_count possible sorting types: asc – results will be sorted in the ascending order… e.g. ["groups_count,desc"] |
internal_groups_list_limit | integer | Optional | maximum number of returned technology groups optional field you can use this field to limit the number of items with identical "group" in the results default value: 5 minimum value: 1 maximum value: 10000 |
internal_categories_list_limit | integer | Optional | maximum number of returned technology categories within the same group optional field you can use this field to limit the number of items with identical "category" in the results default value: 5 minimum value: 1… |
internal_technologies_list_limit | integer | Optional | maximum number of returned technologies within the same category optional field you can use this field to limit the number of items with identical "technology" in the results default value: 10 minimum value: 1 maximum… |
internal_list_limit | integer | Optional | maximum number of items with identical "category", "group", and "technology" optional field if you use this field, the values specified in internal_groups_list_limit, internal_categories_list_limit and… |
offset | integer | Optional | offset in the results array of returned domains optional field default value: 0 maximum value: 9999 if you specify the 10 value, the first ten technologies in the results array will be omitted and the data will be… |
tag | string | Optional | 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 |
Using this endpoint you will get a list of technologies used in a particular domain. Body: a JSON array with exactly one task object, e.g. [{"target": "dataforseo.com"}]. $0.04 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Optional | target domain required field domain name of the website to analyze Note: results will be returned for the specified domain only e.g. "dataforseo.com" |
This endpoint provides domains based on the HTML terms they use on their homepage. Body: a JSON array with exactly one task object, e.g. [{"search_terms": ["data-attrid"], "order_by": ["last_visited,desc"], "limit": 10, "offset": 0}]. Capped at limit 50. $0.09 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
search_terms | array | Optional | target search terms required field specify target HTML elements, tags, attributes, their content or all of the above if you specify more than one search term, you will receive only the domains containing all of the… e.g. ["data-attrid"] |
keywords | array | Optional | target keywords in the domain’s title, description or meta keywords optional field UTF-8 encoding maximum number of keywords you can specify: 10 example: ["seo","software"] learn more about rules and limitations of… |
mode | string | Optional | search mode optional field possible search mode types: strict_entry – search for results exactly matching the order, intervals and separators in the specified search terms entry – search for results ignoring the order,… |
filters | array | Optional | 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: , >=,… |
order_by | array | Optional | results sorting rules optional field available fields: domain_rank, domain, last_visited, country_iso_code, language_code, content_language_code possible sorting types: asc – results will be sorted in the ascending… e.g. ["last_visited,desc"] |
offset | integer | Optional | 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… e.g. 0 |
offset_token | string | Optional | token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by… |
This endpoint provides domains based on the technology they use. Body: a JSON array with exactly one task object, e.g. [{"technologies": ["Nginx"], "filters": [["country_iso_code", "=", "US"], "and", ["domain_rank", ">", 800]], "order_by": ["last_visited,desc"], "limit": 10}]. Capped at limit 50. $0.13 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
technology_paths | array | Optional | target technology paths required field if you don’t specify groups, technologies, keywords or categories at least one field (technology_paths, groups, technologies, keywords or categories) must be set; each technology… |
groups | array | Optional | ids of the target technology groups required field if you don’t specify technologies, technology_paths, keywords or categories you can find the full list of technology group ids on this page note: you can specify up to… |
categories | array | Optional | ids of the target technology categories required field if you don’t specify groups, technology_paths, keywords or technologies you can find the full list of technology category ids on this page note: you can specify up… |
technologies | array | Optional | target technologies required field if you don’t specify groups, technology_paths, keywords or categories you can find the full list of technologies you can specify here on this page note: you can specify up to 10… e.g. ["Nginx"] |
keywords | array | Optional | target keywords in the domain’s title, description or meta keywords required field if you don’t specify groups, technology_paths, technologies or categories optional field you can specify the maximum of 10 keywords;… |
mode | string | Optional | search mode optional field possible search mode types: as_is – search for results exactly matching the specified group ids, category ids, or technology names entry – search for results matching a part of the specified… |
filters | array | Optional | 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: , >=,… e.g. [["country_iso_code", "=", "US"], "and", ["domain_rank", ">" |
order_by | array | Optional | results sorting rules optional field available fields: domain_rank, domain, last_visited, country_iso_code, language_code, content_language_code possible sorting types: asc – results will be sorted in the ascending… e.g. ["last_visited,desc"] |
offset | integer | Optional | 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… |
offset_token | string | Optional | token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by… |
This endpoint will provide you with the full list of available technologies structured by technology groups and categories each particular technology belongs to. $0.001 per call.
The Technologies Summary endpoint will provide you with the number of domains across different countries and languages that use the specified technology names, technology groups, or technology categories. Body: a JSON array with exactly one task object, e.g. [{"mode": "entry", "technologies": ["Ngi"], "keywords": ["WordPress"], "filters": [["country_iso_code", "=", "US"], "and", ["domain_rank", ">", 800]]}]. $0.04 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
technology_paths | array | Optional | target technology paths required field if you don’t specify groups, technologies and categories each technology path should be specified as a separate object containing “path” and “name”, where “path” is specified as… |
groups | array | Optional | ids of the target technology groups required field if you don’t specify technologies, technology_paths, categories, or keywords you can find the full list of technology group ids on this page note: you can specify up… |
categories | array | Optional | ids of the target technology categories required field if you don’t specify groups, technology_paths, technologies, or keywords you can find the full list of technology category ids on this page note: you can specify… |
technologies | array | Optional | target technologies required field if you don’t specify groups, technology_paths, categories, or keywords you can find the full list of technologies you can specify here on this page note: you can specify up to 10… e.g. ["Ngi"] |
keywords | array | Optional | target keywords in the domain’s title, description or meta keywords required field if you don’t specify groups, technology_paths, categories, or technologies you can specify the maximum of 10 keywords; UTF-8 encoding;… e.g. ["WordPress"] |
mode | string | Optional | search mode optional field possible search mode types: as_is – search for results exactly matching the specified group ids, category ids, or technology names entry – search for results matching a part of the specified… e.g. "entry" |
filters | array | Optional | 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: , >=,… e.g. [["country_iso_code", "=", "US"], "and", ["domain_rank", ">" |
internal_list_limit | integer | Optional | maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the following arrays: countries, languages, content_languages, keywords default value: 10… |
tag | string | Optional | 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 |
The Technology Stats endpoint will provide you with historical data on the number of domains across different countries and languages that use the specified technology. Body: a JSON array with exactly one task object, e.g. [{"technology": "jQuery", "date_from": "2026-04-24", "date_to": "2026-06-24"}]. $0.05 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
technology | string | Optional | target technology required field you can find the full list of technologies you can specify here on this page example: "Salesforce" e.g. "jQuery" |
date_from | string | Optional | starting date of the time range optional field minimum value: 2022-10-31 if you don’t specify this field, the minimum value will be used by default date format: "yyyy-mm-dd" example: "2023-06-01" e.g. "2026-04-24" |
date_to | string | Optional | ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default date format: "yyyy-mm-dd" example: "2023-01-15" e.g. "2026-06-24" |
tag | string | Optional | 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 |
This endpoint will provide you with Whois data enriched with backlink stats, and ranking and traffic info from organic and paid search results. Body: a JSON array with exactly one task object, e.g. [{"limit": 2, "filters": [["epp_status_codes", "in", ["client_transfer_prohibited", "client_update_prohibited"]]]}]. Capped at limit 50. $0.39 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
offset | integer | Optional | offset in the results array of returned items optional field default value: 0 if you specify the 10 value, the first ten items in the results array will be omitted and the data will be provided for the successive… |
offset_token | string | Optional | token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by… |
filters | array | Optional | 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:… e.g. [["epp_status_codes", "in", ["client_transfer_prohibited", " |
order_by | array | Optional | 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… |
tag | string | Optional | 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 |
By calling this API you will receive the list of industries with industry_id supported by Bing Ads Audience Estimation endpoint. $0.001 per call.
By calling this API you will receive the list of job functions with job_function_id supported by Bing Ads Audience Estimation endpoint. $0.001 per call.
This endpoint provides estimated audience size for an ad campaign based on specified targeting criteria. Body: a JSON array with exactly one task object, e.g. [{"location_coordinate": "29.6821525,-82.4098881,100", "age": ["twenty_five_to_thirty_four", "eighteen_to_twenty_four", "unknown"], "bid": 1, "daily_budget": 24. $0.27 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
location_name | string | Optional | 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… |
location_code | integer | Optional | 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… |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don’t 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… e.g. "29.6821525,-82.4098881,100" |
age | array | Optional | selection of age ranges for targeting possible values: eighteen_to_twenty_four, fifty_to_sixty_four, sixty_five_and_above, thirteen_to_seventeen, thirty_five_to_forty_nine, twenty_five_to_thirty_four, unknown,… e.g. ["twenty_five_to_thirty_four", "eighteen_to_twenty_four", "u |
bid | number | Optional | desired bid setting value in USD maximum value: 1000 e.g. 1 |
daily_budget | number | Optional | daily campaign budget value in USD maximum value: 10000 e.g. 24 |
gender | array | Optional | gender to target possible values: male, female, unknown e.g. ["male"] |
industry | array | Optional | industry of LinkedIn profile targeting if you use this field, you can receive the list of available industry names with industry_id by making a separate request to the… e.g. ["806303407", "806301758"] |
job_function | array | Optional | job function of LinkedIn profile targeting if you use this field, you can receive the list of available job function names with job_function_id by making a separate request to the… e.g. ["806298607"] |
You can receive a set of keyword performance stats for a group of keywords depending on the specified match type, location and language parameters. Body: a JSON array with exactly one task object, e.g. [{"location_code": 2840, "language_code": "en", "keywords": ["dataforseo", "seo", "ranking"]}]. $0.27 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | keywords required field The maximum number of keywords you can specify: 1000 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the specified keywords will be… e.g. ["dataforseo", "seo", "ranking"] |
device | string | Optional | device type optional field specify this field if you want to get the data for a particular device typepossible values: desktop, mobile, tablet, all default value: all |
match | string | Optional | keywords match type optional field can take the following values: aggregate returns data across all match types; broad returns data for all user queries containing the specified keyword with varying word order; phrase… |
location_name | string | Optional | 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… |
location_code | integer | Optional | 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… e.g. 2840 |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don’t 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… |
language_name | string | Optional | 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 locations and languages by… |
language_code | string | Optional | search engine language code required field if you don’t specify language_name you can receive the list of available locations and languages by making a separate request to… e.g. "en" |
tag | string | Optional | 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 |
This endpoint will select the relevant keywords for the specified ones. Body: a JSON array with exactly one task object, e.g. [{"location_name": "United States", "language_name": "English", "keywords": ["average page rpm adsense", "adsense blank ads how long", "leads and prospects"]}]. $0.27 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | keywords required field you can specify the maximum of 200 keywords with each keyword containing no more than 100 characters; the specified keywords will be converted to lowercase, data will be provided in a separate… e.g. ["average page rpm adsense", "adsense blank ads how long", " |
location_name | string | Optional | 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… e.g. "United States" |
location_code | integer | Optional | 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… |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don’t 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… |
language_name | string | Optional | 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 supported languages: English, French, German e.g. "English" |
language_code | string | Optional | 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 supported languages: en, fr, de |
sort_by | string | Optional | results sorting parameters optional field Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order default value: relevance |
keywords_negative | array | Optional | keywords negative array optional field These keywords will be ignored in the results array; You can specify a maximum of 200 terms that you want to exclude from the results; the specified keywords will be converted to… |
device | string | Optional | device type optional field specify this field if you want to get the data for a particular device type; possible values: all, mobile, desktop, tablet default value: all |
date_from | string | Optional | starting date of the time range optional field minimal value: 24 months from today’s date; if you don’t specify this field, data will be provided for the last 12 months date format: "yyyy-mm-dd" example: "2020-01-01"… |
date_to | string | Optional | ending date of the time range optional field if you don’t specify this field, data will be provided for the last 12 months; minimum value: two years back from today’s date; maximum value: one month from today’s date;… |
search_partners | boolean | Optional | Bing search partners type optional field if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.… |
tag | string | Optional | 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 |
This endpoint will provide you with a list of keywords relevant to the specified URL along with their search volume for the last month, search volume trend for up to 24 past months (for estimating search volume dynamics), current cost-per-click and… Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "target": "dataforseo.com"}]. $0.27 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Optional | domain or URL required field the domain name or URL of the target website e.g. "dataforseo.com" |
location_name | string | Optional | 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… |
location_code | integer | Optional | 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… e.g. 2840 |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don’t 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… |
language_name | string | Optional | 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 supported languages: English, French, German |
language_code | string | Optional | 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 supported languages: en, fr, de e.g. "en" |
keywords_negative | array | Optional | keywords negative array optional field These keywords will be ignored in the results array; You can specify a maximum of 200 terms that you want to exclude from the results; the specified keywords will be converted to… |
device | string | Optional | device type optional field specify this field if you want to get the data for a particular device typepossible values: all, mobile, desktop, tablet default value: all |
date_from | string | Optional | starting date of the time range optional field minimal value: 24 months from today’s date; if you don’t specify this field, data will be provided for the last 12 months date format: "yyyy-mm-dd" example: "2020-01-01"… |
date_to | string | Optional | ending date of the time range optional field if you don’t specify this field, data will be provided for the last 12 months; minimum value: two years back from today’s date; maximum value: one month from today’s date;… |
sort_by | string | Optional | results sorting parameters optional field Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order default value: relevance |
search_partners | boolean | Optional | Bing search partners type optional field if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.… |
tag | string | Optional | 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 |
This endpoint will provide you with historical search volume data for up to 1000 keywords in one request. Body: a JSON array with exactly one task object, e.g. [{"location_code": 2840, "language_code": "en", "keywords": ["10 minute timer"]}]. $0.27 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | keywords required field The maximum number of keywords you can specify: 1000 The maximum number of characters for each keyword: 100 the specified keywords will be converted to lowercase, data will be provided in a… e.g. ["10 minute timer"] |
location_name | string | Optional | 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… |
location_code | integer | Optional | 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… e.g. 2840 |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don’t 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… |
language_name | string | Optional | 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 engines… |
language_code | string | Optional | 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 engines with… e.g. "en" |
device | array | Optional | device types optional field specify this field if you want to get the data for a particular device types possible values: mobile, desktop, tablet, non_smartphones default value: ["mobile", "desktop", "tablet",… |
period | string | Optional | aggregates the returned data to a certain time period optional field specify this field if you want to get the data in monthly, weekly or daily formatpossible values: monthly, weekly, daily monthly – returns data up to… |
date_from | string | Optional | starting date of the time range optional field minimum value: 24 months back from today’s date maximum value: one day from today’s date date format: "yyyy-mm-dd" example: "2020-01-01"Note: we do not recommend using a… |
date_to | string | Optional | ending date of the time range optional fieldminimum value: two years back from today’s date; maximum value: one day from today’s date; date format: "yyyy-mm-dd" example: "2020-03-15" Note: we do not recommend using a… |
tag | string | Optional | 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 |
This endpoint will provide you with search volume data for the last month, search volume trend for up to 24 past months (that will let you estimate search volume dynamics), current cost-per-click and competition values for paid search. Body: a JSON array with exactly one task object, e.g. [{"location_name": "United States", "language_code": "en", "keywords": ["tom and jerry", "silicon valley", "spider man"]}]. $0.27 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | keywords required field The maximum number of keywords you can specify: 1000 The maximum number of characters for each keyword: 100 the specified keywords will be converted to lowercase, data will be provided in a… e.g. ["tom and jerry", "silicon valley", "spider man"] |
location_name | string | Optional | 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… e.g. "United States" |
location_code | integer | Optional | 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… |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don’t 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… |
language_name | string | Optional | 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 supported languages: English, French, German |
language_code | string | Optional | 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 supported languages: en, fr, de e.g. "en" |
device | string | Optional | device type optional field specify this field if you want to get the data for a particular device type; possible values: all, mobile, desktop, tablet default value: all |
sort_by | string | Optional | results sorting parameters optional field Use these parameters to sort the results by search_volume, cpc, competition or relevance in the descending order default value: relevance |
date_from | string | Optional | starting date of the time range optional field minimal value: 24 months from today’s date if you don’t specify this field, data will be provided for the last 12 months minimum value: two years back from today’s date… |
date_to | string | Optional | ending date of the time range optional field if you don’t specify this field, data will be provided for the last 12 months; minimum value: two years back from today’s date; maximum value: one month from today’s date;… |
search_partners | boolean | Optional | Bing search partners type optional field if you specify true, the results will be delivered for owned, operated, and syndicated networks across Bing, Yahoo, AOL and partner sites that host Bing, AOL, and Yahoo search.… |
tag | string | Optional | 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 |
The Bulk Clickstream Search Volume endpoint of DataForSEO Keywords Data API is designed to provide clickstream-based search volume data for up to 1000 keywords in a single Live request. Body: a JSON array with exactly one task object, e.g. [{"location_code": 2840, "tag": "test-tag", "keywords": ["you tube", "youtube", "youtub"]}]. $0.04 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000; each keyword should be at least 3 characters long; the keywords will be converted to lowercase format; Note:… e.g. ["you tube", "youtube", "youtub"] |
location_name | string | Optional | 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 their location_name… |
location_code | integer | Optional | location code 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 by making a… e.g. 2840 |
tag | string | Optional | 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 e.g. "test-tag" |
ClickstreamDataDataforseoSearchVolumeLive Body: a JSON array with exactly one task object, e.g. [{"location_code": 2840, "language_code": "en", "tag": "test-tag", "keywords": ["you tube", "youtube", "youtub"]}]. $0.54 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000 the keywords will be converted to lowercase format Note: certain symbols and characters (e.g., UTF symbols,… e.g. ["you tube", "youtube", "youtub"] |
location_name | string | Optional | full name of search engine location required field if you don’t specify location_code you can receive the list of available locations with location_name by making a separate request to… |
location_code | integer | Optional | search engine location code required field if you don’t specify location_name if you use this field, you can receive the list of available locations with location_code by making a separate request to the… e.g. 2840 |
language_name | string | Optional | full name of search engine language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the… |
language_code | string | Optional | search engine language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the… e.g. "en" |
use_clickstream | boolean | Optional | use clickstream data to provide results optional field if set to true, you will get DataForSEO search volume values based on clickstream data; if set to false, Bing search volume data will be used to calculate… |
tag | string | Optional | 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 e.g. "test-tag" |
The Clickstream Global Search Volume endpoint of DataForSEO Keywords Data API is designed to provide clickstream-based search volume data for up to 1000 keywords in a single Live request. Body: a JSON array with exactly one task object, e.g. [{"tag": "test-tag", "keywords": ["you tube", "youtube", "youtub"]}]. $0.54 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | target keywords required field UTF-8 encoding maximum number of keywords you can specify in this array: 1000; each keyword should be at least 3 characters long; the keywords will be converted to lowercase format; Note:… e.g. ["you tube", "youtube", "youtub"] |
tag | string | Optional | 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 e.g. "test-tag" |
This endpoint will provide you with the demographic breakdown (by age and gender) of keyword popularity per each specified term based on DataForSEO Trends data. Body: a JSON array with exactly one task object, e.g. [{"keywords": ["rugby", "cricket"], "date_from": "2026-04-24", "date_to": "2026-06-24", "type": "web", "location_name": "United States"}]. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | keywords required field the maximum number of keywords you can specify: 5 avoid symbols and special characters (e.g., UTF symbols, emojis); specifying non-Latin characters, you’ll get data for the countries where they… e.g. ["rugby", "cricket"] |
location_name | string | Optional | full name of search engine location optional field if you don’t use this field, you will recieve global results if you use this field, you don’t need to specify location_code you can receive the list of available… e.g. "United States" |
location_code | integer | Optional | search engine location code optional field if you don’t use this field, you will recieve global results if you use this field, you don’t need to specify location_name you can receive the list of available locations of… |
type | string | Optional | type of element e.g. "web" |
date_from | string | Optional | starting date of the time range optional field if you don’t specify this field, the current day and month of the preceding year will be used by default minimal value for the web type: 2004-01-01 minimal value for other… e.g. "2026-04-24" |
date_to | string | Optional | ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default date format: "yyyy-mm-dd" example: "2019-01-15" e.g. "2026-06-24" |
time_range | string | Optional | preset time ranges optional field if you specify date_from or date_to parameters, this field will be ignored when setting a task possible values for all type parameters: past_4_hours, past_day, past_7_days,… |
tag | string | Optional | 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 |
This endpoint will provide you with the keyword popularity data from DataForSEO Trends. Body: a JSON array with exactly one task object, e.g. [{"keywords": ["iphone 14", "samsung s23"], "location_code": 2840}]. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | keywords required field the maximum number of keywords you can specify: 5 learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article e.g. ["iphone 14", "samsung s23"] |
location_name | string | Optional | full name of search engine location optional field if you don’t use this field, you will recieve global results if you use this field, you don’t need to specify location_code you can receive the list of available… |
location_code | integer | Optional | search engine location code optional field if you don’t use this field, you will recieve global results if you use this field, you don’t need to specify location_name you can receive the list of available locations of… e.g. 2840 |
type | string | Optional | type of element |
date_from | string | Optional | starting date of the time range optional field if you don’t specify this field, the current day and month of the preceding year will be used by default minimal value for the web type: 2004-01-01 minimal value for other… |
date_to | string | Optional | ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default date format: "yyyy-mm-dd" example: "2019-01-15" |
time_range | string | Optional | preset time ranges optional field if you specify date_from or date_to parameters, this field will be ignored when setting a task possible values for all type parameters: past_4_hours, past_day, past_7_days,… |
tag | string | Optional | 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 |
You will receive the list of DataForSEO Trends locations by calling this API. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Required | country |
This endpoint will provide you with the keyword popularity data from DataForSEO Trends. Body: a JSON array with exactly one task object, e.g. [{"keywords": ["rugby", "cricket"], "date_from": "2026-04-24", "date_to": "2026-06-24", "type": "web", "location_name": "United States"}]. $0.02 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | keywords required field the maximum number of keywords you can specify: 5 avoid symbols and special characters (e.g., UTF symbols, emojis); specifying non-Latin characters, you’ll get data for the countries where they… e.g. ["rugby", "cricket"] |
location_name | string | Optional | full name of search engine location optional field if you don’t use this field, you will recieve global results if you use this field, you don’t need to specify location_code you can receive the list of available… e.g. "United States" |
location_code | integer | Optional | search engine location code optional field if you don’t use this field, you will recieve global results if you use this field, you don’t need to specify location_name you can receive the list of available locations of… |
type | string | Optional | type of element e.g. "web" |
date_from | string | Optional | starting date of the time range optional field if you don’t specify this field, the current day and month of the preceding year will be used by default minimal value for the web type: 2004-01-01 minimal value for other… e.g. "2026-04-24" |
date_to | string | Optional | ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default date format: "yyyy-mm-dd" example: "2019-01-15" e.g. "2026-06-24" |
time_range | string | Optional | preset time ranges optional field if you specify date_from or date_to parameters, this field will be ignored when setting a task possible values for all type parameters: past_4_hours, past_day, past_7_days,… |
tag | string | Optional | 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 |
This endpoint will provide you with location-specific keyword popularity data from DataForSEO Trends. Body: a JSON array with exactly one task object, e.g. [{"keywords": ["rugby", "cricket"], "date_from": "2026-04-24", "date_to": "2026-06-24", "type": "web", "location_name": "United States"}]. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | keywords required field the maximum number of keywords you can specify: 5 avoid symbols and special characters (e.g., UTF symbols, emojis); specifying non-Latin characters, you’ll get data for the countries where they… e.g. ["rugby", "cricket"] |
location_name | string | Optional | full name of search engine location optional field if you don’t use this field, you will recieve global results if you use this field, you don’t need to specify location_code you can receive the list of available… e.g. "United States" |
location_code | integer | Optional | search engine location code optional field if you don’t use this field, you will recieve global results if you use this field, you don’t need to specify location_name you can receive the list of available locations of… |
type | string | Optional | type of element e.g. "web" |
date_from | string | Optional | starting date of the time range optional field if you don’t specify this field, the current day and month of the preceding year will be used by default minimal value for the web type: 2004-01-01 minimal value for other… e.g. "2026-04-24" |
date_to | string | Optional | ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default date format: "yyyy-mm-dd" example: "2019-01-15" e.g. "2026-06-24" |
time_range | string | Optional | preset time ranges optional field if you specify date_from or date_to parameters, this field will be ignored when setting a task possible values for all type parameters: past_4_hours, past_day, past_7_days,… |
tag | string | Optional | 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 |
GoogleAdsAdTrafficByKeywordsLive Body: a JSON array with exactly one task object, e.g. [{"location_code": 2840, "language_code": "en", "bid": 999, "match": "exact", "keywords": ["seo marketing"]}]. $0.27 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | keywords required field The maximum number of keywords you can specify: 1000 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the keywords you specify will… e.g. ["seo marketing"] |
bid | integer | Optional | the maximum custom bid required field the collected data will be based on this value it stands for the price you are willing to pay for an ad; the higher value you specify here, the higher values you will get in the… e.g. 999 |
match | string | Optional | keywords match-type required field can take the following values: exact, broad, phrase e.g. "exact" |
location_name | string | Optional | full name of search engine location optional field if you do not indicate the location, you will receive worldwide results, i.e., for all available locations; if you use this field, you don’t need to specify… |
location_code | integer | Optional | search engine location code optional field if you do not indicate the location, you will receive worldwide results, i.e., for all available locations; if you use this field, you don’t need to specify location_name or… e.g. 2840 |
location_coordinate | string | Optional | GPS coordinates of a location optional field if you do not indicate the location, you will receive worldwide results, i.e., for all available locations; if you use this field, you don’t need to specify location_name or… |
language_name | string | Optional | full name of search engine language optional field you can receive the list of available languages of the search engine with their language_name by making a separate request to… |
language_code | string | Optional | search engine language code optional field you can receive the list of available languages of the search engine with their language_code by making a separate request to… e.g. "en" |
date_from | string | Optional | starting date of the forecasting time range required field if you specify date_to if you indicate date_from and date_to, you don’t need to specify date_interval minimum value is tomorrow’s date the value you specify in… |
date_to | string | Optional | ending date of the forecasting time range required field if you specify date_from if you indicate date_from and date_to, you don’t need to specify date_interval minimum value is date_from +1 day maximum value is… |
date_interval | string | Optional | forecasting date interval optional field if you specify date_interval, you don’t need to indicate date_from and date_to possible values: next_week, next_month, next_quarter default value: next_month |
sort_by | string | Optional | results sorting parameters optional field Use these parameters to sort the results by relevance, impressions, ctr, average_cpc, cost, or clicks in the descending order default value: relevance |
tag | string | Optional | 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 |
Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. Body: a JSON array with exactly one task object, e.g. [{"location_code": 2840, "keywords": ["phone", "cellphone"]}]. $0.27 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | keywords required field The maximum number of keywords you can specify: 20 The maximum number of characters for each keyword: 80 the keywords you specify will be converted to a lowercase format Note: Google Ads may… e.g. ["phone", "cellphone"] |
location_name | string | Optional | full name of search engine location optional field if you do not indicate the location, you will receive worldwide results, i.e., for all available locations; if you use this field, you don’t need to specify… |
location_code | integer | Optional | search engine location code optional field if you do not indicate the location, you will receive worldwide results, i.e., for all available locations; if you use this field, you don’t need to specify location_name or… e.g. 2840 |
location_coordinate | string | Optional | GPS coordinates of a location optional field if you do not indicate the location, you will receive worldwide results, i.e., for all available locations; if you use this field, you don’t need to specify location_name or… |
language_name | string | Optional | full name of search engine language optional field you can receive the list of available languages of the search engine with their language_name by making a separate request to… |
language_code | string | Optional | search engine language code optional field you can receive the list of available languages of the search engine with their language_code by making a separate request to… |
search_partners | boolean | Optional | include Google search partners optional field if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search; default value:… |
date_from | string | Optional | starting date of the time range optional field date format: "yyyy-mm-dd" minimal value: 4 years from the current date by default, data is returned for the past 12 months; Note: the indicated date cannot be greater than… |
date_to | string | Optional | ending date of the time range optional field Note: the indicated date cannot be greater than yesterday’s date; if you don’t specify this field, yesterday’s date will be used by default date format: "yyyy-mm-dd"… |
sort_by | string | Optional | results sorting parameters optional field Use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in descending order default value: relevance |
include_adult_keywords | boolean | Optional | include keywords associated with adult content optional field if set to true, adult keywords will be included in the response default value: false note that the API may return no data for such keywords due to Google… |
tag | string | Optional | 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 |
Note that Google Ads Keywords Data API is based on the latest version of the Google Ads API that has replaced legacy Google AdWords API. Body: a JSON array with exactly one task object, e.g. [{"location_code": 2840, "target": "dataforseo.com"}]. $0.27 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Optional | domain or page required field the domain name of the target website or the url of the target page; note: to obtain keywords for the target website, use the target_type parameter. Size: treg relays at most 8 MiB of… e.g. "dataforseo.com" |
target_type | string | Optional | search keywords for site or for url optional field possible values: site, page; default value: page; if set to site, keywords will be provided for the entire site; if set to page, keywords will be provided for the… |
location_name | string | Optional | full name of search engine location optional field if you do not indicate the location, you will receive worldwide results, i.e., for all available locations; if you use this field, you don’t need to specify… |
location_code | integer | Optional | search engine location code optional field if you do not indicate the location, you will receive worldwide results, i.e., for all available locations; if you use this field, you don’t need to specify location_name or… e.g. 2840 |
location_coordinate | string | Optional | GPS coordinates of a location optional field if you do not indicate the location, you will receive worldwide results, i.e., for all available locations; if you use this field, you don’t need to specify location_name or… |
language_name | string | Optional | full name of search engine language optional field you can receive the list of available languages of the search engine with their language_name by making a separate request to… |
language_code | string | Optional | search engine language code optional field you can receive the list of available languages of the search engine with their language_code by making a separate request to… |
search_partners | boolean | Optional | include Google search partners optional field if you specify true, the results will be delivered for owned, operated, and syndicated networks across Google and partner sites that host Google search; default value:… |
date_from | string | Optional | starting date of the time range optional field date format: "yyyy-mm-dd" minimal value: 4 years from the current date by default, data is returned for the past 12 months; Note: the indicated date cannot be greater than… |
date_to | string | Optional | ending date of the time range optional field Note: the indicated date cannot be greater than yesterday’s date; if you don’t specify this field, yesterday’s date will be used by default date format: "yyyy-mm-dd"… |
include_adult_keywords | boolean | Optional | include keywords associated with adult content optional field if set to true, adult keywords will be included in the response default value: false note that the API may return no data for such keywords due to Google… |
sort_by | string | Optional | results sorting parameters optional field Use these parameters to sort the results by relevance, search_volume, competition_index, low_top_of_page_bid, or high_top_of_page_bid in descending order default value: relevance |
tag | string | Optional | 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 |
We use Google Geographical Targeting. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Required | country |
Google Ads search volume, CPC, competition and 12-month trend for up to 1000 keywords Body: a JSON array with exactly one task object, e.g. [{"keywords": ["coffee"], "location_code": 2840, "language_code": "en"}]. $0.27 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Required | up to 1000 keywords, each max 80 chars / 10 words; lowercased by the API e.g. ["coffee"] |
location_code | integer | Optional | 2840 = United States; omitting it returns worldwide volume e.g. 2840 |
language_code | string | Optional | e.g. "en" e.g. "en" |
search_partners | boolean | Optional | include Google search partners; default false |
date_from | string | Optional | yyyy-mm-dd, max 4 years back |
date_to | string | Optional | yyyy-mm-dd, cannot be later than last month |
include_adult_keywords | boolean | Optional | default false |
sort_by | string | Optional | relevance (default) | search_volume | competition_index | low_top_of_page_bid | high_top_of_page_bid |
This endpoint will provide you with the keyword popularity data from the ‘Explore’ feature of Google Trends. Body: a JSON array with exactly one task object, e.g. [{"location_name": "United States", "date_from": "2026-04-24", "date_to": "2026-06-24", "type": "youtube", "category_code": 3, "keywords": ["rugby"]}]. $0.04 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keywords | array | Optional | keywords required field the maximum number of keywords you can specify: 5 the maximum number of characters you can specify in a keyword: 100 the minimum number of characters must be greater than 1 comma characters (,)… e.g. ["rugby", "cricket"] |
location_name | string | Optional | full name of search engine location optional field if you don’t use this field, you will recieve global results if you use this field, you don’t need to specify location_code you can use this field as an array to set… e.g. "United States" |
location_code | string | Optional | search engine location code optional field if you don’t use this field, you will recieve global results if you use this field, you don’t need to specify location_name you can use this field as an array to set several… |
language_name | string | Optional | full name of search engine language optional field default value: English 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_code | string | Optional | search engine language code optional field default value: en 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… |
type | string | Optional | type of element e.g. "youtube" |
category_code | integer | Optional | google trends search category optional field if you don’t specify this field, the 0 value will be applied by default and the search will be carried out across all available categories you can receive the list of… e.g. 3 |
date_from | string | Optional | starting date of the time range optional field if you don’t specify this field, the current day and month of the preceding year will be used by default minimal value for the web type: 2004-01-01 minimal value for other… e.g. "2026-04-24" |
date_to | string | Optional | ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default date format: "yyyy-mm-dd" example: "2019-01-15" e.g. "2026-06-24" |
time_range | string | Optional | preset time ranges optional field if you specify date_from or date_to parameters, this field will be ignored when setting a task possible values for all type parameters: past_hour, past_4_hours, past_day, past_7_days,… |
tag | string | Optional | 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 |
GoogleTrendsLocationsCountry $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Required | country |
This endpoint will provide you with a full list of ASINs assigned to different modifications of a product. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en_US", "location_code": 2840, "asin": "B0756FCPPN"}]. $0.02 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
asin | string | Optional | product ID required field unique product identifier (ASIN) in Amazon you can receive the asin parameter by making a separate request to the <a e.g. "B0756FCPPN" |
location_name | string | Optional | 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 y |
location_code | integer | Optional | 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 r e.g. 2840 |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coor |
language_name | string | Optional | 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 with their language |
language_code | string | Optional | 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 with their language_code</c e.g. "en_US" |
se_domain | string | Optional | 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:… |
tag | string | Optional | 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 |
You will receive the list of supported Amazon locations by this API call. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Required | country |
This endpoint provides results from Amazon product listings according to the specified keyword (product name), location, and language parameters. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en_US", "location_code": 2840, "keyword": "shoes"}]. Capped at depth 10, max_crawl_pages 10. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | keyword required field you can specify up to 700 characters in this field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword , plea e.g. "shoes" |
url | string | Optional | 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… |
location_name | string | Optional | 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 y |
location_code | integer | Optional | 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 r e.g. 2840 |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coor |
language_name | string | Optional | 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 with their language |
language_code | string | Optional | 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 with their language_code</c e.g. "en_US" |
se_domain | string | Optional | 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:… |
department | string | Optional | amazon product department optional field specify one of the following amazon departments for extracting product listings: "Arts & Crafts" , "Automotive" , "Baby" , "Beauty & Personal Care" , "Books" , "Computers"</co |
search_param | string | Optional | additional parameters of the search query optional field you can use the following Amazon search URL parameters for customizing the search example: &low-price=52 - search for products that cost more than 52 USD ;… |
price_min | integer | Optional | minimum product price optional field minimum price of the returned products listed on Amazon for the specified query example: 5 Note: if you specify price_min , the search_param parameter will be ignored |
price_max | integer | Optional | maximum product price optional field maximum price of the returned products listed on Amazon for the specified query example: 100 Note: if you specify price_max , the search_param parameter will be ignored |
sort_by | string | Optional | results sorting rules optional field the following sorting rules are supported: relevance , price_low_to_high , price_high_to_low , featured , avg_customer_review , newest_arrival example: sort_by: |
tag | string | Optional | 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 |
This endpoint provides a list of sellers of the specified product on Amazon. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en_US", "location_code": 2840, "asin": "B07D528W98"}]. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
asin | string | Optional | unique product identifier on Amazon required field you can get this value making a separate request to the Amazon Products endpoint note that there is no full list of possible values as the asin valu e.g. "B07D528W98" |
location_name | string | Optional | full name of the 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 rec |
location_code | integer | Optional | 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 lis e.g. 2840 |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coor |
language_name | string | Optional | full name of the 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 Amazon languages with their language_na |
language_code | string | Optional | 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 Amazon languages with their language_code by e.g. "en_US" |
se_domain | string | Optional | 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:… |
tag | string | Optional | 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 |
MerchantGoogleLocationsCountry $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Required | country |
The result of a task submitted with dataforseo.x.merchant-google-product-info-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
This endpoint provides data on a product listed on Google Shopping, including product description, images, rating, variations, specifications and sellers. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "product_id": "1113158713975221117"}]. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
product_id | string | Optional | unique product identifier on Google Shopping required field if data_docid or gid is not specified we recommend specifying product_id together with data_docid and gid for optimal results; you can get this value for a… e.g. "1113158713975221117" |
data_docid | string | Optional | unique identifier of the SERP data element required field if product_id or gid is not specified we recommend specifying data_docid together with product_id and gid for optimal results; you can get this value for a… |
gid | string | Optional | global product identifier on Google Shopping required field if product_id or data_docid is not specified we recommend specifying gid together with product_id and data_docid for optimal results; you can get this value… |
priority | integer | Optional | 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… |
location_name | string | Optional | full name of the 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… |
location_code | integer | Optional | 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 Google… e.g. 2840 |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don’t 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… |
language_name | string | Optional | full name of the 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 Google Shopping languages with their… |
language_code | string | Optional | 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 Google Shopping languages with their language_code by… e.g. "en" |
se_domain | string | Optional | 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:… |
tag | string | Optional | 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 |
The result of a task submitted with dataforseo.x.merchant-google-products-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
Google Shopping Products endpoint will provide you with the list of products found on Google Shopping for the specified query. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "keyword": "iphone", "price_min": 5}]. Capped at depth 10, max_crawl_pages 10. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | keyword required field you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword,… e.g. "iphone" |
url | string | Optional | 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… |
priority | integer | Optional | 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… |
location_name | string | Optional | full name of the 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… |
location_code | integer | Optional | 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 Google… e.g. 2840 |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don’t 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… |
language_name | string | Optional | full name of the 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 Google Shopping languages with their… |
language_code | string | Optional | 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 Google Shopping languages with their language_code by… e.g. "en" |
se_domain | string | Optional | 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:… |
search_param | string | Optional | additional parameters of the search query optional field you can use the following search URL parameters for customizing the search; example: &tbs=ppr_min:45 – search for products that cost more than 45 USD;… |
price_min | integer | Optional | minimum product price optional field minimum price of the returned products listed on Google Shopping for the specified query example: 5 Note: if you specify price_min, the search_param parameter will be ignored e.g. 5 |
price_max | integer | Optional | maximum product price optional field maximum price of the returned products listed on Google Shopping for the specified query example: 100 Note: if you specify price_max, the search_param parameter will be ignored |
sort_by | string | Optional | results sorting rules optional field the following sorting rules are supported: review_score, price_low_to_high, price_high_to_low example: sort_by:"review_score" Note: if you specify sort_by, the search_param… |
tag | string | Optional | 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 |
Google Shopping Sellers Ad URL is designed to provide you with a full URL of the advertisement containing all additional parameters set by the seller. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
shop_ad_aclk | string | Required | shop_ad_aclk |
The result of a task submitted with dataforseo.x.merchant-google-sellers-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
Google Shopping Sellers endpoint will provide you with the list of top 10 sellers that listed the specified product on Google Shopping. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "product_id": "1113158713975221117"}]. Capped at depth 10. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
product_id | string | Optional | unique product identifier on Google Shopping required field if data_docid or gid is not specified we recommend specifying product_id together with data_docid and gid for optimal results; you can get this value for a… e.g. "1113158713975221117" |
data_docid | string | Optional | unique identifier of the SERP data element required field if product_id or gid is not specified we recommend specifying data_docid together with product_id and gid for optimal results; you can get this value for a… |
gid | string | Optional | global product identifier on Google Shopping required field if product_id or data_docid is not specified we recommend specifying gid together with product_id and data_docid for optimal results; you can get this value… |
pvf | string | Optional | product variant filter on Google Shopping optional field parameter in Google Shopping URL, setting optional product variant filtration; example: Eg4iBWNvbG9yKgV3aGl0ZRISIgxwYWNrYWdlIHNpemUqAjE0EgoiBHNpemUqAnhs |
priority | integer | Optional | 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… |
location_name | string | Optional | full name of the 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… |
location_code | integer | Optional | 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 Google… e.g. 2840 |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don’t 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… |
language_name | string | Optional | full name of the 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 Google Shopping languages with their… |
language_code | string | Optional | 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 Google Shopping languages with their language_code by… e.g. "en" |
se_domain | string | Optional | 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:… |
get_shops_on_google | boolean | Optional | include “buy on Google” shops optional field if set to true, the response will contain the list of sellers that allow to purchase a given product directly on Google Note: if set to true, the cost of a task will be… |
additional_specifications | object | Optional | object containing additional url parameters you can get additional information about the product by using the "additional_specifications object, which you can get by making a separate request to the Google Shopping… |
tag | string | Optional | 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 |
This endpoint allows parsing the content on any page you specify and will return the structured content of the target page, including link URLs, anchors, headings, and textual content. Body: a JSON array with exactly one task object, e.g. [{"url": "https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api", "id": "11161551-1535-0216-0000-500. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Optional | URL of the content to parse required field URL of the page to parse example: https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api e.g. "https://dataforseo.com/blog/a-versatile-alternative-to-goog |
id | string | Optional | ID of the task required field you can get this ID in the response of the Task POST endpoint note: the enable_content_parsing parameter in the POST request must be set to true example:… e.g. "11161551-1535-0216-0000-500b3f307f92" |
markdown_view | boolean | Optional | return page content as markdown optional field if set to true, the markdown-formatted content of the page will be returned in the page_as_markdown field of the response; default value: false |
This endpoint returns a list of pages that have content similar to the page specified in the request. Body: a JSON array with exactly one task object, e.g. [{...}]. Capped at limit 50. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | ID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04” e.g. "07281559-0695-0216-0000-c269be8b7592" |
url | string | Optional | page URL required field specify the initial page you want to receive duplicate content for e.g. "https://www.etsy.com/" |
similarity | integer | Optional | content similarity score by default, the content is considered duplicate if the value is greater than or equals 6 you can specify any similarity score in the 0-to-10 range |
offset | integer | Optional | offset in the results array of returned pages optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided… |
tag | string | Optional | 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 |
This endpoint returns a list of pages that contain duplicate title or description tags. Body: a JSON array with exactly one task object, e.g. [{...}]. Capped at limit 50. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | ID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04” e.g. "07281559-0695-0216-0000-c269be8b7592" |
type | string | Optional | type of element e.g. "duplicate_description" |
accumulator | string | Optional | tag value optional field specify a title or description here if you want to receive a list of duplicate pages that contains this tag |
offset | integer | Optional | offset in the results array of returned pages optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided… |
tag | string | Optional | 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 |
Crawl one URL on demand — status code, load timings, on-page score, meta and content Body: a JSON array with exactly one task object, e.g. [{"url": "https://moz.com/"}]. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Required | FULL absolute URL including scheme — unlike the backlinks endpoints e.g. "https://moz.com/" |
custom_user_agent | string | Optional | custom_user_agent |
browser_preset | string | Optional | desktop | mobile | tablet; requires enable_browser_rendering=true — live API returns 40501 without it. Omit this field if you only need enable_javascript. |
enable_javascript | boolean | Optional | render JS; costs more; default false. Not sufficient for browser_preset. |
enable_browser_rendering | boolean | Optional | measure Core Web Vitals; implies enable_javascript; required for browser_preset; costs more; default false |
accept_language | string | Optional | accept_language |
check_spell | boolean | Optional | default false |
This endpoint will provide you with keyword density and keyword frequency data for terms appearing on the specified website or web page. Body: a JSON array with exactly one task object, e.g. [{...}]. Capped at limit 50. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | ID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04” e.g. "09101923-1535-0216-0000-2389a8854b70" |
keyword_length | integer | Optional | number of words for a keyword required field possible values: 1, 2, 3, 4, 5 e.g. 2 |
url | string | Optional | page URL optional field if you do not specify a page here, the results will be provided for the whole website if you use this field, the API response will contain only keywords from the specified page a page should be… e.g. "https://dataforseo.com/" |
filters | array | Optional | 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:… e.g. ["frequency", ">", 5] |
order_by | array | Optional | 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… |
tag | string | Optional | 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 |
The OnPage Lighthouse API is based on Google’s open-source Lighthouse project and provides data on the quality of web pages. $0.001 per call.
This endpoint will provide you with a list of internal and external links detected on a target website. Body: a JSON array with exactly one task object, e.g. [{...}]. Capped at limit 50. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | ID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04” e.g. "07281559-0695-0216-0000-c269be8b7592" |
page_from | string | Optional | relative page URL optional field if you use this field, the API response will contain only links from the specified page note that in this field you can specify relative URLs only e.g. "/apis/google-trends-api" |
page_to | string | Optional | relative page URL optional field if you use this field, the API response will contain only internal links pointing to the specified page note that in this field you can specify relative URLs only |
offset | integer | Optional | offset in the results array of returned links optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten links in the results array will be omitted and the data will be provided… |
filters | array | Optional | 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:… e.g. [["dofollow", "=", true], "and", ["direction", "=", "externa |
search_after_token | string | Optional | token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request; by… |
tag | string | Optional | 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 |
This endpoint returns a list of pages that are blocked from being indexed by Google and other search engines through robots.txt, HTTP headers, or meta tags settings. Body: a JSON array with exactly one task object, e.g. [{...}]. Capped at limit 50. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | ID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04” e.g. "07281559-0695-0216-0000-c269be8b7592" |
offset | integer | Optional | offset in the results array of returned pages optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided… |
filters | array | Optional | 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:… e.g. [["reason", "=", "robots_txt"], "and", ["url", "like", "%go% |
Using this endpoint, you can capture a full high-quality screenshot of any webpage. Body: a JSON array with exactly one task object, e.g. [{...}]. $0.02 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Optional | page url required field absolute URL of the page to snap note: if the URL you indicate here returns a 404 status code or the indicated value is not a valid URL, you will obtain "error_message":"Screenshot is empty" in… e.g. "https://dataforseo.com/apis" |
accept_language | string | Optional | language header for accessing the website optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) note: if you do not specify this parameter, some websites may deny access; in this case, you will… |
custom_user_agent | string | Optional | custom user agent optional field custom user agent for crawling a website example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36 default… |
browser_preset | string | Optional | preset for browser screen parameters optional field if you use this field, you don’t need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factor possible values: desktop, mobile, tablet… |
browser_screen_width | integer | Optional | browser screen width optional field you can set a custom browser screen width to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; minimum… |
browser_screen_height | integer | Optional | browser screen height optional field you can set a custom browser screen height to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; minimum… |
browser_screen_scale_factor | number | Optional | browser screen scale factor optional field you can set a custom browser screen resolution ratio to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be… |
full_page_screenshot | boolean | Optional | take a screenshot of the full page optional field set to false if you want to capture only the part of the page displayed before scrolling default value: true |
disable_cookie_popup | boolean | Optional | disable the cookie popup optional field set to true if you want to disable the popup requesting cookie consent from the user; default value: false |
switch_pool | boolean | Optional | switch proxy pool optional field if true, additional proxy pools will be used to obtain the requested data; the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit… |
ip_pool_for_scan | string | Optional | proxy pool optional field you can choose a location of the proxy pool that will be used to obtain the requested data; the parameter can be used if page content is inaccessible in one of the locations, resulting in… |
This endpoint returns a list of crawled pages with on-page check-ups and other metrics related to the page performance. Body: a JSON array with exactly one task object, e.g. [{...}]. Capped at limit 50. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | ID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04” e.g. "07281559-0695-0216-0000-c269be8b7592" |
offset | integer | Optional | offset in the results array of returned pages optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided… |
filters | array | Optional | 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:… e.g. [["resource_type", "=", "html"], "and", ["meta.scripts_count |
order_by | array | Optional | 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… e.g. ["meta.content.plain_text_word_count,desc"] |
search_after_token | string | Optional | token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request; by… |
tag | string | Optional | 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 |
This endpoint will return the list of pages where a specific resource is located. Body: a JSON array with exactly one task object, e.g. [{...}]. Capped at limit 50. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | ID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04” e.g. "02241700-1535-0216-0000-034137259bc1" |
url | string | Optional | resource URL required field you can get this URL in the response of the Resources endpoint example: https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js e.g. "https://www.etsy.com/about/jobs.workco2018.js?" |
offset | integer | Optional | offset in the results array of returned pages optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided… |
filters | array | Optional | 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:… |
order_by | array | Optional | 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… |
tag | string | Optional | 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 |
This endpoint returns the HTML of a page you indicate in the request. Body: a JSON array with exactly one task object, e.g. [{...}]. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | ID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04” e.g. "07281559-0695-0216-0000-c269be8b7592" |
url | string | Optional | page url required field the absolute URL of a page to request HTML Note: this field is optional if the task was set using the Instant Pages endpoint e.g. "https://dataforseo.com/apis" |
Redirect chains occur when there are at least two redirects between the initial URL and the destination URL. Body: a JSON array with exactly one task object, e.g. [{...}]. Capped at limit 50. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | ID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04” e.g. "03051327-4536-0216-1000-3b458a2cfcca" |
url | string | Optional | page URL optional field absolute URL of the target page if you use this field, the API response will return only redirect chains which contain the specified URL e.g. "https://test_rdr.dataforseo.com/a/" |
offset | integer | Optional | offset in the results array of returned redirect chains optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten redirect chains in the results array will be omitted and the… |
filters | array | Optional | array of results filtering parameters optional field you can use only one filtering parameter with this endpoint the following filtering parameter is supported: is_redirect_loop the following operators are supported:… |
tag | string | Optional | 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 |
This endpoint will provide you with a list of resources, including images, scripts, stylesheets, and broken elements. Body: a JSON array with exactly one task object, e.g. [{...}]. Capped at limit 50. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | ID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04” e.g. "07281559-0695-0216-0000-c269be8b7592" |
url | string | Optional | page URL optional field specify this field if you want to get the resources for a specific page note that to obtain resource’s meta from a particular URL, you should specify the URL in this field; if you do not… |
offset | integer | Optional | offset in the results array of returned resources optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten resources in the results array will be omitted and the data will be… |
filters | array | Optional | 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:… e.g. [["resource_type", "=", "image"], "and", ["size", ">", 10000 |
relevant_pages_filters | array | Optional | filter the resources by relevant pages optional field you can use this field to obtain resources from pages matching to the defined parameters you can apply the same filters here as available for the pages endpoint you… |
order_by | array | Optional | 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… e.g. ["size,desc"] |
search_after_token | string | Optional | token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request; by… |
tag | string | Optional | 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 |
Using this function, you can get the overall information on a website as well as drill down into exact on-page issues of a website that has been scanned. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
OnPage API checks websites for 60+ customizable on-page parameters defines and displays all found flaws and opportunities for optimization so that you can easily fix them. Body: a JSON array with exactly one task object, e.g. [{"target": "dataforseo.com", "max_crawl_pages": 10, "load_resources": true, "enable_javascript": true, "custom_js": "meta = {}; meta.url = document.URL; meta;". Capped at max_crawl_pages 10. $0.06 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
target | string | Optional | target domain required field domain name should be specified without https:// and www. if you specify the page URL, the results will be returned for the domain included in the URL e.g. "dataforseo.com" |
start_url | string | Optional | the first url to crawl optional field Note: you should specify an absolute URL if you want to crawl a single page, specify its URL in this field and additionally set the max_crawl_pages parameter to 1 you can also use… |
force_sitewide_checks | boolean | Optional | enable sitewide checks when crawling a single page optional field set to true to get data on sitewide checks when crawling a single page; default value: false |
priority_urls | array | Optional | urls to be crawled bypassing the queue optional field URLs specified in this array will be crawled in the first instance, bypassing the crawling queue; Note: you should specify the absolute URL; you can specify up to… |
max_crawl_depth | integer | Optional | crawl depth optional field the linking depth of the pages to crawl; for example, starting page of the crawl is level 0, pages that have links from that page are level 1, etc. |
crawl_delay | integer | Optional | delay between hits, ms optional field the custom delay between crawler hits to the server default value: 2000 |
store_raw_html | boolean | Optional | store HTML of crawled pages optional field set to true if you want to get the HTML of the page using the OnPage Raw HTML endpoint default value: false |
enable_content_parsing | boolean | Optional | parse content on crawled pages optional field set to true to use the OnPage Content Parsing endpoint default value: false |
support_cookies | boolean | Optional | support cookies on crawled pages optional field set to true to support cookies when crawling the pages default value: false |
accept_language | string | Optional | language header for accessing the website optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be… |
custom_robots_txt | string | Optional | custom robots.txt settings optional field example: Disallow: /directory1/ |
robots_txt_merge_mode | string | Optional | merge with or override robots.txt settings optional field possible values: merge, override; set to override if you want to ignore website crawling restrictions and other robots.txt settings default value: merge; Note:… |
custom_user_agent | string | Optional | custom user agent optional field custom user agent for crawling a website example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36 default… |
browser_preset | string | Optional | preset for browser screen parameters optional field if you use this field, you don’t need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factorpossible values: desktop, mobile,… |
browser_screen_width | integer | Optional | browser screen width optional field you can set a custom browser screen width to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to… |
browser_screen_height | integer | Optional | browser screen height optional field you can set a custom browser screen height to perform an audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note:… |
browser_screen_scale_factor | number | Optional | browser screen scale factor optional field you can set a custom browser screen resolution ratio to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be… |
respect_sitemap | boolean | Optional | respect sitemap when crawling optional field set to true if you want to follow the order of pages indicated in the primary sitemap when crawling; default value: false Note: if set to true, the click_depth value in the… |
custom_sitemap | string | Optional | custom sitemap url optional field the URL of the page where the alternative sitemap is located Note: if you want to use this parameter, respect_sitemap should be true |
crawl_sitemap_only | boolean | Optional | crawl only pages indicated in the sitemap optional field set to true if you want to crawl only the pages indicated in the sitemap if you set this parameter to true and do not specify custom_sitemap, we will crawl the… |
load_resources | boolean | Optional | load resources optional field set to true if you want to load image, stylesheets, scripts, and broken resources default value: false Note: if you use this parameter, additional charges will apply; learn more about the… e.g. true |
enable_www_redirect_check | boolean | Optional | check if the domain implemented the www redirection optional field set to true if you want to check if the requested domain implemented the www to non-www or non-www to www redirect; default value: false |
enable_javascript | boolean | Optional | load javascript on a page optional field set to true if you want to load the scripts available on a page default value: false Note: if you use this parameter, additional charges will apply; learn more about the cost of… e.g. true |
enable_xhr | boolean | Optional | enable XMLHttpRequest on a page optional field set to true if you want our crawler to request data from a web server using the XMLHttpRequest object default value: false;if you use this field, enable_javascript must be… |
enable_browser_rendering | boolean | Optional | emulate browser rendering to measure Core Web Vitals optional field by using this parameter you will be able to emulate a browser when loading a web page; enable_browser_rendering loads styles, images, fonts,… |
disable_cookie_popup | boolean | Optional | disable the cookie popup optional field set to true if you want to disable the popup requesting cookie consent from the user; default value: false |
custom_js | string | Optional | custom javascript optional field Note that the execution time for the script you enter here should be 700 ms maximum, for example, you can use the following JS snippet to check if the website contains Google Tag… e.g. "meta = {}; meta.url = document.URL; meta;" |
validate_micromarkup | boolean | Optional | enable microdata validation optional field set to true if you want to use the OnPage API Microdata endpoint default value: false |
allow_subdomains | boolean | Optional | include pages on subdomains optional field set to true if you want to crawl all subdomains of a target website default value: false |
allowed_subdomains | array | Optional | subdomains to crawl optional field specify subdomains that you want to crawl example: ["blog.site.com", "my.site.com", "shop.site.com"] Note: to use this parameter, the allow_subdomains parameter should be set to… |
disallowed_subdomains | array | Optional | subdomains not to crawl optional field specify subdomains that you don’t want to crawl example: ["status.site.com", "docs.site.com"] Note: to use this parameter, the allow_subdomains parameter should be set to true |
check_spell | boolean | Optional | check spelling optional field set to true to check spelling on a website using Hunspell library default value: false |
check_spell_language | string | Optional | language of the spell check optional field supported languages: ‘hy’, ‘eu’, ‘bg’, ‘ca’, ‘hr’, ‘cs’, ‘da’, ‘nl’, ‘en’, ‘eo’, ‘et’, ‘fo’, ‘fa’, ‘fr’, ‘fy’, ‘gl’, ‘ka’, ‘de’, ‘el’, ‘he’, ‘hu’, ‘is’, ‘ia’, ‘ga’, ‘it’,… |
check_spell_exceptions | array | Optional | words excluded from spell check optional field specify the words that you want to exclude from spell check maximum word length: 100 characters maximum amount of words: 1000 example: "SERP", "minifiers", "JavaScript" |
calculate_keyword_density | boolean | Optional | calculate keyword density for the target domain optional field set to true if you want to calculate keyword density for website pages default value: false Note: if you use this parameter, additional charges will apply;… |
checks_threshold | object | Optional | custom threshold values for checks optional field you can specify custom threshold values for the parameters included in the checks object of OnPage API responses; Note: only integer threshold values can be modified;… |
disable_sitewide_checks | array | Optional | prevent certain sitewide checks from running optional field specify the following checks to prevent them from running on the target website: "test_page_not_found" "test_canonicalization" "test_https_redirect"… |
disable_page_checks | array | Optional | prevent certain page checks from running optional field specify certain checks to prevent them from running and impacting the onpage_scoreexample: "disable_page_checks": ["is_5xx_code", "is_4xx_code"] |
switch_pool | boolean | Optional | switch proxy pool optional field if true, additional proxy pools will be used to obtain the requested data; the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit… |
return_despite_timeout | boolean | Optional | return data on pages despite the timeout error optional field if true, the data will be provided on pages that failed to load within 120 seconds and responded with a timeout error; default value: false |
tag | string | Optional | 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 e.g. "some_string_123" |
This endpoint returns a list of resources detected on the target website that could not be crawled due to a content type inconsistency. Body: a JSON array with exactly one task object, e.g. [{...}]. Capped at limit 50. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | ID of the task required field you can get this ID in the response of the Task POST endpoint example: "07131248-1535-0216-1000-17384017ad04" e.g. "07281559-0695-0216-0000-c269be8b7592" |
offset | integer | Optional | offset in the results array of returned uncrawlable resources optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten invalid resources in the results array will be omitted and… |
order_by | array | Optional | 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… |
filters | array | Optional | 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:… e.g. [["meta.content_type", "=", "image/jpeg"], "and", ["url", "l |
This endpoint is designed to provide you with the page speed insights. Body: a JSON array with exactly one task object, e.g. [{...}]. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Optional | ID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04” e.g. "08101204-0696-0216-0000-644a7b21a48a" |
url | string | Optional | page URL required field specify the pages you want to receive timing for e.g. "https://dataforseo.com/tag/broken-links" |
tag | string | Optional | 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 |
You will receive the list of locations by this API call. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Required | country |
The result of a task submitted with dataforseo.x.serp-baidu-organic-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
Baidu SERP API provides top 10 search engine results. Body: a JSON array with exactly one task object, e.g. [{"location_code": 2156, "keyword": "best iphone ever", "tag": "some_string_123", "priority": 2}]. Capped at depth 10, max_crawl_pages 1. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | 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,… e.g. "best iphone ever" |
priority | integer | Optional | 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… e.g. 2 |
language_name | string | Optional | full name of search engine language required field if you don’t 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… |
language_code | string | Optional | search engine language code required field if you don’t 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… |
location_name | string | Optional | 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… |
location_code | integer | Optional | 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… e.g. 2156 |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don’t 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… |
device | string | Optional | device type optional field return results for a specific device type can take the values: desktop, mobile, tablet default value: desktop |
os | string | Optional | 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… |
get_website_url | boolean | Optional | include direct URL for each ranked result optional field if set to true, the returned results will contain direct URLs of the ranked websites by default, the URLs in Baidu results are encoded by the search engine, for… |
stop_crawl_on_match | array | Optional | array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example:… |
match_value | string | Optional | 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… |
match_type | string | Optional | 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 –… |
tag | string | Optional | 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 e.g. "some_string_123" |
You will receive the list of locations by this API call. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Required | country |
Live SERP provides real-time data on top 100 search engine results for the specified keyword, search engine, and location. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "keyword": "flight ticket new york san francisco"}]. Capped at depth 10, max_crawl_pages 1. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | 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,… e.g. "flight ticket new york san francisco" |
location_code | integer | Optional | 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… e.g. 2840 |
language_code | string | Optional | 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… e.g. "en" |
device | string | Optional | device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop |
location_name | string | Optional | 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… |
language_name | string | Optional | 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… |
os | string | Optional | 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… |
tag | string | Optional | 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 |
target | string | Optional | 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… |
stop_crawl_on_match | array | Optional | array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example:… |
match_type | string | Optional | 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 –… |
match_value | string | Optional | 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… |
search_param | string | Optional | additional parameters of the search query optional field get the list of available parameters and additional details here |
calculate_rectangles | boolean | Optional | 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… |
browser_screen_width | integer | Optional | 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… |
browser_screen_height | integer | Optional | 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… |
browser_screen_resolution_ratio | integer | Optional | 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,… |
url | string | Optional | 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… |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don't 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… |
Live SERP provides real-time data on search engine results for the specified keyword, search engine, and location. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "keyword": "albert einstein"}]. Capped at depth 10, max_crawl_pages 1. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | 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,… e.g. "albert einstein" |
location_code | integer | Optional | 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… e.g. 2840 |
language_code | string | Optional | 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… e.g. "en" |
device | string | Optional | device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop |
location_name | string | Optional | 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… |
language_name | string | Optional | 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… |
os | string | Optional | 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… |
tag | string | Optional | 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 |
target | string | Optional | 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… |
stop_crawl_on_match | array | Optional | array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example:… |
match_type | string | Optional | 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 –… |
match_value | string | Optional | 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… |
search_param | string | Optional | additional parameters of the search query optional field get the list of available parameters and additional details here |
url | string | Optional | 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… |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don't 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… |
The result of a task submitted with dataforseo.x.serp-google-ads-advertisers-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
Google Ads Advertisers provides information on advertisers that run campaigns on Google Ads based on the Ads Transparency platform. Body: a JSON array with exactly one task object, e.g. [{"location_code": 2840, "keyword": "apple"}]. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | 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 ,… e.g. "apple" |
priority | integer | Optional | 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… |
location_code | integer | Optional | search engine location code optional field 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… e.g. 2840 |
location_name | string | Optional | full name of search engine location optional field 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_coordinate | string | Optional | GPS coordinates of a location optional field if you use this field, you don't need to specify location_name or location_code example: 52.6178549,-155.352142 Note: if you don't s |
tag | string | Optional | 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 |
The result of a task submitted with dataforseo.x.serp-google-ads-search-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
Google Ads Search provides information on ads that are run by advertisers on Google Ads. Body: a JSON array with exactly one task object, e.g. [{"location_code": 2840, "platform": "google_search", "advertiser_ids": ["AR13752565271262920705", "AR02439908557932462081"]}]. Capped at depth 10. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
advertiser_ids | array | Optional | advertiser identifiers required field if target is not specified you can specify the maximum of 25 values in this array; advertiser_ids values for this parameter can be found in the <a… e.g. ["AR13752565271262920705", "AR02439908557932462081"] |
target | string | Optional | domain name required field if advertiser_ids is not specified domain name associated with an advertiser account |
location_code | integer | Optional | search engine location code optional field 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… e.g. 2840 |
priority | integer | Optional | 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… |
location_name | string | Optional | full name of search engine location optional field 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_coordinate | string | Optional | GPS coordinates of a location optional field if you use this field, you don't need to specify location_name or location_code example: 52.6178549,-155.352142 Note: if you don't s |
tag | string | Optional | 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 |
platform | string | Optional | advertising platform optional field possible values: all , google_play , google_maps , google_search , google_shopping , youtube default value: all e.g. "google_search" |
format | string | Optional | ad format optional field possible values: all , text , image , video |
date_from | string | Optional | starting date of the time range optional field required field if date_to is specified; date format: "yyyy-mm-dd" minimum value: 2018-05-31 maximum value: today's date example: "2020-01-01" |
date_to | string | Optional | ending date of the time range optional field required field if date_from is specified; date format: "yyyy-mm-dd" minimum value: 2018-05-31 maximum value: today's date example: "2020-01-01" |
Google AI Mode SERP API provides search results from the AI Mode feature of Google Search. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "keyword": "what is google ai mode"}]. $0.02 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | 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 ,… e.g. "what is google ai mode" |
location_code | integer | Optional | 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 e.g. 2840 |
language_code | string | Optional | 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… e.g. "en" |
device | string | Optional | device type optional field return results for a specific device type can take the values: desktop , mobile default value: desktop |
location_name | string | Optional | 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 y |
language_name | string | Optional | 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… |
os | string | Optional | 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</code |
tag | string | Optional | 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 |
calculate_rectangles | boolean | Optional | 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> |
browser_screen_width | integer | Optional | 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… |
browser_screen_height | integer | Optional | 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… |
browser_screen_resolution_ratio | integer | Optional | 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,… |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location |
Google Autocomplete is a feature within Google Search that improves the search experience by allowing users to complete searches they started to type. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "keyword": "albert einstein", "client": "gws-wiz-serp"}]. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | 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 ,… e.g. "albert einstein" |
location_code | integer | Optional | search engine location code required field if you don't 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… e.g. 2840 |
language_code | string | Optional | 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… e.g. "en" |
cursor_pointer | integer | Optional | search bar cursor pointer optional field the horizontal numerical position of the cursor pointer within the keyword in the search bar; by modifying the position of the cursor pointer, you will obtain different… |
location_name | string | Optional | 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… |
language_name | string | Optional | 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… |
client | string | Optional | search client for autocomplete optional field autocomplete results may differ depending on the search client; possible values: chrome — used when google search is opened in google chrome; chrome-omni — used in the… e.g. "gws-wiz-serp" |
tag | string | Optional | 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 |
Live Google Dataset Info provides real-time data on the dataset you specify in the request. Body: a JSON array with exactly one task object, e.g. [{"dataset_id": "L2cvMTFqbl85ZHN6MQ=="}]. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
dataset_id | string | Optional | ID of the dataset required field you can find dataset ID in the dataset URL or dataset item of Google Dataset Search result example: L2cvMTFqbl85ZHN6MQ==</cod e.g. "L2cvMTFqbl85ZHN6MQ==" |
language_code | string | Optional | search engine language code optional field if you use this field, you don't need to specify language_name possible value: en |
device | string | Optional | device type optional field return results for a specific device type possible value: desktop |
language_name | string | Optional | full name of search engine language optional field if you use this field, you don't need to specify language_code possible value: English |
os | string | Optional | device operating system optional field possible values: windows , macos default value: windows |
tag | string | Optional | 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 |
Live Google Dataset Search provides real-time data on the top 20 Google Dataset search engine results. Body: a JSON array with exactly one task object, e.g. [{"keyword": "water quality", "last_updated": "1m", "file_formats": ["archive", "image"], "usage_rights": "noncommercial", "is_free": true, "topics": ["natural_. Capped at depth 10. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | 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 ,… e.g. "water quality" |
language_code | string | Optional | search engine language code optional field if you don't specify language_name if you use this field, you don't need to specify language_name possible value: en |
device | string | Optional | device type optional field return results for a specific device type possible value: desktop |
language_name | string | Optional | full name of search engine language optional field if you use this field, you don't need to specify language_code possible value: English |
os | string | Optional | device operating system optional field choose from the following values: windows , macos default value: windows |
tag | string | Optional | 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 |
last_updated | string | Optional | last time the dataset was updated optional field possible values: 1m , 1y , 3y e.g. "1m" |
file_formats | array | Optional | file formats of the dataset optional field possible values: other , archive , text , image , document , tabular e.g. ["archive", "image"] |
usage_rights | string | Optional | usage rights of the dataset optional field possible values: commercial , noncommercial e.g. "noncommercial" |
is_free | boolean | Optional | indicates whether displayed datasets are free optional field possible values: true , false e.g. true |
topics | array | Optional | dataset topics optional field possible values: humanities , social_sciences , life_sciences , agriculture , natural_sciences , geo , computer , architecture_and_urban_planning , engi e.g. ["natural_sciences", "geo"] |
Live Google Finance Explore provides real-time data from the ‘Explore’ tab of Google Finance. Body: a JSON array with exactly one task object, e.g. [{"location_code": 2840, "language_name": "English"}]. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
location_code | integer | Optional | 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… e.g. 2840 |
language_code | string | Optional | 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… |
device | string | Optional | device type optional field return results for a specific device type possible value: desktop |
location_name | string | Optional | 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… |
language_name | string | Optional | 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… e.g. "English" |
os | string | Optional | device operating system optional field possible values: windows |
tag | string | Optional | 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 |
news_type | string | Optional | financial news filters optional field possible values: top_stories , local_market , world_markets default value: top_stories Note: if you specify local_market or world_markets , the charge |
Live Google Finance Markets provides real-time data from the ‘Markets’ tab of Google Finance. Body: a JSON array with exactly one task object, e.g. [{"location_code": 2840, "language_name": "English"}]. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
location_code | integer | Optional | 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… e.g. 2840 |
language_code | string | Optional | 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… |
device | string | Optional | device type optional field return results for a specific device type possible value: desktop |
location_name | string | Optional | 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… |
language_name | string | Optional | 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… e.g. "English" |
os | string | Optional | device operating system optional field possible values: windows |
tag | string | Optional | 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 |
market_type | string | Optional | type of google finance market optional field possible values: most-active , indexes , indexes/americas , indexes/europe-middle-east-africa , indexes/asia-pacific , gainers , losers , climate-lea |
Live Google Finance Quote provides real-time data from the ‘Quote’ tab of Google Finance. Body: a JSON array with exactly one task object, e.g. [{"keyword": "CLW00:NYMEX", "location_code": 2840, "language_name": "English"}]. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | ticker or stock symbol required field in this field you can pass the ticker symbol of publicly traded shares of a particular stock or security on a particular stock exchange; you can specify up to 700 characters in the… e.g. "CLW00:NYMEX" |
location_code | integer | Optional | 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… e.g. 2840 |
language_code | string | Optional | 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… |
device | string | Optional | device type optional field return results for a specific device type possible value: desktop |
location_name | string | Optional | 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… |
language_name | string | Optional | 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… e.g. "English" |
os | string | Optional | device operating system optional field possible values: windows |
tag | string | Optional | 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 |
window | string | Optional | time window for google_finance_quote graph optional field possible values: 1D , 5D , 1M , 6M , YTD , 1Y , 5Y , MAX default value: 1D Note: i |
Live Google Finance Ticker Search allows you to search for financial instruments available on Google Finance along with additional information. Body: a JSON array with exactly one task object, e.g. [{"language_name": "English", "location_code": 2840, "category": "all", "keyword": "DJ"}]. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | company or financial instrument name required field in this field, you can enter the name of a company or financial instrument to search for relevant tickers; you can specify up to 700 characters in the keyword field;… e.g. "DJ" |
location_code | integer | Optional | 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… e.g. 2840 |
language_code | string | Optional | 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… |
location_name | string | Optional | 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… |
language_name | string | Optional | 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… e.g. "English" |
tag | string | Optional | 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 |
category | string | Optional | category of financial instruments to search for optional field possible values: all , stock , index , mutual_fund , currency , futures default value: all e.g. "all" |
Live Google Images SERP provides real-time data on top 100 images results for the specified keyword, search engine, and location. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "keyword": "albert einstein"}]. Capped at depth 10, max_crawl_pages 1. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | 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 ,… e.g. "albert einstein" |
location_code | integer | Optional | 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 e.g. 2840 |
language_code | string | Optional | 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… e.g. "en" |
location_name | string | Optional | 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 y |
language_name | string | Optional | 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… |
os | string | Optional | device operating system optional field note that this API provides results for desktop only choose from the following values: windows , macos default value: windows |
tag | string | Optional | 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 |
search_param | string | Optional | additional parameters of the search query optional field Get the list of available parameters and additional details here. |
url | string | Optional | 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… |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location |
se_domain | string | Optional | 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… |
The result of a task submitted with dataforseo.x.serp-google-jobs-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
This endpoint will provide you with SERP data from the Google Jobs search engine. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "keyword": ".net developer"}]. Capped at depth 10. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | 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 ,… e.g. ".net developer" |
location_code | integer | Optional | search engine location code required field if you don't 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… e.g. 2840 |
language_code | string | Optional | 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… e.g. "en" |
priority | integer | Optional | 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… |
location_name | string | Optional | 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… |
language_name | string | Optional | 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… |
tag | string | Optional | 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 |
location_radius | string | Optional | location search radius optional field location search radius in kilometers; Note: for countries that use the imperial system of units, you will need to convert miles to kilometers by multiplying the value in miles by… |
employment_type | array | Optional | employment contract type optional field type of employment contract for which the search results will be returned; possible values: fulltime , partime , contractor , intern |
Live Google Local_finder SERP provides real-time search engine results for the specified keyword and location. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "keyword": "local nail services", "min_rating": 4.5, "time_filter": "monday"}]. Capped at depth 10. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | 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 ,… e.g. "local nail services" |
location_code | integer | Optional | search engine location code. Required field if you don't specify location_coordinate; 2840 = United States. Use location_code or location_coordinate; Live Local Finder rejects location_name with 40501 Invalid Field… e.g. 2840 |
language_code | string | Optional | 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… e.g. "en" |
device | string | Optional | device type optional field return results for a specific device type can take the values: desktop , mobile default value: desktop |
language_name | string | Optional | 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… |
os | string | Optional | 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</code |
tag | string | Optional | 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 |
priority | integer | Optional | 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… |
location_coordinate | string | Optional | GPS coordinates of a location. Required field if you don't specify location_code. Use location_code or location_coordinate; Live Local Finder rejects location_name with 40501 Invalid Field even though vendor docs list… |
min_rating | number | Optional | filter results by minimum rating optional field possible values for desktop : 3.5 , 4 , 4.5 ; possible values for mobile : 2 , 2.5 , 3 , 3.5 , 4 , 4.5</code e.g. 4.5 |
time_filter | string | Optional | filter results by open hours optional field using this field, you can filter places in the results by the time a place is open for visitors note that Google may also provide results that do not match this filter… e.g. "monday" |
You will receive the list of locations by this API call. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Required | country |
Live Google Maps SERP provides real-time data on top 100 search engine results for the specified keyword, search engine, and location. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "keyword": "albert einstein"}]. Capped at depth 10, max_crawl_pages 1. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | 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 ,… e.g. "albert einstein" |
location_code | integer | Optional | search engine location code. Required field if you don't specify location_coordinate; 2840 = United States. Use location_code or location_coordinate; Live Maps rejects location_name with 40501 Invalid Field even though… e.g. 2840 |
language_code | string | Optional | 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… e.g. "en" |
device | string | Optional | device type optional field return results for a specific device type can take the values: desktop , mobile default value: desktop note: for mobile device, only 20 results are returned for every SERP |
language_name | string | Optional | 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… |
os | string | Optional | 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</code |
tag | string | Optional | 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 |
url | string | Optional | 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… |
location_coordinate | string | Optional | GPS coordinates of a location. Required field if you don't specify location_code. Use location_code or location_coordinate; Live Maps rejects location_name with 40501 Invalid Field even though vendor docs list it. |
se_domain | string | Optional | 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:… |
search_this_area | boolean | Optional | show results from the displayed area optional field can take the values: true , false default value: true if set to false , the search_this_area mode will be turned off Note: if the < |
search_places | boolean | Optional | search places mode optional field the search places mode allows to obtain Google Maps results on a certain place (e.g., Apple Store in New York) however, due to the pecularities of our data mining algorithm, this mode… |
Live Google News SERP provides real-time data on top search engine results for the specified keyword, search engine, and location. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "keyword": "android"}]. Capped at depth 10, max_crawl_pages 1. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | 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 ,… e.g. "android" |
location_code | integer | Optional | 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 e.g. 2840 |
language_code | string | Optional | 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… e.g. "en" |
location_name | string | Optional | 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 y |
language_name | string | Optional | 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… |
os | string | Optional | device operating system optional field note that this API provides results for desktop only choose from the following values: windows , macos default value: windows |
search_param | string | Optional | additional parameters of the search query optional field Get the list of available parameters and additional details here. |
calculate_rectangles | boolean | Optional | 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> |
browser_screen_width | integer | Optional | browser screen width optional field you can set a custom browser screen width to calculate pixel rankings for a particular device; by default, the parameter is set to 1920 ; Note: to use this parameter, set… |
browser_screen_height | integer | Optional | browser screen height optional field you can set a custom browser screen height to calculate pixel rankings for a particular device; by default, the parameter is set to 1080 ; Note: to use this parameter, set… |
browser_screen_resolution_ratio | integer | Optional | browser screen resolution ratio optional field you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device; by default, the parameter is set to 1 ; Note: to use this… |
url | string | Optional | 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… |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location |
se_domain | string | Optional | 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:… |
Live SERP provides real-time data on top search engine results for the specified keyword, search engine, and location. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "keyword": "albert einstein", "calculate_rectangles": true}]. Capped at depth 10, max_crawl_pages 1. $0.02 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | 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 ,… e.g. "albert einstein" |
location_code | integer | Optional | 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 e.g. 2840 |
language_code | string | Optional | 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… e.g. "en" |
device | string | Optional | device type optional field return results for a specific device type can take the values: desktop , mobile default value: desktop |
load_async_ai_overview | boolean | Optional | 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:… |
location_name | string | Optional | 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 y |
language_name | string | Optional | 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… |
os | string | Optional | 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</code |
tag | string | Optional | 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 |
stop_crawl_on_match | array | Optional | array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example:… |
match_type | string | Optional | 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 <cod |
match_value | string | Optional | 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… |
search_param | string | Optional | additional parameters of the search query optional field get the list of available parameters and additional details here Note: the following search engine par |
remove_from_url | array | Optional | 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… |
people_also_ask_click_depth | integer | Optional | 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;… |
group_organic_results | boolean | Optional | 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… |
calculate_rectangles | boolean | Optional | 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> e.g. true |
browser_screen_width | integer | Optional | 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… |
browser_screen_height | integer | Optional | 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… |
browser_screen_resolution_ratio | integer | Optional | 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,… |
url | string | Optional | 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… |
location_coordinate | string | Optional | 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 para |
se_domain | string | Optional | 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:… |
target | string | Optional | 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… |
target_search_mode | string | Optional | 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 ,… |
find_targets_in | array | Optional | 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… |
ignore_targets_in | array | Optional | 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… |
Live Google organic results for a keyword — rank, title, URL, snippet — by location Body: a JSON array with exactly one task object, e.g. [{"keyword": "coffee", "location_code": 2840, "language_code": "en", "depth": 10}]. Capped at depth 10. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Required | up to 700 chars; advanced search operators multiply the price by 5 e.g. "coffee" |
location_code | integer | Required | one of location_code | location_name | location_coordinate; 2840 = United States e.g. 2840 |
location_name | string | Optional | alternative to location_code, e.g. "United States" |
language_code | string | Required | one of language_code | language_name e.g. "en" |
device | string | Optional | desktop (default) | mobile |
os | string | Optional | windows/macos for desktop, android/ios for mobile |
The result of a task submitted with dataforseo.x.serp-google-search-by-image-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
Google Search By Image SERP API provides up to top 100 search engine results based on the image you specified. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "image_url": "https://dataforseo.com/wp-content/uploads/2016/11/data_for_seo_light_429.png"}]. Capped at max_crawl_pages 1. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
image_url | string | Optional | URL of the image required field the results will be based on the image you specified in this field example: https://upload.wikimedia.org/wikipedia/commons/e/ed/Elon_Musk_Royal_Society.jpg e.g. "https://dataforseo.com/wp-content/uploads/2016/11/data_for_ |
location_code | integer | Optional | 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 e.g. 2840 |
language_code | string | Optional | 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… e.g. "en" |
priority | integer | Optional | 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… |
location_name | string | Optional | 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 y |
language_name | string | Optional | 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… |
tag | string | Optional | 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 |
search_param | string | Optional | additional parameters of the search query optional field get the list of available parameters and additional details here |
calculate_rectangles | boolean | Optional | 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> |
browser_screen_width | integer | Optional | browser screen width optional field you can set a custom browser screen width to calculate pixel rankings for a particular device; by default, the parameter is set to 1920 ; Note: to use this parameter, set… |
browser_screen_height | integer | Optional | browser screen height optional field you can set a custom browser screen height to calculate pixel rankings for a particular device; by default, the parameter is set to 1080 ; Note: to use this parameter, set… |
browser_screen_resolution_ratio | integer | Optional | browser screen resolution ratio optional field you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device; by default, the parameter is set to 1 ; Note: to use this… |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location |
se_domain | string | Optional | 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:… |
The result of a task submitted with dataforseo.x.serp-naver-organic-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
Naver SERP API provides top 15 search engine results. Body: a JSON array with exactly one task object, e.g. [{"keyword": "albert einstein", "device": "desktop", "tag": "some_string_123", "postback_url": "https://your-server.com/postbackscript.php", "postback_data": "r. Capped at depth 10, max_crawl_pages 1. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | 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,… e.g. "albert einstein" |
url | string | Optional | direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields in most cases, we wouldn’t recommend using this method; example:… |
priority | integer | Optional | 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… |
device | string | Optional | device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop e.g. "desktop" |
os | string | Optional | 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… |
se_domain | string | Optional | 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.naver.com |
search_param | string | Optional | additional parameters of the search query optional field get the list of available parameters and additional details here |
stop_crawl_on_match | array | Optional | array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example:… |
match_value | string | Optional | 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… |
match_type | string | Optional | 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 –… |
tag | string | Optional | 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 e.g. "some_string_123" |
You will receive the list of locations by this API call. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Required | country |
The result of a task submitted with dataforseo.x.serp-seznam-organic-task-post: free, readable only by the team that submitted it, for 30 days. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
id | string | Required | task id from the matching task_post call |
Seznam SERP API provides top 10 search engine results from one of the most popular search engines in the Czech Republic. Body: a JSON array with exactly one task object, e.g. [{"language_code": "cs", "location_code": 2203, "keyword": "albert einstein"}]. Capped at depth 10, max_crawl_pages 1. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | 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,… e.g. "albert einstein" |
location_name | string | Optional | 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… |
location_code | integer | Optional | 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… e.g. 2203 |
language_name | string | Optional | 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… |
language_code | string | Optional | 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… e.g. "cs" |
url | string | Optional | 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… |
priority | integer | Optional | 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… |
device | string | Optional | device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop |
os | string | Optional | 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… |
se_domain | string | Optional | 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 | Optional | additional parameters of the search query optional field |
calculate_rectangles | boolean | Optional | 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… |
stop_crawl_on_match | array | Optional | array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example:… |
match_value | string | Optional | 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… |
match_type | string | Optional | 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 –… |
tag | string | Optional | 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 |
You will receive the list of locations by this API call. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Required | country |
Live SERP provides real-time data on top search engine results. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "keyword": "albert einstein"}]. Capped at depth 10, max_crawl_pages 1. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Optional | 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… |
keyword | string | Optional | 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,… e.g. "albert einstein" |
location_name | string | Optional | 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… |
location_code | integer | Optional | 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… e.g. 2840 |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don’t 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… |
language_name | string | Optional | 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… |
language_code | string | Optional | 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… e.g. "en" |
device | string | Optional | device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop |
os | string | Optional | 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… |
se_domain | string | Optional | 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:… |
target | string | Optional | 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… |
search_param | string | Optional | additional parameters of the search query optional field get the list of available parameters and additional details here |
stop_crawl_on_match | array | Optional | array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example:… |
match_value | string | Optional | 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… |
match_type | string | Optional | 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 –… |
tag | string | Optional | 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 |
Live Yahoo SERP provides real-time data on search engine results for the specified keyword, search engine, and location. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "keyword": "albert einstein"}]. Capped at depth 10, max_crawl_pages 1. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
url | string | Optional | 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… |
keyword | string | Optional | 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,… e.g. "albert einstein" |
location_name | string | Optional | 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… |
location_code | integer | Optional | 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… e.g. 2840 |
location_coordinate | string | Optional | GPS coordinates of a location required field if you don’t 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… |
language_name | string | Optional | 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… |
language_code | string | Optional | 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… e.g. "en" |
device | string | Optional | device type optional field can take the values:desktop, mobile default value: desktop |
os | string | Optional | 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… |
se_domain | string | Optional | 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:… |
target | string | Optional | 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… |
search_param | string | Optional | additional parameters of the search query optional field get the list of available parameters and additional details here |
stop_crawl_on_match | array | Optional | array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example:… |
match_value | string | Optional | target domain, subdomain, or wildcard value required field if stop_crawl_on_match is specified; required field if stop_crawl_on_match is specified specify a target domain, subdomain, or wildcard value; Note: domain or… |
match_type | string | Optional | 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 –… |
tag | string | Optional | 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 |
You will receive the list of locations by this API call. $0.001 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
country | string | Required | country |
Live SERP provides real-time data on the top 20 blocks of YouTube search engine results. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "keyword": "audi"}]. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
keyword | string | Optional | 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,… e.g. "audi" |
location_code | integer | Optional | 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… e.g. 2840 |
language_code | string | Optional | 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… e.g. "en" |
device | string | Optional | device type optional field return results for a specific device type available values: desktop, mobile |
block_depth | integer | Optional | parsing depth optional field number of blocks of results in SERP default value: 20 max value: 200 Note: your account will be billed per each SERP containing up to 20 results; thus, setting a block depth above 20 may… |
location_name | string | Optional | 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… |
language_name | string | Optional | 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… |
os | string | Optional | 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… |
tag | string | Optional | 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 |
search_param | string | Optional | additional parameters of the search query optional field example: sp=EgIQAg%253D%253D |
Live YouTube Comments provides real-time data on comments on the video you specify in the request. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "video_id": "vQXvyV0zIP4"}]. Capped at depth 10. $0.01 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
video_id | string | Optional | ID of the video required field you can find video ID in the URL or ‘youtube_video’ item of YouTube Organic result example: vQXvyV0zIP4 e.g. "vQXvyV0zIP4" |
location_name | string | Optional | 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… |
location_code | integer | Optional | 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… e.g. 2840 |
language_name | string | Optional | 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… |
language_code | string | Optional | 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… e.g. "en" |
device | string | Optional | device type optional field only value: desktop |
os | string | Optional | device operating system optional field choose from the following values: windows, macos default value: windows |
tag | string | Optional | 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 |
Live YouTube Video Info provides real-time data on the video you specify in the request. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "video_id": "vQXvyV0zIP4"}]. $0.02 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
video_id | string | Optional | ID of the video required field you can find video ID in the URL or 'youtube_video' item of YouTube Organic result example: vQXvyV0zIP4 e.g. "vQXvyV0zIP4" |
location_code | integer | Optional | 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… e.g. 2840 |
language_code | string | Optional | 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… e.g. "en" |
device | string | Optional | device type optional field only value: desktop |
location_name | string | Optional | 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… |
language_name | string | Optional | 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… |
os | string | Optional | device operating system optional field choose from the following values: windows, macos default value: windows |
tag | string | Optional | 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 |
Live YouTube Subtitles provides real-time data on subtitles in the video you specify in the request. Body: a JSON array with exactly one task object, e.g. [{"language_code": "en", "location_code": 2840, "video_id": "Y8Wu4rSNJms"}]. $0.02 per call.
| Parameter | Type | Required | What it is |
|---|---|---|---|
video_id | string | Optional | ID of the video required field you can find video ID in the URL or 'youtube_video' item of YouTube Organic result example: Y8Wu4rSNJms e.g. "Y8Wu4rSNJms" |
location_code | integer | Optional | 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… e.g. 2840 |
language_code | string | Optional | 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… e.g. "en" |
device | string | Optional | device type optional field only value: desktop |
location_name | string | Optional | 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… |
language_name | string | Optional | 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… |
os | string | Optional | device operating system optional field choose from the following values: windows, macos default value: windows |
tag | string | Optional | 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 |
subtitles_language | string | Optional | language code of original text you can get the language code from YouTube Video Info result |
subtitles_translate_language | string | Optional | language code of translated text possible values: "az", "ay", "ak", "sq", "am", "en", "ar", "hy", "as", "af", "eu", "be", "bn", "my", "bg", "bs", "bho", "cy", "hu", "vi", "haw", "ht", "gl", "lg", "el", "ka", "gn",… |