Get Apple App Searches Results by id

 
This endpoint will provide you with a list of apps ranking on the App Store for the keyword specified in a POST request. You will also receive additional information about each application: its ID, icon, reviews count, rating, price, and other data. The results are specific to the keyword as well as location and language parameters specified in the POST request.

checked GET
Pricing

Your account will be charged only for setting a task. You can get the results of the task within the next 30 days for free.
The cost can be calculated on the Pricing page.

Description of the fields for sending a request:

Field name Type Description
id string task identifier
unique task identifier in our system in the UUID format
you will be able to use it within 30 days to request the results of the task at any time

‌‌‌‌
‌‌As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.

You can also get all available SERP features by making a request to the following Sandbox URL:
https://sandbox.dataforseo.com/v3/app_data/apple/app_searches/task_get/advanced/00000000-0000-0000-0000-000000000000
The response will include all available items in the Apple App Searches Advanced endpoint with the fields containing dummy data.
You won’t be charged for using Sandbox endpoints.

Description of the fields in the results array:

Field name Type Description
version string the current version of the API
status_code integer 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_message string general informational message
you can find the full list of general informational messages here
time string execution time, seconds
cost float total tasks cost, USD
tasks_count integer the number of tasks in the tasks array
tasks_error integer the number of tasks in the tasks array that were returned an error
tasks array array of tasks
        id string task identifier
unique task identifier in our system in the UUID format
        status_code integer 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 string informational message of the task
you can find the full list of general informational messages here
        time string execution time, seconds
        cost float cost of the task, USD
        result_count integer number of elements in the result array
        path array URL path
        data object contains the same parameters that you specified in the POST request
        result array array of results
            keyword string keyword received in a POST request
            se_domain string search engine domain in a POST array
            location_code integer location code in a POST array
            language_code string language code in a POST array
            check_url string direct URL to search engine results
in this case, the value will be null
            datetime string date and time when the result was received
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2019-11-15 12:57:46 +00:00
            se_results_count integer the total number of results
            items_count integer the number of items in the results array
            items array found apps
                type string the item’s type
possible item types: "app_store_search_organic"
                rank_group integer position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group
                rank_absolute integer absolute rank among all the listed apps
absolute position among all apps on the list
                position string the alignment of the element in SERP
can take the following values: left
                app_id string ID of the returned app
                title string title of the returned app
                url string URL to the app page on App Store
                icon string URL to the app icon
                reviews_count integer the total number of reviews the app has
                rating object average rating of the app
                    rating_type string the type of the rating
can take the following values: Max5
                    value float the value of the rating
                    votes_count integer the amount of feedback
in this case, the value will be null
                    rating_max integer the maximum value for a rating_type
the maximum value for Max5 is 5
                is_free boolean indicates whether the app is free
                price object price of the app
                    current float current price
refers to the current price indicated in the element
                    regular float regular price
refers to the regular price indicated in the element
                    max_value float the maximum price
refers to the maximum price indicated in the element
                    currency string currency of the listed price
ISO code of the currency applied to the price
                    is_price_range boolean price is provided as a range
indicates whether a price is provided in a range
                    displayed_price string price string in the result
raw price string as provided in the result

‌‌

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-access

# Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access 
login="login" 
password="password" 
cred="$(printf ${login}:${password} | base64)" 
id="04011058-0696-0199-0000-2196151a15cb" 
curl --location --request GET "https://api.dataforseo.com/v3/app_data/apple/app_searches/task_get/advanced/${id}" 
--header "Authorization: Basic ${cred}"  
--header "Content-Type: application/json"
<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
$client = new RestClient($api_url, null, 'login', 'password');

try {
	$result = array();
	// #1 - using this method you can get a list of completed tasks
	// GET /v3/app_data/apple/app_searches/tasks_ready
	$tasks_ready = $client->get('/v3/app_data/apple/app_searches/tasks_ready');
	// you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
	if (isset($tasks_ready['status_code']) AND $tasks_ready['status_code'] === 20000) {
		foreach ($tasks_ready['tasks'] as $task) {
			if (isset($task['result'])) {
				foreach ($task['result'] as $task_ready) {
					// #2 - using this method you can get results of each completed task
					// GET /v3/app_data/apple/app_searches/task_get/advanced/$id
					if (isset($task_ready['endpoint_advanced'])) {
						$result[] = $client->get($task_ready['endpoint_advanced']);
					}
					// #3 - another way to get the task results by id
					// GET /v3/app_data/apple/app_searches/task_get/advanced/$id
					/*
					if (isset($task_ready['id'])) {
						$result[] = $client->get('/v3/app_data/apple/app_searches/task_get/advanced/' . $task_ready['id']);
					}
					*/
				}
			}
		}
	}
	print_r($result);
	// do something with result
} catch (RestClientException $e) {
	echo "n";
	print "HTTP code: {$e->getHttpCode()}n";
	print "Error code: {$e->getCode()}n";
	print "Message: {$e->getMessage()}n";
	print  $e->getTraceAsString();
	echo "n";
}
$client = null;
?>
const task_id = '02231934-2604-0066-2000-570459f04879';

