API Documentation
Help and API wiring guide
INTRODUCTION
AUTHENTICATION
CONNECT
FUNCTIONS
- :analysistoppublishers
- :appkeywordrank
- :appkeywordranktoday
- :appkeywordsearch
- :apprank
- :apprankhourly
- :apprankhourlysingle
- :appreviews
- :appsearch
- :categorylist
- :countrylist
- :worldchart
PRICING
SUPPORT
INTRODUCTION
The APPlyzer API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website's client-side code). JSON is returned by all API responses, including errors, although our API libraries convert responses to appropriate language-specific objects.
AUTHENTICATION
To connect to the API use your API Key which you can find in your profile.
CONNECT
To connect to the APPLyzer API you need to have your key and function with parameters.
You can test the API in your browser or your favorite programming language.
URL:
https://api.applyzer.com/key:APIKEY/function:FUNCTIONNAME/paramater1:value1/paramater2:value2
Example:
https://api.applyzer.com/key:APIKEY/function:appinfo/appid:363590051
Errors
HTTP status code summary
- 200 - OK ::
- Everything worked as expected.
- 400 - Bad Request ::
- The request was unacceptable, often due to missing a required parameter.
- 401 - Unauthorized ::
- No valid API key provided.
- 402 - Request Failed ::
- The parameters were valid but the request failed.
- 404 - Not Found ::
- The requested resource doesn't exist.
- 409 - Limit ::
- You reached your limit. Check your API subscription.
- 429 - Too Many Requests ::
- Too many requests hit the API too quickly.
FUNCTIONS
Function ":analysistoppublishers"
Cost per request: 1
This amount gets added to your monthly total.
Get daily Top Publishers with the amount of apps in a certain app store and category.
Parameters
market : ios/mac/play
device : iphone/ipad/mac/appletv/android
storeid : integer
categoryid : integer
Response
{"data": {"type (string)":{"seller", "count", "percentage"}}, "header":{"date":"SQL Date"}
Example
https://api.applyzer.com/key:APIKEY/function:analysistoppublishers/storeid:1/categoryid:1/market:ios/device:iphone
Function ":appkeywordrank"
Cost per request: 10
This amount gets added to your monthly total.
Get keyword rankings you defined for your app. Sending a request with the storeid is faster.
Parameters
appid : string
Market : iOS/Mac/Play
Device : iPhone/iPad/iPhoneiOS12/iPadiOS12/Mac/AppleTV/Android
Date : SQL YYYY-MM-DD
Optional Parameters
storeid : integer
Response
{"data": {"keyword":{"storeid":"rank"}}}
Example
https://api.applyzer.com/key:APIKEY/function:appkeywordrank/market:ios/device:appletv/date:2016-09-01/appid:363590051/storeid:1
Function ":appkeywordranktoday"
Cost per request: 10
This amount gets added to your monthly total.
Get keyword rankings by search for a keyword in our library. If we do not have the keyword, the result is empty and no requestcosts will be added to your subscription. Sending a request with the storeid is faster.
Parameters
keyword : string
Market : iOS/Mac/Play
Device : iPhone/iPad/Mac/AppleTV/Android
startdate : SQL YYYY-MM-DD
enddate : SQL YYYY-MM-DD
Optional Parameters
storeid : integer
ranklimit : integer
Response
{"data": {"storeid":{"date":[{"rank":integer,"appid":string}]}}}
Example
https://api.applyzer.com/key:APIKEY/function:appkeywordsearch/market:ios/device:iphone/startdate:2020-04-02/enddate:2020-04-07/keyword:agoda/storeid:1
Function ":appkeywordsearch"
Cost per request: 10
This amount gets added to your monthly total.
Get keyword rankings by search for a keyword in our library. If we do not have the keyword, the result is empty and no requestcosts will be added to your subscription. Sending a request with the storeid is faster.
Parameters
keyword : string
Market : iOS/Mac/Play
Device : iPhone/iPad/Mac/AppleTV/Android
startdate : SQL YYYY-MM-DD
enddate : SQL YYYY-MM-DD
Optional Parameters
storeid : integer
ranklimit : integer
Response
{"data": {"storeid":{"date":[{"rank":integer,"appid":string}]}}}
Example
https://api.applyzer.com/key:APIKEY/function:appkeywordsearch/market:ios/device:iphone/startdate:2020-04-02/enddate:2020-04-07/keyword:agoda/storeid:1
Function ":apprank"
Cost per request: 2
This amount gets added to your monthly total.
Get daily rankings for your app.
Choose a start and end date. Check the functions countrylist and categorylist to get the corresponding id's for storeid and categoryid.
Parameters
appid : string
Market : iOS/Mac/Play
Device : iPhone/iPad/Mac/AppleTV/Android/Sticker
StartDate : SQL YYYY-MM-DD
EndDate : SQL YYYY-MM-DD
Optional Parameters
storeid : integer or comma seperated integer
categoryid : integer
type : free/paid/grossing
Response
{"data": {"storeid":{"categoryid":{"type (string)":{"rank", "date"}}}}}
Example
https://api.applyzer.com/key:APIKEY/function:apprank/storeid:1,59/categoryid:1/market:ios/device:appletv/startdate:2018-08-07/enddate:2018-08-10/appid:363590051
Function ":apprankhourly"
Cost per request: 60
This amount gets added to your monthly total.
Get last 24 hour rankings for your app. Check the functions countrylist and categorylist to get the corresponding id's for storeid and categoryid.
Parameters
market : ios/mac/play
device : iphone/ipad/mac/appletv/android
Optional Parameters
storeid : integer
categoryid : integer
Response
{"data": {"storeid":{"categoryid":{"type (string)":{"rank", "timestamp"}}}},"header":{"stores":[], "categories":[], "types (free,paid,grossing)":[], "lasthour", "timezone"}
Example
https://api.applyzer.com/key:APIKEY/function:apprankhourly/storeid:1/categoryid:1/market:ios/device:appletv/appid:363590051
Function ":apprankhourlysingle"
Cost per request: 3
This amount gets added to your monthly total.
Get last hour rankings for your app. The lasthour is shown in CEST.
Parameters
market : ios/mac/play
device : iphone/ipad/mac/appletv/android
Optional Parameters
storeid : integer
categoryid : integer
type : free/paid/grossing
lasthour : 00-23 CEST
Response
{"data": {"storeid":{"categoryid":{"type (string)":{"rank", "timestamp"}}}},"header":{"stores":[], "categories":[], "types (free,paid,grossing)":[], "lasthour", "timezone"}
Example
https://api.applyzer.com/key:APIKEY/function:apprankhourlysingle/storeid:1/categoryid:1/market:ios/device:appletv/appid:363590051
Function ":appreviews"
Cost per request: 5
This amount gets added to your monthly total.
Get for your app the latest reviews.
Parameters
Market : iOS/Mac/Play
appid : app id
Optional Parameters
Response
{"data": [{"date (string)":"SQL DATE", "from":"string", "country":"string", "subject":"string","rating":"string", "text":"string"}]}
Example
https://api.applyzer.com/key:APIKEY/function:appreviews/market:ios/appid:123456789
Function ":appsearch"
Cost per request: 1
This amount gets added to your monthly total.
Get meta data by search.
Parameters
appid : string min 3 characters
Optional Parameters
market : ios/mac/play
Response
{"data": {"appid","name","company","changed","downloads","imageurl","market","category"}}
Example
https://api.applyzer.com/key:APIKEY/function:appsearch/term:angry birds
Function ":categorylist"
Cost per request: 0
Get a list of categories with id
Parameters
market : ios/mac/play
Response
{"data": {"id","name"}}
Example
https://api.applyzer.com/key:APIKEY/function:categorylist/market:ios
Function ":countrylist"
Cost per request: 0
Get a list of countries with id. Play countries are true.
Parameters
market : ios/mac/play
Response
{"data": {"id","name","play","code"}}
Example
https://api.applyzer.com/key:APIKEY/function:countrylist/market:play
Function ":worldchart"
Cost per request: 10
This amount gets added to your monthly total.
Get for any market, country or category the top charts. Check the functions countrylist and categorylist to get the corresponding id's for storeid and categoryid.
Parameters
Market : iOS/Mac/Play
Device : iPhone/iPad/Mac/AppleTV/Android/Sticker
storeid : integer
categoryid : integer
Date : SQL YYYY-MM-DD
Optional Parameters
onlyappids : true/false
limit : integer
Response
{"data": {"rankings":{"type (string)":["appid"]}},{"apps":{"appid":{"name", "url"}}}}
Example
https://api.applyzer.com/key:APIKEY/function:worldchart/storeid:1/categoryid:1/market:ios/device:appletv/date:2016-08-07/limit:10
PRICING
For our API usage is based on the number of API requests you would like to use our service. Please view the DATA plan on our pricing page.
SUPPORT
If you need support implementing the API, send us a email feedback@applyzer.com