# Keyword Intersections

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/dataforseo_labs/amazon/product_keyword_intersections/live`

**Tags:** DataForSEO

The Amazon search terms two or more products both rank for. 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. Where `post_dataforseo_labs_amazon_product_competitors_live` names the rivals, this names the terms they contest.

### Pricing reference

- Metering: Reported response cost.
- Reference request estimate: USD 0.1356.
- Reference customer multiplier: 1.0. Do not apply it again to a settled customer amount.

Reference metadata only, not an account quote, a guaranteed price or a spending cap. Resource credits are not Felo credits. Final charges follow Felo billing records.

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "asins": {
            "type": [
              "object",
              "null"
            ],
            "additionalProperties": {
              "type": [
                "string",
                "null"
              ]
            },
            "description": "<em>asins of target products</em><br><strong>required field</strong><br>product IDs of the products for which you need to find keyword intersections;<br>specify the ASINs as in the following example:<br><code>\"asins\": {<br>\"1\": \"019005476X\",<br>\"2\": \"0190074442\"<br>}</code><br><strong>the maximum number of ASINs you can specify in this object is 20;</strong><br>learn more about the parameter on <a href=\"https://dataforseo.com/help-center/how-to-get-amazon-product-data-using-asin\" rel=\"noopener noreferrer\" target=\"_blank\">this help center page</a>"
          },
          "location_name": {
            "type": "string",
            "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United Kingdom</code>"
          },
          "location_code": {
            "type": "integer",
            "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to<br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>"
          },
          "language_name": {
            "type": "string",
            "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>"
          },
          "language_code": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>language code</em><br><strong>required field if don't specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>"
          },
          "limit": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>the maximum number of products in the results array</em><br>optional field<br>default value: <code>100</code>;<br>maximum value: <code>1000</code>"
          },
          "intersection_mode": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>mode for finding asin intersections</em><br>optional field<br>possible values: <code>union</code>, <code>intersect</code>;<br>default value: <code>intersect</code>;<br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/what-is-intersection-mode-in-amazon-keyword-intersections-endpoint\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>"
          },
          "filters": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": [
                "object",
                "null"
              ]
            },
            "description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>&lt;</code>, <code>&lt;=</code>, <code>&gt;</code>, <code>&gt;=</code>, <code>=</code>, <code>&lt;&gt;</code>, <code>in</code>, <code>not_in</code>, <code>ilike</code>, <code>not_ilike</code>, <code>like</code>, <code>not_like</code>, <code>match</code>, <code>not_match</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code>, as well as <code>ilike</code> and <code>not_ilike</code> to match any string of zero or more characters<br>example:<br><code>[\"avg_position\",\"&lt;\", 10]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>"
          },
          "order_by": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string"
            },
            "description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting parameter<br>example:<br><code>[\"sum_position,desc\"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>[\"intersections,desc\",\"avg_position,asc\"]</code><br>default rule:<br><code>[\"intersections,desc\"]</code>"
          },
          "offset": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> 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",
              "null"
            ],
            "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response"
          }
        },
        "example": [
          {
            "asins": {
              "1": "B09172433Z",
              "2": "B07GBZ4Q68",
              "3": "B07GCKQD77"
            },
            "language_name": "English",
            "location_code": 2840
          }
        ]
      }
    ]
  },
  "example": [
    {
      "asins": {
        "1": "B09172433Z",
        "2": "B07GBZ4Q68",
        "3": "B07GCKQD77"
      },
      "language_name": "English",
      "location_code": 2840
    }
  ]
}
```

## Responses

### 200 — Successful operation

Headers:
- `X-Request-Id` (string) — Request identifier to include when contacting Felo support.

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonProductKeywordIntersectionsLiveResponseInfo"
    }
  ]
}
```

### 400 — The request could not be processed. Check the request parameters.

### 401 — A valid Felo API key is required.

### 402 — The request cannot proceed because a billing requirement is not met.

### 403 — The account is not permitted to perform this operation.

### 429 — A request or spending limit has been reached.

### 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 — Error response; upstream passthrough responses may use provider formats

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_AmazonDeliveryInfo

`#/components/schemas/Response36Afe1097B20_AmazonDeliveryInfo`