const axios = require('axios');

axios({
    method: 'get',
    url: 'https://api.dataforseo.com/v3/app_data/apple/app_searches/task_get/advanced' + task_id,
    auth: {
        username: 'login',
        password: 'password'
    },
    headers: {
        'content-type': 'application/json'
    }
}).then(function (response) {
    var result = response['data']['tasks'];
    // Result data
    console.log(result);
}).catch(function (error) {
    console.log(error);
});
from client import from client import RestClient
# You can download this file from here https://cdn.dataforseo.com/v3/examples/python/python_Client.zip
client = RestClient("login", "password")
# get the task results by id
# GET /v3/app_data/apple/app_searches/task_get/advanced/$id
id = "06141103-2692-0309-1000-980b778b6d25"
response = client.get("/v3/app_data/apple/app_searches/task_get/advanced/" + id)
# you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if response["status_code"] == 20000:
    print(response)
    # do something with result
else:
    print("error. Code: %d Message: %s" % (response["status_code"], response["status_message"]))
using Newtonsoft.Json;
using Newtonsoft.Json;
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;

namespace DataForSeoDemos
{
    public static partial class Demos
    {
        public static async Task app_data_apple_app_searches_task_get_by_id()
        {
            var httpClient = new HttpClient
            {
                BaseAddress = new Uri("https://api.dataforseo.com/"),
                // Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
                DefaultRequestHeaders = { Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes("login:password"))) }
            };
            // get the task results by id
            // GET /v3/app_data/apple/app_searches/task_get/advanced/$id
            // use the task identifier that you recieved upon setting a task
            string id = "06141103-2692-0309-1000-980b778b6d25";
            var taskGetResponse = await httpClient.GetAsync("/v3/app_data/apple/app_searches/task_get/advanced/" + id);
            var result = JsonConvert.DeserializeObject<dynamic>(await taskGetResponse.Content.ReadAsStringAsync());
            if (result.tasks != null)
            {
                var fst = result.tasks.First;
                // you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
                if (fst.status_code >= 40000 || fst.result == null)
                    Console.WriteLine($"error. Code: {fst.status_code} Message: {fst.status_message}");
                else
                    // do something with result
                    Console.WriteLine(String.Join(Environment.NewLine, fst));
            }
            else
                Console.WriteLine($"error. Code: {result.status_code} Message: {result.status_message}");
        }
    }
}

The above command returns JSON structured like this:

