Find Co-Founders & Employees Connect with {{ promotions.totalJobCandidates }} talented F6Sers

API Key

The Mobile API uses an API key to identify your application. API keys are only available to organisations.

Mobile API

Overview

The Mobile Data API lets you access the F6S data about mobile apps. The API communicates over JSON, and currently we only support a synchronize communication.

The following graph shows how the synchronize communication works.

We have a timeout of 500 seconds per request. Each client may call the API 1000 times per day. If you need a higher amount of calls, please contact us at mobile@f6s.com.

Mobile Data API Request Format

The Mobile Data API communicates over JSON, and it can be accessed over the address:

https://mobile.f6s.com/RankingData.php

A JSON call must have the fields header[] and request[]. The returned JSON has a response[] field.

header[] should contain:

  • apikey - string, where the value should be your API key.
  • compress - bool, where the value should be either true or false. If true, then the response JSON is GZIP compressed.
  • sent - unixtimestamp. If empty, it gets set to a received timestamp.
  • responded - unixtimestamp.
  • result OK.

request[] should contain:

  • function - string, where the value should be one of the available functions. See 'Mobile Data API Funtions' below.
  • parameters[] - array, where the value should be an array of the parameters that you want to pass to the function.

The following example represents how a JSON call typically looks like.

{
    "header": {
        "apikey":"0123456789",
        "compress":"true",
        "sent":"unixtimestamp",
        "responded":"unixtimestamp",
        "result":"OK"
    },
    "request": {
        "function":"xyz",
        "parameters": {
            "para1":"xyz",
            "para2":"xyz",
        }
    }
}

Mobile Data API Browser Call

Paste the following url into your browser and change your API key. To view your result in the browser you need to set the parameter "compress" to "false".

https://mobile.f6s.com/RankingData.php?request={"header": {"apikey": "#your api_key", "compress": "false"}, "request": {"function": "getAppChart", "parameters": {"end": "", "storeid": "1", "days": "1", "limit": 500, "device": "iphone", "categoryid": "1", "market": "ios"}}}

Mobile Data API Python Call

The following example shows an API Python call. We would use the SearchApp function, which returns a JSON with basic information of the apps related to a key term - in this case greatstartup.

import urllib2
from urllib import urlencode
import simplejson as json

####YOUR API KEY#####
api_key = ""

base_url = "https://mobile.f6s.com/RankingData.php"
data = {
    "header" : {
        "apikey":api_key,
        "compress":"false"
    },
    "request" : {
        "function":"searchApp",
        "parameters":{
            "term":"angry", "limit":2
        }
    }
}

try:
    # make post request with only one parameter called request which is a serialised json object
    retval = urllib2.urlopen(base_url,urlencode({'data':json.dumps(data)})).read()
    # parse returned json
    retval = json.loads(retval)
    #pretty print result
    print json.dumps(retval,indent=4)
except Exception,e:
    print 'error: ',e 

When you send through this call, the API returns a JSON like the following:

{
    "response": {
        "data": [{
            "appid":"12345678",
            "name":"abc", 
            "company":"abc123", 
            "artist":"abc123", 
            "imageurl":"https://...", 
            "market":"ios"
            }, {
                ...
        }],
    }
}

Mobile Data API PHP Call

The following example shows a Mobile Data API PHP call. We would use the getAppChart function, which gets the daily ranks for the end data and shows the past rank (days).


<?php
//Globals
$url =     'https://mobile.f6s.com/RankingData.php';
$date = new DateTime();
$sent=$date->getTimestamp();
$compress="true"; //receive the answer from the API GZ compressed
$apikey=""; //Enter here your API key
//App Charts
$mdata=array('header'=>array('apikey'=>$apikey, 'sent'=>$sent, 'compress'=>$compress),     'request'=>array('function'=>'getAppChart', 'parameters'=>array('storeid'=>'1', 'categoryid'=>'1',     "device"=>"iphone", 'days'=>'1',     'end'=>'2014-05-02', 'market'=>'ios')));
$mjson=json_encode_tolerant($mdata);
$data = array('request' => $mjson);
if ($compress=="true"){
$result=gzuncompress(getData($url, $data));     
}else{
$result=getData($url, $data);
}
var_dump(json_decode($result,     true));    
function getData($url, $data)
{
$options = array('http' => array('header' =>"Content-type: application/x-www-form-urlencoded\r\n", 'method'=> 'POST', 'content' => http_build_query($data), ), );
$context = stream_context_create($options);
return file_get_contents($url, false, $context);
}
?>

When you send through this call, the API returns a JSON like the following:

{
    "response": {
        "header": {
            "types": {
                "1":"Free iPhone"
            }
        },
        "data": {
            "1": {
                "0": {
                    "appid":"1234", 
                    "name":"abc", 
                    "pastrank":"1"
                }
            }
        }
    }
}

Mobile Data API Functions

1. searchApp

The searchApp function searches for app id, name, company and developer based on the set parameters, and places the results within a data object in the response JSON.

Request

The function value is searchApp.

The parameters are optional and may be either of the following:

  • term - string, is the term to search for. It can be either app id, name, company or developer.

  • limit - integer, is the result limit. The maximum is 250.

  • market (optional) - string, is the market that gets searched. If empty, the function will search through all markets. It accepts:

    • ios, to search into the iOS App Store.
    • play, to search into the Google Play Store.
  • checkonlyforurl (optional) - bool, can be either true or false. It checks only for an URL. Doesn’t give results back if URL doesn’t match the id found in URL.
Name Value Description
function searchApp
parameters array[] Array of parameters
term string Term to search for
limit integer (Optional) Result limit. Max 250
market ios \ play (Optional) The market that gets searched
"request": {
    "function":"searchApp",
    "parameters": {
        "term":"greatstartup",
        "limit": 220,
        "market":"ios",
        "checkonlyforurl": true
    }
}

