NAVNavbar
Logo
cURL php NodeJS Python cSharp

App Store App Intersection Live


This endpoint will provide you with a list of keywords for which the mobile applications specified in the app_ids object rank within the same App Store SERP.

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-dashboard

<?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-dashboard
$client = new RestClient($api_url, null, 'login', 'password');

$post_array = array();
// simple way to set a task
$post_array[] = array(
	"app_ids" => {
	   "1": "686449807",
           "2": "382617920"
        },
	"language_name" => "English",
	"location_code" => 2840,
	"filters" => [
		["keyword_data.keyword_info.search_volume", ">=", 500]
	],
	"limit" => 10
);
try {
   // POST /v3/dataforseo_labs/apple/app_intersection/live
   $result = $client->post('/v3/dataforseo_labs/apple/app_intersection/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;
?>

The above command returns JSON structured like this:

{
  "version": "0.1.20220428",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.9195 sec.",
  "cost": 0.011,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "06241901-2806-0452-0000-6e547e3307e9",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "0.8690 sec.",
      "cost": 0.011,
      "result_count": 1,
      "path": [
        "v3",
        "dataforseo_labs",
        "apple",
        "app_intersection",
        "live"
      ],
      "data": {
        "api": "dataforseo_labs",
        "function": "app_intersection",
        "se_type": "apple",
        "app_ids": {
          "1": "686449807",
          "2": "382617920"
        },
        "location_code": 2840,
        "language_code": "en",
        "limit": 10
      },
      "result": [
        {
          "se_type": "apple",
          "app_ids": {
            "1": "686449807",
            "2": "382617920"
          },
          "location_code": 2840,
          "language_code": "en",
          "total_count": 1370,
          "items_count": 10,
          "items": [
            {
              "se_type": "apple",
              "keyword_data": {
                "se_type": "apple",
                "keyword": "facebook",
                "location_code": 2840,
                "language_code": "en",
                "keyword_info": {
                  "se_type": "apple",
                  "last_updated_time": "2022-06-07 19:03:20 +00:00",
                  "competition": null,
                  "competition_level": null,
                  "cpc": null,
                  "search_volume": 17969000,
                  "low_top_of_page_bid": null,
                  "high_top_of_page_bid": null,
                  "categories": null,
                  "monthly_searches": null
                },
                "serp_info": {
                  "se_type": "apple",
                  "check_url": null,
                  "serp_item_types": null,
                  "se_results_count": 250,
                  "last_updated_time": "2022-06-01 22:45:28 +00:00",
                  "previous_updated_time": null
                }
              },
              "intersection_result": {
                "1": {
                  "type": "app_store_search_organic",
                  "rank_group": 7,
                  "rank_absolute": 7,
                  "position": "left",
                  "app_id": "686449807",
                  "title": "Telegram Messenger",
                  "url": "https://apps.apple.com/us/app/telegram-messenger/id686449807",
                  "icon": "https://is1-ssl.mzstatic.com/image/thumb/Purple122/v4/9c/c9/a9/9cc9a955-a6a3-6c61-9b9a-09f7d051c226/AppIconLLC-1x_U007emarketing-0-7-0-0-85-220.png/512x512bb.jpg",
                  "reviews_count": 142623,
                  "rating": {
                    "rating_type": "Max5",
                    "value": 4.250279903411865,
                    "votes_count": 142623,
                    "rating_max": 5
                  },
                  "is_free": true,
                  "price": {
                    "current": 0,
                    "regular": 0,
                    "max_value": 0,
                    "currency": "USD",
                    "is_price_range": false,
                    "displayed_price": ""
                  }
                },
                "2": {
                  "type": "app_store_search_organic",
                  "rank_group": 9,
                  "rank_absolute": 9,
                  "position": "left",
                  "app_id": "382617920",
                  "title": "Viber Messenger: Chats & Calls",
                  "url": "https://apps.apple.com/us/app/viber-messenger-chats-calls/id382617920",
                  "icon": "https://is5-ssl.mzstatic.com/image/thumb/Purple116/v4/50/d6/33/50d6331f-fd37-25c7-de2b-b9a0e6a5bab6/AppIcon-0-0-1x_U007emarketing-0-0-0-7-0-0-sRGB-0-0-0-GLES2_U002c0-512MB-85-220-0-0.png/512x512bb.jpg",
                  "reviews_count": 351452,
                  "rating": {
                    "rating_type": "Max5",
                    "value": 4.600830078125,
                    "votes_count": 351452,
                    "rating_max": 5
                  },
                  "is_free": true,
                  "price": {
                    "current": 0,
                    "regular": 0,
                    "max_value": 0,
                    "currency": "USD",
                    "is_price_range": false,
                    "displayed_price": ""
                  }
                }
              }
            },
            {
              "se_type": "apple",
              "keyword_data": {
                "se_type": "apple",
                "keyword": "yahoo",
                "location_code": 2840,
                "language_code": "en",
                "keyword_info": {
                  "se_type": "apple",
                  "last_updated_time": "2022-06-07 19:03:19 +00:00",
                  "competition": null,
                  "competition_level": null,
                  "cpc": null,
                  "search_volume": 4426800,
                  "low_top_of_page_bid": null,
                  "high_top_of_page_bid": null,
                  "categories": null,
                  "monthly_searches": null
                },
                "serp_info": {
                  "se_type": "apple",
                  "check_url": null,
                  "serp_item_types": null,
                  "se_results_count": 183,
                  "last_updated_time": "2022-06-01 06:26:15 +00:00",
                  "previous_updated_time": null
                }
              },
              "intersection_result": {
                "1": {
                  "type": "app_store_search_organic",
                  "rank_group": 35,
                  "rank_absolute": 35,
                  "position": "left",
                  "app_id": "686449807",
                  "title": "Telegram Messenger",
                  "url": "https://apps.apple.com/us/app/telegram-messenger/id686449807",
                  "icon": "https://is1-ssl.mzstatic.com/image/thumb/Purple122/v4/9c/c9/a9/9cc9a955-a6a3-6c61-9b9a-09f7d051c226/AppIconLLC-1x_U007emarketing-0-7-0-0-85-220.png/512x512bb.jpg",
                  "reviews_count": 142573,
                  "rating": {
                    "rating_type": "Max5",
                    "value": 4.250349998474121,
                    "votes_count": 142573,
                    "rating_max": 5
                  },
                  "is_free": true,
                  "price": {
                    "current": 0,
                    "regular": 0,
                    "max_value": 0,
                    "currency": "USD",
                    "is_price_range": false,
                    "displayed_price": ""
                  }
                },
                "2": {
                  "type": "app_store_search_organic",
                  "rank_group": 18,
                  "rank_absolute": 18,
                  "position": "left",
                  "app_id": "382617920",
                  "title": "Viber Messenger: Chats & Calls",
                  "url": "https://apps.apple.com/us/app/viber-messenger-chats-calls/id382617920",
                  "icon": "https://is5-ssl.mzstatic.com/image/thumb/Purple116/v4/50/d6/33/50d6331f-fd37-25c7-de2b-b9a0e6a5bab6/AppIcon-0-0-1x_U007emarketing-0-0-0-7-0-0-sRGB-0-0-0-GLES2_U002c0-512MB-85-220-0-0.png/512x512bb.jpg",
                  "reviews_count": 351237,
                  "rating": {
                    "rating_type": "Max5",
                    "value": 4.600840091705322,
                    "votes_count": 351237,
                    "rating_max": 5
                  },
                  "is_free": true,
                  "price": {
                    "current": 0,
                    "regular": 0,
                    "max_value": 0,
                    "currency": "USD",
                    "is_price_range": false,
                    "displayed_price": ""
                  }
                }
              }
            },
            {
              "se_type": "apple",
              "keyword_data": {
                "se_type": "apple",
                "keyword": "msn",
                "location_code": 2840,
                "language_code": "en",
                "keyword_info": {
                  "se_type": "apple",
                  "last_updated_time": "2022-06-07 17:49:51 +00:00",
                  "competition": null,
                  "competition_level": null,
                  "cpc": null,
                  "search_volume": 1618400,
                  "low_top_of_page_bid": null,
                  "high_top_of_page_bid": null,
                  "categories": null,
                  "monthly_searches": null
                },
                "serp_info": {
                  "se_type": "apple",
                  "check_url": null,
                  "serp_item_types": null,
                  "se_results_count": 264,
                  "last_updated_time": "2022-06-02 12:39:18 +00:00",
                  "previous_updated_time": null
                }
              },
              "intersection_result": {
                "1": {
                  "type": "app_store_search_organic",
                  "rank_group": 19,
                  "rank_absolute": 19,
                  "position": "left",
                  "app_id": "686449807",
                  "title": "Telegram Messenger",
                  "url": "https://apps.apple.com/us/app/telegram-messenger/id686449807",
                  "icon": "https://is1-ssl.mzstatic.com/image/thumb/Purple122/v4/9c/c9/a9/9cc9a955-a6a3-6c61-9b9a-09f7d051c226/AppIconLLC-1x_U007emarketing-0-7-0-0-85-220.png/512x512bb.jpg",
                  "reviews_count": 142656,
                  "rating": {
                    "rating_type": "Max5",
                    "value": 4.250160217285156,
                    "votes_count": 142656,
                    "rating_max": 5
                  },
                  "is_free": true,
                  "price": {
                    "current": 0,
                    "regular": 0,
                    "max_value": 0,
                    "currency": "USD",
                    "is_price_range": false,
                    "displayed_price": ""
                  }
                },
                "2": {
                  "type": "app_store_search_organic",
                  "rank_group": 29,
                  "rank_absolute": 29,
                  "position": "left",
                  "app_id": "382617920",
                  "title": "Viber Messenger: Chats & Calls",
                  "url": "https://apps.apple.com/us/app/viber-messenger-chats-calls/id382617920",
                  "icon": "https://is5-ssl.mzstatic.com/image/thumb/Purple116/v4/50/d6/33/50d6331f-fd37-25c7-de2b-b9a0e6a5bab6/AppIcon-0-0-1x_U007emarketing-0-0-0-7-0-0-sRGB-0-0-0-GLES2_U002c0-512MB-85-220-0-0.png/512x512bb.jpg",
                  "reviews_count": 351759,
                  "rating": {
                    "rating_type": "Max5",
                    "value": 4.600880146026611,
                    "votes_count": 351759,
                    "rating_max": 5
                  },
                  "is_free": true,
                  "price": {
                    "current": 0,
                    "regular": 0,
                    "max_value": 0,
                    "currency": "USD",
                    "is_price_range": false,
                    "displayed_price": ""
                  }
                }
              }
            },
            {
              "se_type": "apple",
              "keyword_data": {
                "se_type": "apple",
                "keyword": "tik tok",
                "location_code": 2840,
                "language_code": "en",
                "keyword_info": {
                  "se_type": "apple",
                  "last_updated_time": "2022-06-07 17:56:29 +00:00",
                  "competition": null,
                  "competition_level": null,
                  "cpc": null,
                  "search_volume": 890120,
                  "low_top_of_page_bid": null,
                  "high_top_of_page_bid": null,
                  "categories": null,
                  "monthly_searches": null
                },
                "serp_info": {
                  "se_type": "apple",
                  "check_url": null,
                  "serp_item_types": null,
                  "se_results_count": 263,
                  "last_updated_time": "2022-05-31 07:02:12 +00:00",
                  "previous_updated_time": null
                }
              },
              "intersection_result": {
                "1": {
                  "type": "app_store_search_organic",
                  "rank_group": 79,
                  "rank_absolute": 79,
                  "position": "left",
                  "app_id": "686449807",
                  "title": "Telegram Messenger",
                  "url": "https://apps.apple.com/us/app/telegram-messenger/id686449807",
                  "icon": "https://is1-ssl.mzstatic.com/image/thumb/Purple122/v4/9c/c9/a9/9cc9a955-a6a3-6c61-9b9a-09f7d051c226/AppIconLLC-1x_U007emarketing-0-7-0-0-85-220.png/512x512bb.jpg",
                  "reviews_count": 142498,
                  "rating": {
                    "rating_type": "Max5",
                    "value": 4.250400066375732,
                    "votes_count": 142498,
                    "rating_max": 5
                  },
                  "is_free": true,
                  "price": {
                    "current": 0,
                    "regular": 0,
                    "max_value": 0,
                    "currency": "USD",
                    "is_price_range": false,
                    "displayed_price": ""
                  }
                },
                "2": {
                  "type": "app_store_search_organic",
                  "rank_group": 74,
                  "rank_absolute": 74,
                  "position": "left",
                  "app_id": "382617920",
                  "title": "Viber Messenger: Chats & Calls",
                  "url": "https://apps.apple.com/us/app/viber-messenger-chats-calls/id382617920",
                  "icon": "https://is5-ssl.mzstatic.com/image/thumb/Purple116/v4/50/d6/33/50d6331f-fd37-25c7-de2b-b9a0e6a5bab6/AppIcon-0-0-1x_U007emarketing-0-0-0-7-0-0-sRGB-0-0-0-GLES2_U002c0-512MB-85-220-0-0.png/512x512bb.jpg",
                  "reviews_count": 350966,
                  "rating": {
                    "rating_type": "Max5",
                    "value": 4.600790023803711,
                    "votes_count": 350966,
                    "rating_max": 5
                  },
                  "is_free": true,
                  "price": {
                    "current": 0,
                    "regular": 0,
                    "max_value": 0,
                    "currency": "USD",
                    "is_price_range": false,
                    "displayed_price": ""
                  }
                }
              }
            }
          ]
        }
      ]
    }
  ]
}

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_ids object ids of the target apps
required field
IDs of the target mobile applications 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;
the ids should be specified the following way:
"app_ids": {
"1": "686449807",
"2": "382617920"
}

