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.
Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforapps.com/api-dashboard
# Instead of 'login' and 'password' use your credentials from https://app.dataforapps.com/api-dashboard
login="login"
password="password"
cred="$(printf ${login}:${password} | base64)"
id="04011058-0696-0199-0000-2196151a15cb"
curl --location --request GET "https://api.dataforapps.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.dataforapps.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforapps.com/';
// Instead of 'login' and 'password' use your credentials from https://app.dataforapps.com/api-dashboard
$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.dataforapps.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;
?>
from client import from client import RestClient
# You can download this file from here https://cdn.dataforapps.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.dataforapps.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.dataforapps.com/"),
// Instead of 'login' and 'password' use your credentials from https://app.dataforapps.com/api-dashboard
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.dataforapps.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:
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.
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 DataForApps; 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