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.

Параметры

Параметров пути, запроса и заголовков нет.

Тело запроса

categoriesstring[]Необязательный
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
descriptionstringНеобязательный
keyword in the app’s description optional field keywords that occur in the description of the app; can contain up to 200 characters
titlestringНеобязательный
keyword in the app’s title optional field keywords that occur in the title of the app; can contain up to 200 characters
filtersarrayНеобязательный
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[]Необязательный
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"]
limitintegerНеобязательный
the maximum number of returned apps optional field default value: 100 maximum value: 1000
offsetintegerНеобязательный
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_tokenstringНеобязательный
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
tagstringНеобязательный
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

Пример запроса

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>"
}'

Ответ

Поля ответа

versionstringНеобязательный
the current version of the API
status_codeintegerНеобязательный
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_messagestringНеобязательный
general informational message you can find the full list of general informational messages here
timestringНеобязательный
execution time, seconds
costnumberНеобязательный
total tasks cost, USD
tasks_countintegerНеобязательный
the number of tasks in the tasks array
tasks_errorintegerНеобязательный
the number of tasks in the tasks array that were returned an error
tasksstring[]Необязательный
array of tasks
idstringНеобязательный
task identifier unique task identifier in our system in the UUID format
status_codeintegerНеобязательный
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_messagestringНеобязательный
informational message of the task you can find the full list of general informational messages here
timestringНеобязательный
execution time, seconds
costnumberНеобязательный
cost of the task, USD
result_countintegerНеобязательный
number of elements in the result array
pathstring[]Необязательный
URL path
dataobjectНеобязательный
contains the same parameters that you specified in the POST request
resultstring[]Необязательный
array of results
total_countintegerНеобязательный
the total number of relevant results in the database
countintegerНеобязательный
the number of items in the results array
offsetintegerНеобязательный
offset in the results array of returned apps
offset_tokenstringНеобязательный
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[]Необязательный
array of apps and related data
app_idstringНеобязательный
ID of the returned app
se_domainstringНеобязательный
search engine domain in a POST array
location_codeintegerНеобязательный
location code in a POST array
language_codestringНеобязательный
language code in a POST array
check_urlstringНеобязательный
direct URL to search engine results you can use it to make sure that we provided accurate results
time_updatestringНеобязательный
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
itemobjectНеобязательный
detailed information about the app
typestringНеобязательный
the item’s type possible item types: "app_store_info_organic"
rank_groupintegerНеобязательный
position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group
rank_absoluteintegerНеобязательный
absolute rank among all the listed apps absolute position among all apps on the list
positionstringНеобязательный
the alignment of the element in SERP can take the following values: left
app_idstringНеобязательный
ID of the returned app
titlestringНеобязательный
title of the returned app
urlstringНеобязательный
URL to the app page on App Store
iconstringНеобязательный
URL to the app icon
descriptionstringНеобязательный
description of the returned app
reviews_countintegerНеобязательный
the total number of reviews the app has
ratingobjectНеобязательный
average rating of the app
rating_typestringНеобязательный
the type of the rating can take the following values: Max5
valuenumberНеобязательный
the value of the rating
votes_countintegerНеобязательный
the amount of feedback in this case, the value will be null
rating_maxintegerНеобязательный
the maximum value for a rating_type the maximum value for Max5 is 5
priceobjectНеобязательный
price of the app
currentnumberНеобязательный
current price refers to the current price indicated in the element
regularnumberНеобязательный
regular price refers to the regular price indicated in the element
max_valuenumberНеобязательный
the maximum price refers to the maximum price indicated in the element
currencystringНеобязательный
currency of the listed price ISO code of the currency applied to the price
is_price_rangebooleanНеобязательный
price is provided as a range indicates whether a price is provided in a range
displayed_pricestringНеобязательный
price string in the result raw price string as provided in the result
is_freebooleanНеобязательный
indicates whether the app is free
main_categorystringНеобязательный
app category App Store category most relevant to the app
categoriesstring[]Необязательный
list of additional app categories App Store categories relevant to the app
languagesstring[]Необязательный
languages supported in the app
advisoriesstring[]Необязательный
app advisory rating and usage restrictions
developerstringНеобязательный
name of the app developer
developer_idstringНеобязательный
ID of the developer on App Store
developer_urlstringНеобязательный
URL to the developer page on App Store
versionstringНеобязательный
current version of the app
minimum_os_versionstringНеобязательный
minimum OS version required to install the app
sizestringНеобязательный
size of the app
released_datestringНеобязательный
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_datestringНеобязательный
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_notesstringНеобязательный
update notes contains the latest update notes from the developer
imagesstring[]Необязательный
app images contains URLs to the images published on the app page on App Store
similar_appsstring[]Необязательный
similar apps displays apps similar to the app in a POST request
app_idstringНеобязательный
ID of the app
titlestringНеобязательный
title of the app
urlstringНеобязательный
URL to the app page on App Store
more_apps_by_developerstring[]Необязательный
similar apps information about apps built by the same developer
app_idstringНеобязательный
ID of the app
titlestringНеобязательный
title of the app
urlstringНеобязательный
URL to the app page on App Store