{
    "version": "0.1.20220422",
    "status_code": 20000,
    "status_message": "Ok.",
    "time": "0.1347 sec.",
    "cost": 0,
    "tasks_count": 1,
    "tasks_error": 0,
    "tasks": [
        {
            "id": "04272056-1535-0428-0000-6099c37f7d21",
            "status_code": 20000,
            "status_message": "Ok.",
            "time": "0.0369 sec.",
            "cost": 0,
            "result_count": 1,
            "path": [
                "v3",
                "app_data",
                "apple",
                "app_searches",
                "task_get",
                "advanced",
                "04272056-1535-0428-0000-6099c37f7d21"
            ],
            "data": {
                "se_type": "organic",
                "se": "apple",
                "api": "app_data",
                "function": "app_searches",
                "keyword": "vpn",
                "location_code": 2840,
                "language_code": "en",
                "depth": 200,
                "device": "desktop",
                "os": "windows"
            },
            "result": [
                {
                    "keyword": "vpn",
                    "se_domain": "itunes.apple.com",
                    "location_code": 2840,
                    "language_code": "en",
                    "check_url": null,
                    "datetime": "2022-04-27 17:56:22 +00:00",
                    "se_results_count": 274,
                    "items_count": 198,
                    "items": [
                        {
                            "type": "app_store_search_organic",
                            "rank_group": 1,
                            "rank_absolute": 1,
                            "position": "left",
                            "app_id": "1370293473",
                            "title": "VPN - Super Unlimited Proxy",
                            "url": "https://apps.apple.com/us/app/vpn-super-unlimited-proxy/id1370293473",
                            "icon": "https://is2-ssl.mzstatic.com/image/thumb/Purple112/v4/ca/c3/67/cac367c8-6298-8044-e9f3-5b617098fff8/source/512x512bb.jpg",
                            "reviews_count": 1347479,
                            "rating": {
                                "rating_type": "Max5",
                                "value": 4.63253,
                                "votes_count": 1347479,
                                "rating_max": 5
                            },
                            "is_free": true,
                            "price": {
                                "current": 0,
                                "regular": null,
                                "max_value": null,
                                "currency": "USD",
                                "is_price_range": false,
                                "displayed_price": null
                            }
                        },
                        {
                            "type": "app_store_search_organic",
                            "rank_group": 2,
                            "rank_absolute": 2,
                            "position": "left",
                            "app_id": "443369807",
                            "title": "HotspotShield VPN & Wifi Proxy",
                            "url": "https://apps.apple.com/us/app/hotspotshield-vpn-wifi-proxy/id443369807",
                            "icon": "https://is2-ssl.mzstatic.com/image/thumb/Purple122/v4/3b/2c/01/3b2c01b4-bfa4-bbd8-ef44-484221f07d1b/source/512x512bb.jpg",
                            "reviews_count": 147890,
                            "rating": {
                                "rating_type": "Max5",
                                "value": 4.46584,
                                "votes_count": 147890,
                                "rating_max": 5
                            },
                            "is_free": true,
                            "price": {
                                "current": 0,
                                "regular": null,
                                "max_value": null,
                                "currency": "USD",
                                "is_price_range": false,
                                "displayed_price": null
                            }
                        },
                        {
                            "type": "app_store_search_organic",
                            "rank_group": 3,
                            "rank_absolute": 3,
                            "position": "left",
                            "app_id": "946659216",
                            "title": "Best VPN Proxy Betternet",
                            "url": "https://apps.apple.com/us/app/best-vpn-proxy-betternet/id946659216",
                            "icon": "https://is4-ssl.mzstatic.com/image/thumb/Purple116/v4/37/eb/bb/37ebbb1a-75ce-7ef4-1933-3342611680a5/source/512x512bb.jpg",
                            "reviews_count": 189700,
                            "rating": {
                                "rating_type": "Max5",
                                "value": 4.52062,
                                "votes_count": 189700,
                                "rating_max": 5
                            },
                            "is_free": true,
                            "price": {
                                "current": 0,
                                "regular": null,
                                "max_value": null,
                                "currency": "USD",
                                "is_price_range": false,
                                "displayed_price": null
                            }
                        },
                        {
                            "type": "app_store_search_organic",
                            "rank_group": 4,
                            "rank_absolute": 4,
                            "position": "left",
                            "app_id": "1193154948",
                            "title": "VPN 360 - Unlimited VPN Proxy",
                            "url": "https://apps.apple.com/us/app/vpn-360-unlimited-vpn-proxy/id1193154948",
                            "icon": "https://is3-ssl.mzstatic.com/image/thumb/Purple122/v4/15/87/86/15878628-7fed-a10a-1ab6-818817bc076f/source/512x512bb.jpg",
                            "reviews_count": 296293,
                            "rating": {
                                "rating_type": "Max5",
                                "value": 4.67716,
                                "votes_count": 296293,
                                "rating_max": 5
                            },
                            "is_free": true,
                            "price": {
                                "current": 0,
                                "regular": null,
                                "max_value": null,
                                "currency": "USD",
                                "is_price_range": false,
                                "displayed_price": null
                            }
                        },
                        {
                            "type": "app_store_search_organic",
                            "rank_group": 5,
                            "rank_absolute": 5,
                            "position": "left",
                            "app_id": "1282216562",
                            "title": "VPN - Unlimited Best VPN Proxy",
                            "url": "https://apps.apple.com/us/app/vpn-unlimited-best-vpn-proxy/id1282216562",
                            "icon": "https://is3-ssl.mzstatic.com/image/thumb/Purple122/v4/d3/0e/fa/d30efa72-07f6-943e-1b88-50ffd6bd4b0f/source/512x512bb.jpg",
                            "reviews_count": 135164,
                            "rating": {
                                "rating_type": "Max5",
                                "value": 4.66001,
                                "votes_count": 135164,
                                "rating_max": 5
                            },
                            "is_free": true,
                            "price": {
                                "current": 0,
                                "regular": null,
                                "max_value": null,
                                "currency": "USD",
                                "is_price_range": false,
                                "displayed_price": null
                            }
                        }
                    ]
                }
            ]
        }
    ]
}