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
# Instead of 'login' and 'password' use your credentials from https://app.dataforapps.com/api-dashboard
login="login"
password="password"
cred="$(printf ${login}:${password} | base64)"
curl --location --request GET "https://api.dataforapps.com/v3/app_data/apple/locations"
--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/';
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;
?>
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")
# 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
response = client.get("/v3/app_data/apple/locations")
# 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"]))
const axios = require('axios');
axios({
method: 'get',
url: 'https://api.dataforapps.com/v3/app_data/apple/locations',
auth: {
username: 'login',
password: 'password'
},
headers: {
'content-type': 'application/json'
}
}).then(function (response) {
var result = response['data']['tasks'][0]['result'];
// Result data
console.log(result);
}).catch(function (error) {
console.log(error);
});
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_locations()
{
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"))) }
};
// 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
var response = await httpClient.GetAsync("/v3/app_data/apple/locations");
var result = JsonConvert.DeserializeObject<dynamic>(await response.Content.ReadAsStringAsync());
// you can find the full list of the response codes here https://docs.dataforapps.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:
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: