> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Dataforseo Dataforseo Labs Amazon Related Keywords:
> The Related Keywords endpoint provides keywords appearing in the "Related Searches" section on Amazon. Includes inputs, outputs, and CLI examples.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=dataforseo_dataforseo_labs_amazon_related_keywords_live:{"keyword":"{{keyword}}"}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| ------------------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.keyword` | `string` | Yes | | 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 |
| `payload.location_name` | `string` | No | | full name of the location required field if you don't specify location\_code Note: it is required to specify either location\_name or location\_code you can receive the list of available locations with their location\_name by making a separate request to [https://api.dataforseo.com/v3/dataforseo\_labs/locations\_and\_languages](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 |
| `payload.location_code` | `integer` | No | | 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](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 |
| `payload.language_name` | `string` | No | | full name of the language required field if you don't specify language\_code Note: it is required to specify either language\_name or language\_code you can receive the list of available locations with their language\_name by making a separate request to [https://api.dataforseo.com/v3/dataforseo\_labs/locations\_and\_languages](https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages) example: English |
| `payload.language_code` | `string` | No | | 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](https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages) example: en |
| `payload.depth` | `integer` | No | | 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 |
| `payload.include_seed_keyword` | `boolean` | No | | 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 |
| `payload.ignore_synonyms` | `boolean` | No | | 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 |
| `payload.limit` | `integer` | No | | the maximum number of returned keywords optional field default value: 100 maximum value: 1000 |
| `payload.offset` | `integer` | No | | 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 |
| `payload.tag` | `string` | No | | user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "The Related Keywords endpoint provides keywords appearing in the \"Related Searches\" section on Amazon.",
"properties": {
"keyword": {
"type": "string",
"description": "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"
},
"location_name": {
"type": "string",
"description": "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"
},
"location_code": {
"type": "integer",
"description": "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"
},
"language_name": {
"type": "string",
"description": "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"
},
"language_code": {
"type": "string",
"description": "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"
},
"depth": {
"type": "integer",
"description": "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"
},
"include_seed_keyword": {
"type": "boolean",
"description": "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"
},
"ignore_synonyms": {
"type": "boolean",
"description": "ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false"
},
"limit": {
"type": "integer",
"description": "the maximum number of returned keywords optional field default value: 100 maximum value: 1000"
},
"offset": {
"type": "integer",
"description": "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",
"description": "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"
}
},
"required": [
"keyword"
],
"additionalProperties": false
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ----------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `result.version` | `string` | Yes | | the current version of the API |
| `result.status_code` | `integer` | Yes | | general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions |
| `result.status_message` | `string` | Yes | | general informational message you can find the full list of general informational messages here |
| `result.time` | `string` | Yes | | execution time, seconds |
| `result.tasks_count` | `integer` | Yes | | the number of tasks in the tasks array |
| `result.tasks_error` | `integer` | Yes | | the number of tasks in the tasks array returned with an error |
| `result.tasks` | `array` | Yes | | array of tasks |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Top-level response envelope for dataforseo_dataforseo_labs_amazon_related_keywords_live.",
"properties": {
"version": {
"type": "string",
"description": "the current version of the API"
},
"status_code": {
"type": "integer",
"description": "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",
"description": "general informational message you can find the full list of general informational messages here"
},
"time": {
"type": "string",
"description": "execution time, seconds"
},
"tasks_count": {
"type": "integer",
"description": "the number of tasks in the tasks array"
},
"tasks_error": {
"type": "integer",
"description": "the number of tasks in the tasks array returned with an error"
},
"tasks": {
"type": "array",
"description": "array of tasks",
"items": {}
}
},
"required": [
"version",
"status_code",
"status_message",
"time",
"tasks_count",
"tasks_error",
"tasks"
],
"additionalProperties": false
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute dataforseo_dataforseo_labs_amazon_related_keywords_live --payload '{
"keyword": "string"
}' --json
```
### CLI flags
| Flag | Description |
| --------------------------- | --------------------------------------------------- |
| `--json` | Print machine-readable output. |
| `--wait` | Wait for terminal provider status when supported. |
| `--debug` | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS` | Max seconds to wait in wait mode. |
| `--poll-interval SECONDS` | Polling interval in seconds during wait mode. |
| `--timeout SECONDS` | Request timeout in seconds. |
| `--connect-timeout SECONDS` | Connection timeout in seconds. |
## Cost
* Pricing model: `provider_usage` (provider usage).
* Estimated Deepline credits: `0.01` per pricing unit.
* Billing mode: `post_deduct`.