```json
{
  "type": "object",
  "properties": {
    "delivery_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "message accompanying the delivery information as posted by the seller"
    },
    "delivery_date_from": {
      "type": [
        "string",
        "null"
      ],
      "description": "the earliest date when the product can be shipped"
    },
    "delivery_date_to": {
      "type": [
        "string",
        "null"
      ],
      "description": "the latest date when the product can be delivered"
    },
    "fastest_delivery_date_from": {
      "type": [
        "string",
        "null"
      ],
      "description": "the earliest date when the product can be delivered with a fast delivery option"
    },
    "fastest_delivery_date_to": {
      "type": [
        "string",
        "null"
      ],
      "description": "the latest date when the product can be delivered with a fast delivery option"
    },
    "delivery_price": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_PriceInfo"
        }
      ],
      "description": "price for the delivery\nprice of the delivery based on the location you specified in the POST request;\nif free delivery is available, the value is null"
    }
  }
}
```

### Response36Afe1097B20_AmazonInfo

`#/components/schemas/Response36Afe1097B20_AmazonInfo`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>search engine type</em>"
    },
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "type of element"
    },
    "rank_group": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>position within a group of elements with identical <code>type</code> values</em><br>positions of elements with different <code>type</code> values are omitted from <code>rank_group</code>"
    },
    "rank_absolute": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>absolute rank in Amazon SERP</em><br>absolute position among all the elements in SERP"
    },
    "position": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>the alignment of the element in Amazon SERP</em><br>can take the following values:<br><code>left</code>, <code>right</code>"
    },
    "xpath": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>the <a href=\"https://en.wikipedia.org/wiki/XPath\">XPath</a> of the element</em>"
    },
    "domain": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>Amazon domain</em>"
    },
    "title": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>product title</em>"
    },
    "url": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>URL of the product page</em>"
    },
    "asin": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>ASIN in a POST array</em>"
    },
    "image_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>URL of the product image featured in the results</em>"
    },
    "price_from": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>the regular price of a product</em><br>example:<br><code>49.98</code>"
    },
    "price_to": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>the upper limit of the product price range</em><br>example:<br><code>384.99</code>"
    },
    "currency": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>currency in the <a href=\"https://en.wikipedia.org/wiki/ISO_4217\">ISO</a> format</em><br>example:<br><code>USD</code>"
    },
    "special_offers": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "<em>special offer details</em><br>contains special offer details, including coupon and Subscribe & Save discounts"
    },
    "is_best_seller": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "<em>\"Best Seller\" label</em><br>if the value is <code>true</code>, the product is marked with the \"Best Seller\" label"
    },
    "is_amazon_choice": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "<em>\"Amazon's choice\" label</em><br>if the value is <code>true</code>, the product is marked with the \"Amazon's choice\" label"
    },
    "rating": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_RatingInfo"
        }
      ],
      "properties": {
        "value": {
          "type": [
            "number",
            "null"
          ],
          "description": "the value of the rating",
          "format": "float"
        }
      },
      "description": "<em>the item's rating </em><br>the popularity rate based on reviews and displayed in SERP"
    },
    "delivery_info": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_AmazonDeliveryInfo"
        }
      ],
      "description": "<em>delivery information</em><br>delivery information including free and fast delivery date ranges"
    },
    "bought_past_month": {
      "type": [
        "integer",
        "null"
      ]
    }
  }
}
```

### Response36Afe1097B20_AmazonKeywordData

`#/components/schemas/Response36Afe1097B20_AmazonKeywordData`

```json
{
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "search engine type"
    },
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "related keyword"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "location code in a POST array",
      "format": "int64"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "language code in a POST array"
    },
    "keyword_info": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_AmazonKeywordInfo"
        }
      ],
      "description": "keyword info for the returned keyword"
    }
  }
}
```

### Response36Afe1097B20_AmazonKeywordInfo

`#/components/schemas/Response36Afe1097B20_AmazonKeywordInfo`

```json
{
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "search engine type"
    },
    "last_updated_time": {
      "type": [
        "string",
        "null"
      ],
      "description": "date and time when keyword data was updated\nin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”\nexample:    '2019-11-15 12:57:46 +00:00'"
    },
    "search_volume": {
      "type": [
        "integer",
        "null"
      ],
      "description": "average monthly search volume rate\nrepresents the (approximate) number of searches for the provided keyword idea on Amazon",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`