if you specify a single ID here, the API will return results only for one application;
the maximum number of app IDs you can specify in this object is 20
location_name string full name of the location
required field if you don’t specify location_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 specify location_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 specify language_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 specify language_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:
["keyword_data.keyword_info.search_volume",">",500]

[["keyword_data.keyword_info.search_volume","<>",500],"and",[intersection_result.382617920.rank_group",">=","10"]]
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:
["intersection_result.382617920.rank_absolute,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:
["intersection_result.382617920.rank_absolute,desc","keyword_data.keyword_info.search_volume,asc"]
default rule:
["keyword_data.keyword_info.search_volume,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 keywords
optional field
default value: 100
maximum value: 1000
offset integer offset in the results array of returned keywords
optional field
default value: 0
if you specify the 10 value, the first ten keywords 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_ids object ids of the apps 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 ranking keywords for the app specified in the app_id field
                  se_type string search engine type
                  keyword_data object keyword data for the returned keyword
                      se_type string search engine type
                      keyword string returned keyword
                      location_code integer location code in a POST array
                      language_code string language code in a POST array
                      keyword_info object keyword info for the returned keyword
                          se_type string search engine type
                          last_updated_time string date and time when keyword data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”;
example:
2019-11-15 12:57:46 +00:00
                          competition float competition
represents the relative amount of competition associated with the given keyword;
the value is based on Google Ads data and can be between 0 and 1 (inclusive);
in this case, will equal null
                          competition_level string competition level
represents the relative level of competition associated with the given keyword in paid SERP only;
possible values: LOW, MEDIUM, HIGH
if competition level is unknown, the value is null;
learn more about the metric in this help center article;
in this case, will equal null
                          cpc float cost-per-click
represents the average cost per click (USD) historically paid for the keyword;
in this case, will equal null
                          search_volume integer average monthly search volume rate
represents the (approximate) number of searches for the given keyword on App Store
                          low_top_of_page_bid float minimum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)
the value may differ depending on the location specified in a POST request;
in this case, will equal null
                          high_top_of_page_bid float maximum bid for the ad to be displayed at the top of the first page
indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)
the value may differ depending on the location specified in a POST request;
in this case, will equal null
                          categories array product and service categories
you can download the full list of possible categories;
in this case, will equal null
                          monthly_searches array monthly searches
represents the (approximate) number of searches for this keyword (as available for the past twelve months), targeted to the specified geographic locations;
in this case, will equal null
                      serp_info object SERP data
the value will be null if you didn’t set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database
                          se_type string search engine type
search engine type specified in a POST request;
for this endpoint, the field equals bing
                          check_url string direct URL to search engine results
you can use it to make sure that we provided accurate results
                          serp_item_types array types of search results in SERP
contains types of search results (items) found in SERP;
in this case, will equal null
                          se_results_count string number of search results for the returned keyword
                          last_updated_time string date and time when SERP data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2019-11-15 12:57:46 +00:00
                          previous_updated_time string previous to the most recent date and time when SERP data was updated
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example:
2019-10-15 12:57:46 +00:00
                  intersection_result object contains SERP data for the returned keyword
data will be provided in separate arrays for each app ID you specified in the app_ids object when setting a task;
depending on the number of specified app IDs, it can contain from 1 to 20 arrays named respectively
                      1 object contains SERP data for the respective app ID
field name varies in the range from 1 to 20 according to the number of app IDs in the app_ids object;
possible types of SERP elements:
app_store_search_organic
                          type string type of the SERP element
possible values: 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 in SERP
absolute position among all the elements in SERP
                          position string the alignment of the element in SERP
can take the following values:
left, right
                          app_id string id of the app
                          title string title of the 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 of the app
                          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

‌‌