v0.1.0-beta

OpenAPI 3.1.0

Related Keywords

Felo API Support

MIT

Server

https://openapi.felo.ai

Client Libraries

Shell Curl

DataForSEO

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO Operations

post/v1/beta/dataforseo/dataforseo_labs/amazon/related_keywords/live

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.

Body

required

application/json

Type: array object[]
- Type: object
  keyword
  Type: string
  required
  
  keyword required field UTF-8 encoding the keywords should be specified in the lowercase format learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
  
  depth
  Type: integer
  
  keyword 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
  
  ignore_synonyms
  Type: boolean
  
  ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false
  
  include_seed_keyword
  Type: boolean
  
  include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false
  
  language_code
  Type: string
  
  language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en
  
  language_name
  Type: string
  
  full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available locations with their language_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English
  
  limit
  Type: integer
  
  the maximum number of returned keywords optional field default value: 100 maximum value: 1000
  
  location_code
  Type: integer
  
  location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a 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
  
  location_name
  Type: string
  
  full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name 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
  
  offset
  Type: integer
  
  offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
  
  tag
  Type: string
  
  user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response
  
  Empty object
  Empty object

Responses

200
Type: object

Successful response
cost
Type: number

total tasks cost, USD

status_code
Type: integer

general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions

status_message
Type: string

general informational message you can find the full list of general informational messages here

tasks
Type: array string[]

array of tasks

tasks_count
Type: integer

the number of tasks in the tasks array

tasks_error
Type: integer

the number of tasks in the tasks array returned with an error

tasks.cost
Type: number

cost of the task, USD

tasks.data
Type: object

contains the same parameters that you specified in the POST request

tasks.id
Type: string

task identifier unique task identifier in our system in the UUID format

tasks.path
Type: array string[]

URL path

tasks.result
Type: array string[]

array of results

tasks.result_count
Type: integer

number of elements in the result array

tasks.result.items
Type: array string[]

contains objects with keywords and related data

tasks.result.items_count
Type: integer

the number of results returned in the items array

tasks.result.items.depth
Type: integer

keyword search depth

tasks.result.items.keyword_data
Type: object

keyword data for the returned keyword

tasks.result.items.keyword_data.keyword
Type: string

related keyword

tasks.result.items.keyword_data.keyword_info
Type: object

keyword info for the returned keyword

tasks.result.items.keyword_data.keyword_info.last_updated_time
Type: string

date 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

tasks.result.items.keyword_data.keyword_info.se_type
Type: string

search engine type

tasks.result.items.keyword_data.keyword_info.search_volume
Type: integer

average monthly search volume rate represents the (approximate) number of searches for the provided keyword idea on Amazon

tasks.result.items.keyword_data.language_code
Type: string

language code in a POST array

tasks.result.items.keyword_data.location_code
Type: integer

location code in a POST array

tasks.result.items.keyword_data.se_type
Type: string

search engine type

tasks.result.items.related_keywords
Type: array string[]

list of related keywords represents the list of search queries which are related to the keyword returned in the array above

tasks.result.items.se_type
Type: string

search engine type

tasks.result.language_code
Type: string

language code in a POST array

tasks.result.location_code
Type: integer

location code in a POST array

tasks.result.se_type
Type: string

search engine type

tasks.result.seed_keyword
Type: string

keyword in a POST array

tasks.result.seed_keyword_data
Type: object

keyword data for the seed keyword fields in the object are identical to that of keyword_data

tasks.result.total_count
Type: integer

total amount of results in our database relevant to your request

tasks.status_code
Type: integer

status 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

tasks.status_message
Type: string

informational message of the task you can find the full list of general informational messages here

tasks.time
Type: string

execution time, seconds

time
Type: string

execution time, seconds

version
Type: string

the current version of the API
application/json
400

Bad request
401

Unauthorized
402

The request cannot proceed because a billing requirement is not met.
403

The account is not permitted to perform this operation.
429

Rate limit exceeded
500

Internal server error
502

The service could not complete the request.
503

The API or billing service is temporarily unavailable.
504

The service timed out while processing the request.
default

The operation failed. Keep the response request ID when contacting Felo support.

post/v1/beta/dataforseo/dataforseo_labs/amazon/related_keywords/live

curl https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/amazon/related_keywords/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {},
  {}
]'

Show Schema

{
  "version": "string",
  "status_code": 1,
  "status_message": "string",
  "time": "string",
  "cost": 1,
  "tasks_count": 1,
  "tasks_error": 1,
  "tasks": [
    "string"
  ],
  "tasks.id": "string",
  "tasks.status_code": 1,
  "tasks.status_message": "string",
  "tasks.time": "string",
  "tasks.cost": 1,
  "tasks.result_count": 1,
  "tasks.path": [
    "string"
  ],
  "tasks.data": {},
  "tasks.result": [
    "string"
  ],
  "tasks.result.se_type": "string",
  "tasks.result.seed_keyword": "string",
  "tasks.result.seed_keyword_data": {},
  "tasks.result.location_code": 1,
  "tasks.result.language_code": "string",
  "tasks.result.total_count": 1,
  "tasks.result.items_count": 1,
  "tasks.result.items": [
    "string"
  ],
  "tasks.result.items.se_type": "string",
  "tasks.result.items.keyword_data": {},
  "tasks.result.items.keyword_data.se_type": "string",
  "tasks.result.items.keyword_data.keyword": "string",
  "tasks.result.items.keyword_data.location_code": 1,
  "tasks.result.items.keyword_data.language_code": "string",
  "tasks.result.items.keyword_data.keyword_info": {},
  "tasks.result.items.keyword_data.keyword_info.se_type": "string",
  "tasks.result.items.keyword_data.keyword_info.last_updated_time": "string",
  "tasks.result.items.keyword_data.keyword_info.search_volume": 1,
  "tasks.result.items.depth": 1,
  "tasks.result.items.related_keywords": [
    "string"
  ]
}

Successful response

Related Keywords

AuthenticationRequired

DataForSEO

Related Keywords