# Live Apple App Listings Search Results **API:** Data API **Endpoint:** `POST /v1/beta/dataforseo/app_data/apple/app_listings/search/live` **Tags:** DataForSEO 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`. ### Pricing reference - Metering: Reported response cost. - Reference request estimate: USD 0.012. - 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. ## Base URL - `https://openapi.felo.ai` ## Authentication - `FeloBearerAuth` (http bearer, bearer format Felo API Key) - `FeloApiKey` (apiKey in header `X-API-Key`) ## Request body Required: **no** ### application/json Schema: ```json { "type": "array", "items": { "type": [ "object", "null" ], "oneOf": [ { "type": "object", "properties": { "categories": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "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" }, "description": { "type": [ "string", "null" ], "description": "keyword in the app's description
optional field
keywords that occur in the description of the app;
can contain up to 200 characters" }, "title": { "type": [ "string", "null" ], "description": "keyword in the app's title
optional field
keywords that occur in the title of the app;
can contain up to 200 characters" }, "filters": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ] }, "description": "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_filtersn" }, "order_by": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "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\"]" }, "limit": { "type": [ "integer", "null" ], "description": "the maximum number of returned apps
optional field
default value: 100
maximum value: 1000" }, "offset": { "type": [ "integer", "null" ], "description": "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_token": { "type": [ "string", "null" ], "description": "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" }, "tag": { "type": [ "string", "null" ], "description": "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": [ { "title": "vpn", "description": "vpn", "categories": [ "Utilities" ], "order_by": [ "item.rating.value,desc" ], "filters": [ [ "item.rating.value", ">", 4.5 ] ], "limit": 10 } ] } ] }, "example": [ { "title": "vpn", "description": "vpn", "categories": [ "Utilities" ], "order_by": [ "item.rating.value,desc" ], "filters": [ [ "item.rating.value", ">", 4.5 ] ], "limit": 10 } ] } ``` ## Responses ### 200 — Successful operation Headers: - `X-Request-Id` (string) — Request identifier to include when contacting Felo support. **application/json** Schema: object | null ```json { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_AppDataAppleAppListingsSearchLiveResponseInfo" } ] } ``` ### 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** Schema: ```json {} ``` ## Schema definitions ### Response36Afe1097B20_AppDataAppleAppListingsSearchLiveItem `#/components/schemas/Response36Afe1097B20_AppDataAppleAppListingsSearchLiveItem` ```json { "type": "object", "properties": { "app_id": { "type": [ "string", "null" ], "description": "ID of the returned app" }, "se_domain": { "type": [ "string", "null" ], "description": "search engine domain in a POST array" }, "location_code": { "type": [ "integer", "null" ], "description": "location code in a POST array" }, "language_code": { "type": [ "string", "null" ], "description": "language code in a POST array" }, "check_url": { "type": [ "string", "null" ], "description": "direct URL to search engine results
you can use it to make sure that we provided accurate results" }, "time_update": { "type": [ "string", "null" ], "description": "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" }, "item": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_AppStoreInfoOrganic" } ], "description": "detailed information about the app" } } } ``` ### Response36Afe1097B20_AppDataAppleAppListingsSearchLiveResponseInfo `#/components/schemas/Response36Afe1097B20_AppDataAppleAppListingsSearchLiveResponseInfo` ```json { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_AppDataAppleAppListingsSearchLiveTaskInfo" } ] }, "description": "array of tasks" } } } ] } ``` ### Response36Afe1097B20_AppDataAppleAppListingsSearchLiveResultInfo `#/components/schemas/Response36Afe1097B20_AppDataAppleAppListingsSearchLiveResultInfo` ```json { "type": "object", "properties": { "total_count": { "type": [ "integer", "null" ], "description": "the total number of relevant results in the database", "format": "int64" }, "count": { "type": [ "integer", "null" ], "description": "the number of items in the results array", "format": "int64" }, "offset": { "type": [ "integer", "null" ], "description": "offset in the results array of returned apps" }, "offset_token": { "type": [ "string", "null" ], "description": "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" }, "items": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_AppDataAppleAppListingsSearchLiveItem" } ] }, "description": "array of apps and related data" } } } ``` ### Response36Afe1097B20_AppDataAppleAppListingsSearchLiveTaskInfo `#/components/schemas/Response36Afe1097B20_AppDataAppleAppListingsSearchLiveTaskInfo` ```json { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_AppDataAppleAppListingsSearchLiveResultInfo" } ] }, "description": "array of results" } } } ] } ``` ### Response36Afe1097B20_AppStoreInfoOrganic `#/components/schemas/Response36Afe1097B20_AppStoreInfoOrganic` ```json { "type": "object", "properties": { "type": { "type": [ "string", "null" ], "description": "type of element" }, "rank_group": { "type": [ "integer", "null" ], "description": "position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group" }, "rank_absolute": { "type": [ "integer", "null" ], "description": "absolute rank among all the listed apps
absolute position among all apps on the list" }, "position": { "type": [ "string", "null" ], "description": "the alignment of the element in SERP
can take the following values: left" }, "app_id": { "type": [ "string", "null" ], "description": "ID of the app" }, "title": { "type": [ "string", "null" ], "description": "title of the app" }, "subtitle": { "type": [ "string", "null" ], "description": "subtitle of the app" }, "url": { "type": [ "string", "null" ], "description": "URL to the app page on App Store" }, "icon": { "type": [ "string", "null" ], "description": "URL to the app icon" }, "description": { "type": [ "string", "null" ], "description": "description of the app" }, "reviews_count": { "type": [ "integer", "null" ], "description": "the total number of reviews of the app", "format": "int64" }, "rating": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_RatingInfo" } ], "description": "average rating of the app" }, "price": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_PriceInfo" } ], "description": "price of the app" }, "is_free": { "type": [ "boolean", "null" ], "description": "indicates whether the app is free" }, "main_category": { "type": [ "string", "null" ], "description": "main category/genre of the app" }, "categories": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] }, "description": "all relevant categories/genres of the app
Note: this field returns only one relevant category in the array" }, "languages": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] }, "description": "languages supported in the app
Note: this field returns only one supported language in the array" }, "advisories": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] }, "description": "age rating and age-based content advisories" }, "developer": { "type": [ "string", "null" ], "description": "name of the app developer" }, "developer_id": { "type": [ "string", "null" ], "description": "ID of the app developer" }, "developer_url": { "type": [ "string", "null" ], "description": "URL to the developer page on App Store" }, "version": { "type": [ "string", "null" ], "description": "current version of the app" }, "minimum_os_version": { "type": [ "string", "null" ], "description": "minimum OS version required to install the app" }, "size": { "type": [ "string", "null" ], "description": "size of the app" }, "released_date": { "type": [ "string", "null" ], "description": "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
Note: this field is deprecated and always returns null" }, "last_update_date": { "type": [ "string", "null" ], "description": "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_notes": { "type": [ "string", "null" ], "description": "update notes
contains the latest update notes from the developer" }, "images": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] }, "description": "app images
contains URLs to the images used on the app page on App Store" }, "similar_apps": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_AppsInfo" } ] }, "description": "similar apps
displays apps similar to the app in a POST request" }, "more_apps_by_developer": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_AppsInfo" } ] }, "description": "similar apps
information about apps built by the same developer" } } } ``` ### Response36Afe1097B20_AppsInfo `#/components/schemas/Response36Afe1097B20_AppsInfo` ```json { "type": "object", "properties": { "app_id": { "type": [ "string", "null" ], "description": "ID of the app" }, "title": { "type": [ "string", "null" ], "description": "title of the app" }, "url": { "type": [ "string", "null" ], "description": "URL to the app page on Google Play" } } } ``` ### Response36Afe1097B20_BaseResponseInfo `#/components/schemas/Response36Afe1097B20_BaseResponseInfo` ```json { "properties": { "version": { "type": [ "string", "null" ], "description": "the current version of the API" }, "status_code": { "type": [ "integer", "null" ], "description": "general status code\nyou can find the full list of the response codes here" }, "status_message": { "type": [ "string", "null" ], "description": "general informational message\nyou can find the full list of general informational messages here" }, "time": { "type": [ "string", "null" ], "description": "total execution time, seconds" }, "cost": { "type": [ "number", "null" ], "description": "total tasks cost, USD", "format": "double" }, "tasks_count": { "type": [ "integer", "null" ], "description": "the number of tasks in the tasks array", "format": "int64" }, "tasks_error": { "type": [ "integer", "null" ], "description": "the number of tasks in the tasks array returned with an error", "format": "int64" } } } ``` ### Response36Afe1097B20_BaseResponseTaskInfo `#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo` ```json { "properties": { "id": { "type": [ "string", "null" ], "description": "task identifier\nunique task identifier in our system in the UUID format" }, "status_code": { "type": [ "integer", "null" ], "description": "status code of the task\ngenerated by DataForSEO, can be within the following range: 10000-60000\nyou can find the full list of the response codes here" }, "status_message": { "type": [ "string", "null" ], "description": "informational message of the task\nyou can find the full list of general informational messages here" }, "time": { "type": [ "string", "null" ], "description": "execution time, seconds" }, "cost": { "type": [ "number", "null" ], "description": "total tasks cost, USD", "format": "double" }, "result_count": { "type": [ "integer", "null" ], "description": "number of elements in the result array", "format": "int64" }, "path": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] }, "description": "URL path" }, "data": { "type": [ "object", "null" ], "additionalProperties": { "type": [ "object", "null" ] }, "description": "contains the same parameters that you specified in the POST request" } } } ``` ### Response36Afe1097B20_PriceInfo `#/components/schemas/Response36Afe1097B20_PriceInfo` ```json { "type": "object", "properties": { "current": { "type": [ "number", "null" ], "description": "current price\nindicates the current price of the product or service featured in the result", "format": "double" }, "regular": { "type": [ "number", "null" ], "description": "regular price\nindicates the regular price of the product or service with no discounts applied", "format": "double" }, "max_value": { "type": [ "number", "null" ], "description": "the maximum price\nthe maximum price of the product or service as indicated in the result", "format": "double" }, "currency": { "type": [ "string", "null" ], "description": "currency of the listed price\nISO code of the currency applied to the price" }, "is_price_range": { "type": [ "boolean", "null" ], "description": "price is provided as a range\nindicates whether a price is provided in a range" }, "displayed_price": { "type": [ "string", "null" ], "description": "price string in the result\nraw price string as provided in the result" } } } ``` ### Response36Afe1097B20_RatingInfo `#/components/schemas/Response36Afe1097B20_RatingInfo` ```json { "properties": { "rating_type": { "type": [ "string", "null" ], "description": "the type of rating\nhere you can find the following elements: Max5, Percents, CustomMax" }, "value": { "type": [ "number", "null" ], "description": "the value of the rating", "format": "double" }, "votes_count": { "type": [ "integer", "null" ], "description": "the amount of feedback", "format": "int64" }, "rating_max": { "type": [ "integer", "null" ], "description": "the maximum value for a rating_type" } } } ```