{ "count": 84, "generatedAt": "2026-07-16T21:02:04.110Z", "sourceVersion": "dataforseo-mcp-server@2.9.9", "tools": [ { "name": "ai_opt_kw_data_loc_and_lang", "title": "AI Optimization Keywords Data Locations and Languages", "description": "Utility tool for 'AI Optimization Keyword Data Locations and Languages' (ai_opt_kw_data_loc_and_lang) to get list of availible locations and languages", "module": "ai-optimization", "endpoint": "/v3/ai_optimization/ai_keyword_data/locations_and_languages", "method": "GET", "pathTemplate": null, "params": [], "payloadPassthrough": null }, { "name": "ai_optimization_keyword_data_search_volume", "title": "AI Optimization Keyword Data Search Volume", "description": "This endpoint provides search volume data for your target keywords, reflecting their estimated usage in AI LLMs", "module": "ai-optimization", "endpoint": "/v3/ai_optimization/ai_keyword_data/keywords_search_volume/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "keywords", "coreType": "array", "nullable": false, "optional": false, "description": "Keywords. The maximum number of keywords you can specify: 1000" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location, example: 'United Kingdom', 'United States'" }, { "name": "language_code", "coreType": "string", "nullable": false, "optional": false, "description": "Search engine language code (e.g., 'en')" } ], "payloadPassthrough": true }, { "name": "ai_optimization_llm_mentions_filters", "title": "AI Optimization LLM Mentions Filters", "description": "This endpoint provides all the necessary information about filters that can be used with AI Optimization LLM Mentions API endpoints", "module": "ai-optimization", "endpoint": "/v3/ai_optimization/llm_mentions/available_filters", "method": "GET", "pathTemplate": null, "params": [], "payloadPassthrough": null }, { "name": "ai_opt_llm_ment_agg_metrics", "title": "AI Optimization LLM Mentions Aggregated Metrics", "description": "This endpoint provides aggregated metrics for mentions of the keywords or domains specified in the target array of the request.", "module": "ai-optimization", "endpoint": "/v3/ai_optimization/llm_mentions/aggregated_metrics/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "array", "nullable": false, "optional": false, "description": "Array of target objects to search for LLM mentions. Each object must contain either 'domain' or 'keyword'. Maximum number of targets: 1000" }, { "name": "location_name", "coreType": "string", "nullable": false, "optional": true, "description": "full name of the location, example: 'United Kingdom', 'United States'" }, { "name": "language_code", "coreType": "string", "nullable": false, "optional": true, "description": "Search engine language code (e.g., 'en')" }, { "name": "platform", "coreType": "enum", "nullable": false, "optional": true, "description": "Platform to search for LLM mentions" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like\nUse % with like/not_like/ilike/not_ilike as a wildcard.\nExample:\n Single: [\"ai_search_volume\", \">\", \"1000\"]\nThe full list of possible filters is available in 'ai_optimization_llm_mentions_fil" }, { "name": "internal_list_limit", "coreType": "number", "nullable": false, "optional": true, "description": "Internal parameter to limit the number of items processed. Not exposed to end-users." } ], "payloadPassthrough": true }, { "name": "ai_opt_llm_ment_cross_agg_metrics", "title": "AI Optimization LLM Mentions Cross Aggregated Metrics", "description": "This endpoint provides aggregated metrics grouped by custom keys for mentions of the keywords or domains specified in the target array of the request", "module": "ai-optimization", "endpoint": "/v3/ai_optimization/llm_mentions/cross_aggregated_metrics/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "targets", "coreType": "array", "nullable": false, "optional": false, "description": "array of objects containing target entities with aggregation keys. you can specify up to 10, but not less than 2" }, { "name": "location_name", "coreType": "string", "nullable": false, "optional": true, "description": "full name of the location, example: 'United Kingdom', 'United States'" }, { "name": "language_code", "coreType": "string", "nullable": false, "optional": true, "description": "Search engine language code (e.g., 'en')" }, { "name": "platform", "coreType": "enum", "nullable": false, "optional": true, "description": "Platform to search for LLM mentions" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like\nUse % with like/not_like/ilike/not_ilike as a wildcard.\nExample:\n Single: [\"ai_search_volume\", \">\", \"1000\"]\nThe full list of possible filters is available in 'ai_optimization_llm_mentions_fil" }, { "name": "internal_list_limit", "coreType": "number", "nullable": false, "optional": true, "description": "Internal parameter to limit the number of items processed. Not exposed to end-users." } ], "payloadPassthrough": true }, { "name": "ai_opt_llm_ment_search", "title": "AI Optimization LLM Mentions Search", "description": "This endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned pages for the specified target", "module": "ai-optimization", "endpoint": "/v3/ai_optimization/llm_mentions/search/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "array", "nullable": false, "optional": false, "description": "Array of target objects to search for LLM mentions. Each object must contain either 'domain' or 'keyword'. Maximum number of targets: 1000" }, { "name": "location_name", "coreType": "string", "nullable": false, "optional": true, "description": "full name of the location, example: 'United Kingdom', 'United States'" }, { "name": "language_code", "coreType": "string", "nullable": false, "optional": true, "description": "Search engine language code (e.g., 'en')" }, { "name": "platform", "coreType": "enum", "nullable": false, "optional": true, "description": "Platform to search for LLM mentions" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like\nUse % with like/not_like/ilike/not_ilike as a wildcard.\nExample:\n Single: [\"ai_search_volume\", \">\", \"1000\"]\nThe full list of possible filters is available in 'ai_optimization_llm_mentions_fil" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "resuresults sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to set up a sorting type\nexample:\n[\"ai_search_volume,desc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexample:\n[\"ai_search_volume,desc\"]\nThe ful" }, { "name": "limit", "coreType": "number", "nullable": false, "optional": true, "description": "Number of results to return. Default is 10, maximum is 1000." } ], "payloadPassthrough": true }, { "name": "ai_opt_llm_ment_top_domains", "title": "AI Optimization LLM Mentions Top Domains", "description": "This endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned domains for the specified target", "module": "ai-optimization", "endpoint": "/v3/ai_optimization/llm_mentions/top_domains/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "array", "nullable": false, "optional": false, "description": "Array of target objects to search for LLM mentions. Each object must contain either 'domain' or 'keyword'. Maximum number of targets: 1000" }, { "name": "location_name", "coreType": "string", "nullable": false, "optional": true, "description": "full name of the location, example: 'United Kingdom', 'United States'" }, { "name": "language_code", "coreType": "string", "nullable": false, "optional": true, "description": "Search engine language code (e.g., 'en')" }, { "name": "platform", "coreType": "enum", "nullable": false, "optional": true, "description": "Platform to search for LLM mentions" }, { "name": "links_scope", "coreType": "enum", "nullable": false, "optional": true, "description": "specifies which links will be used to extract domains and aggregation" }, { "name": "initial_dataset_filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like\nUse % with like/not_like/ilike/not_ilike as a wildcard.\nExample:\n Single: [\"ai_search_volume\", \">\", \"1000\"]\nThe full list of possible filters is available in 'ai_optimization_llm_mentions_fil" }, { "name": "items_list_limit", "coreType": "number", "nullable": false, "optional": true, "description": "maximum number of results in the items array, min value is 1, max value is 10" }, { "name": "internal_list_limit", "coreType": "number", "nullable": false, "optional": true, "description": "maximum number of elements within internal arrays, min value is 1, max value is 10" } ], "payloadPassthrough": true }, { "name": "ai_opt_llm_ment_top_pages", "title": "AI Optimization LLM Mentions Top Pages", "description": "This endpoint provides aggregated LLM mentions metrics grouped by the most frequently mentioned pages for the specified target", "module": "ai-optimization", "endpoint": "/v3/ai_optimization/llm_mentions/top_pages/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "array", "nullable": false, "optional": false, "description": "Array of target objects to search for LLM mentions. Each object must contain either 'domain' or 'keyword'. Maximum number of targets: 1000" }, { "name": "location_name", "coreType": "string", "nullable": false, "optional": true, "description": "full name of the location, example: 'United Kingdom', 'United States'" }, { "name": "language_code", "coreType": "string", "nullable": false, "optional": true, "description": "Search engine language code (e.g., 'en')" }, { "name": "platform", "coreType": "enum", "nullable": false, "optional": true, "description": "Platform to search for LLM mentions" }, { "name": "links_scope", "coreType": "enum", "nullable": false, "optional": true, "description": "specifies which links will be used to extract domains and aggregation" }, { "name": "initial_dataset_filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like\nUse % with like/not_like/ilike/not_ilike as a wildcard.\nExample:\n Single: [\"ai_search_volume\", \">\", \"1000\"]\nThe full list of possible filters is available in 'ai_optimization_llm_mentions_fil" }, { "name": "items_list_limit", "coreType": "number", "nullable": false, "optional": true, "description": "maximum number of results in the items array, min value is 1, max value is 10" }, { "name": "internal_list_limit", "coreType": "number", "nullable": false, "optional": true, "description": "maximum number of elements within internal arrays, min value is 1, max value is 10" } ], "payloadPassthrough": true }, { "name": "ai_opt_llm_ment_loc_and_lang", "title": "AI Optimization LLM Mentions Locations and Languages", "description": "Utility tool for 'AI Optimization LLM Mentions Locations and Languages' (ai_opt_llm_ment_loc_and_lang) to get list of available locations and languages", "module": "ai-optimization", "endpoint": "/v3/ai_optimization/llm_mentions/locations_and_languages", "method": "GET", "pathTemplate": null, "params": [], "payloadPassthrough": null }, { "name": "ai_optimization_chat_gpt_scraper_locations", "title": "AI Optimization Chat GPT Scraper Locations", "description": "Utility tool for ai_optimization_chat_gpt_scraper to get list of available locations", "module": "ai-optimization", "endpoint": "/v3/ai_optimization/chat_gpt/llm_scraper/locations", "method": "POST", "pathTemplate": null, "params": [ { "name": "country_iso_code", "coreType": "string", "nullable": false, "optional": true, "description": "ISO 3166-1 alpha-2 country code, for example: US, GB, MT" }, { "name": "location_name", "coreType": "string", "nullable": false, "optional": true, "description": "Name of location or it`s part." } ], "payloadPassthrough": true }, { "name": "ai_optimization_chat_gpt_scraper", "title": "AI Optimization Chat GPT Scraper", "description": "This endpoint provides results from ChatGPT searches", "module": "ai-optimization", "endpoint": "/v3/ai_optimization/chat_gpt/llm_scraper/live/advanced", "method": "POST", "pathTemplate": null, "params": [ { "name": "keyword", "coreType": "string", "nullable": false, "optional": false, "description": "keyword\nrequired field\nyou can specify up to 2000 characters in the keyword field\nall %## will be decoded (plus character ‘+’ will be decoded to a space character)\nif you need to use the “%” character for your keyword, please specify it as “%25”;\nif you need to use the “+” character for your keyword, please specify it as “%2B”" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location, example: 'United Kingdom', 'United States'" }, { "name": "language_code", "coreType": "string", "nullable": false, "optional": false, "description": "Search engine language code (e.g., 'en')" }, { "name": "force_web_search", "coreType": "boolean", "nullable": false, "optional": true, "description": "force AI agent to use web search" } ], "payloadPassthrough": true }, { "name": "ai_optimization_llm_models", "title": "AI Optimization LLM Models", "description": "Utility tool for ai_optimization_llm_response to get list of availible locations and languages", "module": "ai-optimization", "endpoint": "/v3/ai_optimization/TESTSTR/llm_responses/models", "method": "GET", "pathTemplate": { "template": "/v3/ai_optimization/{llm_type}/llm_responses/models", "vars": [ "llm_type" ] }, "params": [ { "name": "llm_type", "coreType": "string", "nullable": false, "optional": false, "description": "type of llm. Must be one of: 'claude', 'gemini', 'chat_gpt', 'perplexity'" } ], "payloadPassthrough": null }, { "name": "ai_optimization_llm_response", "title": "AI Optimization LLM Response", "description": "This endpoint allows you to retrieve structured responses from a specific AI model, based on the input parameters", "module": "ai-optimization", "endpoint": "/v3/ai_optimization/TESTSTR/llm_responses/live", "method": "POST", "pathTemplate": { "template": "/v3/ai_optimization/{llm_type}/llm_responses/live", "vars": [ "llm_type" ] }, "params": [ { "name": "llm_type", "coreType": "string", "nullable": false, "optional": false, "description": "type of llm. Must be one of: 'claude', 'gemini', 'chat_gpt', 'perplexity'" }, { "name": "user_prompt", "coreType": "string", "nullable": false, "optional": false, "description": "Prompt for the AI model. The question or task you want to send to the AI model. You can specify up to 500 characters in the user_prompt field" }, { "name": "model_name", "coreType": "string", "nullable": false, "optional": false, "description": "name of the AI model. consists of the actual model name and version name. if not sure which model to use, first call the ai_optimization_llm_models tool to get list of available models for the specified llm_type" }, { "name": "temperature", "coreType": "number", "nullable": false, "optional": true, "description": "randomness of the AI response optional field higher values make output more diverse; lower values make output more focused;" }, { "name": "top_p", "coreType": "number", "nullable": false, "optional": true, "description": "diversity of the AI response, optional field, controls diversity of the response by limiting token selection;" }, { "name": "web_search", "coreType": "boolean", "nullable": false, "optional": true, "description": "enable web search for current information. When enabled, the AI model can access and cite current web information;" } ], "payloadPassthrough": true }, { "name": "backlinks_anchors", "title": "Backlinks Anchors", "description": "This endpoint will provide you with a detailed overview of anchors used when linking to the specified website with relevant backlink data for each of them", "module": "backlinks", "endpoint": "/v3/backlinks/anchors/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "string", "nullable": false, "optional": false, "description": "domain, subdomain or webpage to get backlinks for\n required field\na domain or a subdomain should be specified without https:// and www.\na page should be specified with absolute URL (including http:// or https://)" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "the maximum number of returned anchors" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of returned anchors\noptional field\ndefault value: 0\nif 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 anchors" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: =, <>, in, not_in, like, not_like, ilike, not_ilike, regex, not_regex, match, not_match\nUse % with like/not_like to match any string of zero or more characters.\nExamples:\n Single: [\"rank\",\">\",\"80\"]\n Combined: [[\"page_from_rank\",\">\",\"55\"],\"and\",[\"dofollow\",\"=\",true]]" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to set up a sorting type\nexample:\n[\"rank,desc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexample:\n[\"domain_from_rank,desc\",\"page_from_rank,asc\"]" } ], "payloadPassthrough": true }, { "name": "backlinks_backlinks", "title": "Backlinks Backlinks", "description": "This endpoint will provide you with a list of backlinks and relevant data for the specified domain, subdomain, or webpage", "module": "backlinks", "endpoint": "/v3/backlinks/backlinks/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "string", "nullable": false, "optional": false, "description": "domain, subdomain or webpage to get backlinks for\n required field\na domain or a subdomain should be specified without https:// and www.\na page should be specified with absolute URL (including http:// or https://)" }, { "name": "mode", "coreType": "string", "defaultValue": "as_is", "nullable": false, "optional": true, "description": "results grouping type\noptional field\npossible grouping types:\nas_is – returns all backlinks\none_per_domain – returns one backlink per domain\none_per_anchor – returns one backlink per anchor\ndefault value: as_is" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "the maximum number of returned backlinks" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of the returned backlinks\noptional field\ndefault value: 0\nif 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" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: =, <>, in, not_in, like, not_like, ilike, not_ilike, regex, not_regex, match, not_match\nUse % with like/not_like to match any string of zero or more characters.\nExamples:\n Single: [\"rank\",\">\",\"80\"]\n Combined: [[\"page_from_rank\",\">\",\"55\"],\"and\",[\"dofollow\",\"=\",true]]" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to set up a sorting type\nexample:\n[\"rank,desc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexample:\n[\"domain_from_rank,desc\",\"page_from_rank,asc\"]" } ], "payloadPassthrough": true }, { "name": "backlinks_bulk_backlinks", "title": "Backlinks Bulk Backlinks", "description": "This endpoint will provide you with the number of backlinks pointing to domains, subdomains, and pages specified in the targets array. The returned numbers correspond to all live backlinks, that is, total number of referring links with all attributes (e.g., nofollow, noreferrer, ugc, sponsored etc) that were found during the latest check.\nNote that if you indicate a domain as a target, you will get results for the root domain (domain with all of its subdomains), e.g. dataforseo.com and app.dataforseo.com", "module": "backlinks", "endpoint": "/v3/backlinks/bulk_backlinks/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "targets", "coreType": "array", "nullable": false, "optional": false, "description": "domains, subdomains or webpages to get rank for\nrequired field\nyou can set up to 1000 domains, subdomains or webpages\nthe domain or subdomain should be specified without https:// and www.\nthe page should be specified with absolute URL (including http:// or https://)\nexample:\n\"targets\": [\n\"forbes.com\",\n\"cnn.com\",\n\"bbc.com\",\n\"yelp.com\",\n\"https://www.apple.com/iphone/\",\n\"https://ahrefs.com/blog/\",\n\"ibm.com\",\n\"https://variety.com/\",\n\"https://stackoverflow.com/\",\n\"www.trustpilot.com\"\n]" } ], "payloadPassthrough": true }, { "name": "backlinks_bulk_new_lost_backlinks", "title": "Backlinks Bulk New Lost Backlinks", "description": "This endpoint will provide you with the number of referring domains pointing to domains, subdomains, and pages specified in the targets array. The returned numbers are based on all live referring domains, that is, total number of domains pointing to the target with any type of backlinks (e.g., nofollow, noreferrer, ugc, sponsored etc) that were found during the latest check.\nNote that if you indicate a domain as a target, you will get result for the root domain (domain with all of its subdomains), e.g. dataforseo.com and app.dataforseo.com", "module": "backlinks", "endpoint": "/v3/backlinks/bulk_new_lost_backlinks/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "targets", "coreType": "array", "nullable": false, "optional": false, "description": "domains, subdomains or webpages to get rank for\nrequired field\nyou can set up to 1000 domains, subdomains or webpages\nthe domain or subdomain should be specified without https:// and www.\nthe page should be specified with absolute URL (including http:// or https://)\nexample:\n\"targets\": [\n\"forbes.com\",\n\"cnn.com\",\n\"bbc.com\",\n\"yelp.com\",\n\"https://www.apple.com/iphone/\",\n\"https://ahrefs.com/blog/\",\n\"ibm.com\",\n\"https://variety.com/\",\n\"https://stackoverflow.com/\",\n\"www.trustpilot.com\"\n]" }, { "name": "date_from", "coreType": "string", "nullable": false, "optional": true, "description": "starting date of the time range\noptional field\nthis field indicates the date which will be used as a threshold for new and lost backlinks;\nthe backlinks that appeared in our index after the specified date will be considered as new;\nthe backlinks that weren’t found after the specified date, but were present before, will be considered as lost;\ndefault value: today’s date -(minus) one month;\ne.g. if today is 2021-10-13, default date_from will be 2021-09-13.\nminimum value equals today’s date -(minus" } ], "payloadPassthrough": true }, { "name": "backlinks_bulk_new_lost_referring_domains", "title": "Backlinks Bulk New Lost Referring Domains", "description": "This endpoint will provide you with the number of referring domains pointing to the domains, subdomains and pages specified in the targets array.\nNote that if you indicate a domain as a target, you will get result for the root domain (domain with all of its subdomains), e.g. dataforseo.com and app.dataforseo.com", "module": "backlinks", "endpoint": "/v3/backlinks/bulk_new_lost_referring_domains/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "targets", "coreType": "array", "nullable": false, "optional": false, "description": "domains, subdomains or webpages to get rank for\nrequired field\nyou can set up to 1000 domains, subdomains or webpages\nthe domain or subdomain should be specified without https:// and www.\nthe page should be specified with absolute URL (including http:// or https://)\nexample:\n\"targets\": [\n\"forbes.com\",\n\"cnn.com\",\n\"bbc.com\",\n\"yelp.com\",\n\"https://www.apple.com/iphone/\",\n\"https://ahrefs.com/blog/\",\n\"ibm.com\",\n\"https://variety.com/\",\n\"https://stackoverflow.com/\",\n\"www.trustpilot.com\"\n]" }, { "name": "date_from", "coreType": "string", "nullable": false, "optional": true, "description": "starting date of the time range\noptional field\nthis field indicates the date which will be used as a threshold for new and lost backlinks;\nthe backlinks that appeared in our index after the specified date will be considered as new;\nthe backlinks that weren’t found after the specified date, but were present before, will be considered as lost;\ndefault value: today’s date -(minus) one month;\ne.g. if today is 2021-10-13, default date_from will be 2021-09-13.\nminimum value equals today’s date -(minus" } ], "payloadPassthrough": true }, { "name": "backlinks_bulk_pages_summary", "title": "Backlinks Bulk Pages Summary", "description": "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. If you indicate a single page as a target, you will get comprehensive summary data on all backlinks for that page.", "module": "backlinks", "endpoint": "/v3/backlinks/bulk_pages_summary/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "targets", "coreType": "array", "nullable": false, "optional": false, "description": "domains, subdomains or webpages to get summary data for\nrequired field\na domain or a subdomain should be specified without https:// and www.\na page should be specified with absolute URL (including http:// or https://)\nyou can specify up to 1000 pages, domains, or subdomains in each request.\nnote that the URLs you set in a single request cannot belong to more than 100 different domains." }, { "name": "include_subdomains", "coreType": "boolean", "defaultValue": true, "nullable": false, "optional": true, "description": "" } ], "payloadPassthrough": true }, { "name": "backlinks_bulk_ranks", "title": "Backlinks Bulk Ranks", "description": "This endpoint will provide you with rank scores of the domains, subdomains, and pages specified in the targets array. The score is based on the number of referring domains pointing to the specified domains, subdomains, or pages. The rank values represent real-time data for the date of the request and range from 0 (no backlinks detected) to 1,000 (highest rank). A similar scoring system is used in Google’s Page Rank algorithm", "module": "backlinks", "endpoint": "/v3/backlinks/bulk_ranks/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "targets", "coreType": "array", "nullable": false, "optional": false, "description": "domains, subdomains or webpages to get rank for\nrequired field\nyou can set up to 1000 domains, subdomains or webpages\nthe domain or subdomain should be specified without https:// and www.\nthe page should be specified with absolute URL (including http:// or https://)\nexample:\n\"targets\": [\n\"forbes.com\",\n\"cnn.com\",\n\"bbc.com\",\n\"yelp.com\",\n\"https://www.apple.com/iphone/\",\n\"https://ahrefs.com/blog/\",\n\"ibm.com\",\n\"https://variety.com/\",\n\"https://stackoverflow.com/\",\n\"www.trustpilot.com\"\n]" }, { "name": "rank_scale", "coreType": "string", "defaultValue": "one_thousand", "nullable": false, "optional": true, "description": "" } ], "payloadPassthrough": true }, { "name": "backlinks_bulk_referring_domains", "title": "Backlinks Bulk Referring Domains", "description": "This endpoint will provide you with the number of referring domains pointing to domains, subdomains, and pages specified in the targets array. The returned numbers are based on all live referring domains, that is, total number of domains pointing to the target with any type of backlinks (e.g., nofollow, noreferrer, ugc, sponsored etc) that were found during the latest check.\nNote that if you indicate a domain as a target, you will get result for the root domain (domain with all of its subdomains), e.g. dataforseo.com and app.dataforseo.com", "module": "backlinks", "endpoint": "/v3/backlinks/bulk_referring_domains/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "targets", "coreType": "array", "nullable": false, "optional": false, "description": "domains, subdomains or webpages to get rank for\nrequired field\nyou can set up to 1000 domains, subdomains or webpages\nthe domain or subdomain should be specified without https:// and www.\nthe page should be specified with absolute URL (including http:// or https://)\nexample:\n\"targets\": [\n\"forbes.com\",\n\"cnn.com\",\n\"bbc.com\",\n\"yelp.com\",\n\"https://www.apple.com/iphone/\",\n\"https://ahrefs.com/blog/\",\n\"ibm.com\",\n\"https://variety.com/\",\n\"https://stackoverflow.com/\",\n\"www.trustpilot.com\"\n]" } ], "payloadPassthrough": true }, { "name": "backlinks_bulk_spam_score", "title": "Backlinks Bulk Spam Score", "description": "This endpoint will provide you with spam scores of the domains, subdomains, and pages you specified in the targets array. Spam Score is DataForSEO’s proprietary metric that indicates how “spammy” your target is on a scale from 0 to 100", "module": "backlinks", "endpoint": "/v3/backlinks/bulk_spam_score/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "targets", "coreType": "array", "nullable": false, "optional": false, "description": "domains, subdomains or webpages to get rank for\nrequired field\nyou can set up to 1000 domains, subdomains or webpages\nthe domain or subdomain should be specified without https:// and www.\nthe page should be specified with absolute URL (including http:// or https://)\nexample:\n\"targets\": [\n\"forbes.com\",\n\"cnn.com\",\n\"bbc.com\",\n\"yelp.com\",\n\"https://www.apple.com/iphone/\",\n\"https://ahrefs.com/blog/\",\n\"ibm.com\",\n\"https://variety.com/\",\n\"https://stackoverflow.com/\",\n\"www.trustpilot.com\"\n]" } ], "payloadPassthrough": true }, { "name": "backlinks_competitors", "title": "Backlinks Competitors", "description": "This endpoint will provide you with a list of competitors that share some part of the backlink profile with a target website, along with a number of backlink intersections and the rank of every competing website", "module": "backlinks", "endpoint": "/v3/backlinks/competitors/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "string", "nullable": false, "optional": false, "description": "domain, subdomain or webpage to get backlinks for\n required field\na domain or a subdomain should be specified without https:// and www.\na page should be specified with absolute URL (including http:// or https://)" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "the maximum number of returned domains" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of returned networks\noptional field\ndefault value: 0\nif 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 pages" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match\nUse % with like/not_like to match any string of zero or more characters.\nExamples:\n Single: [\"rank\",\">\",\"100\"]\n Combined: [[\"target\",\"like\",\"%forbes%\"],\"and\",[[\"rank\",\">\",\"100\"],\"or\",[\"intersections\",\">\"," }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to set up a sorting type\nexample:\n[\"rank,desc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexample:\n[\"intersections,desc\",\"rank,asc\"]" }, { "name": "main_domain", "coreType": "boolean", "defaultValue": true, "nullable": false, "optional": true, "description": "" }, { "name": "exclude_large_domains", "coreType": "boolean", "defaultValue": true, "nullable": false, "optional": true, "description": "" }, { "name": "exclude_internal_backlinks", "coreType": "boolean", "defaultValue": true, "nullable": false, "optional": true, "description": "" } ], "payloadPassthrough": true }, { "name": "backlinks_domain_intersection", "title": "Backlinks Domain Intersection", "description": "This endpoint will provide you with the list of domains pointing to the specified websites. This endpoint is especially useful for creating a Link Gap feature that shows what domains link to your competitors but do not link out to your website", "module": "backlinks", "endpoint": "/v3/backlinks/domain_intersection/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "targets", "coreType": "array", "nullable": false, "optional": false, "description": "domains, subdomains or webpages to get links for\nrequired field\nyou can set up to 20 domains, subdomains or webpages\na domain or a subdomain should be specified without https:// and www.\na page should be specified with absolute URL (including http:// or https://)" }, { "name": "exclude_targets", "coreType": "array", "nullable": false, "optional": true, "description": "domains, subdomains or webpages you want to exclude\noptional field\nyou can specify up to 10 domains, subdomains or webpages\nif you use this array, results will contain the referring domains that link to targets but don't link to exclude_targets\nexample: [\"bbc.com\",\"https://www.apple.com/iphone/*\",\"https://dataforseo.com/apis/*\"]" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "the maximum number of returned results" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the array of returned results\noptional field\ndefault value: 0\nif 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" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match\nUse % with like/not_like to match any string of zero or more characters.\nExamples:\n Single: [\"1.internal_links_count\",\">\",\"1\"]\n Combined: [[\"2.referring_pages\",\">\",\"2\"],\"and\",[\"1.backlinks\",\">\",\"10\"]]" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to set up a sorting type\nexample:\n[\"backlinks,desc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexample:\n[\"backlinks,desc\",\"rank,asc\"]" } ], "payloadTransforms": { "targets": "numbered_object" }, "payloadPassthrough": true }, { "name": "backlinks_domain_pages_summary", "title": "Backlinks Domain Pages Summary", "description": "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. If you indicate a single page as a target, you will get comprehensive summary data on all backlinks for that page", "module": "backlinks", "endpoint": "/v3/backlinks/domain_pages_summary/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "string", "nullable": false, "optional": false, "description": "domain, subdomain or webpage to get backlinks for\n required field\na domain or a subdomain should be specified without https:// and www.\na page should be specified with absolute URL (including http:// or https://)" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "the maximum number of returned anchors" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of returned anchors\noptional field\ndefault value: 0\nif 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 anchors" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match\nUse % with like/not_like to match any string of zero or more characters.\nExamples:\n Single: [\"referring_links_types.anchors\",\">\",\"1\"]\n Combined: [[\"broken_pages\",\">\",\"2\"],\"and\",[\"backlinks\",\">\",\"10\"]]" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to set up a sorting type\nexample:\n[\"backlinks,desc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexample:\n[\"backlinks,desc\",\"rank,asc\"]" } ], "payloadPassthrough": true }, { "name": "backlinks_domain_pages", "title": "Backlinks Domain Pages", "description": "This endpoint will provide you with a detailed overview of domain pages with backlink data for each page", "module": "backlinks", "endpoint": "/v3/backlinks/domain_pages/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "string", "nullable": false, "optional": false, "description": "domain, subdomain or webpage to get backlinks for\n required field\na domain or a subdomain should be specified without https:// and www.\na page should be specified with absolute URL (including http:// or https://)" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "the maximum number of returned pages" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of returned pages\noptional field\ndefault value: 0\nif 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" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match\nUse % with like/not_like to match any string of zero or more characters.\nExamples:\n Single: [\"meta.internal_links_count\",\">\",\"1\"]\n Combined: [[\"meta.external_links_count\",\">\",\"2\"],\"and\",[\"backlinks\",\">\",\"" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to set up a sorting type\nexample:\n[\"page_summary.backlinks,desc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexample:\n[\"page_summary.backlinks,desc\"," } ], "payloadPassthrough": true }, { "name": "backlinks_available_filters", "title": "Backlinks Available Filters", "description": "Here you will find all the necessary information about filters that can be used with DataForSEO Backlinks API endpoints.\n\nPlease, keep in mind that filters are associated with a certain object in the result array, and should be specified accordingly.", "module": "backlinks", "endpoint": "/v3/backlinks/available_filters", "method": "GET", "pathTemplate": null, "params": [ { "name": "tool", "coreType": "string", "nullable": false, "optional": true, "description": "The name of the tool to get filters for" } ], "payloadPassthrough": null }, { "name": "backlinks_page_intersection", "title": "Backlinks Page Intersection", "description": "This endpoint will provide you with the list of domains pointing to the specified websites. This endpoint is especially useful for creating a Link Gap feature that shows what domains link to your competitors but do not link out to your website", "module": "backlinks", "endpoint": "/v3/backlinks/page_intersection/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "targets", "coreType": "array", "nullable": false, "optional": false, "description": "domains, subdomains or webpages to get links for\nrequired field\nyou can set up to 20 domains, subdomains or webpages\na domain or a subdomain should be specified without https:// and www.\na page should be specified with absolute URL (including http:// or https://)" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "the maximum number of returned results" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the array of returned results\noptional field\ndefault value: 0\nif 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" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match\nUse % with like/not_like to match any string of zero or more characters.\nExamples:\n Single: [\"1.rank\",\">\",\"80\"]\n Combined: [[\"2.page_from_rank\",\">\",\"55\"],\"and\",[\"1.original\",\"=\",\"true\"]]" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to set up a sorting type\nexample:\n[\"rank,desc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexample:\n[\"domain_from_rank,desc\",\"page_from_rank,asc\"]" } ], "payloadTransforms": { "targets": "numbered_object" }, "payloadPassthrough": true }, { "name": "backlinks_referring_domains", "title": "Backlinks Referring Domains", "description": "This endpoint will provide you with a detailed overview of referring domains pointing to the target you specify", "module": "backlinks", "endpoint": "/v3/backlinks/referring_domains/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "string", "nullable": false, "optional": false, "description": "domain, subdomain or webpage to get backlinks for\n required field\na domain or a subdomain should be specified without https:// and www.\na page should be specified with absolute URL (including http:// or https://)" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "the maximum number of returned pages" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of returned pages\noptional field\ndefault value: 0\nif 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" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match\nUse % with like/not_like to match any string of zero or more characters.\nExamples:\n Single: [\"meta.internal_links_count\",\">\",\"1\"]\n Combined: [[\"meta.external_links_count\",\">\",\"2\"],\"and\",[\"backlinks\",\">\",\"" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to set up a sorting type\nexample:\n[\"page_summary.backlinks,desc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexample:\n[\"page_summary.backlinks,desc\"," } ], "payloadPassthrough": true }, { "name": "backlinks_referring_networks", "title": "Backlinks Referring Networks", "description": "This endpoint will provide you with a detailed overview of referring domains pointing to the target you specify", "module": "backlinks", "endpoint": "/v3/backlinks/referring_networks/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "string", "nullable": false, "optional": false, "description": "domain, subdomain or webpage to get backlinks for\n required field\na domain or a subdomain should be specified without https:// and www.\na page should be specified with absolute URL (including http:// or https://)" }, { "name": "network_address_type", "coreType": "string", "defaultValue": "ip", "nullable": false, "optional": true, "description": "indicates the type of network to get data for\noptional field\npossible values: ip, subnet\ndefault value: ip" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "the maximum number of returned networks" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of returned networks\noptional field\ndefault value: 0\nif 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 pages" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match\nUse % with like/not_like to match any string of zero or more characters.\nExamples:\n Single: [\"referring_pages\",\">\",\"1\"]\n Combined: [[\"referring_pages\",\">\",\"2\"],\"and\",[\"backlinks\",\">\",\"10\"]]" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to set up a sorting type\nexample:\n[\"backlinks,desc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexample:\n[\"backlinks,desc\",\"rank,asc\"]" } ], "payloadPassthrough": true }, { "name": "backlinks_summary", "title": "Backlinks Summary", "description": "This endpoint will provide you with an overview of backlinks data available for a given domain, subdomain, or webpage", "module": "backlinks", "endpoint": "/v3/backlinks/summary/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "string", "nullable": false, "optional": false, "description": "domain, subdomain or webpage to get backlinks for\n required field\na domain or a subdomain should be specified without https:// and www.\na page should be specified with absolute URL (including http:// or https://)" }, { "name": "include_subdomains", "coreType": "boolean", "defaultValue": true, "nullable": false, "optional": true, "description": "" }, { "name": "exclude_internal_backlinks", "coreType": "boolean", "defaultValue": true, "nullable": false, "optional": true, "description": "" } ], "payloadPassthrough": true }, { "name": "backlinks_timeseries_new_lost_summary", "title": "Backlinks Timeseries New Lost Summary", "description": "This endpoint will provide you with the number of new and lost backlinks and referring domains for the domain specified in the target field.\nThe results will be provided for a period between the two indicated dates, and metrics will be grouped by the time range that you define: day, week, month, or year.\nData from this endpoint will be especially helpful for building time-series graphs of new and lost backlinks and referring domains.\n\n", "module": "backlinks", "endpoint": "/v3/backlinks/timeseries_new_lost_summary/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "string", "nullable": false, "optional": false, "description": "domain to get data for\nrequired field\na domain should be specified without https:// and www.\nexample:\n\"forbes.com\"" }, { "name": "date_from", "coreType": "string", "nullable": false, "optional": true, "description": "" }, { "name": "date_to", "coreType": "string", "nullable": false, "optional": true, "description": "" }, { "name": "group_range", "coreType": "string", "defaultValue": "month", "nullable": false, "optional": true, "description": "" } ], "payloadPassthrough": true }, { "name": "backlinks_timeseries_summary", "title": "Backlinks Timeseries Summary", "description": "This endpoint will provide you with an overview of backlink data for the target domain available during a period between the two indicated dates. Backlink metrics will be grouped by the time range that you define: day, week, month, or year.\nData from this endpoint will be especially helpful for building time-series graphs of daily, weekly, monthly, and yearly link-building progress", "module": "backlinks", "endpoint": "/v3/backlinks/timeseries_summary/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "string", "nullable": false, "optional": false, "description": "domain to get data for\nrequired field\na domain should be specified without https:// and www.\nexample:\n\"forbes.com\"" }, { "name": "date_from", "coreType": "string", "nullable": false, "optional": true, "description": "" }, { "name": "date_to", "coreType": "string", "nullable": false, "optional": true, "description": "" }, { "name": "group_range", "coreType": "string", "defaultValue": "month", "nullable": false, "optional": true, "description": "" } ], "payloadPassthrough": true }, { "name": "business_data_business_listings_filters", "title": "Business Data Business Listings Filters", "description": "Here you will find all the necessary information about filters that can be used with Business Data API business listings endpoints.\n\nPlease, keep in mind that filters are associated with a certain object in the result array, and should be specified accordingly.", "module": "business-data-api", "endpoint": "/v3/business_data/business_listings/available_filters", "method": "GET", "pathTemplate": null, "params": [ { "name": "tool", "coreType": "string", "nullable": false, "optional": true, "description": "The name of the tool to get filters for" } ], "payloadPassthrough": null }, { "name": "business_data_business_listings_search", "title": "Business Data Business Listings Search", "description": "Business Listings Search API provides results containing information about business entities listed on Google Maps in the specified categories. You will receive the address, contacts, rating, working hours, and other relevant data", "module": "business-data-api", "endpoint": "/v3/business_data/business_listings/search/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "description", "coreType": "string", "nullable": false, "optional": true, "description": "description of the element in SERP\noptional field\nthe description of the business entity for which the results are collected;\ncan contain up to 200 characters" }, { "name": "title", "coreType": "string", "nullable": false, "optional": true, "description": "title of the element in SERP\noptional field\nthe name of the business entity for which the results are collected;\ncan contain up to 200 characters" }, { "name": "categories", "coreType": "array", "nullable": false, "optional": true, "description": "business categories\nthe categories you specify are used to search for business listings;\nif you don’t use this field, we will return business listings found in the specified location;\nyou can specify up to 10 categories" }, { "name": "location_coordinate", "coreType": "string", "nullable": false, "optional": true, "description": "GPS coordinates of a location\noptional field\nlocation_coordinate parameter should be specified in the “latitude,longitude,radius” format\nthe maximum number of decimal digits for “latitude” and “longitude”: 7\nthe value of “radius” is specified in kilometres (km)\nthe minimum value for “radius”: 1\nthe maximum value for “radius”: 100000\nexample:\n53.476225,-2.243572,200" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "the maximum number of returned businesses" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of returned businesses\noptional field\ndefault value: 0\nif 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 entities" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like, match, not_match\nUse % with like/not_like as a wildcard.\nExample:\n Single: [\"rating.value\", \">\", 3]" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to set up a sorting parameter\nexample:\n[\"rating.value,desc\"]note that you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexample:\n[\"rating.value,desc\",\"rating.votes_co" }, { "name": "is_claimed", "coreType": "boolean", "defaultValue": true, "nullable": false, "optional": true, "description": "" } ], "payloadPassthrough": true }, { "name": "content_analysis_phrase_trends", "title": "Content Analysis Phrase Trends", "description": "This endpoint will provide you with data on all citations of the target keyword for the indicated date range", "module": "content-analysis", "endpoint": "/v3/content_analysis/phrase_trends/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "keyword", "coreType": "string", "nullable": false, "optional": false, "description": "target keyword\n Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;" }, { "name": "keyword_fields", "coreType": "object", "nullable": false, "optional": true, "description": "target keyword fields and target keywords\n use this parameter to filter the dataset by keywords that certain fields should contain;\n you can indicate several fields;\n Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;\n example:\n {\n \"snippet\": \"\\\"logitech mouse\\\"\",\n \"main_title\": \"sale\"\n }" }, { "name": "page_type", "coreType": "array", "nullable": false, "optional": true, "description": "target page types" }, { "name": "initial_dataset_filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based initial dataset filter expression applied to Search endpoint fields. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like, has, has_not, match, not_match\nUse % with like/not_like as a wildcard.\nExamples:\n Single: [\"domain\", \"<>\", \"logitech.com\"]\n Combined: [[\"domain\", \"<>\", \"logitech.com\"], \"and\"," }, { "name": "date_from", "coreType": "string", "nullable": false, "optional": false, "description": "starting date of the time range\n date format: \"yyyy-mm-dd\"" }, { "name": "date_to", "coreType": "string", "nullable": false, "optional": true, "description": "" }, { "name": "date_group", "coreType": "enum", "defaultValue": "month", "nullable": false, "optional": true, "description": "" }, { "name": "internal_list_limit", "coreType": "number", "defaultValue": 1, "nullable": false, "optional": true, "description": "" } ], "payloadPassthrough": true }, { "name": "content_analysis_search", "title": "Content Analysis Search", "description": "This endpoint will provide you with detailed citation data available for the target keyword", "module": "content-analysis", "endpoint": "/v3/content_analysis/search/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "keyword", "coreType": "string", "nullable": false, "optional": false, "description": "target keyword\n Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;" }, { "name": "keyword_fields", "coreType": "object", "nullable": false, "optional": true, "description": "target keyword fields and target keywords\n use this parameter to filter the dataset by keywords that certain fields should contain;\n you can indicate several fields;\n Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;\n example:\n {\n \"snippet\": \"\\\"logitech mouse\\\"\",\n \"main_title\": \"sale\"\n }" }, { "name": "page_type", "coreType": "array", "nullable": false, "optional": true, "description": "target page types" }, { "name": "search_mode", "coreType": "enum", "nullable": false, "optional": true, "description": "results grouping type" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "maximum number of results to return" }, { "name": "offset", "coreType": "number", "defaultValue": 0, "nullable": false, "optional": true, "description": "offset in the results array of returned keywords" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like, match, not_match\nUse % with like/not_like as a wildcard.\nExamples:\n Single: [\"country\", \"=\", \"US\"]\n Combined: [[\"domain_rank\", \">\", 800], \"and\", [\"content_info.connotation_types.negative\", \">\", 0.9]]\n Nested: [[\"domain_rank\"" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to set up a sorting type\nexample:\n[\"content_info.sentiment_connotations.anger,desc\"]\ndefault rule:\n[\"content_info.sentiment_connotations.anger,desc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should us" } ], "payloadPassthrough": true }, { "name": "content_analysis_summary", "title": "Content Analysis Summary", "description": "This endpoint will provide you with an overview of citation data available for the target keyword", "module": "content-analysis", "endpoint": "/v3/content_analysis/summary/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "keyword", "coreType": "string", "nullable": false, "optional": false, "description": "target keyword\n Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;" }, { "name": "keyword_fields", "coreType": "object", "nullable": false, "optional": true, "description": "target keyword fields and target keywords\n use this parameter to filter the dataset by keywords that certain fields should contain;\n you can indicate several fields;\n Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;\n example:\n {\n \"snippet\": \"\\\"logitech mouse\\\"\",\n \"main_title\": \"sale\"\n }" }, { "name": "page_type", "coreType": "array", "nullable": false, "optional": true, "description": "target page types" }, { "name": "initial_dataset_filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based initial dataset filter expression applied to Search endpoint fields. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like, has, has_not, match, not_match\nUse % with like/not_like as a wildcard.\nExamples:\n Single: [\"domain\", \"<>\", \"logitech.com\"]\n Combined: [[\"domain\", \"<>\", \"logitech.com\"], \"and\"," }, { "name": "positive_connotation_threshold", "coreType": "number", "defaultValue": 0.4, "nullable": false, "optional": true, "description": "" }, { "name": "sentiments_connotation_threshold", "coreType": "number", "defaultValue": 0.4, "nullable": false, "optional": true, "description": "" }, { "name": "internal_list_limit", "coreType": "number", "defaultValue": 1, "nullable": false, "optional": true, "description": "" } ], "payloadPassthrough": true }, { "name": "dataforseo_labs_bulk_traffic_estimation", "title": "DataForSEO Labs Bulk Traffic Estimation", "description": "This endpoint will provide you with estimated monthly traffic volumes for up to 1,000 domains, subdomains, or webpages. Along with organic search traffic estimations, you will also get separate values for paid search, featured snippet, and local pack results.", "module": "dataforseo-labs", "endpoint": "/v3/dataforseo_labs/google/bulk_traffic_estimation/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "targets", "coreType": "array", "nullable": false, "optional": false, "description": "target domains, subdomains, and webpages.\n you can specify domains, subdomains, and webpages in this field;\ndomains and subdomains should be specified without https:// and www.;\npages should be specified with absolute URL, including https:// and www.;\nyou can set up to 1000 domains, subdomains or webpages" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\nrequired field\nonly in format \"Country\" (not \"City\" or \"Region\")\nexample:\n'United Kingdom', 'United States', 'Canada'" }, { "name": "language_code", "coreType": "string", "defaultValue": "en", "nullable": false, "optional": true, "description": "language code\n required field\n example:\n en" }, { "name": "ignore_synonyms", "coreType": "boolean", "defaultValue": true, "nullable": false, "optional": true, "description": "ignore highly similar keywords, if set to true, results will be more accurate" }, { "name": "item_types", "coreType": "array", "defaultValue": [ "organic" ], "nullable": false, "optional": true, "description": "" } ], "payloadPassthrough": true }, { "name": "dataforseo_labs_google_competitors_domain", "title": "DataForSEO Labs Google Competitors Domain", "description": "This endpoint will provide you with a full overview of ranking and traffic data of the competitor domains from organic and paid search. In addition to that, you will get the metrics specific to the keywords both competitor domains and your domain rank for within the same SERP.", "module": "dataforseo-labs", "endpoint": "/v3/dataforseo_labs/google/competitors_domain/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "string", "nullable": false, "optional": false, "description": "target domain" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\nrequired field\nonly in format \"Country\" (not \"City\" or \"Region\")\nexample:\n'United Kingdom', 'United States', 'Canada'" }, { "name": "language_code", "coreType": "string", "defaultValue": "en", "nullable": false, "optional": true, "description": "language code\n required field\n example:\n en" }, { "name": "ignore_synonyms", "coreType": "boolean", "defaultValue": true, "nullable": false, "optional": true, "description": "ignore highly similar keywords, if set to true, results will be more accurate" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "Maximum number of keywords to return" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of returned keywords\n optional field\n default value: 0\n 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 keywords" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like\nUse % with like/not_like/ilike/not_ilike as a wildcard.\nExamples:\n Single: [\"metrics.organic.count\", \">\", 50]\n Combined: [[\"metrics.organic.pos_1\", \"<>\", 0], \"and\", [\"metrics.organic.impress" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to set up a sorting parameter\ndefault rule:\n[\"relevance,desc\"]\nexample:\n[\"relevance,desc\",\"keyword_info.search_volume,desc\"]" }, { "name": "exclude_top_domains", "coreType": "boolean", "defaultValue": true, "nullable": false, "optional": true, "description": "indicates whether to exclude world's largest websites\n optional field\n default value: false\n set to true if you want to get highly-relevant competitors excluding the top websites" }, { "name": "include_clickstream_data", "coreType": "boolean", "defaultValue": false, "nullable": false, "optional": true, "description": "Include or exclude data from clickstream-based metrics in the result" }, { "name": "item_types", "coreType": "array", "defaultValue": [ "organic" ], "nullable": false, "optional": true, "description": "" } ], "payloadPassthrough": true }, { "name": "dataforseo_labs_google_domain_intersection", "title": "DataForSEO Labs Google Domain Intersection", "description": "This endpoint will provide you with the keywords for which both specified domains rank within the same SERP. You will get search volume, competition, cost-per-click and impressions data on each intersecting keyword. Along with that, you will get data on the first and second domain's SERP element discovered for this keyword, as well as the estimated traffic volume and cost of ad traffic.", "module": "dataforseo-labs", "endpoint": "/v3/dataforseo_labs/google/domain_intersection/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target1", "coreType": "string", "nullable": false, "optional": false, "description": "target domain 1" }, { "name": "target2", "coreType": "string", "nullable": false, "optional": false, "description": "target domain 2" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\nrequired field\nonly in format \"Country\" (not \"City\" or \"Region\")\nexample:\n'United Kingdom', 'United States', 'Canada'" }, { "name": "language_code", "coreType": "string", "defaultValue": "en", "nullable": false, "optional": true, "description": "language code\n required field\n example:\n en" }, { "name": "ignore_synonyms", "coreType": "boolean", "defaultValue": true, "nullable": false, "optional": true, "description": "ignore highly similar keywords, if set to true, results will be more accurate" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "Maximum number of keywords to return" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of returned keywords\n optional field\n default value: 0\n 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 keywords" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like\nUse % with like/not_like/ilike/not_ilike as a wildcard.\nExamples:\n Single: [\"keyword_data.keyword_info.search_volume\", \"in\", [100, 1000]]\n Combined: [[\"first_domain_serp_element.etv\", \">\", 0" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to set up a sorting parameter\nexample:\n[\"keyword_data.keyword_info.competition,desc\"]\ndefault rule:\n[\"keyword_data.keyword_info.search_volume,desc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use" }, { "name": "intersections", "coreType": "boolean", "defaultValue": true, "nullable": false, "optional": true, "description": "" }, { "name": "include_clickstream_data", "coreType": "boolean", "defaultValue": false, "nullable": false, "optional": true, "description": "Include or exclude data from clickstream-based metrics in the result" }, { "name": "item_types", "coreType": "array", "defaultValue": [ "organic" ], "nullable": false, "optional": true, "description": "" } ], "payloadPassthrough": true }, { "name": "dataforseo_labs_google_domain_rank_overview", "title": "DataForSEO Labs Google Domain Rank Overview", "description": "This endpoint will provide you with ranking and traffic data from organic and paid search for the specified domain. You will be able to review the domain ranking distribution in SERPs as well as estimated monthly traffic volume for both organic and paid results.", "module": "dataforseo-labs", "endpoint": "/v3/dataforseo_labs/google/domain_rank_overview/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "string", "nullable": false, "optional": false, "description": "target domain" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\nrequired field\nonly in format \"Country\" (not \"City\" or \"Region\")\nexample:\n'United Kingdom', 'United States', 'Canada'" }, { "name": "language_code", "coreType": "string", "defaultValue": "en", "nullable": false, "optional": true, "description": "language code\n required field\n example:\n en" }, { "name": "ignore_synonyms", "coreType": "boolean", "defaultValue": true, "nullable": false, "optional": true, "description": "ignore highly similar keywords, if set to true, results will be more accurate" } ], "payloadPassthrough": true }, { "name": "dataforseo_labs_google_historical_rank_overview", "title": "DataForSEO Labs Google Historical Rank Overview", "description": "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", "module": "dataforseo-labs", "endpoint": "/v3/dataforseo_labs/google/historical_rank_overview/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "string", "nullable": false, "optional": false, "description": "target domain" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\nrequired field\nonly in format \"Country\" (not \"City\" or \"Region\")\nexample:\n'United Kingdom', 'United States', 'Canada'" }, { "name": "language_code", "coreType": "string", "defaultValue": "en", "nullable": false, "optional": true, "description": "language code\n required field\n example:\n en" }, { "name": "ignore_synonyms", "coreType": "boolean", "defaultValue": true, "nullable": false, "optional": true, "description": "ignore highly similar keywords, if set to true, results will be more accurate" }, { "name": "include_clickstream_data", "coreType": "boolean", "defaultValue": false, "nullable": false, "optional": true, "description": "Include or exclude data from clickstream-based metrics in the result" } ], "payloadPassthrough": true }, { "name": "dataforseo_labs_google_historical_serps", "title": "DataForSEO Labs Google Historical SERPs", "description": "This endpoint will provide you with Google SERPs collected within the specified time frame. You will also receive a complete overview of featured snippets and other extra elements that were present within the specified dates. The data will allow you to analyze the dynamics of keyword rankings over time for the specified keyword and location.", "module": "dataforseo-labs", "endpoint": "/v3/dataforseo_labs/google/historical_serps/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "keyword", "coreType": "string", "nullable": false, "optional": false, "description": "target keyword" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\nrequired field\nonly in format \"Country\" (not \"City\" or \"Region\")\nexample:\n'United Kingdom', 'United States', 'Canada'" }, { "name": "language_code", "coreType": "string", "defaultValue": "en", "nullable": false, "optional": true, "description": "language code\n required field\n example:\n en" }, { "name": "date_from", "coreType": "string", "nullable": false, "optional": true, "description": "starting date of the time range, date format: YYYY-MM-DD" }, { "name": "date_to", "coreType": "string", "nullable": false, "optional": true, "description": "ending date of the time range, date format: YYYY-MM-DD" } ], "payloadPassthrough": true }, { "name": "dataforseo_labs_google_page_intersection", "title": "DataForSEO Labs Google Page Intersection", "description": "This endpoint will provide you with the keywords for which specified pages rank within the same SERP. You will get search volume, competition, cost-per-click and impressions data on each intersecting keyword. Along with that, you will get data on SERP elements that specified pages rank for in search results, as well as the estimated traffic volume and cost of ad traffic. Page Intersection endpoint supports organic, paid, local pack and featured snippet results.\n\nFind keywords several webpages rank for:\nIf you would like to get the keywords several pages rank for, you need to specify webpages only in the pages object. This way, you will receive intersected ranked keywords for the specified URLs.\n\nFind keywords your competitors rank for but you do not:\nIf you would like to receive all keywords several pages rank for, but particular pages do not, you need to use the exclude_pages array as well. This way you will receive the keywords for which the URLs from the pages object rank for, but the URLs from the exclude_pages array do not", "module": "dataforseo-labs", "endpoint": "/v3/dataforseo_labs/google/page_intersection/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "pages", "coreType": "array", "nullable": false, "optional": false, "description": "pages array\nrequired field\nyou can set up to 20 pages in this object\nthe pages should be specified with absolute URLs (including http:// or https://)\nif you specify a single page here, we will return results only for this page;\nyou can also use a wildcard ('*') character to specify the search pattern\nexample:\n\"example.com\"\nsearch for the exact URL\n\"example.com/eng/*\"\nsearch for the example.com page and all its related URLs which start with '/eng/', such as \"example.com/eng/index.html\" and \"examp" }, { "name": "exclude_pages", "coreType": "array", "nullable": false, "optional": true, "description": "URLs of pages you want to exclude\noptional field\nyou can set up to 10 pages in this array\nif you use this array, results will contain the keywords for which URLs from the pages object rank, but URLs from exclude_pages array do not;\nnote that if you specify this field, the results will be based on the keywords any URL from pages ranks for regardless of intersections between them. However, you can set intersection_mode to intersect and results will contain the keywords all URLs from pages rank for" }, { "name": "intersection_mode", "coreType": "enum", "nullable": false, "optional": true, "description": "indicates whether to intersect keywords\noptional field\nuse this field to intersect or merge results for the specified URLs\npossible values: union, intersect\n\nunion – results are based on all keywords any URL from pages rank for;\n\nintersect – results are based on the keywords all URLs from pages rank for in the same SERP:\n\nby default, results are based on the intersect mode if you specify only pages array. If you specify exclude_pages as well, results are based on the union mode" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\nrequired field\nonly in format \"Country\" (not \"City\" or \"Region\")\nexample:\n'United Kingdom', 'United States', 'Canada'" }, { "name": "language_code", "coreType": "string", "defaultValue": "en", "nullable": false, "optional": true, "description": "language code\n required field\n example:\n en" }, { "name": "ignore_synonyms", "coreType": "boolean", "defaultValue": true, "nullable": false, "optional": true, "description": "ignore highly similar keywords, if set to true, results will be more accurate" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "Maximum number of keywords to return" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of returned keywords\n optional field\n default value: 0\n 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 keywords" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like\nUse % with like/not_like/ilike/not_ilike as a wildcard.\nExamples:\n Single: [\"keyword_data.keyword_info.search_volume\", \"in\", [100, 1000]]\n Combined: [[\"intersection_result.1.etv\", \">\", 0], \"" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to set up a sorting parameter\nexample:\n[\"keyword_data.keyword_info.competition,desc\"]\ndefault rule:\n[\"keyword_data.keyword_info.search_volume,desc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use" }, { "name": "include_clickstream_data", "coreType": "boolean", "defaultValue": false, "nullable": false, "optional": true, "description": "Include or exclude data from clickstream-based metrics in the result" }, { "name": "item_types", "coreType": "array", "defaultValue": [ "organic" ], "nullable": false, "optional": true, "description": "" } ], "payloadTransforms": { "pages": "numbered_object" }, "payloadPassthrough": true }, { "name": "dataforseo_labs_google_ranked_keywords", "title": "DataForSEO Labs Google Ranked Keywords", "description": "This endpoint will provide you with the list of keywords that any domain or webpage is ranking for. You will also get SERP elements related to the keyword position, as well as impressions, monthly searches and other data relevant to the returned keywords.", "module": "dataforseo-labs", "endpoint": "/v3/dataforseo_labs/google/ranked_keywords/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "string", "nullable": false, "optional": false, "description": "domain name or page url\nrequired field\nthe domain name of the target website or URL of the target webpage;\nthe domain name must be specified without https:// or www.;\nthe webpage URL must be specified with https:// or www.\nNote: if you specify the webpage URL without https:// or www., the result will be returned for the entire domain rather than the specific page" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\nrequired field\nonly in format \"Country\" (not \"City\" or \"Region\")\nexample:\n'United Kingdom', 'United States', 'Canada'" }, { "name": "language_code", "coreType": "string", "defaultValue": "en", "nullable": false, "optional": true, "description": "language code\n required field\n example:\n en" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "Maximum number of keywords to return" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of returned keywords\n optional field\n default value: 0\n 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 keywords" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array of filter conditions and logical operators. Each filter condition is an array of [field, operator, value].\n Maximum 8 filters allowed.\n Available operators: =, <>, <, <=, >, >=, in, not_in, like, not_like, ilike, not_ilike, regex, not_regex, match, not_match\n Logical operators: \"and\", \"or\"\n Examples:\n Simple filter: [[\"ranked_serp_element.serp_item.rank_group\",\"<=\",10]]\n With logical operator: [[\"ranked_serp_element.serp_item.rank_group\",\"<=\",10],\"" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to set up a sorting type\nexample:\n[\"keyword_data.keyword_info.competition,desc\"]\ndefault rule:\n[\"ranked_serp_element.serp_item.rank_group,asc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use a co" }, { "name": "include_subdomains", "coreType": "boolean", "nullable": false, "optional": true, "description": "Include keywords from subdomains" }, { "name": "include_clickstream_data", "coreType": "boolean", "defaultValue": false, "nullable": false, "optional": true, "description": "Include or exclude data from clickstream-based metrics in the result" }, { "name": "item_types", "coreType": "array", "defaultValue": [ "organic" ], "nullable": false, "optional": true, "description": "" } ], "payloadPassthrough": true }, { "name": "dataforseo_labs_google_relevant_pages", "title": "DataForSEO Labs Google Relevant Pages", "description": "This endpoint will provide you with rankings and traffic data for the web pages of the specified domain. You will be able to review each page’s ranking distribution and estimated monthly traffic volume from both organic and paid searches.", "module": "dataforseo-labs", "endpoint": "/v3/dataforseo_labs/google/relevant_pages/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "string", "nullable": false, "optional": false, "description": "target domain" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\nrequired field\nonly in format \"Country\" (not \"City\" or \"Region\")\nexample:\n'United Kingdom', 'United States', 'Canada'" }, { "name": "language_code", "coreType": "string", "defaultValue": "en", "nullable": false, "optional": true, "description": "language code\n required field\n example:\n en" }, { "name": "ignore_synonyms", "coreType": "boolean", "defaultValue": true, "nullable": false, "optional": true, "description": "ignore highly similar keywords, if set to true, results will be more accurate" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "Maximum number of keywords to return" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of returned keywords\n optional field\n default value: 0\n 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 keywords" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like\nUse % with like/not_like/ilike/not_ilike as a wildcard.\nExamples:\n Single: [\"metrics.organic.count\", \">\", 50]\n Combined: [[\"metrics.organic.pos_1\", \"<>\", 0], \"and\", [\"metrics.organic.impress" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to specify a sorting type\nexample:\n[\"metrics.paid.etv,asc\"]\nNote: you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexample:\n[\"metrics.organic.etv,desc\",\"metrics.paid" }, { "name": "exclude_top_domains", "coreType": "boolean", "defaultValue": true, "nullable": false, "optional": true, "description": "indicates whether to exclude world’s largest websites\noptional field\ndefault value: false\nset to true if you want to get highly-relevant competitors excluding the top websites" }, { "name": "item_types", "coreType": "array", "defaultValue": [ "organic" ], "nullable": false, "optional": true, "description": "" }, { "name": "include_clickstream_data", "coreType": "boolean", "defaultValue": false, "nullable": false, "optional": true, "description": "Include or exclude data from clickstream-based metrics in the result" } ], "payloadPassthrough": true }, { "name": "dataforseo_labs_google_serp_competitors", "title": "DataForSEO Labs Google SERP Competitors", "description": "This endpoint will provide you with a list of domains ranking for the keywords you specify. You will also get SERP rankings, rating, estimated traffic volume, and visibility values the provided domains gain from the specified keywords.", "module": "dataforseo-labs", "endpoint": "/v3/dataforseo_labs/google/serp_competitors/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "keywords", "coreType": "array", "nullable": false, "optional": false, "description": "keywords array\nrequired field\nthe results will be based on the keywords you specify in this array\nUTF-8 encoding;\nthe keywords will be converted to lowercase format;\nyou can specify the maximum of 200 keywords" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\nrequired field\nonly in format \"Country\" (not \"City\" or \"Region\")\nexample:\n'United Kingdom', 'United States', 'Canada'" }, { "name": "language_code", "coreType": "string", "defaultValue": "en", "nullable": false, "optional": true, "description": "language code\n required field\n example:\n en" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "Maximum number of keywords to return" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of returned keywords\n optional field\n default value: 0\n 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 keywords" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like\nUse % with like/not_like/ilike/not_ilike as a wildcard.\nExamples:\n Single: [\"median_position\", \"in\", [1, 10]]\n Combined: [[\"median_position\", \"in\", [1, 10]], \"and\", [\"domain\", \"not_like\", \"%" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nthe comma is used as a separator\nexample:\n[\"avg_position,asc\"]\ndefault rule:\n[\"rating,desc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexample:\n[\"avg_position,asc\",\"etv,de" }, { "name": "include_subdomains", "coreType": "boolean", "nullable": false, "optional": true, "description": "Include keywords from subdomains" }, { "name": "item_types", "coreType": "array", "defaultValue": [ "organic" ], "nullable": false, "optional": true, "description": "" } ], "payloadPassthrough": true }, { "name": "dataforseo_labs_google_subdomains", "title": "DataForSEO Labs Google Subdomains", "description": "This endpoint will provide you with a list of subdomains of the specified domain, along with the ranking distribution across organic and paid search. In addition to that, you will also get the estimated traffic volume of subdomains based on search volume.", "module": "dataforseo-labs", "endpoint": "/v3/dataforseo_labs/google/subdomains/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "string", "nullable": false, "optional": false, "description": "target domain" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\nrequired field\nonly in format \"Country\" (not \"City\" or \"Region\")\nexample:\n'United Kingdom', 'United States', 'Canada'" }, { "name": "language_code", "coreType": "string", "defaultValue": "en", "nullable": false, "optional": true, "description": "language code\n required field\n example:\n en" }, { "name": "ignore_synonyms", "coreType": "boolean", "defaultValue": true, "nullable": false, "optional": true, "description": "ignore highly similar keywords, if set to true, results will be more accurate" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "Maximum number of keywords to return" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of returned keywords\n optional field\n default value: 0\n 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 keywords" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like\nUse % with like/not_like/ilike/not_ilike as a wildcard.\nExamples:\n Single: [\"metrics.organic.count\", \">\", 50]\n Combined: [[\"metrics.organic.pos_1\", \"<>\", 0], \"and\", [\"metrics.organic.impress" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to specify a sorting type\nexample:\n[\"metrics.paid.etv,asc\"]\nNote: you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexample:\n[\"metrics.organic.etv,desc\",\"metrics.paid" }, { "name": "item_types", "coreType": "array", "defaultValue": [ "organic" ], "nullable": false, "optional": true, "description": "" }, { "name": "include_clickstream_data", "coreType": "boolean", "defaultValue": false, "nullable": false, "optional": true, "description": "Include or exclude data from clickstream-based metrics in the result" } ], "payloadPassthrough": true }, { "name": "dataforseo_labs_bulk_keyword_difficulty", "title": "DataForSEO Labs Bulk Keyword Difficulty", "description": "This endpoint will provide you with the Keyword Difficulty metric for a maximum of 1,000 keywords in one API request. Keyword Difficulty stands for the relative difficulty of ranking in the first top-10 organic results for the related keyword. Keyword Difficulty in DataForSEO API responses indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100.", "module": "dataforseo-labs", "endpoint": "/v3/dataforseo_labs/google/bulk_keyword_difficulty/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "keywords", "coreType": "array", "nullable": false, "optional": false, "description": "target keywords\nrequired field\nUTF-8 encoding\nmaximum number of keywords you can specify in this array: 1000" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\nrequired field\nonly in format \"Country\" (not \"City\" or \"Region\")\nexample:\n'United Kingdom', 'United States', 'Canada'" }, { "name": "language_code", "coreType": "string", "defaultValue": "en", "nullable": false, "optional": true, "description": "language code\n required field\n example:\n en" } ], "payloadPassthrough": true }, { "name": "dataforseo_labs_google_historical_keyword_data", "title": "DataForSEO Labs Google Historical Keyword Data", "description": "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. You can get historical keyword data since August, 2021, depending on keywords along with location and language combination", "module": "dataforseo-labs", "endpoint": "/v3/dataforseo_labs/google/historical_keyword_data/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "keywords", "coreType": "array", "nullable": false, "optional": false, "description": "keywords\nrequired field\nThe maximum number of keywords you can specify: 700\nThe maximum number of characters for each keyword: 80\nThe maximum number of words for each keyword phrase: 10\nthe specified keywords will be converted to lowercase format, data will be provided in a separate array\nnote that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them\nyou will not be charged for the k" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\nrequired field\nonly in format \"Country\" (not \"City\" or \"Region\")\nexample:\n'United Kingdom', 'United States', 'Canada'" }, { "name": "language_code", "coreType": "string", "defaultValue": "en", "nullable": false, "optional": true, "description": "language code\n required field\n example:\n en" } ], "payloadPassthrough": true }, { "name": "dataforseo_labs_google_keyword_overview", "title": "DataForSEO Labs Google Keyword Overview", "description": "This endpoint provides Google keyword data for specified keywords. For each keyword, you will receive current cost-per-click, competition values for paid search, search volume, search intent, monthly searches", "module": "dataforseo-labs", "endpoint": "/v3/dataforseo_labs/google/keyword_overview/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "keywords", "coreType": "array", "nullable": false, "optional": false, "description": "keywords\nrequired field\nThe maximum number of keywords you can specify: 700\nThe maximum number of characters for each keyword: 80\nThe maximum number of words for each keyword phrase: 10\nthe specified keywords will be converted to lowercase format, data will be provided in a separate array\nnote that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them\nyou will not be charged for the k" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\nrequired field\nonly in format \"Country\" (not \"City\" or \"Region\")\nexample:\n'United Kingdom', 'United States', 'Canada'" }, { "name": "language_code", "coreType": "string", "defaultValue": "en", "nullable": false, "optional": true, "description": "language code\n required field\n example:\n en" }, { "name": "include_clickstream_data", "coreType": "boolean", "defaultValue": false, "nullable": false, "optional": true, "description": "Include or exclude data from clickstream-based metrics in the result" } ], "payloadPassthrough": true }, { "name": "dataforseo_labs_google_keywords_for_site", "title": "DataForSEO Labs Google Keywords For Site", "description": "The Keywords For Site endpoint will provide you with a list of keywords relevant to the target domain. Each keyword is supplied with relevant, search volume data for the last month, cost-per-click, competition", "module": "dataforseo-labs", "endpoint": "/v3/dataforseo_labs/google/keywords_for_site/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "string", "nullable": false, "optional": false, "description": "target domain" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\nrequired field\nonly in format \"Country\" (not \"City\" or \"Region\")\nexample:\n'United Kingdom', 'United States', 'Canada'" }, { "name": "language_code", "coreType": "string", "defaultValue": "en", "nullable": false, "optional": true, "description": "language code\n required field\n example:\n en" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "Maximum number of keywords to return" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of returned keywords\n optional field\n default value: 0\n 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 keywords" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like\nUse % with like/not_like/ilike/not_ilike as a wildcard.\nExamples:\n Single: [\"keyword_info.search_volume\", \">\", 0]\n Combined: [[\"keyword_info.search_volume\", \"in\", [0, 1000]], \"and\", [\"keywor" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to set up a sorting parameter\ndefault rule:\n[\"relevance,desc\"]\nexample:\n[\"relevance,desc\",\"keyword_info.search_volume,desc\"]" }, { "name": "include_subdomains", "coreType": "boolean", "nullable": false, "optional": true, "description": "Include keywords from subdomains" }, { "name": "include_clickstream_data", "coreType": "boolean", "defaultValue": false, "nullable": false, "optional": true, "description": "Include or exclude data from clickstream-based metrics in the result" } ], "payloadPassthrough": true }, { "name": "dataforseo_labs_google_keyword_ideas", "title": "DataForSEO Labs Google Keyword Ideas", "description": "The Keyword Ideas provides search terms that are relevant to the product or service categories of the specified keywords. The algorithm selects the keywords which fall into the same categories as the seed keywords specified in a POST array.\nAs a result, you will get a list of relevant keyword ideas for up to 200 seed keywords.\nAlong with each keyword idea, you will get its search volume rate for the last month, search volume trend for the previous 12 months, as well as current cost-per-click and competition values. Moreover, this endpoint supplies minimum, maximum and average values of daily impressions, clicks and CPC for each result.\n", "module": "dataforseo-labs", "endpoint": "/v3/dataforseo_labs/google/keyword_ideas/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "keywords", "coreType": "array", "nullable": false, "optional": false, "description": "target keywords" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\n required field\n only in format \"Country\" (not \"City\" or \"Region\")\n example:\n 'United Kingdom', 'United States', 'Canada'" }, { "name": "language_code", "coreType": "string", "defaultValue": "en", "nullable": false, "optional": true, "description": "language code\n required field\n example:\n en" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "Maximum number of keywords to return" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of returned keywords\n optional field\n default value: 0\n 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 keywords" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like\nUse % with like/not_like/ilike/not_ilike as a wildcard.\nExamples:\n Single: [\"keyword_info.search_volume\", \">\", 0]\n Combined: [[\"keyword_info.search_volume\", \"in\", [0, 1000]], \"and\", [\"keywor" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to set up a sorting parameter\ndefault rule:\n[\"relevance,desc\"]\nrelevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. Note tha" }, { "name": "include_clickstream_data", "coreType": "boolean", "defaultValue": false, "nullable": false, "optional": true, "description": "Include or exclude data from clickstream-based metrics in the result" } ], "payloadPassthrough": true }, { "name": "dataforseo_labs_google_keyword_suggestions", "title": "DataForSEO Labs Google Keyword Suggestions", "description": "The Keyword Suggestions provides search queries that include the specified seed keyword.\n\nThe algorithm is based on the full-text search for the specified keyword and therefore returns only those search terms that contain the keyword you set in the POST array with additional words before, after, or within the specified key phrase. Returned keyword suggestions can contain the words from the specified key phrase in a sequence different from the one you specify.\n\nAs a result, you will get a list of long-tail keywords with each keyword in the list matching the specified search term.\n\nAlong with each suggested keyword, you will get its search volume rate for the last month, search volume trend for the previous 12 months, as well as current cost-per-click and competition values. Moreover, this endpoint supplies minimum, maximum and average values of daily impressions, clicks and CPC for each result.\n\n", "module": "dataforseo-labs", "endpoint": "/v3/dataforseo_labs/google/keyword_suggestions/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "keyword", "coreType": "string", "nullable": false, "optional": false, "description": "target keyword" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\nrequired field\nonly in format \"Country\" (not \"City\" or \"Region\")\nexample:\n'United Kingdom', 'United States', 'Canada'" }, { "name": "language_code", "coreType": "string", "defaultValue": "en", "nullable": false, "optional": true, "description": "language code\n required field\n example:\n en" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "Maximum number of keywords to return" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of returned keywords\n optional field\n default value: 0\n 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 keywords" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like\nUse % with like/not_like/ilike/not_ilike as a wildcard.\nExamples:\n Single: [\"keyword_info.search_volume\", \">\", 0]\n Combined: [[\"keyword_info.search_volume\", \"in\", [0, 1000]], \"and\", [\"keywor" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\na comma is used as a separator\nexample:\n[\"keyword_info.competition,desc\"]\ndefault rule:\n[\"keyword_info.search_volume,desc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexamp" }, { "name": "include_clickstream_data", "coreType": "boolean", "defaultValue": false, "nullable": false, "optional": true, "description": "Include or exclude data from clickstream-based metrics in the result" } ], "payloadPassthrough": true }, { "name": "dataforseo_labs_google_related_keywords", "title": "DataForSEO Labs Google Related Keywords", "description": "The Related Keywords endpoint provides keywords appearing in the\n \"searches related to\" SERP element\nYou can get up to 4680 keyword ideas by specifying the search depth. Each related keyword comes with the list of relevant product categories, search volume rate for the last month, search volume trend for the previous 12 months, as well as current cost-per-click and competition values. Moreover, this endpoint supplies minimum, maximum and average values of daily impressions, clicks and CPC for each result.\n\nDatasource: DataForSEO SERPs Database\nSearch algorithm: depth-first search for queries appearing in the \"search related to\" element of SERP for the specified seed keyword.\n", "module": "dataforseo-labs", "endpoint": "/v3/dataforseo_labs/google/related_keywords/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "keyword", "coreType": "string", "nullable": false, "optional": false, "description": "target keyword" }, { "name": "depth", "coreType": "number", "defaultValue": 1, "nullable": false, "optional": true, "description": "keyword search depth" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\nrequired field\nonly in format \"Country\" (not \"City\" or \"Region\")\nexample:\n'United Kingdom', 'United States', 'Canada'" }, { "name": "language_code", "coreType": "string", "defaultValue": "en", "nullable": false, "optional": true, "description": "language code\n required field\n example:\n en" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "Maximum number of keywords to return" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of returned keywords\n optional field\n default value: 0\n 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 keywords" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like\nUse % with like/not_like/ilike/not_ilike as a wildcard.\nExamples:\n Single: [\"keyword_data.keyword_info.search_volume\", \">\", 0]\n Combined: [[\"keyword_info.search_volume\", \"in\", [0, 1000]], \"a" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to set up a sorting type\nexample:\n[\"keyword_data.keyword_info.competition,desc\"]\ndefault rule:\n[\"keyword_data.keyword_info.search_volume,desc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use a co" }, { "name": "include_clickstream_data", "coreType": "boolean", "defaultValue": false, "nullable": false, "optional": true, "description": "Include or exclude data from clickstream-based metrics in the result" } ], "payloadPassthrough": true }, { "name": "dataforseo_labs_search_intent", "title": "DataForSEO Labs Search Intent", "description": "This endpoint will provide you with search intent data for up to 1,000 keywords. For each keyword that you specify when setting a task, the API will return the keyword's search intent and intent probability. Besides the highest probable search intent, the results will also provide you with other likely search intent(s) and their probability.\nBased on keyword data and search results data, our system has been trained to detect four types of search intent: informational, navigational, commercial, transactional.", "module": "dataforseo-labs", "endpoint": "/v3/dataforseo_labs/google/search_intent/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "keywords", "coreType": "array", "nullable": false, "optional": false, "description": "target keywords\nrequired field\nUTF-8 encoding\nmaximum number of keywords you can specify in this array: 1000" }, { "name": "language_code", "coreType": "string", "defaultValue": "en", "nullable": false, "optional": true, "description": "language code\n required field\n Note: this endpoint currently supports the following languages only:\nar,\nzh-TW,\ncs,\nda,\nnl,\nen,\nfi,\nfr,\nde,\nhe,\nhi,\nit,\nja,\nko,\nms,\nnb,\npl,\npt,\nro,\nru,\nes,\nsv,\nth,\nuk,\nvi,\nbg,\nhr,\nsr,\nsl,\nbs" } ], "payloadPassthrough": true }, { "name": "dataforseo_labs_google_top_searches", "title": "DataForSEO Labs Google Top Searches", "description": "The Top Searches endpoint of DataForSEO Labs API can provide you with over 7 billion keywords from the DataForSEO Keyword Database. Each keyword in the API response is provided with a set of relevant keyword data with Google Ads metrics", "module": "dataforseo-labs", "endpoint": "/v3/dataforseo_labs/google/top_searches/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\nrequired field\nonly in format \"Country\" (not \"City\" or \"Region\")\nexample:\n'United Kingdom', 'United States', 'Canada'" }, { "name": "language_code", "coreType": "string", "defaultValue": "en", "nullable": false, "optional": true, "description": "language code\n required field\n example:\n en" }, { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "Maximum number of keywords to return" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of returned keywords\n optional field\n default value: 0\n 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 keywords" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like\nUse % with like/not_like/ilike/not_ilike as a wildcard.\nExamples:\n Single: [\"keyword_info.search_volume\", \">\", 0]\n Combined: [[\"keyword_info.search_volume\", \"in\", [0, 1000]], \"and\", [\"keywor" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "resuresults sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to set up a sorting type\nexample:\n[\"keyword_info.competition,desc\"]\ndefault rule:\n[\"keyword_info.search_volume,desc\"]\nnote that you can set no more than three sorting rules in a single request\nyou should use a comma to separate severa" }, { "name": "include_clickstream_data", "coreType": "boolean", "defaultValue": false, "nullable": false, "optional": true, "description": "Include or exclude data from clickstream-based metrics in the result" } ], "payloadPassthrough": true }, { "name": "dataforseo_labs_available_filters", "title": "DataForSEO Labs Available Filters", "description": "Here you will find all the necessary information about filters that can be used with DataForSEO Labs API endpoints.\n\nPlease, keep in mind that filters are associated with a certain object in the result array, and should be specified accordingly.", "module": "dataforseo-labs", "endpoint": "/v3/dataforseo_labs/available_filters", "method": "GET", "pathTemplate": null, "params": [ { "name": "tool", "coreType": "string", "nullable": false, "optional": true, "description": "The name of the tool to get filters for" } ], "payloadPassthrough": null }, { "name": "domain_analytics_technologies_available_filters", "title": "Domain Analytics Technologies Available Filters", "description": "Here you will find all the necessary information about filters that can be used with DataForSEO Technologies API endpoints.\n\nPlease, keep in mind that filters are associated with a certain object in the result array, and should be specified accordingly.", "module": "domain-analytics", "endpoint": "/v3/domain_analytics/technologies/available_filters", "method": "GET", "pathTemplate": null, "params": [ { "name": "tool", "coreType": "string", "nullable": false, "optional": true, "description": "The name of the tool to get filters for" } ], "payloadPassthrough": null }, { "name": "domain_analytics_technologies_domain_technologies", "title": "Domain Analytics Technologies Domain Technologies", "description": "Using this endpoint you will get a list of technologies used in a particular domain", "module": "domain-analytics", "endpoint": "/v3/domain_analytics/technologies/domain_technologies/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "target", "coreType": "string", "nullable": false, "optional": false, "description": "target domain\nrequired field\ndomain name of the website to analyze\nNote: results will be returned for the specified domain only" } ], "payloadPassthrough": true }, { "name": "domain_analytics_whois_available_filters", "title": "Domain Analytics WHOIS Available Filters", "description": "Here you will find all the necessary information about filters that can be used with DataForSEO WHOIS API endpoints.\n\nPlease, keep in mind that filters are associated with a certain object in the result array, and should be specified accordingly.", "module": "domain-analytics", "endpoint": "/v3/domain_analytics/whois/available_filters", "method": "GET", "pathTemplate": null, "params": [ { "name": "tool", "coreType": "string", "nullable": false, "optional": true, "description": "The name of the tool to get filters for" } ], "payloadPassthrough": null }, { "name": "domain_analytics_whois_overview", "title": "Domain Analytics WHOIS Overview", "description": "This endpoint will provide you with Whois data enriched with backlink stats, and ranking and traffic info from organic and paid search results. Using this endpoint you will be able to get all these data for the domains matching the parameters you specify in the request", "module": "domain-analytics", "endpoint": "/v3/domain_analytics/whois/overview/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "limit", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "the maximum number of returned domains" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of returned businesses\noptional field\ndefault value: 0\nif 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 entities" }, { "name": "filters", "coreType": "array", "nullable": false, "optional": true, "description": "Array-based filter expression. A single condition is a 3-element array: [field, operator, value]. Combine conditions with [\"and\"|\"or\"] between them: [condition, \"and\", condition]. Max 8 filters.\nOperators: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like, match, not_match\nUse % with like/not_like as a wildcard.\nExample:\n Single: [\"rating.value\", \">\", 3]" }, { "name": "order_by", "coreType": "array", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nyou can use the same values as in the filters array to sort the results\npossible sorting types:\nasc – results will be sorted in the ascending order\ndesc – results will be sorted in the descending order\nyou should use a comma to set up a sorting parameter\nexample:\n[\"rating.value,desc\"]note that you can set no more than three sorting rules in a single request\nyou should use a comma to separate several sorting rules\nexample:\n[\"rating.value,desc\",\"rating.votes_co" }, { "name": "is_claimed", "coreType": "boolean", "defaultValue": true, "nullable": false, "optional": true, "description": "" } ], "payloadPassthrough": true }, { "name": "kw_data_dfs_trends_demography", "title": "Keywords Data DataForSEO Trends Demography", "description": "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", "module": "keywords-data", "endpoint": "/v3/keywords_data/dataforseo_trends/demography/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "location_name", "coreType": "string", "defaultValue": null, "nullable": false, "optional": true, "description": "full name of the location\n optional field\n in format \"Country\"\n example:\n United Kingdom" }, { "name": "keywords", "coreType": "array", "nullable": false, "optional": false, "description": "keywords\n the maximum number of keywords you can specify: 5" }, { "name": "type", "coreType": "enum", "defaultValue": "web", "nullable": false, "optional": true, "description": "dataforseo trends type" }, { "name": "date_from", "coreType": "string", "nullable": false, "optional": true, "description": "starting date of the time range\n if you don’t specify this field, the current day and month of the preceding year will be used by default\n minimal value for the web type: 2004-01-01\n minimal value for other types: 2008-01-01\n date format: \"yyyy-mm-dd\"\n example:\n \"2019-01-15\"" }, { "name": "date_to", "coreType": "string", "nullable": false, "optional": true, "description": "ending date of the time range\n if you don’t specify this field, the today’s date will be used by default\n date format: \"yyyy-mm-dd\"\n example:\n \"2019-01-15\"" }, { "name": "time_range", "coreType": "enum", "defaultValue": "past_7_days", "nullable": false, "optional": true, "description": "preset time ranges\n if you specify date_from or date_to parameters, this field will be ignored when setting a task" } ], "payloadPassthrough": true }, { "name": "kw_data_dfs_trends_explore", "title": "Keywords Data DataForSEO Trends Explore", "description": "This endpoint will provide you with the keyword popularity data from DataForSEO Trends. You can check keyword trends for Google Search, Google News, and Google Shopping", "module": "keywords-data", "endpoint": "/v3/keywords_data/dataforseo_trends/explore/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "location_name", "coreType": "string", "defaultValue": null, "nullable": false, "optional": true, "description": "full name of the location\n optional field\n in format \"Country\"\n example:\n United Kingdom" }, { "name": "keywords", "coreType": "array", "nullable": false, "optional": false, "description": "keywords\n the maximum number of keywords you can specify: 5" }, { "name": "type", "coreType": "enum", "defaultValue": "web", "nullable": false, "optional": true, "description": "dataforseo trends type" }, { "name": "date_from", "coreType": "string", "nullable": false, "optional": true, "description": "starting date of the time range\n if you don’t specify this field, the current day and month of the preceding year will be used by default\n minimal value for the web type: 2004-01-01\n minimal value for other types: 2008-01-01\n date format: \"yyyy-mm-dd\"\n example:\n \"2019-01-15\"" }, { "name": "date_to", "coreType": "string", "nullable": false, "optional": true, "description": "ending date of the time range\n if you don’t specify this field, the today’s date will be used by default\n date format: \"yyyy-mm-dd\"\n example:\n \"2019-01-15\"" }, { "name": "time_range", "coreType": "enum", "defaultValue": "past_7_days", "nullable": false, "optional": true, "description": "preset time ranges\n if you specify date_from or date_to parameters, this field will be ignored when setting a task" } ], "payloadPassthrough": true }, { "name": "kw_data_dfs_trends_subregion_interests", "title": "Keywords Data DataForSEO Trends Subregion Interests", "description": "This endpoint will provide you with location-specific keyword popularity data from DataForSEO Trends", "module": "keywords-data", "endpoint": "/v3/keywords_data/dataforseo_trends/subregion_interests/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "location_name", "coreType": "string", "defaultValue": null, "nullable": false, "optional": true, "description": "full name of the location\n optional field\n in format \"Country\"\n example:\n United Kingdom" }, { "name": "keywords", "coreType": "array", "nullable": false, "optional": false, "description": "keywords\n the maximum number of keywords you can specify: 5" }, { "name": "type", "coreType": "enum", "defaultValue": "web", "nullable": false, "optional": true, "description": "dataforseo trends type" }, { "name": "date_from", "coreType": "string", "nullable": false, "optional": true, "description": "starting date of the time range\n if you don’t specify this field, the current day and month of the preceding year will be used by default\n minimal value for the web type: 2004-01-01\n minimal value for other types: 2008-01-01\n date format: \"yyyy-mm-dd\"\n example:\n \"2019-01-15\"" }, { "name": "date_to", "coreType": "string", "nullable": false, "optional": true, "description": "ending date of the time range\n if you don’t specify this field, the today’s date will be used by default\n date format: \"yyyy-mm-dd\"\n example:\n \"2019-01-15\"" }, { "name": "time_range", "coreType": "enum", "defaultValue": "past_7_days", "nullable": false, "optional": true, "description": "preset time ranges\n if you specify date_from or date_to parameters, this field will be ignored when setting a task" } ], "payloadPassthrough": true }, { "name": "kw_data_google_ads_locations", "title": "Keywords Data Google Ads Locations", "description": "Utility tool for kw_data_google_ads_search_volume to get list of availible locations.", "module": "keywords-data", "endpoint": "/v3/keywords_data/google_ads/locations", "method": "POST", "pathTemplate": null, "params": [ { "name": "country_iso_code", "coreType": "string", "nullable": false, "optional": false, "description": "ISO 3166-1 alpha-2 country code, for example: US, GB, MT" }, { "name": "location_type", "coreType": "string", "nullable": false, "optional": true, "description": "Type of location. Possible variants: 'TV Region','Postal Code','Neighborhood','Governorate','National Park','Quarter','Canton','Airport','Okrug','Prefecture','City','Country','Province','Barrio','Sub-District','Congressional District','Municipality District','district','DMA Region','Union Territory','Territory','Colloquial Area','Autonomous Community','Borough','County','State','District','City Region','Commune','Region','Department','Division','Sub-Ward','Municipality','University'" }, { "name": "location_name", "coreType": "string", "nullable": false, "optional": true, "description": "Name of location or it`s part." } ], "payloadPassthrough": true }, { "name": "kw_data_google_ads_search_volume", "title": "Keywords Data Google Ads Search Volume", "description": "Get search volume data for keywords from Google Ads", "module": "keywords-data", "endpoint": "/v3/keywords_data/google_ads/search_volume/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\nrequired field\nLocation format - hierarchical, comma-separated (from most specific to least)\n Can be one of:\n 1. Country only: \"United States\"\n 2. Region,Country: \"California,United States\"\n 3. City,Region,Country: \"San Francisco,California,United States\"" }, { "name": "language_code", "coreType": "string", "defaultValue": null, "nullable": false, "optional": true, "description": "Language two-letter ISO code (e.g., 'en').\noptional field" }, { "name": "keywords", "coreType": "array", "nullable": false, "optional": false, "description": "Array of keywords to get search volume for" } ], "payloadPassthrough": true }, { "name": "kw_data_google_trends_categories", "title": "Keywords Data Google Trends Categories", "description": "This endpoint will provide you list of Google Trends Categories", "module": "keywords-data", "endpoint": "/v3/keywords_data/google_trends/categories/live", "method": "GET", "pathTemplate": null, "params": [] }, { "name": "kw_data_google_trends_explore", "title": "Keywords Data Google Trends Explore", "description": "This endpoint will provide you with the keyword popularity data from the ‘Explore’ feature of Google Trends. You can check keyword trends for Google Search, Google News, Google Images, Google Shopping, and YouTube", "module": "keywords-data", "endpoint": "/v3/keywords_data/google_trends/explore/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "location_name", "coreType": "string", "defaultValue": null, "nullable": false, "optional": true, "description": "full name of the location\n optional field\n in format \"Country\"\n example:\n United Kingdom" }, { "name": "language_code", "coreType": "string", "defaultValue": null, "nullable": false, "optional": true, "description": "Language two-letter ISO code (e.g., 'en').\n optional field" }, { "name": "keywords", "coreType": "array", "nullable": false, "optional": false, "description": "keywords\n the maximum number of keywords you can specify: 5\n the maximum number of characters you can specify in a keyword: 100\n the minimum number of characters must be greater than 1\n comma characters (,) in the specified keywords will be unset and ignored\n Note: keywords cannot consist of a combination of the following characters: < > | \" - + = ~ ! : * ( ) [ ] { }\n\n Note: to obtain google_trends_topics_list and google_trends_queries_list items, speci" }, { "name": "type", "coreType": "enum", "defaultValue": "web", "nullable": false, "optional": true, "description": "google trends type" }, { "name": "date_from", "coreType": "string", "nullable": false, "optional": true, "description": "starting date of the time range\n if you don’t specify this field, the current day and month of the preceding year will be used by default\n minimal value for the web type: 2004-01-01\n minimal value for other types: 2008-01-01\n date format: \"yyyy-mm-dd\"\n example:\n \"2019-01-15\"" }, { "name": "date_to", "coreType": "string", "nullable": false, "optional": true, "description": "ending date of the time range\n if you don’t specify this field, the today’s date will be used by default\n date format: \"yyyy-mm-dd\"\n example:\n \"2019-01-15\"" }, { "name": "time_range", "coreType": "enum", "defaultValue": "past_7_days", "nullable": false, "optional": true, "description": "preset time ranges\n if you specify date_from or date_to parameters, this field will be ignored when setting a task" }, { "name": "item_types", "coreType": "array", "defaultValue": [ "google_trends_graph" ], "nullable": false, "optional": true, "description": "types of items returned\n to speed up the execution of the request, specify one item at a time" }, { "name": "category_code", "coreType": "number", "defaultValue": null, "nullable": false, "optional": true, "description": "google trends search category\n you can receive the list of available categories with their category_code by making a separate request to the keywords_data_google_trends_categories tool" } ], "payloadPassthrough": true }, { "name": "merchant_amazon_asin_live_advanced", "title": "Merchant Amazon ASIN Live Advanced", "description": "Get detailed product information from Amazon by ASIN (Amazon Standard Identification Number).\nReturns product title, price, description, images, reviews summary, seller info,\nshipping options, and other product attributes for the specified ASIN.", "module": "merchant", "endpoint": "/v3/merchant/amazon/asin/live/advanced", "method": "POST", "pathTemplate": null, "params": [ { "name": "asin", "coreType": "string", "nullable": false, "optional": false, "description": "product ID\nrequired field\nunique product identifier (ASIN) in Amazon\nyou can receive the asin parameter by making a separate request to the merchant_amazon_products_live_advanced" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\nrequired field\nLocation format - hierarchical, comma-separated (from most specific to least)\n Can be one of:\n 1. Country only: \"United States\"\n 2. Postal Code,Region,Country: \"90210,California,United States\"" }, { "name": "language_code", "coreType": "string", "defaultValue": "en_US", "nullable": false, "optional": true, "description": "language code\nrequired field\nexample: \"en_US\"\nsupported languages: ar_SA, ar_AE, zh_CN, zh_TW, cs_CZ, nl_NL, en_AU, en_CA, en_IN, en_AE, en_GB, en_US, fr_CA, fr_FR, de_DE, he_IL, hi_IN, it_IT, ja_JP, ko_KR, pl_PL, pt_BR, es_MX, es_ES, es_US, sv_SE, tr_TR" } ], "payloadPassthrough": true }, { "name": "merchant_amazon_locations", "title": "Merchant Amazon Locations", "description": "Utility tool for Amazon merchant tools (merchant_amazon_asin_live_advanced,\nmerchant_amazon_sellers_live_advanced, merchant_amazon_products_live_advanced)\nto get the list of available locations with their location_code and location_name values.\nYou can optionally filter the list by country ISO code.", "module": "merchant", "endpoint": "/v3/merchant/amazon/locations/TESTSTR", "method": "GET", "pathTemplate": null, "params": [ { "name": "country", "coreType": "string", "nullable": false, "optional": true, "description": "ISO 3166-1 alpha-2 country code to filter locations by\noptional field\nexample: \"US\", \"GB\", \"DE\"\nif omitted, the full list of available Amazon locations is returned" }, { "name": "location_name_contains", "coreType": "string", "nullable": false, "optional": true, "description": "filter locations by a substring match on location_name\noptional field\nexample: \"New York\", \"London\"\nif omitted, no name filtering is applied" }, { "name": "limit", "coreType": "number", "nullable": false, "optional": true, "description": "maximum number of locations to return" }, { "name": "offset", "coreType": "number", "nullable": false, "optional": true, "description": "offset in the results array of returned locations" } ], "payloadPassthrough": null }, { "name": "merchant_amazon_products_live_advanced", "title": "Merchant Amazon Products Live Advanced", "description": "Search Amazon products by keyword and get the list of matching items.\nReturns product titles, ASINs, prices, ratings, images, sponsored placements,\nand other SERP-like results for the specified keyword on Amazon.", "module": "merchant", "endpoint": "/v3/merchant/amazon/products/live/advanced", "method": "POST", "pathTemplate": null, "params": [ { "name": "keyword", "coreType": "string", "nullable": false, "optional": false, "description": "keyword\nrequired field\nthe keyword that will be searched for on Amazon;\nexample: \"shoes\"" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\n required field\n Location format - hierarchical, comma-separated (from most specific to least)\n Can be one of:\n 1. Country only: \"United States\"\n 2. Postal Code,Region,Country: \"90210,California,United States\"" }, { "name": "language_code", "coreType": "string", "defaultValue": "en_US", "nullable": false, "optional": true, "description": "language code\nrequired field\nexample: \"en_US\"\nsupported languages: ar_SA, ar_AE, zh_CN, zh_TW, cs_CZ, nl_NL, en_AU, en_CA, en_IN, en_AE, en_GB, en_US, fr_CA, fr_FR, de_DE, he_IL, hi_IN, it_IT, ja_JP, ko_KR, pl_PL, pt_BR, es_MX, es_ES, es_US, sv_SE, tr_TR" }, { "name": "department", "coreType": "enum", "nullable": false, "optional": true, "description": "amazon product department\noptional field\nspecify one of the supported amazon departments for extracting product listings" }, { "name": "price_min", "coreType": "number", "nullable": false, "optional": true, "description": "minimum product price\noptional field\nminimum price of the returned products listed on Amazon for the specified query\nexample: 5\nNote: if you specify price_min, the search_param parameter will be ignored" }, { "name": "price_max", "coreType": "number", "nullable": false, "optional": true, "description": "maximum product price\noptional field\nmaximum price of the returned products listed on Amazon for the specified query\nexample: 100\nNote: if you specify price_max, the search_param parameter will be ignored" }, { "name": "sort_by", "coreType": "enum", "nullable": false, "optional": true, "description": "results sorting rules\noptional field\nsupported values: relevance, price_low_to_high, price_high_to_low, featured, avg_customer_review, newest_arrival\nexample: \"relevance\"" } ], "payloadPassthrough": true }, { "name": "merchant_amazon_sellers_live_advanced", "title": "Merchant Amazon Sellers Live Advanced", "description": "Get the list of sellers offering a specific Amazon product (by ASIN).\nReturns seller names, ratings, prices, shipping conditions, and product offers\navailable from each merchant for the requested ASIN.", "module": "merchant", "endpoint": "/v3/merchant/amazon/sellers/live/advanced", "method": "POST", "pathTemplate": null, "params": [ { "name": "asin", "coreType": "string", "nullable": false, "optional": false, "description": "product identifier (ASIN) on Amazon\nrequired field\nthe unique identifier of the product on Amazon;\nexample: \"B07D528W98\"" }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\n required field\n Location format - hierarchical, comma-separated (from most specific to least)\n Can be one of:\n 1. Country only: \"United States\"\n 2. Postal Code,Region,Country: \"90210,California,United States\"" }, { "name": "language_code", "coreType": "string", "defaultValue": "en_US", "nullable": false, "optional": true, "description": "language code\nrequired field\nexample: \"en_US\"\nsupported languages: ar_SA, ar_AE, zh_CN, zh_TW, cs_CZ, nl_NL, en_AU, en_CA, en_IN, en_AE, en_GB, en_US, fr_CA, fr_FR, de_DE, he_IL, hi_IN, it_IT, ja_JP, ko_KR, pl_PL, pt_BR, es_MX, es_ES, es_US, sv_SE, tr_TR" } ], "payloadPassthrough": true }, { "name": "on_page_content_parsing", "title": "On Page Content Parsing", "description": "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.", "module": "onpage", "endpoint": "/v3/on_page/content_parsing/live", "method": "POST", "pathTemplate": null, "params": [ { "name": "url", "coreType": "string", "nullable": false, "optional": false, "description": "URL of the page to parse" }, { "name": "enable_javascript", "coreType": "boolean", "nullable": false, "optional": true, "description": "Enable JavaScript rendering" }, { "name": "custom_user_agent", "coreType": "string", "nullable": false, "optional": true, "description": "Custom User-Agent header" }, { "name": "accept_language", "coreType": "string", "nullable": false, "optional": true, "description": "Accept-Language header value" } ], "payloadPassthrough": true }, { "name": "on_page_instant_pages", "title": "On Page Instant Pages", "description": "Using this function you will get page-specific data with detailed information on how well a particular page is optimized for organic search", "module": "onpage", "endpoint": "/v3/on_page/instant_pages", "method": "POST", "pathTemplate": null, "params": [ { "name": "url", "coreType": "string", "nullable": false, "optional": false, "description": "URL to analyze" }, { "name": "enable_javascript", "coreType": "boolean", "nullable": false, "optional": true, "description": "Enable JavaScript rendering" }, { "name": "custom_js", "coreType": "string", "nullable": false, "optional": true, "description": "Custom JavaScript code to execute" }, { "name": "custom_user_agent", "coreType": "string", "nullable": false, "optional": true, "description": "Custom User-Agent header" }, { "name": "accept_language", "coreType": "string", "nullable": false, "optional": true, "description": "language header for accessing the website\n all locale formats are supported (xx, xx-XX, xxx-XX, etc.)\n Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the \"type\":\"broken in the response array" } ], "payloadPassthrough": true }, { "name": "on_page_lighthouse", "title": "On Page Lighthouse", "description": "The OnPage Lighthouse API is based on Google’s open-source Lighthouse project for measuring the quality of web pages and web apps.", "module": "onpage", "endpoint": "/v3/on_page/lighthouse/live/json", "method": "POST", "pathTemplate": null, "params": [ { "name": "url", "coreType": "string", "nullable": false, "optional": false, "description": "URL of the page to parse" }, { "name": "enable_javascript", "coreType": "boolean", "nullable": false, "optional": true, "description": "Enable JavaScript rendering" }, { "name": "custom_user_agent", "coreType": "string", "nullable": false, "optional": true, "description": "Custom User-Agent header" }, { "name": "accept_language", "coreType": "string", "nullable": false, "optional": true, "description": "Accept-Language header value" }, { "name": "full_data", "coreType": "boolean", "nullable": false, "optional": true, "description": "Return the complete API response instead of a reduced version" } ], "payloadPassthrough": true }, { "name": "serp_organic_live_advanced", "title": "SERP Organic Live Advanced", "description": "Get organic search results for a keyword in specified search engine", "module": "serp", "endpoint": "/v3/serp/google/organic/live/advanced", "method": "POST", "pathTemplate": { "template": "/v3/serp/{search_engine}/organic/live/advanced", "vars": [ "search_engine" ] }, "params": [ { "name": "search_engine", "coreType": "string", "defaultValue": "google", "nullable": false, "optional": true, "description": "search engine name, one of: google, yahoo, bing." }, { "name": "location_name", "coreType": "string", "defaultValue": "United States", "nullable": false, "optional": true, "description": "full name of the location\nrequired field\nLocation format - hierarchical, comma-separated (from most specific to least)\n Can be one of:\n 1. Country only: \"United States\"\n 2. Region,Country: \"California,United States\"\n 3. City,Region,Country: \"San Francisco,California,United States\"" }, { "name": "depth", "coreType": "number", "defaultValue": 10, "nullable": false, "optional": true, "description": "parsing depth\noptional field\nnumber of results in SERP" }, { "name": "language_code", "coreType": "string", "nullable": false, "optional": false, "description": "search engine language code (e.g., 'en')" }, { "name": "keyword", "coreType": "string", "nullable": false, "optional": false, "description": "Search keyword" }, { "name": "max_crawl_pages", "coreType": "number", "defaultValue": 1, "nullable": false, "optional": true, "description": "page crawl limit\noptional field\nnumber of search results pages to crawl\nmax value: 100\nNote: the max_crawl_pages and depth parameters complement each other" }, { "name": "device", "coreType": "string", "defaultValue": "desktop", "nullable": false, "optional": true, "description": "device type\noptional field\ncan take the values:desktop, mobile\ndefault value: desktop" }, { "name": "people_also_ask_click_depth", "coreType": "number", "nullable": false, "optional": true, "description": "clicks on the corresponding element\n specify the click depth on the people_also_ask element to get additional people_also_ask_element items;" } ], "payloadPassthrough": true }, { "name": "serp_locations", "title": "SERP Locations", "description": "Utility tool for serp_organic_live_advanced to get list of availible locations.", "module": "serp", "endpoint": "/v3/serp/google/locations", "method": "POST", "pathTemplate": { "template": "/v3/serp/{search_engine}/locations", "vars": [ "search_engine" ] }, "params": [ { "name": "search_engine", "coreType": "string", "defaultValue": "google", "nullable": false, "optional": true, "description": "search engine name, one of: google, yahoo, bing." }, { "name": "country_iso_code", "coreType": "string", "nullable": false, "optional": false, "description": "ISO 3166-1 alpha-2 country code, for example: US, GB, MT" }, { "name": "location_type", "coreType": "string", "nullable": false, "optional": true, "description": "Type of location. Possible variants: 'TV Region','Postal Code','Neighborhood','Governorate','National Park','Quarter','Canton','Airport','Okrug','Prefecture','City','Country','Province','Barrio','Sub-District','Congressional District','Municipality District','district','DMA Region','Union Territory','Territory','Colloquial Area','Autonomous Community','Borough','County','State','District','City Region','Commune','Region','Department','Division','Sub-Ward','Municipality','University'" }, { "name": "location_name", "coreType": "string", "nullable": false, "optional": true, "description": "Name of location or it`s part." } ], "payloadPassthrough": true }, { "name": "serp_youtube_locations", "title": "SERP YouTube Locations", "description": "Utility tool to get list of available locations for: serp_youtube_organic_live_advanced, serp_youtube_video_info_live_advanced, serp_youtube_video_comments_live_advanced, serp_youtube_video_subtitles_live_advanced.", "module": "serp", "endpoint": "/v3/serp/youtube/locations", "method": "POST", "pathTemplate": null, "params": [ { "name": "country_iso_code", "coreType": "string", "nullable": false, "optional": false, "description": "ISO 3166-1 alpha-2 country code, for example: US, GB, MT" }, { "name": "location_type", "coreType": "string", "nullable": false, "optional": true, "description": "Type of location. Possible variants: 'TV Region','Postal Code','Neighborhood','Governorate','National Park','Quarter','Canton','Airport','Okrug','Prefecture','City','Country','Province','Barrio','Sub-District','Congressional District','Municipality District','district','DMA Region','Union Territory','Territory','Colloquial Area','Autonomous Community','Borough','County','State','District','City Region','Commune','Region','Department','Division','Sub-Ward','Municipality','University'" }, { "name": "location_name", "coreType": "string", "nullable": false, "optional": true, "description": "Name of location or it`s part." } ], "payloadPassthrough": true }, { "name": "serp_youtube_organic_live_advanced", "title": "SERP YouTube Organic Live Advanced", "description": "provides top 20 blocks of youtube search engine results for a keyword", "module": "serp", "endpoint": "/v3/serp/youtube/organic/live/advanced", "method": "POST", "pathTemplate": null, "params": [ { "name": "keyword", "coreType": "string", "nullable": false, "optional": false, "description": "Search keyword" }, { "name": "location_name", "coreType": "string", "nullable": false, "optional": false, "description": "full name of the location\nrequired field\nLocation format - hierarchical, comma-separated (from most specific to least)\n Can be one of:\n 1. Country only: \"United States\"\n 2. Region,Country: \"California,United States\"\n 3. City,Region,Country: \"San Francisco,California,United States\"" }, { "name": "language_code", "coreType": "string", "nullable": false, "optional": false, "description": "search engine language code (e.g., 'en')" }, { "name": "device", "coreType": "string", "defaultValue": "desktop", "nullable": false, "optional": true, "description": "device type\noptional field\ncan take the values:desktop, mobile\ndefault value: desktop" }, { "name": "os", "coreType": "string", "defaultValue": "windows", "nullable": false, "optional": true, "description": "device operating system\noptional field\nif you specify desktop in the device field, choose from the following values: windows, macos\ndefault value: windows\nif you specify mobile in the device field, choose from the following values: android, ios\ndefault value: android" }, { "name": "block_depth", "coreType": "number", "defaultValue": 20, "nullable": false, "optional": true, "description": "parsing depth\noptional field\nnumber of blocks of results in SERP\nmax value: 700" } ], "payloadPassthrough": true }, { "name": "serp_youtube_video_comments_live_advanced", "title": "SERP YouTube Video Comments Live Advanced", "description": "provides data on the video comments you specify", "module": "serp", "endpoint": "/v3/serp/youtube/video_comments/live/advanced", "method": "POST", "pathTemplate": null, "params": [ { "name": "video_id", "coreType": "string", "nullable": false, "optional": false, "description": "ID of the video" }, { "name": "location_name", "coreType": "string", "nullable": false, "optional": false, "description": "full name of the location\nrequired field\nLocation format - hierarchical, comma-separated (from most specific to least)\n Can be one of:\n 1. Country only: \"United States\"\n 2. Region,Country: \"California,United States\"\n 3. City,Region,Country: \"San Francisco,California,United States\"" }, { "name": "language_code", "coreType": "string", "nullable": false, "optional": false, "description": "search engine language code (e.g., 'en')" }, { "name": "device", "coreType": "string", "defaultValue": "desktop", "nullable": false, "optional": true, "description": "device type\noptional field\ncan take the values:desktop, mobile\ndefault value: desktop" }, { "name": "os", "coreType": "string", "defaultValue": "windows", "nullable": false, "optional": true, "description": "device operating system\noptional field\nif you specify desktop in the device field, choose from the following values: windows, macos\ndefault value: windows\nif you specify mobile in the device field, choose from the following values: android, ios\ndefault value: android" }, { "name": "depth", "coreType": "number", "defaultValue": 20, "nullable": false, "optional": true, "description": "parsing depth, number of results in SERP, max value: 700" } ], "payloadPassthrough": true }, { "name": "serp_youtube_video_info_live_advanced", "title": "SERP YouTube Video Info Live Advanced", "description": "provides data on the video you specify", "module": "serp", "endpoint": "/v3/serp/youtube/video_info/live/advanced", "method": "POST", "pathTemplate": null, "params": [ { "name": "video_id", "coreType": "string", "nullable": false, "optional": false, "description": "ID of the video" }, { "name": "location_name", "coreType": "string", "nullable": false, "optional": false, "description": "full name of the location\nrequired field\nLocation format - hierarchical, comma-separated (from most specific to least)\n Can be one of:\n 1. Country only: \"United States\"\n 2. Region,Country: \"California,United States\"\n 3. City,Region,Country: \"San Francisco,California,United States\"" }, { "name": "language_code", "coreType": "string", "nullable": false, "optional": false, "description": "search engine language code (e.g., 'en')" }, { "name": "device", "coreType": "string", "defaultValue": "desktop", "nullable": false, "optional": true, "description": "device type\noptional field\ncan take the values:desktop, mobile\ndefault value: desktop" }, { "name": "os", "coreType": "string", "defaultValue": "windows", "nullable": false, "optional": true, "description": "device operating system\noptional field\nif you specify desktop in the device field, choose from the following values: windows, macos\ndefault value: windows\nif you specify mobile in the device field, choose from the following values: android, ios\ndefault value: android" } ], "payloadPassthrough": true }, { "name": "serp_youtube_video_subtitles_live_advanced", "title": "SERP YouTube Video Subtitles Live Advanced", "description": "provides data on the video subtitles you specify", "module": "serp", "endpoint": "/v3/serp/youtube/video_subtitles/live/advanced", "method": "POST", "pathTemplate": null, "params": [ { "name": "video_id", "coreType": "string", "nullable": false, "optional": false, "description": "ID of the video" }, { "name": "location_name", "coreType": "string", "nullable": false, "optional": false, "description": "full name of the location\nrequired field\nLocation format - hierarchical, comma-separated (from most specific to least)\n Can be one of:\n 1. Country only: \"United States\"\n 2. Region,Country: \"California,United States\"\n 3. City,Region,Country: \"San Francisco,California,United States\"" }, { "name": "language_code", "coreType": "string", "nullable": false, "optional": false, "description": "search engine language code (e.g., 'en')" }, { "name": "subtitles_language", "coreType": "string", "nullable": false, "optional": true, "description": "language code of original text (e.g., 'en')" }, { "name": "subtitles_translate_language", "coreType": "string", "nullable": false, "optional": true, "description": "language code of translated text (e.g., 'en')" }, { "name": "device", "coreType": "string", "defaultValue": "desktop", "nullable": false, "optional": true, "description": "device type\noptional field\ncan take the values:desktop, mobile\ndefault value: desktop" }, { "name": "os", "coreType": "string", "defaultValue": "windows", "nullable": false, "optional": true, "description": "device operating system\noptional field\nif you specify desktop in the device field, choose from the following values: windows, macos\ndefault value: windows\nif you specify mobile in the device field, choose from the following values: android, ios\ndefault value: android" } ], "payloadPassthrough": true } ] }