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

Top Searches

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

Top Searches

​

The highest-volume keywords in a location, unfiltered by seed or site. 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. This is the discovery end of the family: use it when there is no seed keyword yet, then narrow with post_dataforseo_labs_google_keyword_ideas_live.

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)[]
    • filters
      Type: array (object | null)[] | null

      array of results filtering parameters
      optional field
      you can add several filters at once (8 filters maximum)
      you should set a logical operator and, or between the conditions
      the following operators are supported:
      regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like,not_like
      you can use the % operator with like and not_like,as well as ilike and not_ilike to match any string of zero or more characters
      example:
      ["keyword_info.search_volume",">",0]

      [["keyword_info.search_volume","in",[0,1000]],
      "and",
      ["keyword_info.competition_level","=","LOW"]]

      [["keyword_info.search_volume",">",100],
      "and",
      [["keyword_info.cpc","<",0.5],
      "or",

      ["keyword_info.high_top_of_page_bid","<=",0.5]]]
      for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide

      Empty object
    • 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: false

    • include_clickstream_data
      Type: boolean | null

      include or exclude data from clickstream-based metrics in the result
      optional field
      if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response
      default value: false
      with this parameter enabled, you will be charged double the price for the request

      learn more about how clickstream-based metrics are calculated in this help center article

    • include_serp_info
      Type: boolean | null

      include data from SERP for each keyword
      optional field
      if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response
      default value: false

    • 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 the
      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 the
      https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
      example:
      English

    • limit
      Type: integer | null

      the maximum number of returned keywords
      optional field
      note: you can get more than 1000 results by using the offset_token provided in the response to each subsequent request
      default value: 1000
      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 the
      https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
      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 the
      https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
      example:
      United Kingdom

    • 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
      Note: we recommend using this parameter only when retrieving up to 10,000 results
      for retrieving over 10,000 results, use the offset_token instead.

    • offset_token
      Type: string | null

      offset token for subsequent requests
      optional field
      provided in the identical filed of the response to each request;
      use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;
      by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;
      offset_token values are unique for each subsequent task
      Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task.
      learn more about this parameter on our Help Center

    • order_by
      Type: array string[] | null

      results sorting rules
      optional field
      you can use the same values as in the filters array to sort the results
      possible sorting types:
      asc - results will be sorted in the ascending order
      desc - results will be sorted in the descending order
      you should use a comma to set up a sorting type
      example:
      ["keyword_info.competition,desc"]
      default rule:
      ["keyword_info.search_volume,desc"]
      note that you can set no more than three sorting rules in a single request
      you should use a comma to separate several sorting rules
      example:
      ["keyword_info.search_volume,desc","keyword_info.cpc,desc"]

    • 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_DataforseoLabsGoogleTopSearchesLiveResponseInfo
    • 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_DataforseoLabsGoogleTopSearchesLiveTaskInfo
        • 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 keywords and related data

            • avg_backlinks_info
              Type: object | null · Response36Afe1097B20_AvgBacklinksInfo

              backlink data for the returned keyword
              this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 webpages ranking organically for the keyword

              • backlinks
                Type: number | null

                average number of backlinks

              • dofollow
                Type: number | null

                average number of dofollow links

              • 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

              • main_domain_rank
                Type: number | null

                average main domain rank
                learn more about the metric and its calculation formula in this help center article

              • rank
                Type: number | null

                average rank
                learn more about the metric and its calculation formula in this help center article

              • referring_domains
                Type: number | null

                average number of referring domains

              • referring_main_domains
                Type: number | null

                average number of referring main domains

              • referring_pages
                Type: number | null

                average number of referring pages

              • se_type
                Type: string | null

                search engine type

            • clickstream_keyword_info
              Type: object | null · Response36Afe1097B20_ClickstreamKeywordInfo

              clickstream data for the returned keyword
              to retrieve results for this field, the parameter include_clickstream_data must be set to true

              • age_distribution
                Type: object | null

                distribution of clickstream-based metrics by age
                learn more about how the metric is calculated in this help center article

                • propertyName
                  Type: integer | null Format: int64

                  Signed 64-bit integers (long type).

              • gender_distribution
                Type: object | null

                distribution of estimated clickstream-based metrics by gender
                learn more about how the metric is calculated in this help center article

                • propertyName
                  Type: integer | null Format: int64

                  Signed 64-bit integers (long type).

              • 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

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

                monthly searches
                represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations

                • month
                  Type: integer | null

                  month

                • search_volume
                  Type: integer | null

                  monthly average search volume rate

                • year
                  Type: integer | null

                  year

              • search_volume
                Type: integer | null Format: int64

                average monthly search volume rate
                represents the (approximate) number of searches for the given keyword idea on google.com

            • keyword
              Type: string | null

              returned keyword idea

            • keyword_info
              Type: object | null · Response36Afe1097B20_KeywordInfo

              keyword data for the returned keyword idea

              • categories
                Type: array integer[] | null

                product and service categories
                you can download the full list of possible categories

              • competition
                Type: number | null

                competition
                represents the relative amount of competition associated with the given keyword. This value is based on Google Ads data and can be between 0 and 1 (inclusive)

              • competition_level
                Type: string | null

                competition level
                represents the relative level of competition associated with the given keyword in paid SERP only;
                possible values: LOW, MEDIUM, HIGH
                if competition level is unknown, the value is null;
                learn more about the metric in this help center article

              • cpc
                Type: number | null

                cost-per-click
                represents the average cost per click (USD) historically paid for the keyword

              • high_top_of_page_bid
                Type: number | null

                maximum bid for the ad to be displayed at the top of the first page
                indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)
                the value may differ depending on the location specified in a POST request

              • 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

              • low_top_of_page_bid
                Type: number | null

                minimum bid for the ad to be displayed at the top of the first page
                indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)
                the value may differ depending on the location specified in a POST request

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

                monthly searches
                represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations

                • month
                  Type: integer | null

                  month

                • search_volume
                  Type: integer | null

                  monthly average search volume rate

                • year
                  Type: integer | null

                  year

              • 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 given keyword idea on google.com

              • search_volume_trend
                Type: object | null · Response36Afe1097B20_SearchVolumeTrend

                search volume trend changes
                represents search volume change in percent compared to the previous period

                • monthly
                  Type: integer | null

                  search volume change in percent compared to the previous month

                • quarterly
                  Type: integer | null

                  search volume change in percent compared to the previous quarter

                • yearly
                  Type: integer | null

                  search volume change in percent compared to the previous year

            • keyword_info_normalized_with_bing
              Type: object | null · Response36Afe1097B20_KeywordInfoNormalizedWithInfo

              contains keyword search volume normalized with Bing search volume

              • is_normalized
                Type: boolean | null

                keyword info is normalized if true, values are normalized with Bing data

              • last_updated_time
                Type: string | null

                date and time when the dataset was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00

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

                monthly search volume rates array of objects with search volume rates in a certain month of a year

                • month
                  Type: integer | null

                  month

                • search_volume
                  Type: integer | null

                  monthly average search volume rate

                • year
                  Type: integer | null

                  year

              • search_volume
                Type: integer | null

                current search volume rate of a keyword

            • keyword_info_normalized_with_clickstream
              Type: object | null · Response36Afe1097B20_KeywordInfoNormalizedWithInfo

              contains keyword search volume normalized with clickstream data

              • is_normalized
                Type: boolean | null

                keyword info is normalized if true, values are normalized with Bing data

              • last_updated_time
                Type: string | null

                date and time when the dataset was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00

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

                monthly search volume rates array of objects with search volume rates in a certain month of a year

                • month
                  Type: integer | null

                  month

                • search_volume
                  Type: integer | null

                  monthly average search volume rate

                • year
                  Type: integer | null

                  year

              • search_volume
                Type: integer | null

                current search volume rate of a keyword

            • keyword_properties
              Type: object | null · Response36Afe1097B20_KeywordProperties

              additional information about the keyword

              • core_keyword
                Type: string | null

                main keyword in a group
                contains the main keyword in a group determined by the synonym clustering algorithm
                if the value is null, our database does not contain any keywords the corresponding algorithm could identify as synonymous with keyword

              • detected_language
                Type: string | null

                detected language of the keyword
                indicates the language of the keyword as identified by our system

              • is_another_language
                Type: boolean | null

                detected language of the keyword is different from the set language
                if true, the language set in the request does not match the language determined by our system for a given keyword

              • keyword_difficulty
                Type: integer | null

                difficulty of ranking in the first top-10 organic results for a keyword
                indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100;
                calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP;
                learn more about the metric in this help center guide

              • se_type
                Type: string | null

                search engine type

              • synonym_clustering_algorithm
                Type: string | null

                the algorithm used to identify synonyms
                possible values:
                keyword_metrics - indicates the algorithm based on keyword_info parameters
                text_processing - indicates the text-based algorithm
                if the value is null, our database does not contain any keywords the corresponding algorithm could identify as synonymous with keyword

              • words_count
                Type: integer | null Format: int64

                number of words in the keyword
                indicates how many words the keyword consists of

            • 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

            • search_intent_info
              Type: object | null · Response36Afe1097B20_SearchIntentInfo

              search intent info for the returned keyword
              learn about search intent in this help center article

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

                supplementary search intents
                possible values: informational, navigational, commercial, transactional

              • 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

              • main_intent
                Type: string | null

                main search intent
                possible values: informational, navigational, commercial, transactional

              • se_type
                Type: string | null

                search engine type

            • serp_info
              Type: object | null · Response36Afe1097B20_SerpInfo

              SERP data
              the value will be null if you didn't set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database

              • check_url
                Type: string | null

                direct URL to search engine results
                you can use it to make sure that we provided accurate results

              • 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

              • previous_updated_time
                Type: string | null

                previous to the most recent date and time when SERP data was updated
                in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
                example:
                2019-10-15 12:57:46 +00:00

              • se_results_count
                Type: integer | null Format: int64

                number of search results for the returned keyword

              • se_type
                Type: string | null

                search engine type

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

                types of search results in SERP
                contains types of search results (items) found in SERP
                possible item types:
                answer_box, app, carousel, multi_carousel, featured_snippet, google_flights, google_reviews, third_party_reviews, google_posts, images, jobs, knowledge_graph, local_pack, hotels_pack, map, organic, paid, people_also_ask, related_searches, people_also_search, shopping, top_stories, twitter, video, events, mention_carousel, recipes, top_sights, scholarly_articles, popular_products, podcasts, questions_and_answers, find_results_on, stocks_box, visual_stories, commercial_units, local_services, google_hotels, math_solver, currency_box, product_considerations, found_on_web, short_videos, refine_products, explore_brands, perspectives, discussions_and_forums, compare_sites, courses, ai_overview;
                note that the actual results will be returned only for organic, paid, featured_snippet, and local_pack elements

          • 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

          • offset
            Type: integer | null

            current offset value

          • offset_token
            Type: string | null

            offset token for subsequent requests
            you can use the string provided in this field to get the subsequent results of the initial task;
            note: offset_token values are unique for each subsequent task

          • 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/google/top_searches/live
curl https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/google/top_searches/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "language_name": "English",
    "location_code": 2840,
    "limit": 3
  }
]'

{
  "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,
          "location_code": null,
          "language_code": null,
          "total_count": null,
          "items_count": null,
          "offset": null,
          "offset_token": null,
          "items": [
            {
              "se_type": null,
              "keyword": null,
              "location_code": null,
              "language_code": null,
              "keyword_info": "[Max Depth Exceeded]",
              "keyword_info_normalized_with_bing": "[Max Depth Exceeded]",
              "keyword_info_normalized_with_clickstream": "[Max Depth Exceeded]",
              "clickstream_keyword_info": "[Max Depth Exceeded]",
              "keyword_properties": "[Max Depth Exceeded]",
              "serp_info": "[Max Depth Exceeded]",
              "avg_backlinks_info": "[Max Depth Exceeded]",
              "search_intent_info": "[Max Depth Exceeded]"
            }
          ]
        }
      ]
    }
  ]
}

Successful operation

Top Searches

Need help?