Response

The results are displayed within a data[] array, which typically contains:

  • appid - string, is the id of the app.

  • name - string, is the app full name.

  • company - string, is the company that developed the app.

  • artist - string, is the app developer.

  • imageurl - string, is the URL of the app image in the app store.

  • market - string, is app store type. It can be ios or play.

  • category - string, is the category id. See Category List section.
Name Value Description
appid string App id
name string App full name
company string Company that developed the app
artist string App developer
imageurl string URL of the app image in the app store
market string App store type
category string Category id
"data": [{
    "appid":"12345",
    "name":"GreatStartup",
    "company":"GreatStartup Ltd",
    "artist":"GreatStartup Ltd",
    "imageurl":"https://...",
    "market":"ios",
    "category":"11",
    {...}
}]
2. getAppInfo

The getAppInfo function returns the information about an app, and places the results within a data object in the response JSON.

Request

The function value is getAppInfo.

The parameters are optional and may be either of the following:

  • appid - string, is the app id.

  • language (optional) - string, is the language code for returned localization (app name, description). See country list for language codes.

  • market (optional) - string, is the market that gets searched. If empty, the function will search through all markets. It accepts:
    • ios, to search into the iOS App Store.
    • play, to search into the Google Play Store.
Name Value Description
function getAppInfo
parameters array[] Array of parameters
appid string App id
language string language code
market ios \ play (Optional) Market that gets searched
"request": {
    "function":"getAppInfo",
    "parameters": {
        "appid":"123456",
        "market":"ios"
    }
}

Response

The results are displayed within a data[] array, which typically contains:

  • appid - string, is the id of the app.

  • name - string, is the app full name.

  • price - string, is the app price.

  • company - string, is the company that developed the app.

  • artist - string, is the app developer.

  • imageurl - string, is the URL of the app image in the app store.

  • market - string, is the app store type. It can be ios or play.

  • category - string, is the category id. See Category List section.

  • downloads - string, is the number of app downloads.

  • history[] - array, contains the history that has been collected for an app.

  • description - string, description of app in UTF-8 (default language is english).

  • screenshots - string, screenshots separated with a "pipe".
Name Value Description
appid string App id
name string App full name
price string App price
company string Company that developed the app
artist string App developer
imageurl string URL of the app image in the app store
market string App store type
category string Category id
downloads string Number of app downloads
history array[] History that has been collected for an app
description string Description in UTF-8
screenshots string Screenshots seperated with a "pipe"
"data": [{
    "appid":"12345",
    "name":"GreatStartup",
    "company":"GreatStartup Ltd",
    "artist":"GreatStartup Ltd",
    "imageurl":"https://...",
    "market":"ios",
    "category":"11",
    "downloads":"0",
    "history":"{...}"
}]
3. getAppRating

The getAppRating function returns the information about the rating of an app, and places the results within a data object in the response JSON.

Request

The function value is getAppRating.

The parameters are optional and may be either of the following:

  • appid - string, is the app id.

  • storeid (optional) - integer, the app store country id.

  • market (optional) - string, is the market that gets searched. If empty, the function will search through all markets. It accepts:

    • ios, to search into the iOS App Store.
    • play, to search into the Google Play Store.
  • showhistory - bool, true or false; shows ratings of the past.

  • starthistory (optional) - date, sets the start history date.

  • endhistory (optional) - date, sets the end history date. If used, starthistory has to be set as well.
Name Value Description
function getAppRating
parameters array[] Array of parameters
appid string App id
storeid string App store country id
market ios \ play (Optional) Market that gets searched
showhistory bool True or False, shows rating history
starthistory date (Optional) Start history date
endhistory date (Optional) End history date
"request": {
    "function":"getAppRating",
    "parameters": {
        "appid":"1234566",
        "storeid": 2,
        "market":"ios",
        "showhistory": true,
        "starthistory": "2014-06-22",
        "endhistory": "2014-07-22"
    }
}

Response

The response header[] contains:

  • stores[] - array, contains basic information about the stores.

    • storeid - string, is the app store country id.

    • storedesc - string, is the name of the app store country.

The results are displayed within a data[] array, which typically contains:

  • storeid[] - array, is the app store country id.

  • raiting_average - integer, is the average rating of the app.

  • raiting_count - integer, is the number of ratings.

  • raiting_count_5stars - integer, is the number of 5 stars ratings.

  • raiting_count_4stars - integer, is the number of 4 stars ratings.

  • raiting_count_3stars - integer, is the number of 3 stars ratings.

  • raiting_count_2stars - integer, is the number of 2 stars ratings.

  • raiting_count_1stars - integer, is the number of 1 stars ratings.

  • lastchecked - date, is the last update date.

  • ts - timestamp, is the last update date as timestamp.

  • history[] - array, contains the history with raiting_average, raiting_count, raiting_count_5stars, raiting_count_4stars, raiting_count_3stars, raiting_count_2stars, raiting_count_1stars, lastchecked and ts for timestamp.
Header
Name Value Description
stores array App full name
storeid string App store country id
storedesc string App developer
Data
Name Value Description
storeid array App store country id
raiting_average integer Average rating
raiting_count integer Number of ratings
raiting_count_5stars integer Number of 5 stars
raiting_count_4stars integer Number of 4 stars
raiting_count_3stars integer Number of 3 stars
raiting_count_2stars integer Number of 2 stars
raiting_count_1stars integer Number of 1 stars
lastchecked date Last update date
ts timestamp Last update date
history array History of Ratings
{
    "header": {
        "stores":{
            "1":"United States"
        }
    }, "data": {
        "1":{
            "rating_average":5,
            "rating_count":10,
            "rating_count_5stars":10,
            "rating_count_4stars":0,
            "rating_count_3stars":0,
            "rating_count_2stars":0,
            "rating_count_1stars":0,
            "lastchecked":"2014-10-09",
            "ts":"123456789",
            "history":[]
        }
    }, "summary": {
        "rating_average":5,
        "rating_count":10,
        "rating_count_5stars":10,
        "rating_count_4stars":0,
        "rating_count_3stars":0,
        "rating_count_2stars":0,
        "rating_count_1stars":0
    }
}
4. getAppReview

