Title
Content
Ok
Cancel

API Documentation

Help and API wiring guide

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/Mac/AppleTV/Android
Date : SQL YYYY-MM-DD

Optional Parameters

storeid : integer

Response

{"data": {"keyword":{"storeid":"rank"}}}

Example

https://api.applyzer.com/APIKEY/function:appkeywordrank/market:ios/device:appletv/date:2016-09-01/appid:363590051/storeid:1

Function ":appkeywordranktoday"

Cost per request: 2
This amount gets added to your monthly total.

Get todays keyword rankings found for your app.

Parameters

market : ios/mac/play
device : iphone/ipad/mac/appletv/sticker/android
appid : string

Optional Parameters

storeid : integer
keyword : string

Response

{"data": {"keyword":{"storeid":"rank"}}}

Example

https://api.applyzer.com/APIKEY/function:appkeywordrank/market:ios/device:appletv/date:2016-09-01/appid:363590051/storeid:1

Function ":apprank"

Cost per request: 1
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
StartDate : SQL YYYY-MM-DD
EndDate : SQL YYYY-MM-DD

Optional Parameters

storeid : 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/categoryid:1/market:ios/device:appletv/startdate:2016-08-07/enddate:2016-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 ":appsearch"

Cost per request: 1
This amount gets added to your monthly total.

Get meta data by search.

Parameters

term : 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:appinfo/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
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 we have a given pricetable which is based on the number of API requests you would like to use our service. Please contact us to learn more on our pricing.

Requests per Month
Price
Extra 10k requests
100k
EUR 490
EUR 47
200k
EUR 940
EUR 45
300k
EUR 1320
EUR 43
400k
EUR 1650
EUR 41
500k
EUR 1920
EUR 39

SUPPORT

If you need support implementing the API, send us a email [email protected]