NAVNavbar
cURL php NodeJS Python cSharp

List of Apple Locations for App Data API

 
By calling this endpoint you will receive the list of Apple locations supported in App Data API.

You can also download the full list of supported locations in the CSV format (last updated 2024-11-05).

Note: All locations in Russia and Belarus are not supported across all DataForApps services due to the invasion of Ukraine.

 

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

<?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/';
try {
	// Instead of 'login' and 'password' use your credentials from https://app.dataforapps.com/api-dashboard
	$client = new RestClient($api_url, null, 'login', 'password');
} 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";
	exit();
}
try {
	// using this method you can get a list of locations
	// GET /v3/app_data/apple/locations
	// in addition to 'apple' you can also set other search engine
	// the full list of possible parameters is available in documentation
	$result = $client->get('/v3/app_data/apple/locations');
	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;
?>

The above command returns JSON structured like this:

{
  "version": "0.1.20220420",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.4267 sec.",
  "cost": 0,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "04211826-2806-0434-0000-2df1073ffaa3",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "0.3696 sec.",
      "cost": 0,
      "result_count": 105,
      "path": [
        "v3",
        "app_data",
        "apple",
        "locations"
      ],
      "data": {
        "api": "app_data",
        "function": "locations",
        "se": "apple"
      },
      "result": [
        {
          "location_code": 2036,
          "location_name": "Australia",
          "location_name_parent": null,
          "country_iso_code": "AU",
          "location_type": "Country"
        },
        {
          "location_code": 2124,
          "location_name": "Canada",
          "location_name_parent": null,
          "country_iso_code": "CA",
          "location_type": "Country"
        },
        {
          "location_code": 2250,
          "location_name": "France",
          "location_name_parent": null,
          "country_iso_code": "FR",
          "location_type": "Country"
        }
      ]
    }
  ]
}

‌‌As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information about available locations.

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
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 DataForApps; can be within the following range: 10000-60000
you can find the full list of 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 parameters passed in the URL of the GET request
        result array array of results
            location_code integer location code
            location_name string full name of the location
            location_name_parent integer the name of the superordinate location
example:
"location_code": 1006473,
"location_name": "Altrincham,England,United Kingdom",
"location_name_parent": "England,United Kingdom",
where location_name_parent corresponds to:

"location_code": 20339,
"location_name": "England,United Kingdom"

note: Apple App Data API currently supports countries only, that is why this value will always be null

            country_iso_code string ISO country code of the location
            location_type string location type