The getAppReview function returns information about app reviews, and places the results within a data object in the response JSON.

Request

The function value is getAppReview.

The parameters are optional and may be either of the following:

  • appid - string, is the app id.

  • storeid (optional) - integer, is the app store country id.

  • market (optional) - string, is the market that gets searched. If empty, the function will search through all markets. It accepts:

    • ios, to search into the iOS App Store.
    • play, to search into the Google Play Store.
  • limit - integer, is the result limit.

  • start - date, is the start date.

  • end - date, is the end date.
Name Value Description
function getAppReview
parameters array Array of parameters
appid string App id
storeid string App store country id
market ios \ play (Optional) Market that gets searched
limit integer (Optional) Result limit
start date (Optional) Start date. YYYY-MM-DD
end date (Optional) End date. YYYY-MM-DD
"request": {
    "function":"getAppReview",
    "parameters": {
        "appid":"1234566",
        "storeid": 2,
        "market":"ios",
        "limit": 200
    }
}

Response

The response header[] contains:

  • stores[] - array, contains basic information about the stores.

    • storeid - string, is the app store country id.

    • storedesc - string, is the name of the app store country.

The results are displayed within a data[] array, which typically contains:

  • storeid[] - array, is the app store country id.

  • from - string, is the name of the reviewer.

  • title - string, is the review title.

  • text - string, is the full review text.

  • rating - string, is the review rating.

  • version - string, is the app version that was reviewed (this data isn't relevant anymore, as a version number is no longer provided).

  • adddate - date, is the date when the review was made.
Header
Name Value Description
stores array App full name
storeid string App store country id
storedesc string App developer
Data
Name Value Description
storeid array App store country id
from integer Reviewer's name
title integer Review title
text integer Review text
rating integer Review rating
version integer App version reviewed
adddate integer Review date
{
    "header":{
        "stores":{
            "1":"United States"
        }
    },"data":{
        "1":[
            {
                "adddate":"2009-08-26",
                "from":"MaddieTheGinger",
                "title":"Awesome!",
                "text":"This game is SO addictive! Some of these are easy but some are REALLY hard. Please keep adding new pictures!",
                "rating":"5",
                "version":" 1.0"
            },{
                "adddate":"2009-08-04",
                "from":"weisome",
                "title":"Test Your Eye Skills!",
                "text":"In this game you are shown a picture for 2 seconds and then the picture will change a little. You get 8 seconds to figure out what changed. Time runs out and you lose. To me the picture doesn't change but maybe I'm blind. :p This is really great for people who like these kind of games. I for one really don't like it but I still enjoy it. :)",
                "rating":"5",
                "version":" 1.0"
            }
        ]
    }
}
5. getAppRankedStores

The getAppRankedStores function returns a list of StoreIDs where an app is ranked in, and places the results within a data object in the response JSON.

Request

The function value is getAppRankedStores.

The parameters are optional and may be either of the following:

  • appid - string, is the app id.

  • start (optional) - date, is the start date. If no start date is given only the last 365 days back get checked.

  • end (optional) - date, is the end date.

  • categoryid (optional) - integer, the id of the app category.

  • device - string, is the type of device. It accepts the following values:

    • iphone
    • ipad
    • play
  • market (optional) - string, is the market that gets searched. If empty, the function will search through all markets. It accepts:
    • ios, to search into the iOS App Store.
    • play, to search into the Google Play Store.
Name Value Description
function getAppRankedStores
parameters array Array of parameters
appid string App id
start date (Optional) Start date. YYYY-MM-DD
end date (Optional) End date. YYYY-MM-DD
categoryid (Optional) App category id
device iphone \ ipad \ play Type of device
market ios \ play (Optional) Market that gets searched
"request": {
    "function":"getAppRankedStores",
    "parameters": {
        "appid":"1234566",
        "start":"YYYY-MM-DD", 
        "end":"YYYY-MM-DD", 
        "categoryid": 2, 
        "device": "iphone", 
        "market": "ios"
    }
}

Response

The results are displayed within a data[] array, which typically contains:

  • storeid - string, is the app store country id.

  • storedesc - string, is the app store country name.
Name Value Description
storeid string App store country id
storedesc string App store country name
"data": [{
    "storeid":"1",
    "storedesc": "United States"
}]
6. getAppRank

The getAppRank function returns app rankings, and places the results within a data object in the response JSON.

Request

The function value is getAppRank.

The parameters are optional and may be either of the following:

  • appid - string, is the app id.

  • start (optional) - date, is the start date.

  • end (optional) - date, is the end date.

  • storeid (optional) - integer, is the app store country id.

  • categoryid (optional) - integer, the id of the app category.

  • device - string, is the type of device. It accepts the following values:

    • iphone
    • ipad
    • play
  • market (optional) - string, is the market that gets searched. If empty, the function will search through all markets. It accepts:
    • ios, to search into the iOS App Store.
    • play, to search into the Google Play Store.
Name Value Description
function getAppRank
parameters array Array of parameters
appid string App id
start date Start date. YYYY-MM-DD
end date End date. YYYY-MM-DD
categoryid (Optional) App category id
device iphone \ ipad \ play Type of device
market ios \ play (Optional) Market that gets searched
"request": {
    "function":"getAppRank",
    "parameters": {
        "appid": "123456", 
        "start":"2014-10-06", 
        "end":"2014-11-06", 
        "storeid": 2, 
        "categoryid": "12", 
        "device":"iphone", 
        "market": "ios"
    }
}

Response

The response header[] contains:

  • stores[] - array, contains basic information about the stores.

    • storeid - string, is the app store country id.
    • storedesc - string, is the name of the app store country.
  • categories[] - array, contains:
    • categoryid - string, is the category id.
    • categorydesc - string, is the category name.

The results are displayed within a data[] array, which typically contains:

  • storeid[] - array, is the id of the app store country.

  • categoryid[] - array, is app category id.

  • popid[] - array, is a ID to show the type of rank for an app - it can be either free, paid or grossing.

  • rank - string, is the app rank.

  • date - date, is the date of when the app was ranked.
Header
Name Value Description
stores array
storeid string App store country id
storedesc string App store country name
categories array
categoryid string Category id
categorydesc string Category name
Data
Name Value Description
storeid array App store country id
categoryid string Category id
popid array Type id
rank string App rank
date date SQL Date
{
    "header": { 
        "stores": {}, 
        "categories": {}
    }, "data": { 
        "storeid": { 
            "categoryid": { 
                "popid": { 
                    "rank": "1", 
                    "date": "2014-08-14"
                }
            }
        }
    }
}
7. getAppRankHourly

The getAppRankHourly function returns 24 hours of data about app ranking, and places the results within a data object in the response JSON.

Request

The function value is getAppRankHourly.

The parameters are optional and may be either of the following:

  • appid - string, is the app id.

  • categoryid (optional) - integer, the id of the app category.

  • device - string, is the type of device. It accepts the following values:

    • iphone
    • ipad
    • play
  • market (optional) - string, is the market that gets searched. If empty, the function will search through all markets. It accepts:
    • ios, to search into the iOS App Store.
    • play, to search into the Google Play Store.
Name Value Description
function getAppRankHourly
parameters array Array of parameters
appid string App id
categoryid (Optional) App category id
device iphone \ ipad \ play Type of device
market ios \ play (Optional) Market that gets searched
"request": {
    "function":"getAppRankHourly",
    "parameters": {
        "appid": "123456", 
        "categoryid": "12", 
        "device":"iphone", 
        "market": "ios"
    }
}

Response

The response header[] contains:

  • lasthour - 0-24, gives the last hour collected.

  • stores[] - array, contains basic information about the stores.

    • storeid - string, is the app store country id.
    • storedesc - string, is the name of the app store country.
  • categories[] - array, contains:
    • categoryid - string, is the category id.
    • categorydesc - string, is the category name.

The results are displayed within a data[] array, which typically contains:

  • storeid[] - array, is the id of the app store country.

  • categoryid[] - array, is app category id.

  • popid[] - array, is a ID to show the type of rank for an app - it can be either free, paid or grossing.

  • rank - string, is the app rank.

  • hour - 0-24, is the hour when the app was ranked.
Header
Name Value Description
lasthour 0-24 Last hour collected
stores array
storeid string App store country id
storedesc string App store country name
categories array
categoryid string Category id
categorydesc string Category name
Data
Name Value Description
storeid array App store country id
categoryid array Category id
popid array Type id
rank string App rank
hour 0-24 Time when ranked
{
    "header": { 
        "stores": {}, 
        "categories": {}, 
        "lasthour": "5" 
        {}
    }, "data": { 
        "storeid": { 
            "categoryid": { 
                "popid": { 
                    "rank": "1", 
                    "date": "2014-08-14"
                }
            }
        }
    }
}
8. getAppRankBest

The getAppRankBest function returns the best rank in the last 6 months of data, and places the results within a data object in the response JSON.

Request

The function value is getAppRankBest.

The parameters are optional and may be either of the following:

  • appid - string, is the app id.

  • start (optional) - date, is the start date.

  • end (optional) - date, is the end date.

  • storeid (optional) - integer, is the id of the app store country.

  • categoryid (optional) - integer, the id of the app category.

  • device - string, is the type of device. It accepts the following values:

    • iphone
    • ipad
    • play
  • market (optional) - string, is the market that gets searched. If empty, the function will search through all markets. It accepts:
    • ios, to search into the iOS App Store.
    • play, to search into the Google Play Store.
Name Value Description
function getAppRankBest
parameters array Array of parameters
appid string App id
start date Start date. YYYY-MM-DD
end date End date. YYYY-MM-DD
categoryid (Optional) App category id
device iphone \ ipad \ play Type of device
market ios \ play (Optional) Market that gets searched
"request": {
    "function":"getAppRankBest",
    "parameters": {
        "appid": "123456", 
        "start":"2014-10-06", 
        "end":"2014-11-06", 
        "storeid": 2, 
        "categoryid": "12", 
        "device":"iphone", 
        "market": "ios"
    }
}

Response

The response header[] contains:

  • stores[] - array, contains basic information about the stores.

    • storeid - string, is the app store country id.
    • storedesc - string, is the name of the app store country.
  • categories[] - array, contains:
    • categoryid - string, is the category id.
    • categorydesc - string, is the category name.

The results are displayed within a data[] array, which typically contains:

  • storeid[] - array, is the id of the app store country.

  • categoryid[] - array, is app category id.

  • popid[] - array, is a ID to show the type of rank for an app - it can be either free, paid or grossing.

  • rank - string, is the app rank.

  • date - date, is the date of when the app was ranked.
Header
Name Value Description
stores array
storeid string App store country id
storedesc string App store country name
categories array
categoryid string Category id
categorydesc string Category name
Data
Name Value Description
storeid array App store country id
categoryid string Category id
popid array Type id
rank string App rank
date date SQL Date
{
    "header": { 
        "stores": {}, 
        "categories": {}, 
        "types": {}
    }, "data": { 
        "storeid": { 
            "categoryid": { 
                "popid": { 
                    "rank": "1", 
                    "date": "2014-08-14"
                }
            }
        }
    }
}
9. getAppRankAverage

The getAppRankAverage function returns the average rank in the last 6 months data, and places the results within a data object in the response JSON.

Request

The function value is getAppRankAverage.

The parameters are optional and may be either of the following:

  • appid - string, is the app id.

  • days - integer, is the number of days. Default is 7, Max is 180.

  • end (optional) - date, is the end date.

  • categoryid (optional) - integer, the id of the app category.

  • device - string, is the type of device. It accepts the following values:

    • iphone
    • ipad
    • play
  • market (optional) - string, is the market that gets searched. If empty, the function will search through all markets. It accepts:
    • ios, to search into the iOS App Store.
    • play, to search into the Google Play Store.
Name Value Description
function getAppRankAverage
parameters array Array of parameters
appid string App id
days integer Default 7, Max 180
end date End date. YYYY-MM-DD
categoryid (Optional) App category id
device iphone \ ipad \ play Type of device
market ios \ play (Optional) Market that gets searched
"request": {
    "function":"getAppRankAverage",
    "parameters": {
        "appid": "123456", 
        "start":"2014-10-06", 
        "end":"2014-11-06", 
        "storeid": 2, 
        "categoryid": "12", 
        "device":"iphone", 
        "market": "ios"
    }
}

Response

The response header[] contains:

  • stores[] - array, contains basic information about the stores.

    • storeid - string, is the app store country id.
    • storedesc - string, is the name of the app store country.
  • categories[] - array, contains:
    • categoryid - string, is the category id.
    • categorydesc - string, is the category name.

The results are displayed within a data[] array, which typically contains:

  • storeid[] - array, is the id of the app store country.

  • categoryid[] - array, is app category id.

  • popid[] - array, is a ID to show the type of rank for an app - it can be either free, paid or grossing.

  • rank - string, is the app rank.
Header
Name Value Description
stores array
storeid string App store country id
storedesc string App store country name
categories array
categoryid string Category id
categorydesc string Category name
Data
Name Value Description
storeid array App store country id
categoryid string Category id
popid array Type id
rank string App rank
{
    "header": { 
        "stores": {}, 
        "categories": {}
    }, "data": { 
        "storeid": { 
            "categoryid": { 
                "popid": { 
                    "rank": "1", 
                    "date": "2014-08-14"
                }
            }   
        }   
    }
}
10. getAppRankGrowth

The getAppRankGrowth function returns the rank growth in the last 6 months data, and places the results within a data object in the response JSON.

Request

The function value is getAppRankGrowth.

The parameters are optional and may be either of the following:

  • appid - string, is the app id.

  • days - integer, is the number of days. Default is 1. Max is 180.

  • end (optional) - date, is the end date.

  • categoryid (optional) - integer, the id of the app category.

  • device - string, is the type of device. It accepts the following values:

    • iphone
    • ipad
    • play
  • market (optional) - string, is the market that gets searched. If empty, the function will search through all markets. It accepts:
    • ios, to search into the iOS App Store.
    • play, to search into the Google Play Store.
Name Value Description
function getAppRankGrowth
parameters array Array of parameters
appid string App id
days integer Default 1, Max 180
end date End date. YYYY-MM-DD
categoryid (Optional) App category id
device iphone \ ipad \ play Type of device
market ios \ play (Optional) Market that gets searched
"request": {
    "function":"getAppRankGrowth",
    "parameters": {
        "appid": "123456", 
        "start":"2014-10-06", 
        "end":"2014-11-06", 
        "storeid": 2, 
        "categoryid": "12", 
        "device":"iphone", 
        "market": "ios"
    }
}

Response

The response header[] contains:

  • stores[] - array, contains basic information about the stores.

    • storeid - string, is the app store country id.
    • storedesc - string, is the name of the app store country.
  • categories[] - array, contains:
    • categoryid - string, is the category id.
    • categorydesc - string, is the category name.

The results are displayed within a data[] array, which typically contains:

  • storeid[] - array, is the id of the app store country.

  • categoryid[] - array, is app category id.

  • popid[] - array, is a ID to show the type of rank for an app - it can be either free, paid or grossing.

  • firstrank - string, is the first rank.

  • lastrank - string, is the last rank.

  • growth - string, is the rank growth.
Header
Name Value Description
stores array
storeid string App store country id
storedesc string App store country name
categories array
categoryid string Category id
categorydesc string Category name
Data
Name Value Description
storeid array App store country id
categoryid string Category id
popid array Type id
firstrank string First rank
lastrank string Last rank
growth string Rank growth
{
    "header": { 
        "stores": {}, 
        "categories": {}
    }, "data": { 
        "storeid": { 
            "categoryid": { 
                "popid": { 
                    "rank": "1", 
                    "date": "2014-08-14"
                }
            }
        }
    }
}
11. getAppRankHourlyGrowth

The getAppRankHourlyGrowth function returns the hourly ranks for an app compared with a past rank, and places the results within a data object in the response JSON.

Request

The function value is getAppRankHourlyGrowth.

The parameters are optional and may be either of the following:

  • appid - string, is the app id.

  • hoursback - integer, is the number of hours back to compare the rankings.

  • end (optional) - date, is the end date.

  • categoryid (optional) - integer, the id of the app category.

  • device - string, is the type of device. It accepts the following values:

    • iphone
    • ipad
    • play
  • market (optional) - string, is the market that gets searched. If empty, the function will search through all markets. It accepts:
    • ios, to search into the iOS App Store.
    • play, to search into the Google Play Store.
Name Value Description
function getAppRankHourlyGrowth
parameters array Array of parameters
appid string App id
hoursback integer Hours back to compare
end date End date. YYYY-MM-DD
categoryid (Optional) App category id
device iphone \ ipad \ play Type of device
market ios \ play (Optional) Market that gets searched
"request": {
    "function":"getAppRankHourlyGrowth",
    "parameters": {
        "appid": "123456", 
        "start":"2014-10-06", 
        "end":"2014-11-06", 
        "storeid": 2, 
        "categoryid": "12", 
        "hoursback": "1", 
        "device":"iphone", 
        "market": "ios"
    }
}

Response

The response header[] contains:

  • stores[] - array, contains basic information about the stores.

    • storeid - string, is the app store country id.
    • storedesc - string, is the name of the app store country.
  • categories[] - array, contains:
    • categoryid - string, is the category id.
    • categorydesc - string, is the category name.

The results are displayed within a data[] array, which typically contains:

  • storeid[] - array, is the id of the app store country.

  • categoryid[] - array, is app category id.

  • popid[] - array, is a ID to show the type of rank for an app - it can be either free, paid or grossing.

  • firstrank - string, is the first rank.

  • lastrank - string, is the last rank.

  • growth - string, is the rank growth.
Header
Name Value Description
stores array
storeid string App store country id
storedesc string App store name
categories array
categoryid string Category id
categorydesc string Category name
Data
Name Value Description
storeid array App store country id
categoryid string Category id
popid array Type id
firstrank string First rank
lastrank string Last rank
growth string Rank growth
{
    "header": { 
        "stores": {}, 
        "categories": {}
    }, "data": { 
        "storeid": { 
            "categoryid": { 
                "popid": { 
                    "firstrank": "1", 
                    "lastrank": "1", 
                    "growth": "100%"
                }
            }
        }
    }
}
12. getAppChart

The getAppChart function returns the daily ranks for the end data and shows the past rank. It places the results within a data object in the response JSON. Requests can take longer if the time range is very high.

Request

The function value is getAppChart.

The parameters are optional and may be either of the following:

  • appid - string, is the app id.

  • days - integer, is the number of days to compare.

  • end - date, is the end date.

  • categoryid (optional) - integer, the id of the app category.

  • offset (optional) - integer, if you want to start from a certain rank to get the char.

  • limit (optional) - integer, is the max amount of rows.

  • language (optional) - string, is the language code for returned localization (app name, description). See country list for language codes.

  • years (optional) - integer, only value is 2 for the past 2 years. If dates are set .

  • market (optional) - string, is the market that gets searched. If empty, the function will search through all markets. It accepts:
    • ios, to search into the iOS App Store.
    • play, to search into the Google Play Store.
Name Value Description
function getAppChart
parameters array Array of parameters
appid string App id
days integer Days to compare
end date End date. YYYY-MM-DD
categoryid (Optional) App category id
offset integer Chart offset
limit integer Max amount of rows
language string language code
market ios \ play (Optional) Market that gets searched
"request": {
    "function":"getAppChart",
    "parameters": {
        "start":"2014-10-06", 
        "end":"2014-11-06", 
        "storeid": 2, 
        "categoryid": "12", 
        "device":"iphone", 
        "market": "ios"
    }
}

Response

The response header[] contains:

  • types[] - array, contains basic information about the types.
    • popid - string, is the type id.
    • popdesc - string, is the name of the type.

The results are displayed within a data[] array, which typically contains:

  • rank - string, is the app rank.

  • popid[] - array, is a ID to show the type of rank for an app - it can be either free, paid or grossing.

  • appid - string, is the app id.

  • name - string, is the app name.

  • pastrank - string, is the app rank given the amount of days back.
Header
Name Value Description
types array
popid string Type id
popdesc string Type name
Data
Name Value Description
rank string App rank
popid array Type id
appid string App id
name string App name
pastrank string Past rank
{
    "header": {
        "lastrank": "1000" , 
        "types": {}
    }, "data": { 
        "rank": { 
            "popid": { 
                "appid": "123456", 
                "name": "test", 
                "pastrank": "1", 
                "appurl: "", 
                "imageurl": ""
            }
        }
    }
}
13. getAppChartHourly

The getAppChartHourly function returns the hourly ranks for the current hour and shows the past rank. It places the results within a data object in the response JSON.

Request

The function value is getAppChartHourly.

The parameters are optional and may be either of the following:

  • appid - string, is the app id.

  • hoursback (Optional) - integer, (1-23) is the number of hours to go back to current hour.

  • pasthoursback (Optional) - integer, (1-23) is the number of hours to go compare against against hoursback. Leave empty for current hour.

  • categoryid (optional) - integer, the id of the app category.

  • limit (optional) - integer, is the max amount of rows.

  • language (optional) - string, is the language code for returned localization (app name, description). See country list for language codes.

  • market - string, is the market that gets searched. If empty, the function will search through all markets. It accepts:
    • ios, to search into the iOS App Store.
    • play, to search into the Google Play Store.
Name Value Description
function getAppChartHourly
parameters array Array of parameters
appid string App id
hoursback 1-23 Hours to compare
end date End date. YYYY-MM-DD
categoryid (Optional) App category id
offset integer Chart offset
limit integer Max amount of rows
language string language code
market ios \ play Market that gets searched
"request": {
    "function":"getAppChartHourly",
    "parameters": {
        "appid": "123456", 
        "storeid": 2, 
        "hoursback":1, 
        "categoryid": "12", 
        "device":"iphone", 
        "market": "ios"
    }
}

Response

The response header[] contains:

  • types[] - array, contains basic information about the types.

    • popid - string, is the type id.
    • popdesc - string, is the name of the type.
  • lastrank - string, is the last rank that was found.

  • lasthour - timestamp, is the current hour.

  • pasthour - timestamp, is the previous hour of a rank.

The results are displayed within a data[] array, which typically contains:

  • rank - string, is the app rank.

  • popid[] - array,is a ID to show the type of rank for an app - it can be either free, paid or grossing.

  • appid - string, is the app id.

  • name - string, is the app name.

  • pastrank - string, is the app rank given the amount of days back.
Header
Name Value Description
types array
popid string Type id
popdesc string Type name
lastrank string Type name
lasthour timestamp UTC Current hour
pasthour timestamp UTC Previous hour of a rank
Data
Name Value Description
rank string App rank
popid array Type id
appid string App id
name string App name
pastrank string Past rank
{
    "header": { 
        "lastrank": "1000" , 
        "types": {}
    }, "data": { 
        "rank": { 
            "popid": { 
                "appid": "123456", 
                "name": "test", 
                "pastrank": "1", 
                "appurl: "", 
                "imageurl": ""
            }
        }
    }
}
14. getAppKeywordRank

The getAppKeywordRank function returns app keyword rankings, and places the results within a data object in the response JSON.

Request

The function value is getAppKeywordRank.

The parameters are optional and may be either of the following:

  • appid - string, is the app id.

  • start (optional) - date, is the start date.

  • end (optional) - date, is the end date.

  • storeid (optional) - integer, is the app store country id.

  • categoryid (optional) - integer, the id of the app category.

  • device - string, is the type of device. It accepts the following values:

    • iphone
    • ipad
  • market (optional) - string, is the market that gets searched. If empty, the function will search through all markets. It accepts:
    • ios, to search into the iOS App Store.
Name Value Description
function getAppKeywordRank
parameters array Array of parameters
appid string App id
start date Start date. YYYY-MM-DD
end date End date. YYYY-MM-DD
device iphone \ ipad \ play Type of device
market ios (Optional) Market that gets searched
"request": {
    "function":"getAppRank",
    "parameters": {
        "appid": "123456", 
        "start":"2014-10-06", 
        "end":"2014-11-06", 
        "storeid": 2,  
        "device":"iphone", 
        "market": "ios"
    }
}

Response

The response header[] contains:

  • stores[] - array, contains basic information about the stores.

    • storeid - string, is the app store country id.
    • storedesc - string, is the name of the app store country.
  • categories[] - array, contains:
    • categoryid - string, is the category id.
    • categorydesc - string, is the category name.

The results are displayed within a data[] array, which typically contains:

  • deviceid[] - array, is the id of the device.

  • storeid[] - array, is the id of the app store country..

  • keywordid[] - array, is a ID to show the type of rank for an app - it can be either free, paid or grossing.

  • rank - string, is the app rank.

  • date - date, is the date of when the app was ranked.
Header
Name Value Description
stores array
storeid string App store country id
storedesc string App store country name
keywords array
keywordid string Category id
keyworddesc string Category name
Data
Name Value Description
deviceid array Device id
storeid string App Store id
keywordid array Type id
rank string App rank
date date SQL Date
{
    "header": { 
        "stores": {}, 
        "keywords": {}
    }, "data": { 
        "deviceid": { 
            "storeid": { 
                "keywordid": { 
                    "rank": "1", 
                    "date": "2014-08-14" 
                }
            }
        }
    }
}

Country List

Country availability is listed below for iOS and Google Play. Historic data ranges may vary by country and store. Localized names and descriptions aren't for every store available.

ID Country Language Code iOS Play
1 United States en yes yes
2 Argentina cy yes yes
3 Australia en yes yes
4 Austria de yes yes
5 Belgium fr-be yes yes
6 Brazil pt yes yes
7 Canada en yes yes
8 Chile ay yes yes
9 China zh-cn yes yes
10 Colombia es yes yes
11 Costa Rica es yes yes
12 Croatia hr yes yes
13 Czech Republic cs yes yes
14 Denmark da yes yes
15 Germany de yes yes
16 El Salvador es yes yes
17 Spain es yes yes
18 Finland fi yes yes
19 France fr yes yes
20 Greece el yes yes
21 Guatemala es yes yes
22 Hong Kong zh yes yes
23 Hungary hu yes yes
24 India hi yes yes
25 Indonesia id yes yes
26 Ireland en yes yes
27 Israel he yes yes
28 Italy it yes yes
29 Korea ko yes yes
30 Kuwait ar yes yes
31 Lebanon ar yes yes
32 Luxembourg lb yes yes
33 Malaysia ms yes yes
34 Mexico es yes yes
35 Netherlands nl yes yes
36 New Zealand en yes yes
37 Norway no yes yes
38 Pakistan ur yes yes
39 Panama es yes yes
40 Peru es yes yes
41 Philippines ti yes yes
42 Poland pl yes yes
43 Portugal pt yes yes
44 Qatar ar yes yes
45 Romania ro yes yes
46 Russia ru yes yes
47 Saudi Arabia ar yes yes
48 Switzerland de yes yes
49 Singapore zh-sg yes yes
50 Slovakia sk yes yes
51 Slovenia hu yes yes
52 South Africa en yes yes
53 Sri Lanka si yes yes
54 Sweden sv yes yes
55 Taiwan zh yes yes
56 Thailand th yes yes
57 Turkey tr yes yes
58 United Arab Emirates ar yes yes
59 United Kingdom en yes yes
60 Venezuela es yes yes
61 Vietnam vi yes yes
62 Japan ja yes yes
63 Dominican Republic es yes yes
64 Uruguay es yes yes
65 Paraguay es yes yes
66 Nicaragua es yes yes
67 Moldova mo yes yes
68 Malta mt yes yes
69 Macau zh yes no
70 Lithuania lt yes yes
71 Latvia lv yes yes
72 Kazakhstan kk yes yes
73 Ecuador es yes yes
74 Egypt ar yes yes
75 Estonia et yes yes
76 Honduras es yes yes
77 Jamaica en yes yes
78 Armenia hy yes yes
79 Botswana tn yes yes
80 Bulgaria bg yes yes
81 Jordan ar-jo yes yes
82 Kenya sw yes yes
83 Macedonia mk yes yes
84 Madagascar mg yes no
85 Mali yes yes
86 Mauritius yes yes
87 Niger yes yes
88 Senegal yes yes
89 Tunisia yes yes
90 Uganda yes yes
91 Algeria yes yes
92 Angola yes yes
93 Anguilla yes no
94 Antigua and Barbuda yes yes
95 Azerbaijan yes yes
96 Bahamas yes yes
97 Bahrain yes yes
98 Barbados yes no
99 Belarus yes yes
100 Belize yes yes
101 Bermuda yes no
102 Bolivia yes yes
103 British Virgin Islands yes no
104 Brunei yes no
105 Cayman Islands yes no
106 Cyprus yes yes
107 Dominica yes no
108 Ghana yes yes
109 Grenada yes no
110 Guyana yes no
111 Iceland yes yes
112 Montserrat yes no
113 Nigeria yes yes
114 Oman yes yes
115 St. Kitts and Nevis yes no
116 St. Lucia yes no
117 St. Vincent and The Grenadines yes no
118 Suriname yes no
119 Tanzania yes yes
120 Trinidad and Tobago yes yes
121 Turks and Caicos yes no
122 Uzbekistan yes yes
123 Yemen yes yes
124 Albania sq yes yes
125 Benin fr yes yes
126 Bhutan dz yes no
127 Burkina Faso fr yes no
128 Cambodia km yes yes
129 Cape Verde pt yes yes
130 Chad fr yes no
131 Congo fr yes no
132 Fiji fj yes yes
133 Gambia en yes no
134 Guinea-Bissau pt yes yes
135 Kyrgyzstan ky yes yes
136 Laos lo yes yes
137 Liberia en yes no
138 Malawi ny yes no
139 Mauritania ar yes no
140 Micronesia en yes no
141 Mongolia mn yes no
142 Mozambique pt yes yes
143 Namibia en yes yes
144 Nepal ne yes yes
145 Palau en yes no
146 Papua New Guinea en yes yes
147 Sao Tome and Principe pt yes no
148 Seychelles en yes no
149 Sierra Leone en yes no
150 Solomon Islands en yes no
151 Swaziland en yes no
152 Tajikistan tg yes yes
153 Turkmenistan tk yes yes
154 Ukraine uk yes yes
155 Zimbabwe en yes yes

Category List iOS

ID Name
1 Top Overall
2 Books
3 Business
4 Education
5 Entertainment
6 Finance
7 Healthcare/Fitness
8 Lifestyle
9 Medical
10 Music
11 Navigation
12 News
13 Photography
14 Productivity
15 Reference
16 Social/Networking
17 Sports
18 Travel
19 Utilities
20 Weather
21 Games
22 Games/Action
23 Games/Adventure
24 Games/Arcade
25 Games/Board
26 Games/Card
27 Games/Casino
28 Games/Dice
29 Games/Educational
30 Games/Family
31 Games/Kids
32 Games/Music
33 Games/Puzzle
34 Games/Racing
35 Games/Role Playing
36 Games/Simulation
37 Games/Sports
38 Games/Strategy
39 Games/Trivia
40 Games/Word
42 Developer Tools
43 Graphics and Design
44 Video
45 Newsstand
46 Catalogs
47 Food & Drink
48 Newsstand / Movies and Music
49 Newsstand / Arts and Photography
50 Newsstand / Automotive
51 Newsstand / Brides & Weddings
52 Newsstand / Business & Investing
53 Newsstand / Children's Magazines
54 Newsstand / Computers & Internet
55 Newsstand / Cooking, Food & Drink
56 Newsstand / Crafts & Hobbies
57 Newsstand / Electronics & Audio
58 Newsstand / Entertainment
59 Newsstand / Fashion & Style
60 Newsstand / Health, Mind & Body
61 Newsstand / History
62 Newsstand / Home & Garden
63 Newsstand / Literary Magazines & Journals
64 Newsstand / Men's Interest
65 Newsstand / News & Politics
66 Newsstand / Outdoors & Nature
67 Newsstand / Parenting & Family
68 Newsstand / Pets
69 Newsstand / Professional & Trade
70 Newsstand / Regional News
71 Newsstand / Science
72 Newsstand / Sports & Leisure
73 Newsstand / Teens
74 Newsstand / Travel & Regional
75 Newsstand / Women's Interest
80 Shopping

Category List Google Play

ID Name
1 Top Overall
2 Books and Reference
3 Business
4 Comics
5 Productivity
6 Finance
7 Photography
8 Health and Fitness
9 Communication
10 Education
11 Lifestyle
12 App Wallpaper
13 Media and Video
14 Medical
15 News and Magazines
16 Personalization
17 Travel and Local
18 Shopping
19 Libraries and Demo
20 Social
21 Sports
22 Tools
23 Entertainment
24 Transportation
25 Weather
26 App Widgets
27 Games
28 Games Adventure
29 Games Action
30 Games Arcade
31 Games Board
32 Games Family
33 Games Puzzle
34 Games Casual
35 Games Card
36 Games Casino
37 Games Educational
38 Games Wallpaper
39 Games Music
40 Games Trivia
41 Games Racing
42 Games Role Playing
43 Games Simultation
44 Games Sports
45 Games Strategy
46 Games Widgets
47 Games Word
48 Top Applications
49 Music and Audio
50 Family Action
51 Family Education
52 Family Braingames
53 Family Rolegames
54 Family
55 Family Music and Video

PopIDs

ID Name Market
90 Free play
91 Paid play
92 Grossing play
93 New Paid play
94 New Free play
0 iPhone Paid ios
1 iPhone Free ios
2 iPhone Grossing ios
30 Mac Paid mac
27 Mac Free mac
38 Mac Grossing mac
44 iPad Free ios
47 iPad Paid ios
46 iPad Grossing ios