Data API / DataForSEO / DataForSEO Labs
Related Keywords
Amazon search terms related to a seed keyword. Pages with limit, offset and offset_token; use the token past the first pages. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. The Google-side equivalent is post_dataforseo_labs_google_related_keywords_live; shopping intent and web intent diverge sharply, so do not substitute one for the other.
Parameters
No path, query, or header parameters.
Request body
keywordstringRequiredkeyword required field UTF-8 encoding the keywords should be specified in the lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
location_namestringOptionalfull name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States
location_codeintegerOptionallocation code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840
language_namestringOptionalfull name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English
language_codestringOptionallanguage code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en
depthintegerOptionalkeyword search depth optional field default value: 1; number of the returned results depends on the value you set in this field; you can specify a level from 0 to 4; estimated number of keywords for each level (maximum): 0 – the keyword set in the keyword field 1 – 6 keywords 2 – 42 keywords 3 – 258 keywords 4 – 1554 keywords
include_seed_keywordbooleanOptionalinclude data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false
ignore_synonymsbooleanOptionalignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false
limitintegerOptionalthe maximum number of returned keywords optional field default value: 100 maximum value: 1000
offsetintegerOptionaloffset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
tagstringOptionaluser-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response
Example request
curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/amazon/related_keywords/live" \
-H "Authorization: Bearer $FELO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"keyword": "<string>",
"location_name": "<string>",
"location_code": 0,
"language_name": "<string>",
"language_code": "<string>",
"depth": 0,
"include_seed_keyword": false,
"ignore_synonyms": false
}'Response
Response fields
versionstringOptionalthe current version of the API
status_codeintegerOptionalgeneral status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
status_messagestringOptionalgeneral informational message you can find the full list of general informational messages here
timestringOptionalexecution time, seconds
costnumberOptionaltotal tasks cost, USD
tasks_countintegerOptionalthe number of tasks in the tasks array
tasks_errorintegerOptionalthe number of tasks in the tasks array returned with an error
tasksstring[]Optionalarray of tasks
idstringOptionaltask identifier unique task identifier in our system in the UUID format
status_codeintegerOptionalstatus code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here
status_messagestringOptionalinformational message of the task you can find the full list of general informational messages here
timestringOptionalexecution time, seconds
costnumberOptionalcost of the task, USD
result_countintegerOptionalnumber of elements in the result array
pathstring[]OptionalURL path
dataobjectOptionalcontains the same parameters that you specified in the POST request
resultstring[]Optionalarray of results
se_typestringOptionalsearch engine type
seed_keywordstringOptionalkeyword in a POST array
seed_keyword_dataobjectOptionalkeyword data for the seed keyword fields in the object are identical to that of keyword_data
location_codeintegerOptionallocation code in a POST array
language_codestringOptionallanguage code in a POST array
total_countintegerOptionaltotal amount of results in our database relevant to your request
items_countintegerOptionalthe number of results returned in the items array
itemsstring[]Optionalcontains objects with keywords and related data
se_typestringOptionalsearch engine type
keyword_dataobjectOptionalkeyword data for the returned keyword
se_typestringOptionalsearch engine type
keywordstringOptionalrelated keyword
location_codeintegerOptionallocation code in a POST array
language_codestringOptionallanguage code in a POST array
keyword_infoobjectOptionalkeyword info for the returned keyword
se_typestringOptionalsearch engine type
last_updated_timestringOptionaldate and time when keyword data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00
search_volumeintegerOptionalaverage monthly search volume rate represents the (approximate) number of searches for the provided keyword idea on Amazon
depthintegerOptionalkeyword search depth
related_keywordsstring[]Optionallist of related keywords represents the list of search queries which are related to the keyword returned in the array above