```json
{
  "properties": {
    "version": {
      "type": [
        "string",
        "null"
      ],
      "description": "the current version of the API"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "general status code\nyou can find the full list of the response codes here"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "general informational message\nyou can find the full list of general informational messages here"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "total execution time, seconds"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "total tasks cost, USD",
      "format": "double"
    },
    "tasks_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "the number of tasks in the tasks array",
      "format": "int64"
    },
    "tasks_error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "the number of tasks in the tasks array returned with an error",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseTaskInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`

```json
{
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "description": "task identifier\nunique task identifier in our system in the UUID format"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "status code of the task\ngenerated by DataForSEO, can be within the following range: 10000-60000\nyou can find the full list of the response codes here"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "informational message of the task\nyou can find the full list of general informational messages here"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "execution time, seconds"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "total tasks cost, USD",
      "format": "double"
    },
    "result_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "number of elements in the result array",
      "format": "int64"
    },
    "path": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "URL path"
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ]
      },
      "description": "contains the same parameters that you specified in the POST request"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsAmazonProductKeywordIntersectionsLiveItem

`#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonProductKeywordIntersectionsLiveItem`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>search engine type</em>"
    },
    "keyword_data": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_AmazonKeywordData"
        }
      ],
      "description": "<em>keyword data for the returned keyword</em>"
    },
    "intersection_result": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_AmazonInfo"
          }
        ]
      },
      "description": "<em>data on the intersection</em>"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsAmazonProductKeywordIntersectionsLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonProductKeywordIntersectionsLiveResponseInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
    },
    {
      "type": "object",
      "properties": {
        "tasks": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonProductKeywordIntersectionsLiveTaskInfo"
              }
            ]
          },
          "description": "<em>array of tasks</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_DataforseoLabsAmazonProductKeywordIntersectionsLiveResultInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonProductKeywordIntersectionsLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>search engine type</em>"
    },
    "asins": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "<em>ASINs in a POST array</em>"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>"
    },
    "total_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>total amount of results in our database relevant to your request</em>",
      "format": "int64"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>the number of results returned in the <code>items</code> array</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonProductKeywordIntersectionsLiveItem"
          }
        ]
      },
      "description": "<em>contains detected Amazon product competitors and related data</em>"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsAmazonProductKeywordIntersectionsLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonProductKeywordIntersectionsLiveTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonProductKeywordIntersectionsLiveResultInfo"
              }
            ]
          },
          "description": "<em>array of results</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_PriceInfo

`#/components/schemas/Response36Afe1097B20_PriceInfo`

```json
{
  "type": "object",
  "properties": {
    "current": {
      "type": [
        "number",
        "null"
      ],
      "description": "current price\nindicates the current price of the product or service featured in the result",
      "format": "double"
    },
    "regular": {
      "type": [
        "number",
        "null"
      ],
      "description": "regular price\nindicates the regular price of the product or service with no discounts applied",
      "format": "double"
    },
    "max_value": {
      "type": [
        "number",
        "null"
      ],
      "description": "the maximum price\nthe maximum price of the product or service as indicated in the result",
      "format": "double"
    },
    "currency": {
      "type": [
        "string",
        "null"
      ],
      "description": "currency of the listed price\nISO code of the currency applied to the price"
    },
    "is_price_range": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "price is provided as a range\nindicates whether a price is provided in a range"
    },
    "displayed_price": {
      "type": [
        "string",
        "null"
      ],
      "description": "price string in the result\nraw price string as provided in the result"
    }
  }
}
```

### Response36Afe1097B20_RatingInfo

`#/components/schemas/Response36Afe1097B20_RatingInfo`

```json
{
  "properties": {
    "rating_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "the type of rating\nhere you can find the following elements: Max5, Percents, CustomMax"
    },
    "value": {
      "type": [
        "number",
        "null"
      ],
      "description": "the value of the rating",
      "format": "double"
    },
    "votes_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "the amount of feedback",
      "format": "int64"
    },
    "rating_max": {
      "type": [
        "integer",
        "null"
      ],
      "description": "the maximum value for a rating_type"
    }
  }
}
```