This endpoint will provide you with a list of mobile applications that intersect with the target app for its ranking keywords on App Store. You will obtain the IDs of competitor apps along with search volume and ranking data on competitor ranking keywords.
The returned results are specific to the app_id specified in a POST request.
The app_id parameter can be found on the App Store website as a part of a URL pointing to a specific mobile application. It consists of numbers indicated after id in the URL string. For example, here is the URL of the TikTok app on App Store:
https://apps.apple.com/us/app/id835599320
The app_id of this app is 835599320
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)"
curl --location --request POST "https://api.dataforseo.com/v3/dataforseo_labs/apple/app_competitors/live"
--header "Authorization: Basic ${cred}"
--header "Content-Type: application/json"
--data-raw "[
{
"app_id": "686449807",
"language_name": "English",
"location_code": 2840,
"limit": 10
}
]"
<?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');
$post_array = array();
// simple way to set a task
$post_array[] = array(
"app_id" => "686449807",
"language_name" => "English",
"location_code" => 2840,
"filters" => [
["intersections", ">=", 500]
],
"limit" => 10
);
try {
// POST /v3/dataforseo_labs/apple/app_competitors/live
$result = $client->post('/v3/dataforseo_labs/apple/app_competitors/live', $post_array);
print_r($result);
// do something with post 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 RestClient
# You can download this file from here https://cdn.dataforseo.com/v3/examples/python/python_Client.zip
client = RestClient("login", "password")
post_data = dict()
# simple way to set a task
post_data[len(post_data)] = dict(
app_id="686449807",
location_name="United States",
language_name="English",
filters=[
["intersections", ">=", 500]
],
limit=10
)
# POST /v3/dataforseo_labs/apple/app_competitors/live
response = client.post("/v3/dataforseo_labs/apple/app_competitors/live", post_data)
# 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 System;
using System.Collections.Generic;
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 dataforseo_labs_apple_app_competitors_live()
{
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"))) }
};
var postData = new List<object>();
postData.Add(new
{
app_id = "686449807",
location_name = "United States",
language_name = "English",
filters = new object[]
{
new object[] { "intersections", ">=", 500 }
},
limit = 10
});
// POST /v3/dataforseo_labs/apple/app_competitors/live
// the full list of possible parameters is available in documentation
var taskPostResponse = await httpClient.PostAsync("/v3/dataforseo_labs/apple/app_competitors/live", new StringContent(JsonConvert.SerializeObject(postData)));
var result = JsonConvert.DeserializeObject(await taskPostResponse.Content.ReadAsStringAsync());
// you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if (result.status_code == 20000)
{
// do something with result
Console.WriteLine(result);
}
else
Console.WriteLine($"error. Code: {result.status_code} Message: {result.status_message}");
}
}
}
The above command returns JSON structured like this:
All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute.
You can specify the number of results you want to retrieve, filter and sort them.
Below you will find a detailed description of the fields you can use for setting a task.
Description of the fields for setting a task:
Field name
Type
Description
app_id
string
id of the app required field
ID of the mobile application on App Store;
you can find the ID in the URL of every app listed on App Store;
example:
in the URL https://apps.apple.com/us/app/id835599320
the id is 835599320
location_name
string
full name of the location required field if you don’t specifylocation_code Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only;
example: United States
location_code
integer
location code required field if you don’t specifylocation_name Note: it is required to specify either location_name or location_code
you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only;
example: 2840
language_name
string
full name of the language required field if you don’t specifylanguage_code Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only;
example: English
language_code
string
language code required field if you don’t specifylanguage_name Note: it is required to specify either language_name or language_code
you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only
example: en
filters
array
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: <, <=, >, >=, =, <>, in, not_in
example: ["intersections",">",500]
[[["intersections",">=",50],"and",["competitor_metrics.app_store_search_organic.pos_1","in",[1,5]]],
"or",
["sum_position",">=","10000"]]
for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide
order_by
array
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 specify a sorting type;
example: ["intersections,asc"] Note: you can set no more than three sorting rules in a single request;
you should use a comma to separate several sorting rules;
example: ["intersections,desc","sum_position,asc"]
default rule: ["intersections,desc"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array
limit
integer
the maximum number of returned apps
optional field
default value: 100
maximum value: 1000
offset
integer
offset in the results array of returned apps
optional field
default value: 0
if you specify the 10 value, the first ten apps in the results array will be omitted and the data will be provided for the successive keywords
tag
string
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
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 returned with 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
se_type
string
search engine type
app_id
string
id of the app in a POST array
location_code
integer
location code in a POST array
language_code
string
language code in a POST array
total_count
integer
total amount of results in our database relevant to your request
items_count
integer
the number of results returned in the items array
items
array
contains data related to the app_id and competitor applications
se_type
string
search engine type
app_id
string
id of the competitor app
avg_position
float
average position of the app in App Store SERP Note: average position is calculated for intersected keywords only;
the value for a given application may differ when combined with different target applications
sum_position
integer
sum of all app positions in App Store SERP Note: sum position is calculated for intersected keywords only;
the value for a given application may differ when combined with different target applications
intersections
integer
number of intersecting keywords
competitor_metrics
object
metrics for intersecting keywords
ranking data relevant to the keywords that the provided competitor application shares with the app in a POST request; note: in this array ranking data is provided for the returned competitor’s app_id
app_store_search_organic
object
ranking data from App Store organic search
pos_1
integer
number of SERPs where the competitor app ranks #1 in organic results
pos_2_3
integer
number of SERPs where the competitor app ranks #2-3 in organic results
pos_4_10
integer
number of SERPs where the competitor app ranks #4-10 in organic results
pos_11_100
integer
number of SERPs where the competitor app ranks #11-100 in organic results
count
integer
total count of organic SERPs that contain the competitor app
search_volume
integer
total search volume of the intersecting keywords in App Store organic SERP
full_metrics
object
metrics for all keywords of the application
full overview of ranking data relevant to all keywords that the provided app_id is ranking for
app_store_search_organic
object
ranking data from App Store organic search
pos_1
integer
number of SERPs where the competitor app ranks #1 in organic results
pos_2_3
integer
number of SERPs where the competitor app ranks #2-3 in organic results
pos_4_10
integer
number of SERPs where the competitor app ranks #4-10 in organic results
pos_11_100
integer
number of SERPs where the competitor app ranks #11-100 in organic results
count
integer
total count of organic SERPs that contain the competitor app
search_volume
integer
total search volume of the app’s ranking keywords in App Store organic SERP
