Android Installs

API Documentation

Would you like to run your own business using our services? Here is the API documentation for you! With our API support, you can list or create CPI, Keyword or High Retention campaigns easily.

Check your API key on your profile.

Apps

Apps - ADD

Adds new application

get
http://api.androidinstalls.com/apps

Parameter

Field Type Description
apikey String

Unique API key.

add String

URL of your application

The add parameter's value can be two form of value. Either the Google Play URL https://play.google.com/store/apps/details?id=com.facebook.katana or more preferably only the id part com.facebook.katana.

Success 200

Field Type Description
success String

The App has been created or it's informations refreshed.

id Number

ID of the app

Success-Response:

{
   "success": "The App has been successfully created.",
   "id": 12
}

Error 4xx

Field Type Description
error Array[]

Error parameters.

  code Number

HTTP error code for the current error.

  message String

Description of error.

Apps - LIST

Retrieves all applications

get
http://api.androidinstalls.com/apps

Parameter

Field Type Description
apikey String

Unique API key.

Success 200

Field Type Description
id Number

ID of the app

title String

The title of the app

Success-Response:

[
   {
      "id": 12,
      "title": "Facebook"
   }
]

Error 4xx

Field Type Description
error Array[]

Error parameters.

  code Number

HTTP error code for the current error.

  message String

Description of error.

Campaigns

Campaigns - ADD

Adds new campaign

post
http://api.androidinstalls.com/addcampaign

Parameter

Field Type Description
apikey String

Unique API key.

appid Number

APPID

volume Number

Install volume. Cannot be smaller than 50.

dil optional Number

Daily Installs limit. Cannot be smaller than 50.

countries optional Array[]

A country or multiple countries. Add full country names or country codes. WW or Worldwide by default. In case you are adding full text names, make sure they have exact match in our reference list. More details COUNTRIES/LIST

keywords optional String

Prefered keyword or keywords

Success 200

Field Type Description
success String

Campaign has been created.

Success-Response:

{
   "success": "Campaign has been successfully created.",
   "id": 12
}

Error 4xx

Field Type Description
error Array[]

Error parameters.

  code Number

HTTP error code for the current error.

  message String

Description of error.

Campaigns - GET

Retrieves a single campaign's data

get
http://api.androidinstalls.com/campaigns

Parameter

Field Type Description
apikey String

Unique API key.

id Number

ID of campaign

Success 200

Field Type Description
id Number

ID of the campaign

country String

Country

installs Number

Number of Installs

status String

Status of the campaign

country_list Array[]

List of countries and their install numbers.

  Country as key Number

Country as key and the install number is the value.

Success-Response:

[
   {
      "id": 12,
      "country": "WORLDWIDE",
      "installs": 22,
      "status": "COMPLETED",
      "country_list": {
         "Russia": 20,
         "India": 12
      }
   }
]

Error 4xx

Field Type Description
error Array[]

Error parameters.

  code Number

HTTP error code for the current error.

  message String

Description of error.

Campaigns - LIST

Retrieves all campaigns

get
http://api.androidinstalls.com/campaigns

Parameter

Field Type Description
apikey String

Unique API key.

Success 200

Field Type Description
id Number

ID of the campaign

country String

Country

installs Number

Number of Installs

status String

Status of the campaign

country_list Array[]

List of countries and their install numbers.

  Country as key Number

Country as key and the install number is the value.

Success-Response:

[
   {
      "id": 12,
      "country": "WORLDWIDE",
      "installs": 22,
      "status": "COMPLETED",
      "country_list": {
         "Russia": 20,
         "India": 12
      }
   }
]

Error 4xx

Field Type Description
error Array[]

Error parameters.

  code Number

HTTP error code for the current error.

  message String

Description of error.

High Retention Campaigns

High Retention Campaigns - ADD

Adds new high retention campaign

post
http://api.androidinstalls.com/addhrcampaign

Parameter

Field Type Description
apikey String

Unique API key.

appid Number

APPID

volume Number

Install volume. Cannot be smaller than 50.

dil optional Number

Daily Installs limit. Cannot be smaller than 50.

countries optional Array[]

A country or multiple countries. Add full country names or country codes. WW or Worldwide by default. In case you are adding full text names, make sure they have exact match in our reference list. More details COUNTRIES/LIST

keywords optional String

Prefered keyword or keywords

rdaysoptional Number

Retention days. 1 by default. When the retention time has ended (+2 days extra) we will mark your campaign as 'completed' and you will get a partial refund.

Success 200

Field Type Description
success String

Campaign has been created.

Success-Response:

{
   "success": "High Retention Campaign has been successfully created.",
   "id": 12
}

Error 4xx

Field Type Description
error Array[]

Error parameters.

  code Number

HTTP error code for the current error.

  message String

Description of error.

High Retention Campaigns - GET

Retrieves a single high retention campaign's data

get
http://api.androidinstalls.com/hrcampaigns

Parameter

Field Type Description
apikey String

Unique API key.

id Number

ID of campaign

Success 200

Field Type Description
id Number

ID of the campaign

country String

Country

installs Number

Number of Installs

remaining_installs Number

Number of Remaining Installs

status String

Status of the campaign

country_list Array[]

List of countries and their install numbers.

  Country as key Number

Country as key and the install number is the value.

Success-Response:

[
   {
      "id": 12,
      "country": "WORLDWIDE",
      "installs": 22,
      "remaining_installs": 10,
      "status": "COMPLETED",
      "country_list": {
         "Russia": 20,
         "India": 12
      }
   }
]

Error 4xx

Field Type Description
error Array[]

Error parameters.

  code Number

HTTP error code for the current error.

  message String

Description of error.

High Retention Campaigns - LIST

Retrieves all high retention campaigns

get
http://api.androidinstalls.com/hrcampaigns

Parameter

Field Type Description
apikey String

Unique API key.

Success 200

Field Type Description
id Number

ID of the campaign

country String

Country

installs Number

Number of Installs

remaining_installs Number

Number of Remaining Installs

status String

Status of the campaign

country_list Array[]

List of countries and their install numbers.

  Country as key Number

Country as key and the install number is the value.

Success-Response:

[
   {
      "id": 12,
      "country": "WORLDWIDE",
      "installs": 22,
      "remaining_installs": 10,
      "status": "COMPLETED",
      "country_list": {
         "Russia": 20,
         "India": 12
      }
   }
]

Error 4xx

Field Type Description
error Array[]

Error parameters.

  code Number

HTTP error code for the current error.

  message String

Description of error.

Countries

Countries - LIST

Retrieves a dedicated list of countries for the API. You can use it if you need for adding new Campaigns via the API.

get
http://api.androidinstalls.com/countries

Parameter

Field Type Description
apikey String

Unique API key.

Success 200

Field Type Description
cc String

Country Code

name String

Name of country

Success-Response:

[
   {
      "cc": "US",
      "country": "United States"
   }
]

Error 4xx

Field Type Description
error Array[]

Error parameters.

  code Number

HTTP error code for the current error.

  message String

Description of error.