Data API / DataForSEO / App Data

Live Apple App Listings Search Results

Searches DataForSEO's own index of App Store listings, synchronously - the Apple twin of post_dataforseo_app_google_app_listings_search_live, same arguments and same shape. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Category names come from get_dataforseo_app_apple_app_listings_categories.

Parameters

No path, query, or header parameters.

Request body

categoriesstring[]Optional
app categories optional field the categories you specify are used to search for app listings; you can get the full list of available app listing categories by this link you can specify up to 10 categories
descriptionstringOptional
keyword in the app’s description optional field keywords that occur in the description of the app; can contain up to 200 characters
titlestringOptional
keyword in the app’s title optional field keywords that occur in the title of the app; can contain up to 200 characters
filtersarrayOptional
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, like, not_like you can use the % operator with like and not_like to match any string of zero or more characters example: ["rating.value",">",3] you can receive the list of available filters by making a separate request to https://api.dataforseo.com/v3/app_data/apple/app_listings/available_filters
order_bystring[]Optional
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 parameter example: ["item.rating.value,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: ["item.rating.value,desc","item.rating.value,desc"]
limitintegerOptional
the maximum number of returned apps optional field default value: 100 maximum value: 1000
offsetintegerOptional
offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities 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_tokenstringOptional
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 100,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 should be identical to the previous request learn more about this parameter on our Help Center
tagstringOptional
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

Example request

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/app_data/apple/app_listings/search/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "categories": [
    "<string>"
  ],
  "description": "<string>",
  "title": "<string>",
  "filters": "<string>",
  "order_by": [
    "<string>"
  ],
  "limit": 0,
  "offset": 0,
  "offset_token": "<string>"
}'

Response

Response fields

versionstringOptional
the current version of the API
status_codeintegerOptional
general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
status_messagestringOptional
general informational message you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
total tasks cost, USD
tasks_countintegerOptional
the number of tasks in the tasks array
tasks_errorintegerOptional
the number of tasks in the tasks array that were returned an error
tasksstring[]Optional
array of tasks
idstringOptional
task identifier unique task identifier in our system in the UUID format
status_codeintegerOptional
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_messagestringOptional
informational message of the task you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
cost of the task, USD
result_countintegerOptional
number of elements in the result array
pathstring[]Optional
URL path
dataobjectOptional
contains the same parameters that you specified in the POST request
resultstring[]Optional
array of results
total_countintegerOptional
the total number of relevant results in the database
countintegerOptional
the number of items in the results array
offsetintegerOptional
offset in the results array of returned apps
offset_tokenstringOptional
token for subsequent requests you can use this parameter in the POST request to avoid timeouts while trying to obtain over 100,000 results in a single request
itemsstring[]Optional
array of apps and related data
app_idstringOptional
ID of the returned app
se_domainstringOptional
search engine domain in a POST array
location_codeintegerOptional
location code in a POST array
language_codestringOptional
language code in a POST array
check_urlstringOptional
direct URL to search engine results you can use it to make sure that we provided accurate results
time_updatestringOptional
date and time when SERP data was last updated in the ISO 8601 format: “YYYY-MM-DDThh:mm:ss.sssssssZ” example: 2023-05-23 10:16:19 +00:00
itemobjectOptional
detailed information about the app
typestringOptional
the item’s type possible item types: "app_store_info_organic"
rank_groupintegerOptional
position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group
rank_absoluteintegerOptional
absolute rank among all the listed apps absolute position among all apps on the list
positionstringOptional
the alignment of the element in SERP can take the following values: left
app_idstringOptional
ID of the returned app
titlestringOptional
title of the returned app
urlstringOptional
URL to the app page on App Store
iconstringOptional
URL to the app icon
descriptionstringOptional
description of the returned app
reviews_countintegerOptional
the total number of reviews the app has
ratingobjectOptional
average rating of the app
rating_typestringOptional
the type of the rating can take the following values: Max5
valuenumberOptional
the value of the rating
votes_countintegerOptional
the amount of feedback in this case, the value will be null
rating_maxintegerOptional
the maximum value for a rating_type the maximum value for Max5 is 5
priceobjectOptional
price of the app
currentnumberOptional
current price refers to the current price indicated in the element
regularnumberOptional
regular price refers to the regular price indicated in the element
max_valuenumberOptional
the maximum price refers to the maximum price indicated in the element
currencystringOptional
currency of the listed price ISO code of the currency applied to the price
is_price_rangebooleanOptional
price is provided as a range indicates whether a price is provided in a range
displayed_pricestringOptional
price string in the result raw price string as provided in the result
is_freebooleanOptional
indicates whether the app is free
main_categorystringOptional
app category App Store category most relevant to the app
categoriesstring[]Optional
list of additional app categories App Store categories relevant to the app
languagesstring[]Optional
languages supported in the app
advisoriesstring[]Optional
app advisory rating and usage restrictions
developerstringOptional
name of the app developer
developer_idstringOptional
ID of the developer on App Store
developer_urlstringOptional
URL to the developer page on App Store
versionstringOptional
current version of the app
minimum_os_versionstringOptional
minimum OS version required to install the app
sizestringOptional
size of the app
released_datestringOptional
date and time when the app was released in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”; example: 2019-11-15 12:57:46 +00:00
last_update_datestringOptional
date and time when the app was last updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”; example: 2019-11-15 12:57:46 +00:00
update_notesstringOptional
update notes contains the latest update notes from the developer
imagesstring[]Optional
app images contains URLs to the images published on the app page on App Store
similar_appsstring[]Optional
similar apps displays apps similar to the app in a POST request
app_idstringOptional
ID of the app
titlestringOptional
title of the app
urlstringOptional
URL to the app page on App Store
more_apps_by_developerstring[]Optional
similar apps information about apps built by the same developer
app_idstringOptional
ID of the app
titlestringOptional
title of the app
urlstringOptional
URL to the app page on App Store