v0.2.0-beta

OpenAPI 3.1.0

App Store Keywords For App Live

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/apple/keywords_for_app/live

App Store Keywords For App Live

The keywords an App Store app ranks 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. The Google Play twin is post_dataforseo_labs_google_keywords_for_app_live; the two stores' keyword sets rarely match, which is the reason to run both.

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)[]
- app_id
  Type: string
  
  id of the app
  required field
  ID of the mobile application on App Store;
  you can find the ID in the URL of every app listed on App Store;
  example:
  in the URL https://apps.apple.com/us/app/id835599320
  the id is 835599320
- 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:
  <, <=, >, >=, =, <>, in, not_in
  example:
  ["keyword_data.keyword_info.search_volume",">",500]
  
  [["keyword_data.keyword_info.search_volume","<>",500],"and",["ranked_serp_element.serp_item.rank_group",">=","10"]]
  
  for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide
  
  Empty object
- 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 languages with their language_code by making a separate request to the
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
  Note: this endpoint currently supports the English language only
  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 languages with their language_name by making a separate request to the
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages;
  Note: this endpoint currently supports the English language only;
  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 location 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 location 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
- 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 specify a sorting type;
  example:
  ["ranked_serp_element.serp_item.rank_group,asc"]
  Note: you can set no more than three sorting rules in a single request;
  you should use a comma to separate several sorting rules;
  example:
  ["ranked_serp_element.serp_item.rank_group,desc","keyword_data.keyword_info.search_volume,asc"]
  default rule:
  ["keyword_data.keyword_info.search_volume,desc"]
  Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array
- 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_DataforseoLabsAppleKeywordsForAppLiveResponseInfo
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_DataforseoLabsAppleKeywordsForAppLiveTaskInfo
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

app_id
Type: string | null

id of the app in a POST array

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

contains data related to the ranking keywords for the app specified in the app_id field

keyword_data
Type: object | null · Response36Afe1097B20_KeywordDataInfo

keyword data for the returned keyword

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

ranked_serp_element
Type: object | null · Response36Afe1097B20_AppleRankedSerpElementInfo

contains data on the domain's SERP element found for the returned keyword

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;
in this case, will equal null

se_results_count
Type: integer | null

number of search results for the returned keyword

se_type
Type: string | null

search engine type

serp_item
Type: object | null · Response36Afe1097B20_AppStoreSearchOrganic

contains data on the SERP element
the list of supported SERP elements can be found below

app_id
Type: string | null

id of the app in a POST array

icon
Type: string | null

URL to the app icon

is_free
Type: boolean | null

indicates whether the app is free

position
Type: string | null

the alignment of the element in SERP
can take the following values:
left, right

price
Type: object | null · Response36Afe1097B20_PriceInfo

pricing information for the app

currency
Type: string | null

currency of the listed price ISO code of the currency applied to the price

current
Type: number | null Format: double

current price indicates the current price of the product or service featured in the result

displayed_price
Type: string | null

price string in the result raw price string as provided in the result

is_price_range
Type: boolean | null

price is provided as a range indicates whether a price is provided in a range

max_value
Type: number | null Format: double

the maximum price the maximum price of the product or service as indicated in the result

regular
Type: number | null Format: double

regular price indicates the regular price of the product or service with no discounts applied

rank_absolute
Type: integer | null

absolute rank in SERP
absolute position among all the elements in SERP

rank_group
Type: integer | null

position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group

rating
Type: object | null · Response36Afe1097B20_RatingInfo

average rating of the app

rating_max
Type: integer | null

the maximum value for a rating_type

rating_type
Type: string | null

the type of rating here you can find the following elements: Max5, Percents, CustomMax

value
Type: number | null Format: double

the value of the rating

votes_count
Type: integer | null Format: int64

the amount of feedback

reviews_count
Type: integer | null Format: int64

the total number of reviews of the app

title
Type: string | null

title of the app

type
Type: string | null

type of element

url
Type: string | null

URL to the app page on App Store

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

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

post/v1/beta/dataforseo/dataforseo_labs/apple/keywords_for_app/live

curl https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/apple/keywords_for_app/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "app_id": "686449807",
    "language_name": "English",
    "location_code": 2840,
    "limit": 10
  }
]'

Show Schema

{
  "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,
          "app_id": null,
          "location_code": null,
          "language_code": null,
          "total_count": null,
          "items_count": null,
          "items": [
            {
              "se_type": null,
              "keyword_data": "[Max Depth Exceeded]",
              "ranked_serp_element": "[Max Depth Exceeded]"
            }
          ]
        }
      ]
    }
  ]
}

Successful operation

Need help?

Contact Support for API, billing, and account questions.
Chat with Felo developers on Discord.
Check out our changelog.
Need volume pricing or procurement help? Contact Sales.
Building with an LLM? Read llms.txt.

App Store Keywords For App Live

AuthenticationRequired

DataForSEO

App Store Keywords For App Live

Pricing reference

Need help?