Felo API PlatformFelo API Platform
All DataForSEO endpoints
v0.2.0-beta
OpenAPI 3.1.0

Related Keywords

Server:https://openapi.felo.ai
Client Libraries

DataForSEO

​

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

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.

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.

Body
application/json
  • Type: array (object | null)[]
    • depth
      Type: integer | null

      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 | null

      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: falsen

    • include_seed_keyword
      Type: boolean | null

      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

    • keyword
      Type: string

      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

    • language_code
      Type: string | null

      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 | null

      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 | null

      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 | null

      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

Responses
  • 200
    Type: object | null · Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveResponseInfo
    • cost
      Type: number | null Format: double

      total tasks cost, USD

    • status_code
      Type: integer | null

      general status code you can find the full list of the response codes here

    • status_message
      Type: string | null

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

    • tasks
      Type: array (object | null)[] | null

      array of tasks

      • Type: object | null · Response36Afe1097B20_DataforseoLabsAmazonRelatedKeywordsLiveTaskInfo
        • cost
          Type: number | null Format: double

          total tasks cost, USD

        • data
          Type: object | null

          contains the same parameters that you specified in the POST request

          • propertyName
            Type: object | null
        • id
          Type: string | null

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

        • path
          Type: array (string | null)[] | null

          URL path

        • result
          Type: array (object | null)[] | null

          array of results

          • items
            Type: array (object | null)[] | null

            contains objects with keywords and related data

            • depth
              Type: integer | null

              keyword search depth

            • keyword_data
              Type: object | null · Response36Afe1097B20_AmazonKeywordData

              keyword data for the returned keyword

              • keyword
                Type: string | null

                related keyword

              • keyword_info
                Type: object | null · Response36Afe1097B20_AmazonKeywordInfo

                keyword info for the returned keyword

                • last_updated_time
                  Type: string | null

                  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'

                • se_type
                  Type: string | null

                  search engine type

                • search_volume
                  Type: integer | null Format: int64

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

              • language_code
                Type: string | null

                language code in a POST array

              • location_code
                Type: integer | null Format: int64

                location code in a POST array

              • se_type
                Type: string | null

                search engine type

            • related_keywords
              Type: array string[] | null

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

            • se_type
              Type: string | null

              search engine type

          • items_count
            Type: integer | null Format: int64

            the number of results returned in the items array

          • language_code
            Type: string | null

            language code in a POST array

          • location_code
            Type: integer | null

            location code in a POST array

          • se_type
            Type: string | null

            search engine type

          • seed_keyword
            Type: string | null

            keyword in a POST array

          • seed_keyword_data
            Type: object | null · Response36Afe1097B20_AmazonKeywordData

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

            • keyword
              Type: string | null

              related keyword

            • keyword_info
              Type: object | null · Response36Afe1097B20_AmazonKeywordInfo

              keyword info for the returned keyword

              • last_updated_time
                Type: string | null

                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'

              • se_type
                Type: string | null

                search engine type

              • search_volume
                Type: integer | null Format: int64

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

            • language_code
              Type: string | null

              language code in a POST array

            • location_code
              Type: integer | null Format: int64

              location code in a POST array

            • se_type
              Type: string | null

              search engine type

          • total_count
            Type: integer | null Format: int64

            total amount of results in our database relevant to your request

        • result_count
          Type: integer | null Format: int64

          number of elements in the result array

        • status_code
          Type: integer | null

          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

        • status_message
          Type: string | null

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

        • time
          Type: string | null

          execution time, seconds

    • tasks_count
      Type: integer | null Format: int64

      the number of tasks in the tasks array

    • tasks_error
      Type: integer | null Format: int64

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

    • time
      Type: string | null

      total execution time, seconds

    • version
      Type: string | null

      the current version of the API

    application/json
  • 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
Request Example for 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 '[
  {
    "keyword": "computer mouse",
    "language_name": "English",
    "location_code": 2840,
    "limit": 5,
    "include_seed_keyword": true
  }
]'
{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": [
        {
          "se_type": null,
          "seed_keyword": null,
          "seed_keyword_data": {
            "se_type": null,
            "keyword": null,
            "location_code": null,
            "language_code": null,
            "keyword_info": "[Max Depth Exceeded]"
          },
          "location_code": null,
          "language_code": null,
          "total_count": null,
          "items_count": null,
          "items": [
            {
              "se_type": null,
              "keyword_data": "[Max Depth Exceeded]",
              "depth": null,
              "related_keywords": [
                "[Max Depth Exceeded]"
              ]
            }
          ]
        }
      ]
    }
  ]
}
Related Keywords

Need help?